在线咨询

400-668-7332

 
文档说明常见问题
注册接口账户下载接口文档和示例密钥sign工具

开发接入注意事项

接入流程:注册帐号 - 客服配置通道 - 客服协助用户调试 - 签订合同协议 - 预存费用 - 正式使用

http和http V2.0的加密方式不同,http使用明文密码,http V2.0使用组合MD5加密,两种接口均可安全使用。

防止用户接口被注册机刷短信,请添加图形验证进行防护。如案例:http://www.okbuy.com/members/register

《验证码/通知》专发验证码和通知内容,请勿发送营销广告,如需发送,请联系客服修改配置或添加营销子账户(余额共享)。

《验证码/通知》用户调试过程中,请使用正式内容进行调试并加签名,如:【云曼信息】您好,您的注册验证码是:5599

接入指引

接入注意事项

短信发送方式

调取短信余额

查询关键词语

提取状态报告

提取上行回复

↑ 返回顶部 ↑

 

HTTP2.0短信接口说明

调试模板参考:【云曼信息】你好,您的验证码:5599

短信管理后台:http://cloud.yunsms.cn(发送记录、状态报告、数据统计、平台发送、在线充值...)

请根据您的内容编码选择提交入口;接口发送支持http、WebService,返回结果支持xml、jason,可下载接口文档选择使用。

一、短信发送

1.1、提交地址

UTF-8提交地址:http://cloud.yunsms.cn/v2sms.aspx

GBK提交地址:http://cloud.yunsms.cn/v2smsGBK.aspx

1.2、参数说明

参数字段 含义 参数说明
userid 用户ID 用户ID(登陆后台-发短信-接入摘要)
timestamp 时间戳 系统当前时间字符串,年月日时分秒,例如:20190117230015
sign 接口密钥

接口密钥使用 账号+密码+时间戳 拼接字符串后通过MD5加密生成(32位小写)。例如:

账号:test

密码:yunsms

时间戳:20190117230015

则使用testyunsms20190117230015来生成MD5的签名,生成的签名为:4ae39a0f109f521b488752b9628ac79c

MD5加密工具:V2.0接口密钥工具

mobile 接收号码 短信接收手机号码.多个号码之间用半角逗号隔开
sendTime 发送时间 可选项,为空表示立即发送,定时发送格式2010-10-24 09:08:10
action 发送任务命令 设置为固定的:send
extno 扩展子号 请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多10位数。

例如:

http://cloud.yunsms.cn/v2sms.aspx?action=send&userid=108&timestamp=20190117230015&sign=4ae39a0f109f521b488752b9628ac79c&mobile=13800138000,15900159000&content=【云曼信息】你好,您的验证码:5599&extno=

1.3、返回值

<?xml version="1.0" encoding="utf-8" ?>

<returnsms>

<returnstatus>Success</returnstatus> ---------- 返回状态值:成功返回Success 失败返回:Faild

<message>ok</message> ---------- 返回结果的内容,ok为成功,如失败会返回原因

<remainpoint>156699</remainpoint> ---------- 返回余额

<taskID>57223493</taskID>   ---------- 返回本次任务的序列ID

<successCounts>2</successCounts> ---------- 成功短信数:当提交成功显示提交成功的数量

</returnsms>

二、余额及已发送量查询接口

2.1、提交地址

UTF-8提交地址:http://cloud.yunsms.cn/v2sms.aspx

GBK提交地址:http://cloud.yunsms.cn/v2smsGBK.aspx

2.2、参数说明

参数字段 含义 参数说明
userid 用户ID 用户ID(登陆后台-发短信-接入摘要)
timestamp 时间戳 系统当前时间字符串,年月日时分秒,例如:20190117230015
sign 接口密钥

接口密钥使用 账号+密码+时间戳 拼接字符串后通过MD5加密生成(32位小写)。例如:

账号:test

密码:yunsms

时间戳:20190117230015

则使用testyunsms20190117230015来生成MD5的签名,生成的签名为:4ae39a0f109f521b488752b9628ac79c

MD5加密工具:V2.0接口密钥工具

action 发送任务命令 设置为固定的:overage

例如:

http://cloud.yunsms.cn/v2sms.aspx?action=overage&userid=108&timestamp=20190117230015&sign=4ae39a0f109f521b488752b9628ac79c

2.3、返回值

<?xml version="1.0" encoding="utf-8" ?>

<returnsms>

<returnstatus>Sucess</returnstatus> -- 返回状态值:成功Sucess (注意:此处是Sucess,和其它返回的Success不同)失败返回:Faild

<message>message</message> ---------- 返回信息提示

<payinfo>预付费</payinfo>---------- 返回支付方式  后付费,预付费

<overage>589615</overage>---------- 返回余额

<sendTotal>4684563</sendTotal>---------- 返回总条数  当支付方式为预付费是返回总充值条数

