1、短信模板查询
1.1 请求地址
/{SoftVersion}/Accounts/{accountSid}/SMS/QuerySMSTemplate
1.2 请求包体
属性
类型
约束
说明
appid
String
必选
应用id
templateId
String
可选
模板Id,不带此参数查询全部可用模板
1.3 XML请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/SMS/QuerySMSTemplate?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Host:192.168.0.1:8883
content-length: 139
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
ff8080813c37da53013c3054f5672234
1
1.4 JSON请求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/SMS/QuerySMSTemplate?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Host:192.168.0.1:8883
content-length: 139
Accept:application/json;
Content-Type:application/json;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
{'appId':'ff8080813c37da53013c8054f5612345',” templateId”:”1”}
1.5 响应包体
属性
类型
约束
说明
statusCode
String
必选
请求状态码,取值000000(成功)
totalCount
String
必选
模板总数
TemplateSMS
String
必选
主节点,以下参数包含在此节点内
title
String
必选
模板标题
content
String
必选
模板内容
status
String
必选
模板状态 0:待审核,1:通过审核,2:未通过审核,-1:已删除
type
String
必选
模板类型 0:验证码,1:通知,2:营销短信
dateCreated
String
必选
创建时间
dateUpdated
String
必选
更新时间
id
String
必选
模板Id
1.6 XML响应示例
HTTP/1.1 200 OK
Content-Length:586
000000
2
测试模板【云通讯】您使用的是云通讯短信测试模板,您的验证码是{1},请于{2}分钟内正确输入
1
0
0
0
1
测试模板2【云通讯】您使用的是云通讯短信测试模板,您的验证码是{1}
1
0
0
0
2
1.7 JSON响应示例
HTTP/1.1 200 OK
Content-Length:586
{"statusCode":"000000","totalCount":"1","TemplateSMS":{"title":"测试模板"," content ":"【云通讯】您使用的是云通讯短信测试模板,您的验证码是{1},请于{2}分钟内正确输入"," status ":"1"," type ":"0"," dateCreated ":" 0",” dateUpdated”:” 0”,” id”:” 1”}}
2、短信状态报告查询
2.1 请求地址
POST /{SoftVersion}/Accounts/{accountSid}/SMS/QuerySMS
2.2 请求包体
属性
类型
约束
说明
举例
date
String
必选
发送短信日期
20150710
msgId
String
必选
消息id,对应短信发送接口相应包体的smsMessageSid
21asfds
2.3 XML请求示例
POST /2013-12-26/Accounts/abcde/SMS/QuerySMS?sig=123456 HTTP/1.1
Host: 192.168.0.1:8883
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
20150710
a8348ca09e1d4e73b39625235fa06f41
2.4 JSON请求示例
POST /2013-12-26/Accounts/abcde/SMS/QuerySMS?sig=123456 HTTP/1.1
Host: 192.168.0.1:8883
Accept:application/json;
Content-Type:application/json;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
{"date":"20150710",”msgId”:”a8348ca09e1d4e73b39625235fa06f41”}
2.5 响应包体
属性
类型
约束
说明
statusCode
String
必选
状态报告请求的状态码,000000成功,112356短信已发出但未收到回执请稍后查询,112351短信状态不存在
receiver
String
必选
接收短信的手机号码
sendStatus
String
必选
通道发送状态,0成功1失败
sendtime
String
必选
发送时间
deliverStatus
String
必选
到达状态,即运营商网关返回的手机接收报告。送达结果:0成功1失败
receivetime
String
必选
状态报告时间,即运营商网关返回的手机接收报告时间
3、上行短信/状态推送报告接口
请联系客户经理配置开通,目前只支持XML
3.1 请求地址
POST /{path} 在云通讯官网控制台管理--应用管理--勾选回调功能并提交回调地址请联系客户经理配置
3.2 请求参数
属性
类型
约束
说明
action
String
必选
功能操作标识 ,SMSArrived
smsType
String
必选
短信类型,0:上行短信,1:手机接收状态报告
recvTime
String
必选
收到上行短信/短信送达手机时间,格式:YYYYMMDDHHMMSS
apiVersion
String
必选
REST API版本号,格式:YYYY-MM-DD
fromNum
String
必选
发送/接收短信的手机号码,以13等开头的11位号码
content
String
必选
短信内容,当smsType=1时,该字段的值为短信ID,即下行短信请求响应的smsMessageSid。当smsType=0时,该字段值手机回复的短信内容,内容是utf8格式
appendCode
String
可选
短信扩展码,由数字组成,对应不同的下行短信签名,smsType=0时有效。以此区分不同的下行短信签名
subAppend
String
可选
自定义短信扩展码,对应下行时传递的subAppend,smsType=0时有效。
status
String
可选
短信到达状态, 0为接收成功,其它值为运营商网关错误码,smsType=1时有效
dateSent
String
可选
短信发送时间,格式:YYYYMMDDHHMMSS,smsType=1时有效
deliverCode
String
可选
到达状态描述,即运营商网关状态码。当status非0且smsType=1时有效
3.3 XML请求示例
POST http://{ip|域名}:{port}/{path}
SMSArrived
0
20130923010101
2013-12-26
13912345678
12345
test
0
文档更新时间:2016年7月21日