HTTPS/HTTP接口文档

接口域名:api.
sms.
cn一、工作方式2SMS支持HTTPS短信接口和HTTP短信接口,建议使用HTTPS2密码验证方式2二、字符编码2三、响应格式3四、短信发送34.
1变量模板发送34.
2变量模板批量发送短信54.
3全文发送(全文模板)74.
4全文变量模板一对一批量发送9五、接收状态报告115.
1主动获取状态115.
2推送接收状态报告13六、接收上行短信(回复)136.
1主动获取上行短信(回复)136.
2推送接收上行短信(回复)15七、取剩余短信条数15八、取已发送总条数16九、取发送记录17十、短信模板管理1910.
1添加短信模板1910.
2短信模板审核状态查询2110.
3取短信模板记录22十一、修改密码25十二、接口安全(绑定IP)25一、工作方式SMS支持HTTPS短信接口和HTTP短信接口,建议使用HTTPS双方通过HTTPS或HTTP方式交互数据,第三方可以简单的"name=value"方式发送提交内容或响应请求内容.
即通过HTTPS或HTTP的GET/POST方式交换.

另外双方需要保证数据传输的完整性和安全性,每次发送请求都有响应(响应返回格式为纯文本),安全验证目前采用用户名、密码和IP绑定的方式.

密码验证方式接口密码使用"登录密码"与"用户名"拼接字符串后能过md5加密进行验证如登录密码是:123123如用户名是:test接口密码(pwd)=md5(登录密码+用户名)pwd=md5(123123test)pwd=b9887c5ebb23ebb294acab183ecf0769接口密码可以直接登录短信平台从"短信设置"->"接口密码"获取二、字符编码服务器接收数据可以是GBK或UTF-8编码字符;默认接收数据是UTF-8编码,如提交的是GBK编码字符,需要添加参数encode=gbk.

三、响应格式所为响应即每次向服务器提交请求后返回值响应值格式有:JSON、XML、纯文本默认:JSON格式四、短信发送GET/POST操作格式:http://api.
sms.
cn/sms/ac=send&uid=用户账号&pwd=MD532位密码&mobile=号码&content=内容4.
1变量模板发送接口参数说明:参数名参数字段参数说明ac接口功能接口功能,传入值请填写sendformat返回格式可选项,有三参数值:json,xml,txt默认json格式uid用户账号登录名pwd用户密码32位MD5加密md5(密码+uid)如登录密码是:123123,uid是:test;pwd=md5(123123test)pwd=b9887c5ebb23ebb294acab183ecf0769encode字符编码可选项,默认接收数据是UTF-8编码,如提交的是GBK编码字符,需要添加参数encode=gbkmobile接收号码同时发送给多个号码时,号码之间用英文半角逗号分隔(,);小灵通需加区号如:13972827282,13072827282mobileids消息编号可选项该参数用于发送短信收取状态报告用,格式为消息编号+逗号;与接收号码一一对应,可以重复出现多次.

消息编号:全部由数字组成接收状态报告的时候用到,该消息编号的格式可就为目标号码+当前时间戳整数,精确到毫秒,确保唯一性.
供收取状态报告用如:1590049111112869461937;content短信内容变量模板发送,传参规则{"key":"value"}JSON格式,key的名字须和申请模板中的变量名一致,多个变量之间以逗号隔开.
示例:针对模板"短信验证码{$code},您正在进行{$product}身份验证,请在10分钟内完成操作!
",传参时需传入{"code":"352333","product":"电商平台"}template模板短信ID发送变量模板短信时需要填写对应的模板ID号,进入平台-》短信设置-》模板管理language状态说明语言language=englishmessage状态说明返回英文{"stat":"100","message":"SUCCESS"}例:你在平台添加了短信模板如下:短信验证码{$code},您正在进行{$product}身份验证,请在10分钟内完成操作!

