接口地址:http://api.yunzhixin.com:11140/txp/sms/send
请求方式:http get/post
编码格式:UTF-8
请求示例:http://api.yunzhixin.com:11140/txp/sms/send?
account=xxx&mobile=xxx&order_id=xxx&time=xxx&tpl_id=xxx¶ms=xxx&sign=xxx
请求参数说明:
名称 | 类型 | 必须 | 字段说明 |
account | string | 是 | 用户编号,注册www.yunzhixin.com的手机号码 |
mobile | string | 是 | 用户所需发送的手机号 |
order_id | string | 是 | 商户提交的订单号(商户保证其唯一性) |
time | int64 | 是 | 用户服务器时间戳(毫秒) |
tpl_id | string | 是 | 模板编号 |
params | string | 是 | 短信所需传入的参数,规则参见下方 |
sign | string | 是 | 签名,MD5(mobile|account|time|tpl_id#tradeKey).toUpperCase(),举例参见下方 |
params传入规则:
根据预先审核通过的自定义短信模板所定义的变量名称进行赋值,模板中两个“#”中间为变量名,多个变量使用“,”分隔,表达式为” code:value,code1:value1…”
例如:
短信模板为“您的电话#telephone#成功缴费#money#元,如未到账可直接拨打客服电话#phone#”,params="telephone:13288888888,money:100,phone:400-888888"
加密规则:
sign=MD5(mobile|account|time|tpl_id#tradeKey). toUpperCase()
假设传送的参数如下:
account:10000100,mobile:13288888888,time:1499666964917,tpl_id:TP1701240858154320,
由商务部门给予商户tradeKey为6b57c07e87a743f5bae83874cc3cb19d,
sign=MD5(13288888888|10000100|1499666964917|TP1701240858154320#6b57c07e87a743f5bae83874cc3cb19d). toUpperCase()
返回示例:
{
"return_code":"0000",
"order_id":"CS1502694221615"
"fee":0.05//订单价格
"count":1//订单包含短信条数
}
名称 | 类型 | 字段说明 |
return_code | string | 返回码 |
order_id | string | 商户提交的订单号,提交错误时不返回该项 |
fee | Double | 订单价格(单位:元) |
count | Integer | 订单包含短信条数 |
返回编码 | 信息 |
0000 | 请求成功 |
3050 | 产品参数不能为pullReply空 |
3051 | 产品不存在 |
3052 | 产品下架 |
4598 | 手机号存在在黑名单中 |
5000 | 参数错误 |
5001 | 参数无效 |
5002 | 手机号码无效 |
5003 | 订单号重复 |
5004 | 商户不存在 |
5005 | 商户状态无效 |
5006 | 商户账户不存在 |
5007 | 商户账号余额不足 |
5008 | 商户未设置交易密钥 |
5009 | 无效的交易签名 |
5010 | 网络异常,订单超时 |
5011 | 未绑定IP |
5012 | 商户短信模板ID不存在 |
5015 | 查询归属地错误 |
5016 | 同一号码相同内容30秒内只能获取一次 |
5017 | 同一号码验证码类内容一小时只能获取3次 |
5018 | 同一号码验证码类内容一天只能获取10次 |
5019 | 包含敏感词 |
5023 | 提交的时间戳超过10分钟 |
5032 | 商户价格不存在 |
5062 | 签名未实名 |
4599 | 非白名单号码,无法发送 |
9999 | 系统异常 |
语言 | 标题 | 提供者 | 时间 |
JAVA | 发送短信接口调用示例 | starSky | 2017-10-16 10:04 |
C# | 发送短信接口调用示例 | starSky | 2017-10-16 10:04 |
接口地址:http://api.yunzhixin.com:11140/txp/sms/queryTemplate
请求方式:http get/post
编码格式:UTF-8
请求示例:http://api.yunzhixin.com:11140/txp/sms/queryTemplate?account=xxx&tpl_id=xxx&sign=xxx
请求参数说明:
名称 | 类型 | 必须 | 字段说明 |
account | string | 是 | 用户编号,注册www.yunzhixin.com的手机号码 |
tpl_id | string | 是 | 需要查询的模板编号 |
sign | string | 是 | 签名,MD5(account|tpl_id#tradeKey).toUpperCase(),举例参见下方 |
加密规则:
sign=MD5(account|tpl_id#tradeKey).toUpperCase()
假设传送的参数如下:
account:10000100 ,tpl_id:TP1701240858154320,
由商务部门给予商户tradeKey为6b57c07e87a743f5bae83874cc3cb19d,
sign=MD5(10000100|TP1701240858154320#6b57c07e87a743f5bae83874cc3cb19d).toUpperCase()
返回示例:
{
"return_code":"0000",
"status":"AUDIT_SUCCESS",
"msg":"",
"apply_time":"2017-11-11 11:11:11",
"audit_time":"2017-11-11 11:30:00"
}
名称 | 类型 | 说明 |
return_code | string | 返回码 |
status | string | 模板状态(WAIT_AUDIT-审核中, AUDIT_SUCCESS-审核成功, AUDIT_FAIL-审核失败) |
msg | string | 模板审核失败说明(审核失败时返回,其他状态为空) |
apply_time | string | 模板提交的时间 |
audit_time | string | 模板审核的时间 |
返回编码 | 信息 |
0000 | 请求成功 |
2001 | 商户信息不存在 |
4002 | 模板不存在 |
5000 | 参数错误 |
5008 | 商户未设置秘钥 |
5009 | 秘钥签名无效 |
5024 | 访问过于频繁 |
9999 | 系统异常 |
语言 | 标题 | 提供者 | 时间 |
JAVA | 查询模板状态调用示例 | starSky | 2017-10-16 10:04 |
C# | 查询模板状态调用示例 | starSky | 2017-10-16 10:04 |
接口地址:http://api.yunzhixin.com:11140/txp/smsGroup
请求方式:http get/post
编码格式:UTF-8
请求示例:"http://api.yunzhixin.com:11140/txp/smsGroup?account=xxx&mobile=xxx&tplId=xxx¶ms=xxx&sign=xxx"
请求参数说明:
名称 | 类型 | 必须 | 字段说明 |
account | string | 是 | 用户编号,注册www.yunzhixin.com的手机号码 |
mobile | string | 是 | 用户所需发送的手机号,以英文逗号隔开(最多1000个) |
tplId | string | 是 | 模板编号 |
params | string | 是 | 短信所需传入的参数,规则参见下方 |
sign | string | 是 | 签名,MD5(account|tplId#tradeKey).toUpperCase(),举例参见下方 |
根据预先审核通过的自定义短信模板所定义的变量名称进行赋值,模板中两个“#”中间为变量名,多个变量使用“,”分隔,表达式为” code:value,code1:value1…”
例如:
短信模板为“您的电话#telephone#成功缴费#money#元,如未到账可直接拨打客服电话#phone#”,params="telephone:13288888888,money:100,phone:400-888888"
加密规则:
sign=MD5(account|tplId#tradeKey).toUpperCase()
假设传送的参数如下:
account:10000100 ,tplId:TP1701240858154320,
由商务部门给予商户tradeKey为6b57c07e87a743f5bae83874cc3cb19d,
sign=MD5(10000100|TP1701240858154320#6b57c07e87a743f5bae83874cc3cb19d).toUpperCase()
返回示例:
{
"return_code":"0000",
"totalNum":"2",
}
名称 | 类型 | 字段说明 |
return_code | string | 返回码 |
totalNum | int | 可以发送手机号的个数 |
返回编码 | 信息 |
0000 | 请求成功 |
3050 | 产品参数不能为空 |
3051 | 产品不存在 |
3052 | 产品下架 |
4598 | 手机号存在在黑名单中 |
5000 | 参数为空 |
5001 | 参数无效 |
5002 | 手机号码无效 |
5003 | 订单号重复 |
5004 | 商户不存在 |
5005 | 商户状态无效 |
5006 | 商户账户不存在 |
5007 | 商户账号余额不足 |
5008 | 商户未设置交易密钥 |
5009 | 无效的交易签名 |
5010 | 网络异常,订单超时 |
5011 | 未绑定IP |
5012 | 商户短信模板ID不存在 |
5015 | 查询归属地错误 |
5019 | 包含敏感词 |
5023 | 提交的时间戳超过10分钟 |
5026 | 手机号重复 |
5027 | 发送时间异常(发送时间段09:00-20:00) |
5028 | 手机号异常(无归属地/产品不存在或已下架,限用于批量发送) |
5041 | 手机号码数量超限(1000条) |
5042 | 群发短信只能是通知类和营销类 |
9999 | 系统异常 |
语言 | 标题 | 提供者 | 时间 |
JAVA | 群发短信接口调用示例 | starSky | 2018-02-09 10:04 |
C# | 群发短信接口调用示例 | starSky | 2018-02-09 10:04 |
接口地址:http://api.yunzhixin.com:11140/txp/pullReply
请求方式:http get/post
编码格式:UTF-8
请求示例:http://api.yunzhixin.com:11140/txp/pullReply?account=xxx&sign=xxxx
请求参数说明:
名称 | 类型 | 必须 | 字段说明 |
account | string(11) | 是 | 用户编号,注册www.yunzhixin.com的手机号码 |
sign | string(32) | 是 | 签名,md5(account#tradeKey).toUpperCase(),举例参见下方 |
加密规则:
sign=MD5(account#tradeKey).toUpperCase()
假设传送的参数如下:
account:10000100
由商务部门给予商户tradeKey为6b57c07e87a743f5bae83874cc3cb19d
sign=md5(10000100#6b57c07e87a743f5bae83874cc3cb19d).toUpperCase()
注:该接口只能每十秒调用一次.
返回示例(json格式):
{"return_code":"0000",
"total":1,
"row":[
{"mobile":"15953511028",
"receiveTime": "2018-02-13 10:55:35",
"returnInfo":"测试返回"}
]
}
名称 | 类型 | 字段说明 |
return_code | String | 返回码 |
total | Integer | 返回总条数 |
row | String | 所有回复内容 |
row字段说明:
名称 | 类型 | 字段说明 |
mobile | String | 回复手机号 |
receiveTime | String | 回复时间 |
returnInfo | String | 回复内容 |
错误码说明:
返回编码 | 信息 |
2001 | 商户不存在 |
5000 | 参数错误 |
5008 | 未设置交易密钥 |
5009 | 无效签名 |
5011 | 未绑定IP |
5021 | 操作过快,请稍后重试 |
9999 | 系统异常 |
语言 | 标题 | 提供者 | 时间 |
JAVA | 上行回复调用示例 | starSky | 2018-02-27 10:04 |
C# | 上行回复调用示例 | starSky | 2018-02-27 10:04 |