文档中心

接口说明 / 注意事项

短信接口文档

测试时,请使用正式内容进行测试,请勿给同一手机号连续发送相同内容,运营商已进行规则调整以应对短信炸弹问题。

所有短信均有监控,请勿发送以下内容(营销广告、不合法,要挟、虚假、私人信息、滥发、邀请类)。

网页应用用于手机验证 ,请务必增加图形验证(以防止被人利用,被用于短信轰炸用途),否则不予以接入。

接口列表

地址 描述
http://api.uxins.com/sendsms 发送单条短信 (验证码、触发类)

 

编码

统一使用 UTF-8 编码,请确保您的文件编码及传入参数的格式

 

接口说明:

* 接受HTTP POST请求

* 参数以form形式提交 Content-Type:application/x-www-form-urlencoded

* 参数需要做URLEncode

* 请求编码为UTF-8

* 对于预付费客户,每次调⽤用接⼝口,会扣除短信剩余条数,扣除规则: 单条内容不超过70个字符算⼀一条,超过70个字符后按65个字符拆分,即:131个字符=65+65+1,算3条。 英文字母,标点符号都算1个字符

* 批量发送推荐一次提交100到200个号码

* 接口调用频率建议不超过1秒钟一次

 

参数说明:

参数 参数名称 是否必填 参数说明 样例
partner_id 合作方ID 创美分配的合作方id 836819141237
timestamp 时间戳 发送请求的时间 格式:yyyy-MM-dd HH:mm:ss 2014-12-05 15:30:23
mobile 手机号 多个号码用英文逗号隔开 最多1000个号码 13983762960,18523678576
message 短信内容 最多500个字符  
sign 签名 用于校验请求,计算方法:md5(partner_id+timestamp+api_key)计算结果为32位⼩小写字符串 e71856999083c820dd013300649d30ee
ext 扩展码 扩展码需要通道支持 纯数字,最多4位,建议2位 001

 

签名计算示例:

partner_id="836819141237" timestamp="2014-12-05 15:30:23" api_key="f305524991549d99768f09e345a871bf" md5(partner_id+timestamp+api_key) == “93e412497dbaa58e308acb9973691c51"

 

 

返回值:

返回json格式的数据,包含如下字段:
code:返回码
msg:错误信息
data:返回的数据
成功返回样例:
{"msg": "success", "code": 0, "data": {"13983762960": "181417689521473527"}}
data是一个字典,key是手机号,value是msg_id,系统生成的唯一消息id
失败返回样例:
{"msg": "miss param", "code": -1, "data": ""}

 

 

返回码说明:

0 成功
-1 缺少参数
-2 partner_id错误
-3 手机号格式错误
-4 号码数量超限
-5 手机号有重复
-6 消息长度超限
-7 消息未包含签名
-8 扩展码长度错误
-9 IP不在白名单里(需开启白名单功能)
-10 签名校验错误
-11 预付费客户短信剩余条数不足
-100 系统错误

 

 

编程建议:

域名解析失败会导致接口无法访问,建议开发者catch域名解析错误的异常,通过下面的接口地址重新发起请求
http://115.29.38.84/sendsms

 

 

 

接收短信发送状态

接口URL:

合作方提供

 

 

接口说明:

* 接受HTTP GET请求
* 请求编码为UTF-8

 

 

参数说明:

参数 参数名称 是否必填 参数说明 样例
partner_id 合作方ID 创美分配的合作方id 836819141237
msg_id 消息唯一ID 发送短信接口会返回msg_id【特别说明】 为了便于结算统计,对于发送成功 的超过70个字符的长短信,会拆分 为多条分别上报,拆分规则: 单条内容不超过70个字符算一条, 超过70个字符后按65个字符拆分, 即:131个字符=65+65+1,算3条。 英文字母,标点符号都算1个字符 拆分后的第二条,这个参数是 ${msg_id}_2 拆分后的第三条,这个参数是 ${msg_id}_3,以此类推 181417689521473527
181417689521473527_2
181417689521473527_3
mobile 手机号 短信对应的手机号 13983762960
code 返回码 0:成功 非0:失败  
msg 错误信息 对返回码的说明  
timestamp 时间戳 短信发送成功或失败的时间 格式:yyyy-MM-dd HH:mm:ss 2014-12-05 15:30:23

 

返回值:

成功接收则返回“success”(不包含引号) 返回的Content-Type: text/plain
当合作方收到服务器异步通知并打印出success时,创美会认为推送成功。

 

 

请求示例:

http://partner_url?code=0&mobile=13983762960×tamp=2014-12- 05+15%3A30%3A23&msg_id=181417689521473527&msg=success&partner_id=836819141237

 

 

接收用户上行短信

接口URL:

合作方提供

 

接口说明:

* 接受HTTP GET请求
* 请求编码为UTF-8

 

参数说明:

参数 参数名称 是否必填 参数说明 样例
partner_id 合作方ID 创美分配的合作方id 836819141237
ext 扩展码 当初调⽤用发短信接口时传入的扩展码 001
mobile 手机号 短信对应的手机号 13983762960
message 上行短信内容 用户回复的短信内容  
timestamp 时间戳 收到用户上行短信的时间 格式:yyyy-MM-dd HH:mm:ss 2014-12-05 15:30:23

 

返回值:

成功接收则返回“success”(不包含引号) 返回的Content-Type: text/plain
当合作方收到服务器异步通知并打印出success时,创美会认为推送成功。

 

 

请求示例:

http://partner_url?mobile=13983762960×tamp=2014-12- 05+15%3A30%3A23&ext=001&partner_id=836819141237&message=%E6%94%B6%E5%88%B0%E4%BA%86

 

 

 

查询短信剩余条数(预付费客户)

接口URL:

http://api.uxins.com/getsmsbalancecount

 

接口说明

* 接口针对预付费客户
* 接受HTTP GET请求
* 参数需要做URLEncode
* 请求编码为UTF-8

 

参数说明:

参数 参数名称 是否必填 参数说明 样例
partner_id 合作方ID 创美分配的合作方id 836819141237
timestamp 时间戳 收到用户上行短信的时间 格式:yyyy-MM-dd HH:mm:ss 2014-12-05 15:30:23
sign 签名 用于校验请求,计算方法:md5(partner_id+timestamp+api_key) 计算结果为32位小写字符串 e71856999083c820dd013300649d30ee

 

签名计算示例:

partner_id="836819141237"
timestamp="2014-12-05 15:30:23"
api_key="f305524991549d99768f09e345a871bf"
md5(partner_id+timestamp+api_key) == “93e412497dbaa58e308acb9973691c51"

 

返回值:

返回json格式的数据,包含如下字段:
code:返回码
msg:错误信息
data:返回的数据

成功返回样例:
{"msg": "success", "code": 0, "data": {"smsbalancecount": 9988}}
失败返回样例:
{"msg": "miss param", "code": -1, "data": ""}

 

返回码说明:

0 成功
1 后结款客户不支持查询
-1 缺少参数
-2 参数错误
-10 签名校验错误
-100 系统错误