信信客短信通道API接口是面向有一定技术开发能力的企业或者个人用户而单独研发的短信通道通讯协议。本接口采用了通用的HTTP形式，支持GET或者POST方式接入，可以支持各种操作系统和开发语言，为您提供了ASP、ASP.net、Java、PHP、C#等语言的例子代码，在您注册了平台账号后获得开发者标识即可通过简单的调试后，把短信通道接口嵌入到您自己的系统中，快速拥有无线应用，完善您的企业服务！
1. 准备工作
接入前请在“开发者设置”中设置“开发者状态”为“启用”，并获取“开发者标识”和“开发者密钥”。
为保证信息安全，切勿将开发者信息告知他人。
2. 调用流程
根据接口约定：填充参数 > 生成签名 > 拼装HTTP请求 > 发起HTTP请求 > 得到HTTP响应 > 解析JSON结果。
3. 公共参数
调用任何一个API接口都必须传入的参数，目前的公共参数有：
|
参数名称 |
参数类型 |
是否必须 |
参数描述 |
|
dev_id |
String |
必须 |
开发者标识 |
|
sign |
String |
必须 |
参数签名 |
参数说明：
1. 参数签名：为防止API调用过程中被恶意篡改，调用任何一个API都需要携带签名，服务端会根据请求参数，对签名进行验证，签名不合法的请求将会被拒绝。
4. 接口调用
4.1 短信发送接口
|
接口地址 |
http://www.xinxinke.com/api/send |
|
调用方式 |
GET, POST |
4.1.1 短信发送请求
|
参数名称 |
参数类型 |
是否必须 |
参数描述 |
|
dev_id |
String |
必须 |
开发者标识 |
|
sign |
String |
必须 |
参数签名 |
|
sms_template_code |
String |
必须 |
短信模板代码 |
|
sms_param |
JSON |
可选 |
短信模板变量 |
|
rec_num |
String |
必须 |
接收号码 |
|
ext_num |
Number |
可选 |
扩展子号 |
参数说明：
1. 参数签名：算法md5(dev_id + dev_key + rec_num)。示例：md5("b7d5107d782d4033v35047d4a448089b" + "e35c7a885v0144e79ef9541a36382f21" + "13800138000,18900189000,18600186000")
2. 短信模板变量：传参规则{"key":"value"}，key的名字须和申请模板中的变量名一致，多个变量之间以逗号隔开。示例：针对模板“验证码${code}，您正在进行${product}身份验证，打死不要告诉别人哦！”，传参时需传入{"code":"1234","product":"xinxinke"}
3. 接收号码：支持单个或多个手机号码，传入号码为11位手机号码，以英文逗号分隔，一次调用最多传入1000个号码。示例：13800138000,18900189000,18600186000
4.1.2 短信发送响应
|
状态码 |
描述 |
|
25010 |
正确 |
|
45001 |
非法IP |
|
45010 |
参数个数不合法 |
|
45020 |
开发者标识不合法 |
|
45030 |
参数签名(md5)格式不正确 |
|
45040 |
短信模板代码不合法 |
|
45050 |
扩展子号不合法 |
|
45060 |
接收号码不能为空 |
|
45070 |
不存在有效接收号码 |
|
45080 |
接收号码过多 |
|
45090 |
开发者状态异常 |
|
45100 |
短信签名不合法 |
|
45110 |
参数签名(md5)错误 |
|
45120 |
短信模板不存在 |
|
45130 |
短信模板状态异常 |
|
45140 |
短信参数不合法 |
|
45150 |
短信内容过长 |
|
45160 |
帐户余额不足 |
4.2 短信发送状态报告接口
|
接口地址 |
http://www.xinxinke.com/api/report |
|
调用方式 |
GET, POST |
4.2.1 短信发送状态报告请求
|
参数名称 |
参数类型 |
是否必须 |
参数描述 |
|
dev_id |
String |
必须 |
开发者标识 |
|
sign |
String |
必须 |
参数签名 |
|
rec_num |
String |
可选 |
接收号码 |
|
index |
String |
可选 |
号码提交记录索引 |
参数说明：
1. 参数签名：算法md5(dev_id + dev_key)。示例：md5("b7d5107d782d4033v35047d4a448089b" + "e35c7a885v0144e79ef9541a36382f21")
2. 接收号码：传入号码为11位手机号码。示例：13800138000
4.2.2 短信发送状态报告响应
|
状态码 |
描述 |
|
25010 |
正确 |
|
45001 |
非法IP |
|
45010 |
开发者标识不合法 |
|
45020 |
参数签名(md5)格式不正确 |
|
45030 |
接收号码不合法 |
|
45040 |
开发者状态异常 |
|
45050 |
参数签名(md5)错误 |
|
45060 |
号码提交记录索引不合法 |
4.3 短信接收接口
|
接口地址 |
http://www.xinxinke.com/api/receive |
|
调用方式 |
GET, POST |
4.3.1 短信接收请求
|
参数名称 |
参数类型 |
是否必须 |
参数描述 |
|
dev_id |
String |
必须 |
开发者标识 |
|
sign |
String |
必须 |
参数签名 |
|
src_num |
String |
可选 |
发送号码 |
参数说明：
1. 参数签名：算法md5(dev_id + dev_key)。示例：md5("b7d5107d782d4033v35047d4a448089b" + "e35c7a885v0144e79ef9541a36382f21")
2. 发送号码：传入号码为11位手机号码。示例：13800138000
4.3.2 短信接收响应
|
状态码 |
描述 |
|
25010 |
正确 |
|
45001 |
非法IP |
|
45010 |
开发者标识不合法 |
|
45020 |
参数签名(md5)格式不正确 |
|
45030 |
发送号码不合法 |
|
45040 |
开发者状态异常 |
|
45050 |
参数签名(md5)错误 |
4.4 短信模板接口
|
接口地址 |
http://www.xinxinke.com/api/template |
|
调用方式 |
GET, POST |
4.4.1 短信模板请求
|
参数名称 |
参数类型 |
是否必须 |
参数描述 |
|
dev_id |
String |
必须 |
开发者标识 |
|
sign |
String |
必须 |
参数签名 |
|
action |
String |
必须 |
请求动作 |
|
sms_template_code |
String |
区分动作 |
模板代码 |
|
content |
String |
区分动作 |
模板内容 |
参数说明：
1. 请求动作：
1) 查询：action = query，模板代码为可选项
2) 新增：action = create，模板代码、模板内容为必须项
3) 删除：action = delete，模板代码为必须项
2. 参数签名：
1) 查询：算法md5(dev_id + dev_key)。示例：md5("b7d5107d782d4033v35047d4a448089b" + "e35c7a885v0144e79ef9541a36382f21")
2) 新增、删除：算法md5(dev_id + dev_key + sms_template_code)。示例：md5("b7d5107d782d4033v35047d4a448089b" + "e35c7a885v0144e79ef9541a36382f21" + "dynamic_code")
4.4.2 短信模板响应
|
状态码 |
描述 |
|
25010 |
正确 |
|
45001 |
非法IP |
|
45010 |
开发者标识不合法 |
|
45020 |
参数签名(md5)格式错误 |
|
45030 |
模板代码格式错误 |
|
45040 |
模板内容格式错误 |
|
45050 |
开发者状态异常 |
|
45060 |
参数签名(md5)错误 |
|
45070 |
模板代码已存在 |
|
45080 |
待审核模板过多 |
|
45090 |
请求动作不合法 |