开发者文档
智齿科技
2023-12-29
目录

国际短信

# 国际短信

# 短信模板

接口地址: https://openapi.soboten.com/sms-server/api/templates/list
请求方法: POST

请求参数(header) :

参数 类型 描述 必填
Authorization String 接口访问凭据，获取方式请参考获取鉴权 token 是
Content-type String application/json;charset=UTF-8 是
language String 语言标识：en-英文，zh-中文 否

请求参数(query string)

参数 类型 必填 描述
tplName String 否 模板名称
checkStatus Integer 否 审核状态( 0:未通过、1:已通过、2:审核中)
tplTypeList List 否 短信类型(1:通知类、2:营销类、3:验证码类)
createStartTime Long 否 创建开始时间（毫秒时间戳）
createEndTime Long 否 创建结束时间（毫秒时间戳）
pageNo Integer 是 页码
pageSize Integer 是 条数

请求示例：

curl  https://openapi.soboten.com/sms-server/api/templates/list
-X POST
-H 'language: zh'
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJkY2MyZWU2ZjBhZjg0YmU4ODIzYTBjYzUwYmNmOGU5MSIsImFnZW50SWQiOiIiLCJzZXJ2aWNlRW1haWwiOm51bGwsImlzcyI6InNvYm90IiwidHlwZSI6ImNyZWF0ZVRva2VuVm8uZ2V0UmxtKCkiLCJybG0iOiJ0aGlyZCIsImNvbXBhbnlJZCI6ImMxMmFhODdiN2QzODQ1NDM4ZWFiZjFiYTExNjZhOWE3IiwibmJmIjowLCJ6b25lIjpudWxsLCJleHAiOjE3MDM4NDM1NjA0MDEsImlhdCI6MTcwMzc1NzE2MDQwMSwiYWlkIjoiIiwiY2lkIjoiYzEyYWE4N2I3ZDM4NDU0MzhlYWJmMWJhMTE2NmE5YTcifQ.35sscEHafNwOVb81eWUIw0H-4ugjIU1zqCgL5fpk9bM'
-d '{
    "pageNo": 1,
    "pageSize": 50,
    "tplTypeList": [1,2,3],
    "checkStatus": 1,
    "createStartTime": 1751299200000,
    "createEndTime": 1753977599999
}'
1
2
3
4
5
6
7
8
9
10
11
12

返回参数

参数 类型 必填 描述
retCode String 是 返回编码
retMsg String 是 返回信息
content json 数组 否

content 返回参数

参数 类型 必填 描述
list jsonarray 否
pageNo Integer 是 页数
pageSize Integer 是 每页的条数
pageCount Integer 是 总共的页数
totalCount Integer 是 总共的条数

list 返回参数

参数 类型 必填 描述
tplName String 是 模板名称
tplContent String 是 模板内容
tplId String 是 模板 ID
checkStatus Integer 是 审核状态
failReason String 否 失败原因
tplWordCount Integer 是 预计发送字数
tplNumber Integer 是 计算条数
tplStatus Integer 是 启用状态
tplType Integer 是 短信类型
checkTime Long 否 审核时间
creationTime Long 是 创建时间
creatorName String 是 创建人
updatedTime Long 是 更新时间
updateUserName String 是 更新人

响应示例：