模板ID:100001接收号:13900008888,13900001111,13100006666发送内容:{"key":"234336","product":"电商平台"}http://api.
sms.
cn/sms/ac=send&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&mobile=13900008888,13900009999,13100006666&mobileids=1390000888812869461937,1390000999912869461937,1310000666612869461937&content={"key":"234336","product":"电商平台"}&template=100001返回发送的状态码状态码说明100发送成功101验证失败102短信不足103操作失败104非法字符105内容过多106号码过多107频率过快108号码内容空109账号冻结112号码错误116禁止接口发送117绑定IP不正确151超出设置限制161未添加短信模板162模板格式不正确163模板ID不正确164全文模板不匹配166模板内容重复167模板审核中168模板审核不通过4.
2变量模板批量发送短信接口参数说明:参数名参数字段参数说明ac接口功能接口功能,传入值请填写sendbatchuid用户账号登录名pwd用户密码32位MD5加密md5(密码+uid)如pwd=b9887c5ebb23ebb294acab183ecf0769content短信内容以json格式填写,短信内容必须与模板一致且包含签名【签名】.
不同短信之间用{}隔开,不同短信之间以及手机号与短信内容之间用英文半角逗号,隔开.
参数smscn_mobile手机号码,smscn_mobileids消息编号,其他为变量模板中参数格式如下:[{"smscn_mobile":"手机号码1","smscn_mobileids":"消息编号1","code":"内容1"},{"smscn_mobile":"手机号码2","smscn_mobileids":"消息编号2","code":"内容2"}]template模板短信ID发送变量模板短信时需要填写对应的模板ID号,进入平台-》短信设置-》模板管理language状态说明语言默认中文汉字;language=englishmessage状态说明返回英文{"stat":"100","message":"SUCCESS"}format返回格式可选项,有三参数值:json,xml,txt默认json格式encode字符编码可选项,默认接收数据是UTF-8编码,如提交的是GBK编码字符,需要添加参数encode=gbk例:你在平台添加了全变量模板内容如下:你好:{$user_name}!
您的验证码为{$code}【公司签名】模板ID:500001接口发送内容:接收号:13900008888你好:Jack!
您的验证码为888811【公司签名】接收号:13900000000你好:Peter!
您的验证码为000011【公司签名】接口发送格式如下:http://api.
sms.
cn/sms/ac=sendbatch&template=500001&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&content=[{"smscn_mobile":"13900008888","smscn_mobileids":"1390000888834343216","user_name":"Jack","code":"888811"},{"smscn_mobile":"13900000000","smscn_mobileids":"1390000000034343216","user_name":"Peter","code":"000011"}]响应结果值:json格式{"stat":"100","message":"发送成功"}xml格式100发送成功txt文本字符格sms&stat=100&message=发送成功stat状态码message状态说明状态码说明同上4.
14.
3全文发送(全文模板)接口参数说明:参数名参数字段参数说明ac接口功能接口功能,传入值请填写sendformat返回格式可选项,有三参数值:json,xml,txt默认json格式uid用户账号登录名pwd用户密码32位MD5加密md5(密码+uid)如登录密码是:123123,uid是:test;pwd=md5(123123test)pwd=b9887c5ebb23ebb294acab183ecf0769encode字符编码可选项,默认接收数据是UTF-8编码,如提交的是GBK编码字符,需要添加参数encode=gbkmobile接收号码同时发送给多个号码时,号码之间用英文半角逗号分隔(,);小灵通需加区号如:13972827282,13072827282mobileids消息编号可选项该参数用于发送短信收取状态报告用,格式为消息编号+逗号;与接收号码一一对应,可以重复出现多次.

