Справочник API

SMS

SMS and MMS APIs.

Определения типов

graphql
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!
}

Операции

subscription

smsChanged

Уведомляет клиента об изменениях SMS на устройстве, чтобы он обновил список. Не возвращает содержимое сообщений.

graphql
subscription smsChanged {
  smsChanged { uris }
}
subscription

smsSendResult

Получать результаты отправки SMS/MMS и связывать их по requestId. Использовать success: успех SMS — -1; для MMS 0 означает успех, -1000 — тайм-аут, -1001 — отмену. Успешная отправка не подтверждает доставку.

graphql
subscription smsSendResult {
  smsSendResult { requestId success resultCode }
}
mutation

archiveSmsConversation

Архивирует диалог сообщений с необязательной записью даты архивации.

graphql
mutation archiveSmsConversation($id: ID!, $date: Instant) {
  archiveSmsConversation(id: $id, date: $date)
}
mutation

deleteSms

Безвозвратно удаляет SMS по запросу.

graphql
mutation deleteSms($query: String!) {
  deleteSms(query: $query) { affectedCount }
}
mutation

restoreSms

Восстанавливает SMS из корзины по запросу.

graphql
mutation restoreSms($query: String!) {
  restoreSms(query: $query) { affectedCount }
}
mutation

sendSms

Отправить SMS или открыть редактор MMS телефона с вложениями.

graphql
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 }
}
mutation

trashSms

Перемещает SMS по запросу в корзину.

graphql
mutation trashSms($query: String!) {
  trashSms(query: $query) { affectedCount }
}
mutation

unarchiveSmsConversation

Снимает с диалога статус архивного.

graphql
mutation unarchiveSmsConversation($id: ID!) {
  unarchiveSmsConversation(id: $id)
}
query

archivedSmsConversations

Ищет архивные диалоги SMS с разбивкой на страницы.

graphql
query archivedSmsConversations($query: String!, $offset: Int!, $limit: Int!) {
  archivedSmsConversations(query: $query, offset: $offset, limit: $limit) { id address snippet lastMessageAt messageCount read addresses }
}
query

sims

Показать доступные SIM-карты и телефонные учётные записи устройства.

graphql
query sims {
  sims { id label number subscriptionId }
}
query

sms

Ищет SMS. Пустая строка query перечисляет все сообщения.

graphql
query sms($query: String!, $offset: Int!, $limit: Int!) {
  sms(query: $query, offset: $offset, limit: $limit) { id body address sentAt serviceCenter read threadId type }
}
query

smsBoxCounts

Читает количество сообщений в доступных ящиках SMS.

graphql
query smsBoxCounts {
  smsBoxCounts { total inbox sent drafts }
}
query

smsConversationCount

Подсчитывает диалоги SMS по запросу.

graphql
query smsConversationCount($query: String!) {
  smsConversationCount(query: $query)
}
query

smsConversations

Перечисляет диалоги (цепочки) SMS с разбивкой на страницы.

graphql
query smsConversations($query: String!, $offset: Int!, $limit: Int!) {
  smsConversations(query: $query, offset: $offset, limit: $limit) { id address snippet lastMessageAt messageCount read addresses }
}
query

smsCount

Подсчитывает SMS по запросу.

graphql
query smsCount($query: String!) {
  smsCount(query: $query)
}