{
  "content": {
    "pageNo": 1,
    "pageSize": 50,
    "pageCount": 1,
    "totalCount": 1,
    "list": [
      {
        "tplName": "测试模板",
        "tplContent": "会员系统的验证码为:213",
        "tplId": "1adf96f9369d4e4a8e016c72b0f9e9dc",
        "checkStatus": 1,
        "failReason": "",
        "tplWordCount": 13,
        "tplNumber": 1,
        "tplStatus": 1,
        "tplType": 1,
        "checkTime": 1745983268344,
        "creationTime": 1745983155105,
        "creatorName": "XXX",
        "updatedTime": 1745983155105,
        "updateUserName": "XXX"
      }
    ]
  },
  "retCode": 200,
  "retMsg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# 发送短信

接口地址: https://openapi.soboten.com/sms-server/api/sendSms
请求方法: POST

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，获取方式请参考获取鉴权 token
Content-type String 是 application/json;charset=UTF-8
language String 否 语言标识：en-英文，zh-中文

请求参数(query string)

参数 类型 必填 描述
smsPhone String 是 电话号码，多个手机号使用逗号分隔
tplId String 是 模板 id
tplValue json 数组 否 变量，tplId 字段如果不为空，tplValue 为必填参数 [{"name":"age","value":"1"}]
senderId String 否 发送人 id
outId String 否 第三方的业务 id

请求示例：

curl  https://openapi.soboten.com/sms-server/api/sendSms
-X POST
-H 'language: zh'
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJkY2MyZWU2ZjBhZjg0YmU4ODIzYTBjYzUwYmNmOGU5MSIsImFnZW50SWQiOiIiLCJzZXJ2aWNlRW1haWwiOm51bGwsImlzcyI6InNvYm90IiwidHlwZSI6ImNyZWF0ZVRva2VuVm8uZ2V0UmxtKCkiLCJybG0iOiJ0aGlyZCIsImNvbXBhbnlJZCI6ImMxMmFhODdiN2QzODQ1NDM4ZWFiZjFiYTExNjZhOWE3IiwibmJmIjowLCJ6b25lIjpudWxsLCJleHAiOjE3MDM4NDM1NjA0MDEsImlhdCI6MTcwMzc1NzE2MDQwMSwiYWlkIjoiIiwiY2lkIjoiYzEyYWE4N2I3ZDM4NDU0MzhlYWJmMWJhMTE2NmE5YTcifQ.35sscEHafNwOVb81eWUIw0H-4ugjIU1zqCgL5fpk9bM'
-d '{
        "tplId": "303017a88d2a4873ae6ee6654c1b3fc8",
        "mobile": "8618031672790",
        "tplValue":[{"name":"age","value":"6"}],
        "outId": "123"
    }'
1
2
3
4
5
6
7
8
9
10

返回参数

参数 类型 必填 描述
retCode String 是 返回编码
retMsg String 是 返回信息
content json 数组 是 短信 ID 列表

content

参数 类型 必填 描述
sendId String 是 消息 ID
sendStatus String 是 短信状态码
reason String 否 错误码
reasonDescription String 否 错误描述
smsPhone String 是 手机号

响应示例：

{
  "content": [
    {
      "sendId": "5e2382ed31a16N4bdbCa6bcS810c1f31764e",
      "smsPhone": "8618031672790",
      "reason": "0",
      "reasonDescription": "提交成功",
      "sendStatus": "2"
    }
  ],
  "retCode": 200,
  "retMsg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# 查询短信记录

接口地址: https://openapi.soboten.com/sms-server/api/smsRecord
请求方法: POST

请求参数(header) :

参数 类型 必填 描述
Authorization String 是 接口访问凭据，获取方式请参考获取鉴权 token
Content-type String 是 application/json;charset=UTF-8
language String 否 语言标识：en-英文，zh-中文

请求参数(query string)

参数 类型 必填 描述
sendStatus Integer 否 发送状态(1:成功，0:失败，2:审核中)
tplIdList String 数组 否 模板 id
ruleCodeList String 数组 否 通道名称集合
smsPhone String 否 手机号码
startTime long 否 开始时间，时间戳（毫秒），startTime 和 endTime 字段为空时，默认返回最近 30 天的数据
endTime long 否 结束时间，时间戳（毫秒），startTime 和 endTime 字段为空时，默认返回最近 30 天的数据
outId String 否 第三方业务标识
pageNo Integer 是 页数
pageSize Integer 是 条数

请求示例：

curl  https://openapi.soboten.com/sms-server/api/smsRecord
-X POST
-H 'language: zh'
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJkY2MyZWU2ZjBhZjg0YmU4ODIzYTBjYzUwYmNmOGU5MSIsImFnZW50SWQiOiIiLCJzZXJ2aWNlRW1haWwiOm51bGwsImlzcyI6InNvYm90IiwidHlwZSI6ImNyZWF0ZVRva2VuVm8uZ2V0UmxtKCkiLCJybG0iOiJ0aGlyZCIsImNvbXBhbnlJZCI6ImMxMmFhODdiN2QzODQ1NDM4ZWFiZjFiYTExNjZhOWE3IiwibmJmIjowLCJ6b25lIjpudWxsLCJleHAiOjE3MDM4NDM1NjA0MDEsImlhdCI6MTcwMzc1NzE2MDQwMSwiYWlkIjoiIiwiY2lkIjoiYzEyYWE4N2I3ZDM4NDU0MzhlYWJmMWJhMTE2NmE5YTcifQ.35sscEHafNwOVb81eWUIw0H-4ugjIU1zqCgL5fpk9bM'
-d '{
        "pageNo":1,
        "pageSize":50,
        "startTime":1703692800000,
        "endTime":1703779199999
    }'