</returnsms>

三、非法关键词查询

3.1、提交地址

UTF-8提交地址:http://cloud.yunsms.cn/v2sms.aspx

GBK提交地址:http://cloud.yunsms.cn/v2smsGBK.aspx

3.2、参数说明

参数字段 含义 参数说明
userid 用户ID 用户ID(登陆后台-发短信-接入摘要)
timestamp 时间戳 系统当前时间字符串,年月日时分秒,例如:20190117230015
sign 接口密钥

接口密钥使用 账号+密码+时间戳 拼接字符串后通过MD5加密生成(32位小写)。例如:

账号:test

密码:yunsms

时间戳:20190117230015

则使用testyunsms20190117230015来生成MD5的签名,生成的签名为:4ae39a0f109f521b488752b9628ac79c

MD5加密工具:V2.0接口密钥工具

action 发送任务命令 设置为固定的:checkkeyword
content 短信内容 检测内容是否包含屏蔽词

例如:

http://cloud.yunsms.cn/v2sms.aspx?action=checkkeyword&userid=108&timestamp=20190117230015&sign=4ae39a0f109f521b488752b9628ac79c&content=【云曼信息】你好,您的验证码:5599

3.3、返回值

<?xml version="1.0" encoding="utf-8" ?>

<returnsms>

<message>message</message> ---------- 返回信息提示

</returnsms>

四、状态报告接口

4.1、提交地址

提交地址:http://cloud.yunsms.cn/v2statusApi.aspx

4.2、参数说明

参数字段 含义 参数说明
userid 用户ID 用户ID(登陆后台-发短信-接入摘要)
timestamp 时间戳 系统当前时间字符串,年月日时分秒,例如:20190117230015
sign 接口密钥

接口密钥使用 账号+密码+时间戳 拼接字符串后通过MD5加密生成(32位小写)。例如:

账号:test

密码:yunsms

时间戳:20190117230015

则使用testyunsms20190117230015来生成MD5的签名,生成的签名为:4ae39a0f109f521b488752b9628ac79c

MD5加密工具:V2.0接口密钥工具

statusNum 每次取得号码数 必须为数字,默认4000,可不填
action 任务名称 设置为固定的:query

例如:

http://cloud.yunsms.cn/v2statusApi.aspx?action=query&userid=108&timestamp=20190117230015&sign=4ae39a0f109f521b488752b9628ac79c

4.3、返回值

<?xml version="1.0" encoding="utf-8" ?>

<returnsms>

<statusbox>

<mobile>13800138000</mobile>-------------对应的手机号码

<taskid>1212</taskid>-------------同一批任务ID

<status>10</status>---------状态报告----10:发送成功,20:发送失败

<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间

<errorcode>DELIVRD</errorcode>-运营商网关返回值,不同网关返回值不同,仅作为参考

<extno>01</extno>--子号,即自定义扩展号

</statusbox>

<statusbox>

<mobile>13800138001</mobile>

<taskid>1212</taskid>

<status>20</status>

<receivetime>2011-12-02 22:12:11</receivetime>

<errorcode>2</errorcode>

<extno></extno>

</statusbox>

</returnsms>

五、上行回复

5.1、提交地址

提交地址:http://cloud.yunsms.cn/v2callApi.aspx

5.2、参数说明

参数字段 含义 参数说明
userid 用户ID 用户ID(登陆后台-发短信-接入摘要)
timestamp 时间戳 系统当前时间字符串,年月日时分秒,例如:20190117230015
sign 接口密钥

接口密钥使用 账号+密码+时间戳 拼接字符串后通过MD5加密生成(32位小写)。例如:

账号:test

密码:yunsms

时间戳:20190117230015

则使用testyunsms20190117230015来生成MD5的签名,生成的签名为:4ae39a0f109f521b488752b9628ac79c

MD5加密工具:V2.0接口密钥工具

action 发送任务命令 设置为固定的:query

例如:

http://cloud.yunsms.cn/v2callApi.aspx?action=query&userid=108&timestamp=20190117230015&sign=4ae39a0f109f521b488752b9628ac79c

5.3、返回值

<?xml version="1.0" encoding="utf-8" ?>

<returnsms>

<callbox>

<mobile>13800138000</mobile>-------------对应的手机号码

<taskid>1212</taskid>-------------同一批任务ID

<content>你好,收到!</content>---------上行内容

<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间

<extno>01</extno>----子号,即自定义扩展号

</callbox>

<callbox>

<mobile>13800138001</mobile>

<taskid>1212</taskid>

<content>好的,收到!</content>

<receivetime>2011-12-02 22:12:11</receivetime>

<extno>01</extno>

</callbox>

</returnsms>

联系我们

电话:400-668-7332

传真:0551-6550-2013

邮箱:service@yunsms.cn

地址:安徽省合肥市蜀山区建业领翔3#1001