SMS
SMS and MMS APIs.
Définitions de types
type Subscription {
smsChanged: SmsProviderChange
smsSendResult: SmsSendResult!
}
type Mutation {
archiveSmsConversation(id: ID!, date: Instant): Boolean!
deleteSms(query: String!): ActionResult!
restoreSms(query: String!): ActionResult!
sendSms(number: String!, body: String!, attachmentPaths: [String!]! = [], subscriptionId: Int, requestId: String!): SmsSendReceipt!
trashSms(query: String!): ActionResult!
unarchiveSmsConversation(id: ID!): Boolean!
}
type Query {
archivedSmsConversations(query: String!, offset: Int!, limit: Int!): [SmsConversation!]!
sims: [Sim!]!
sms(query: String!, offset: Int!, limit: Int!): [Sms!]!
smsBoxCounts: SmsCounts!
smsConversationCount(query: String!): Int!
smsConversations(query: String!, offset: Int!, limit: Int!): [SmsConversation!]!
smsCount(query: String!): Int!
}
type ActionResult {
affectedCount: Int!
}
enum DataType {
DEFAULT
AUDIO
VIDEO
IMAGE
SMS
CONTACT
NOTE
FEED_ENTRY
CALL
PACKAGE
FILE
APP_FILE
DOC
}
scalar Instant
type Sim {
id: ID!
label: String!
number: String!
subscriptionId: Int!
}
type Sms {
id: ID!
body: String!
address: String!
sentAt: Instant!
serviceCenter: String!
read: Boolean!
threadId: ID!
type: SmsType!
typeCode: Int!
subscriptionId: Int!
isMms: Boolean!
attachments: [SmsAttachment!]!
tags: [Tag!]!
}
type SmsAttachment {
path: String!
contentType: String!
name: String!
}
type SmsConversation {
id: ID!
address: String!
snippet: String!
lastMessageAt: Instant!
messageCount: Int!
read: Boolean!
addresses: [String!]!
}
type SmsCounts {
total: Int!
inbox: Int!
sent: Int!
drafts: Int!
}
type SmsProviderChange {
uris: [String!]!
}
type SmsSendReceipt {
requestId: String!
requiresConfirmation: Boolean!
}
type SmsSendResult {
requestId: String!
success: Boolean!
resultCode: Int
}
enum SmsType {
INBOX
SENT
DRAFT
OUTBOX
FAILED
QUEUED
UNKNOWN
}
type Tag {
id: ID!
name: String!
type: DataType!
count: Int!
}Opérations
smsChanged
Indique au client d’actualiser la liste des SMS lorsque les messages de l’appareil changent. Ne renvoie pas le contenu des messages.
subscription smsChanged {
smsChanged { uris }
}smsSendResult
Recevoir les résultats SMS/MMS et les associer par requestId. Utiliser success : le succès SMS vaut -1 ; pour MMS, 0 indique le succès, -1000 le délai dépassé et -1001 l’annulation. Un envoi réussi ne confirme pas la livraison.
subscription smsSendResult {
smsSendResult { requestId success resultCode }
}archiveSmsConversation
Archiver une conversation de messages, en enregistrant éventuellement sa date d’archivage.
mutation archiveSmsConversation($id: ID!, $date: Instant) {
archiveSmsConversation(id: $id, date: $date)
}deleteSms
Supprimer définitivement les SMS correspondant à la requête.
mutation deleteSms($query: String!) {
deleteSms(query: $query) { affectedCount }
}restoreSms
Restaurer les SMS dans la corbeille correspondant à la requête.
mutation restoreSms($query: String!) {
restoreSms(query: $query) { affectedCount }
}sendSms
Envoyer un SMS ou ouvrir le composeur MMS du téléphone avec les pièces jointes.
mutation sendSms($number: String!, $body: String!, $attachmentPaths: [String!]!, $subscriptionId: Int, $requestId: String!) {
sendSms(number: $number, body: $body, attachmentPaths: $attachmentPaths, subscriptionId: $subscriptionId, requestId: $requestId) { requestId requiresConfirmation }
}trashSms
Déplacer dans la corbeille les SMS correspondant à la requête.
mutation trashSms($query: String!) {
trashSms(query: $query) { affectedCount }
}unarchiveSmsConversation
Retirer le statut archivé d’une conversation.
mutation unarchiveSmsConversation($id: ID!) {
unarchiveSmsConversation(id: $id)
}archivedSmsConversations
Rechercher les conversations SMS archivées avec pagination.
query archivedSmsConversations($query: String!, $offset: Int!, $limit: Int!) {
archivedSmsConversations(query: $query, offset: $offset, limit: $limit) { id address snippet lastMessageAt messageCount read addresses }
}sims
Lister les cartes SIM et comptes téléphoniques disponibles sur l’appareil.
query sims {
sims { id label number subscriptionId }
}sms
Rechercher des SMS. Utiliser une chaîne vide pour query afin de tous les lister.
query sms($query: String!, $offset: Int!, $limit: Int!) {
sms(query: $query, offset: $offset, limit: $limit) { id body address sentAt serviceCenter read threadId type }
}smsBoxCounts
Lire le nombre de messages dans les boîtes SMS disponibles.
query smsBoxCounts {
smsBoxCounts { total inbox sent drafts }
}smsConversationCount
Compter les conversations SMS correspondant à une requête.
query smsConversationCount($query: String!) {
smsConversationCount(query: $query)
}smsConversations
Lister les conversations SMS (fils) avec pagination.
query smsConversations($query: String!, $offset: Int!, $limit: Int!) {
smsConversations(query: $query, offset: $offset, limit: $limit) { id address snippet lastMessageAt messageCount read addresses }
}smsCount
Compter les SMS correspondant à une requête.
query smsCount($query: String!) {
smsCount(query: $query)
}