1
2
3
4
5
6
7
8
9
10

返回参数

参数 类型 必填 描述
retCode String 是 返回编码
retMsg String 是 返回信息
content json 数组 否

content 返回参数

参数 类型 必填 描述
list jsonarray 是
pageNo Integer 是 页数
pageSize Integer 是 每页的条数
pageCount Integer 是 总共的页数
totalCount Integer 是 总共的条数

list 返回参数

参数 类型 必填 描述
sendId String 是 消息 ID
smsContent String 是 短信内容
smsPhone String 是 手机号
reasonDescription String 是 失败理由
applyName String 是 通道名称
sendStatus String 是 短信状态码
smsTemplateName String 是 短信模板
sendTime long 否 发送时间
smsFeeNum Integer 否 计费条数
smsWordCount Integer 否 短信字数
companyId String 是 公司 id
createTime Long 是 创建时间
sendTime Long 否 发送时间
smsType Integer 否 短信类型 1 通知类 2 运营类 3 验证码
extensions Json 否 扩展字段
areaId String 否 地区 id
areaName String 否 地区名称
senderId String 否 senderId

响应示例：

{
  "content": {
    "pageNo": 1,
    "pageSize": 1,
    "pageCount": 22,
    "totalCount": 22,
    "list": [
      {
        "sendId": "db7a16c3312dcN4153Caff0S7aa5a862adb1",
        "smsContent": "您好。线先生，这边看到您在本店的会员即将到期，如需要，请及时联系您的客户经理进行续期。",
        "smsPhone": "8618031672790",
        "companyId": "c12aa87b7d3845438eabf1ba1166a9a7",
        "reason": "E200019",
        "sendStatus": 0,
        "sendTime": 1703764945163,
        "createTime": 1703764929289,
        "updateTime": 1703764950011,
        "smsFeeNum": 0,
        "smsWordCount": 43,
        "smsTemplateName": "xx会员",
        "smsType": 1,
        "reasonDescription": "E200019",
        "extensions": null,
        "areaName": "中国大陆",
        "areaId": "853100",
        "senderId": null
      }
    ],
    "sumInfo": {},
    "dateInfo": []
  },
  "retCode": 200,
  "retMsg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

# webhook 推送发送结果

  • 第一次如果推送失败，后面每隔 30 分钟推送一次，推送 3 次

    参数 类型 必填 描述
    sendId String 是 消息 ID
    sendStatus String 是 短信状态码
    reason String 否 错误码
    reasonDescription String 否 错误描述
    smsPhone String 是 手机号
    smsNum Integer 是 短信条数
    outId String 是 第三方的业务 id
    receiveTime long 否 接收时间戳（毫秒）

响应示例：

[
  {
    "sendId": "5e2382ed31a16N4bdbCa6bcS810c1f31764e",
    "smsPhone": "8618031672790",
    "reason": "E200019",
    "reasonDescription": "失败",
    "sendStatus": "0",
    "outId": "0001",
    "receiveTime": 1703764950011,
    "smsNum": 1
  }
]
1
2
3
4
5
6
7
8
9
10
11
12
上次更新: 2026/3/30 15:14:45

← Android 推送SDK集成文档→

最近更新
01
消息合规API
05-28
02
知识中心 API
07-25
03
在线客服统计V6 API
04-23
更多文章>
Theme by Vdoing