消息编号:全部由数字组成接收状态报告的时候用到,该消息编号的格式可就为目标号码+当前时间戳整数,精确到毫秒,确保唯一性.
供收取状态报告用如:1590049111112869461937;content短信内容发送内容需要进行URL字符标准化转码.
{URL字符编码说明:返回字符串,此字符串中除了-_.
之外的所有非字母数字字符都将被替换成百分号(%)后跟两位十六进制数,空格则编码为加号(+)}ASP:server.
URLEncode("短信内容")PHP:urlencode("短信内容")JAVA:java.
net.
URLEncoder.
encode("短信内容")例:接收号:13900008888,13900001111,13100006666发送内容:发送测试http://api.
sms.
cn/sms/ac=send&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&mobile=13900008888,1390000test,13100006666&mobileids=1390000888812869461937,1390000test12869461937,1310000666612869461937&content=%B7%A2%CB%CD%B2%E2%CA%D4响应结果值:json格式{"stat":"100","message":"发送成功"}xml格式100发送成功txt文本字符格sms&stat=100&message=发送成功stat状态码message状态说明返回发送的状态码状态码说明100发送成功101验证失败102短信不足103操作失败104非法字符105内容过多106号码过多107频率过快108号码内容空109账号冻结112号码错误116禁止接口发送117绑定IP不正确161未添加短信模板162模板格式不正确163模板ID不正确164全文模板不匹配4.
4全文变量模板一对一批量发送接口参数说明:参数名参数字段参数说明ac接口功能接口功能,传入值请填写sendsingleuid用户账号登录名pwd用户密码32位MD5加密md5(密码+uid)如pwd=b9887c5ebb23ebb294acab183ecf0769content短信内容以json格式填写,短信内容必须与模板一致且包含签名【签名】.
不同短信之间用{}隔开,不同短信之间以及手机号与短信内容之间用英文半角逗号,隔开;格式如下:[{"mobile":"手机号码1","msg":"内容1"},{"mobile":"手机号码2","msg":"内容2"}]format返回格式可选项,有三参数值:json,xml,txt默认json格式encode字符编码可选项,默认接收数据是UTF-8编码,如提交的是GBK编码字符,需要添加参数encode=gbk例:你在平台添加了全文变量模板内容如下:你好!
{**},您的订单已经发出,顺丰订单号:{**}.
【公司签名】接口发送内容:接收号:13900008888你好!
陈先生,您的订单已经发出,顺丰订单号:34324155455444.
【公司签名】接收号:13900000000你好!
李先生,您的订单已经发出,顺丰订单号:34343335455422.
【公司签名】接口发送格式如下:http://api.
sms.
cn/sms/ac=sendsingle&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&content=[{"mobile":"13900008888","msg":"你好!
陈先生,您的订单已经发出,顺丰订单号:34324155455444.
【公司签名】"},{"mobile":"13900000000","msg":"你好!
李先生,您的订单已经发出,顺丰订单号:34343335455422.
【公司签名】"}]注:发送内容content需要进行URL字符标准化转码.
响应结果值:json格式{"stat":"100","message":"发送成功"}xml格式100发送成功txt文本字符格sms&stat=100&message=发送成功stat状态码message状态说明状态码说明同上4.
1,4.
2五、接收状态报告5.
1主动获取状态GET/POST操作格式:http://api.
sms.
cn/sms/ac=status&uid=用户账号&pwd=MD532位密码接口参数说明:参数名参数字段参数说明ac接口功能接口功能,传入值请填写statusformat返回格式可选项,参数值:json,xml默认json格式uid用户账号pwd用户密码32位MD5加密md5(登录密码+用户账号)例:http://api.
sms.
cn/sms/ac=status&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769响应返回值:json格式{"stat":"100","total":"50","values":[{"retime":"2010-11-1418:04:19","mobile":"13900008888","mobileids":"1390000888800001","resultcode":"100","status":"DELIVRD"},{"retime":"2010-11-1418:09:19","mobile":"13900008888","mobileids":"1390000888800001","resultcode":"100","status":"DELIVRD"}]}xml格式1003002016-04-1111:04:3514778557233147785572331460343857100DELIVRD2016-04-1111:04:3113914455766139144557669924723100DELIVRD响应结果值说明:参数说明stat接口状态100成功total当前总记录数量retime状态返回时间mobile手机号mobileids发送唯一编号resultcode状态码:100//成功130//失败131//空号132//停机133//关机134//无状态status运营网关状态5.
2推送接收状态报告发送状态报告请求消息使用说明:由服务器平台发送状态报告到您的接口程序上,使用Http协议GET和POST方式发送,您需要提交一个http接口地址来接收如下格式参数值操作的格式:http://您服务器接口地址cmd=stat&uid=用户账号&mobileids=消息编号&mobile=接收号码&status=消息状态接口参数说明:参数参数字段名说明cmd操作命令返回值:statuid用户账号返回值:发送短信用户名mobileids消息编号返回值:消息编号mobile接收号码返回值:接收的号码resultcode状态码100//成功130//失败131//空号132//停机133//关机134//无状态例:http://您服务器接口地址cmd=stat&uid=test&mobileids=1590049111112869461937&mobile=15900491111&status=100六、接收上行短信(回复)6.
1主动获取上行短信(回复)操作的格式:http://api.
sms.
cn/sms/ac=reply&uid=用户账号&pwd=MD532位密码注:提取的回复短信不能在重复提取接口参数说明:参数参数字段名说明ac接口功能接口功能,传入值请填写statusformat返回格式可选项,参数值:json,xml默认json格式uid用户账号pwd用户密码小写32位MD5加密encode字符编码可选项,默认接收数据是GBK编码,如提交的是UTF-8编码字符,需要添加参数encode=utf8例:http://api.
sms.
cn/sms/ac=reply&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769响应结果为JSON和XMLJSON{"stat":"100","total":"100","values":[{"retime":"2012-04-1310:00:23","mobile":"15900001111","content":"谢谢你!
"},{"retime":"2012-04-1309:59:50","mobile":"15900001111","content":"收到"}]}XML1001002012-04-1310:00:2315900001111谢谢你!
2012-04-1309:59:5015900001111收到响应结果值说明:参数说明stat接口状态100成功total当前总记录数量retime回复时间mobile回复手机号content回复内容6.
2推送接收上行短信(回复)使用说明:由服务器平台发送上行回复短信到您的接口程序上,使用Http协议GET和POST方式发送,您需要提交一个http接口地址来接收如下格式参数值操作的格式:http://您服务器接口地址cmd=res&uid=用户账号&mobileids=消息编号&mobile=接收号码&status=消息状态接口参数说明:参数参数字段名说明cmd操作命令返回值:resuid用户账号返回值:发送短信用户名time回复时间返回值:YYYY-MM-DDHH:II:SSmobile接收号码返回值:接收的号码content消息内容返回值:UTF-8字符串七、取剩余短信条数操作格式:http://api.
sms.
cn/sms/ac=number&uid=用户账号&pwd=MD5位32密码接口参数说明:参数参数字段名说明ac接口功能接口功能,传入值请填写numberformat返回格式可选项,参数值:json,xml默认json格式uid用户账号pwd用户密码32位MD5加密例:http://api.
sms.
cn/sms/ac=number&uid=test&pwd=fa246d0262c3925617b0c72bb20eeb1d响应结果:JSON{"stat":"100","number":"2123432"}XML1002123432sms&stat=100&remain=100八、取已发送总条数操作格式:http://api.
sms.
cn/sms/ac=number&uid=用户账号&pwd=MD5位32密码&cmd=send接口参数说明:参数参数字段名说明ac接口功能接口功能,传入值请填写numberformat返回格式可选项,参数值:json,xml默认json格式uid用户账号pwd用户密码32位MD5加密cmdsend取已发送条数响应结果:JSON{"stat":"100","number":"2123432"}XML1002123432九、取发送记录操作的格式:http://api.
sms.
cn/sms/ac=query&uid=用户账号&pwd=MD532位密码接口参数说明:每次最多取50条记录,记录只能取一次,取过的记录不能在取参数参数字段名说明ac接口功能接口功能,传入值请填写queryformat返回格式可选项,参数值:json,xml默认json格式uid用户账号pwd用户密码小写32位MD5加密date日期可选项,取指定日期记录(2011-12-12)key查询号码可选项,取指定手机号记录encode字符编码可选项,默认接收数据是GBK编码,如提交的是UTF-8编码字符,需要添加参数encode=utf8例:http://api.
sms.
cn/sms/ac=query&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769响应结果为JOSN或XML格式返回如下格式:JSON格式:{"stat":100,"total":"1896397","page_size":"50","total_page":"37928","values":[{"sendtime":"2013-11-1418:04:19","mobile":"13900008888","content":"我的发送记录1【云信】","status":"1"},{"sendtime":"2013-11-1418:04:19","mobile":"13900008888","content":"我的发送记录2【云信】","status":"1"}]}无回复内容时返回空{"total":"0","page_size":"0","total_page":"0"}XML格式:100189634750379282013-11-1418:04:1913900008888发送的内容112013-11-1418:04:1913900008888发送的内容21无回复内容时返回空000响应结果值说明:参数说明stat接口状态100成功total总记录数量page_size当前记录数量total_page总页数sendtime发送时间mobile手机号content发送的内容status提交状态[status:发送状态1提交成功0提交失败]十、短信模板管理10.
1添加短信模板操作格式:http://api.
sms.
cn/sms/ac=template&uid=用户名&pwd=32位MD5加密&title=短信模板标题&content=要添加的模板内容接口参数说明:参数名参数字段参数说明ac接口功能接口功能,传入值请填写templateuid用户账号登录名pwd用户密码32位MD5加密md5(密码+uid)如登录密码是:123123,uid是:test;pwd=md5(123123test)pwd=b9887c5ebb23ebb294acab183ecf0769title模板标题模板标题名称用于备注查询[选填]content模板内容模板内容包含短信内容和签名.
全文变量模板的变量用{**}代替,JSON变量模板的变量用源码中相应的变量参数代替.