入门指南
服务协议
api文档
sdk下载

短信API

1.发送通知短信

功能说明:

请求地址:https://api.100sms.cn/api/sms/batchSubmit

发送前,需要在软件内报备模板,系统会自动匹配审核通过的模板,如果匹配到任何一个模板即可发送,否则会发送失败。

请求参数:

名称 类型 是否必须 描述
apikey string 用户唯一标识
submits[] list 发送信息列表,最多1000个
submits[].mobile string 用户唯一标识
apikey string 手机号码
submits[].message string 短信内容
短信格式为:【短信签名】短信内容。如:【亿佰云通讯】您的验证码是1234。短信签名必须在短信开头,并加上中文全角中括号。短信签名应与公司名称或品牌名称相符。短信签名也会计算字数。

请求示例: https://api.100sms.cn/api/sms/batchSubmit

1
2
3
4
5
6
7
8
9
10
11
Content-Type: application/json
{
  "apikey": "a71bf24527ad11e6b5b9ac853dae864c",
  "submits": [{
    "mobile": "13800000001",
    "message": "【亿佰云通讯】您的验证码是1234"
  }, {
    "mobile": "13800000001",
    "message": "【亿佰云通讯】您的验证码是5678"
  }]
}

语言 github地址
Java 点击查看
PHP 点击查看
Python 点击查看

注:如没有您使用语言的SDK,您可以根据下方短信API开发接口。

响应参数:

名称 类型 描述
code int 返回状态
message string 返回信息
response[] list 响应内容,与发送信息列表对应
response[].code string 单个号码发送状态
response[].message string 单个号码发送信息
response[].mobile string 手机号码
response[].taskId string 任务id,用于匹配状态报告

响应示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "code": 200,
  "message": "发送成功",
  "response": [{
    "code": 200,
    "message": "发送成功",
    "mobile": "13800000001",
    "taskId": "9752328968043757569"
  }, {
    "code": 410,
    "message": "手机号格式错误",
    "mobile": "13800000001",
    "taskId": "9752328968043757570"
  }]
}

2.获取状态报告

功能说明:

调用此接口可以获取72小时内的状态报告,已成功获取的数据将会删除,不会再次返回。

请求地址:https://api.100sms.cn/api/sms/pullStatusReport

请求参数:

1
2
3
4
Content-Type: application/json
{
  "apikey":"a71bf24527ad11e6b5b9ac853dae864c"
}

响应参数:

响应示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "code": 1,
  "message": "拉取成功",
  "response": [{
    "taskId": 9752328968043757569,
    "mobile": "13800000001",
    "report": "DELIVRD",
    "reportTime": 1464784505529
  }, {
    "taskId": 9752328968043757569,
    "mobile": "13800000001",
    "report": "DELIVRD",
    "reportTime": 1464784516136
  }]
}

3.获取回复

功能说明:

调用此接口可以获取72小时内的回复短信,已成功获取的数据将会删除,不会再次返回。

请求地址:https://api.100sms.cn/api/sms/pullReply

请求参数:

请求示例:

POST:https://api.100sms.cn/api/sms/pullReply

1
2
3
4
Content-Type: application/json
{
  "apikey":"a71bf24527ad11e6b5b9ac853dae864c"
}

响应参数:

响应示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "code": 1,
  "message": "拉取成功",
  "response": [{
    "mobile": "13800000001",
    "message": "好的",
    "replyTime": 1464784505529
  }, {
    "mobile": "13800000001",
    "message": "知道了",
    "replyTime": 1464784516136
  }]
}

4.错误响应

响应参数:

响应示例:

1
2
3
4
5
{
  "code": 500,
  "message": "服务器异常",
  "response": null
}

错误列表:

默认模板

QQ咨询

电话咨询

0571-8861 9915