API 参考
SMS
短信与彩信接口。
类型定义
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
手机上的短信有变化时通知客户端刷新短信列表,不返回短信内容。
graphql
subscription smsChanged {
smsChanged { uris }
}subscription
smsSendResult
接收 SMS 与 MMS 的发送结果;用 requestId 对应 SmsSendReceipt.requestId。通过 success 判断结果,不要用 resultCode == 0:Android 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
永久删除符合查询条件的短信。
graphql
mutation deleteSms($query: String!) {
deleteSms(query: $query) { affectedCount }
}mutation
restoreSms
恢复符合查询条件的已移入回收站的短信。
graphql
mutation restoreSms($query: String!) {
restoreSms(query: $query) { affectedCount }
}mutation
sendSms
发送短信;有附件时发起彩信编辑。
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
将符合查询条件的短信移入回收站。
graphql
mutation trashSms($query: String!) {
trashSms(query: $query) { affectedCount }
}mutation
unarchiveSmsConversation
取消会话的归档状态。
graphql
mutation unarchiveSmsConversation($id: ID!) {
unarchiveSmsConversation(id: $id)
}query
archivedSmsConversations
分页搜索已归档的短信会话。
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
搜索短信;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
读取各可用短信箱的消息数。
graphql
query smsBoxCounts {
smsBoxCounts { total inbox sent drafts }
}query
smsConversationCount
统计符合查询条件的短信会话数。
graphql
query smsConversationCount($query: String!) {
smsConversationCount(query: $query)
}query
smsConversations
分页列出短信会话。
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
统计符合查询条件的短信数。
graphql
query smsCount($query: String!) {
smsCount(query: $query)
}