API接口说明：
1.我们提供基于http和cmpp的接口文档，支持Php、.net、Java、c+等语言类接口；
2. 如要技术对接的请联系客服qq：27371688
一、发送模板短信
1. 接口地址
|
请求类型 |
请求url |
|
http请求方式：POST（请使用http协议） |
http://api.duanxinke.com/msg/template |
|
post数据请求示例 |
{ "uid":"123", "account":"账号", "pwd":"密码", "mobile":"XXXXXXXXXXX,XXXXXXXXXXX", "company":"短信客"， //签名 "tpl_id":"111"， //您申请的短信模板ID "tpl_value":"XXXX,XXXX" //变量值 } |
2. 发送短信接口参数说明
|
参数名称 |
说明 |
|
uid |
企业id |
|
account |
用户帐号，由系统管理员提供 |
|
pwd |
账号对应的密码 |
|
mobile |
手机号（多个手机号请用英文,隔开-例如：XXXXXXXXXXX,XXXXXXXXXXX）,最多50000个号码 |
|
company |
短信签名 |
|
tpl_id |
短信模板id（将您需要的模板发给系统管理员，模板格式示例：您的验证码{#var}，该验证码{#var}分钟内有效，请勿泄漏于他人！，{#var}为变量） |
|
tpl_value |
变量值（多个变量按照先后顺序用英文,隔开-例如：XXXXXXXXXXX,XXXXXXXXXXX） |
3. 发送短信响应包参数说明
|
失败返回数据： |
{"status":0,"message":"提交失败","respCode":"失败id","respMsg":"失败原因","msgid":"","successCounts":0} |
|
成功返回数据： |
{"status":1,"message":"提交成功""respCode":"0","respMsg":"提交成功","msgid":"msgid号","successCounts":"提交成功的短信数"} |
4. 返回值参数说明
|
respCode返回值 |
含义 |
|
0 |
提交成功 |
|
1 |
uid、pwd、account为空或错误 |
|
2 |
手机号为空 |
|
3 |
内容超过250个字 |
|
4 |
手机号错误 |
|
5 |
余额不足 |
|
6 |
手机号数量超过50000个 |
|
7 |
未设置签名 |
|
8 |
短信模板不合法 |
|
9 |
变量填写错误 |
|
10 |
其他错误 |
|
注意：A、系统会自动过滤不合法的手机号； |
|
|
注意：B、 同样的内容对同一个号码发多条，系统会自动去重，这样做是为了避免因重复发送造成的投诉。 |
|
二、查询余额
1. 查询余额
|
请求类型 |
请求url |
|
http请求方式：POST（请使用http协议） |
http://api.duanxinke.com/msg/balance |
|
post数据请求示例 |
{ "uid":"123", "account":"账号", "pwd":"密码" } |
2. 查询余额接口参数说明
|
接收值 |
意义 |
|
uid |
企业id |
|
account |
用户帐号，由系统管理员提供 |
|
pwd |
账号对应的密码 |
3. 查询余额响应包参数说明
|
失败返回数据： |
{"status":0,"message":"查询失败","respCode":"失败id","respMsg":"失败原因"} |
|
成功返回数据： |
{"status":1,"message":"查询成功""respCode":"0","respMsg":"余额"} |
4.返回值参数说明
|
respCode返回值 |
含义 |
|
0 |
查询成功（respMsg显示账户剩余短信数） |
|
1 |
uid、pwd、account为空或错误 |
三、短信状态报告
1. 查询短信状态
|
请求类型 |
请求url |
|
http请求方式：POST（请使用http协议） |
http://api.duanxinke.com/msg/status |
|
post数据请求示例 |
{ "uid":"123", "account":"账号", "pwd":"密码" } |
2. 查询短信状态接口参数说明
|
接收值 |
意义 |
|
uid |
企业id |
|
account |
用户帐号，由系统管理员提供 |
|
pwd |
账号对应的密码 |
3. 查询短信状态响应包参数说明
|
失败返回数据： |
{"status":0,"message":"查询失败","respCode":"失败id","respMsg":"失败原因"} |
|
成功返回数据： |
{ "status":1, "message":"查询成功", "respCode":0, "respMsg": [{"mobile":"XXXXXXXXXXX","msgid":50,"msgstatus":10,"receivetime":"2018-05-18 14:00:00"}, {"mobile":"XXXXXXXXXXX","msgid":51,"msgstatus":20,"receivetime":""}] } |
4.返回值参数说明
|
respCode返回值 |
含义 |
说明 |
|
0 |
查询成功 |
mobile：对应的手机号码 msgid：同一批短信任务id msgstatus：10发送成功 20发送失败 receivetime：接收时间 |
|
1 |
uid、pwd、account为空或错误 |
|
|
2 |
暂无记录 |
|
四、上行接口
1. 上行接口
|
请求类型 |
请求url |
|
http请求方式：POST（请使用http协议） |
http://api.duanxinke.com/msg/query |
|
post数据请求示例 |
{ "uid":"123", "account":"账号", "pwd":"密码" } |
2. 上行接口参数说明
|
接收值 |
意义 |
|
uid |
企业id |
|
account |
用户帐号，由系统管理员提供 |
|
pwd |
账号对应的密码 |
3. 上行接口响应包参数说明
|
失败返回数据： |
{"status":0,"message":"查询失败","respCode":"失败id","respMsg":"失败原因"} |
|
成功返回数据： |
{ "status":1, "message":"查询成功", "respCode":0, "respMsg": [{"mobile":"XXXXXXXXXXX","msgid":50,"content":"XXXXXXXXXXX","receivetime":"2018-05-18 14:00:00"}, {"mobile":"XXXXXXXXXXX","msgid":51,"content":"XXXXXXXXXXX","receivetime":""}] } |
4.返回值参数说明
|
respCode返回值 |
含义 |
说明 |
|
0 |
查询成功 |
mobile：对应的手机号码 msgid：短信任务id content：上行内容 receivetime：接收时间 |
|
1 |
uid、pwd、account为空或错误 |
|
|
2 |
暂无记录 |
|
接口文档下载：{点击下图即可下载文档}
