信信客  •  宇展盈讯科技旗舰产品,安全,效率,可靠,放心!
 
信信客接入指南

  信信客短信通道 API 接口是面向有一定技术开发能力的企业或者个人用户而单独研发的短信通道通讯协议。本接口采用了通用的 HTTP 形式,支持 GET 或者 POST 方式接入,可以支持各种操作系统和开发语言,为您提供了 ASP, ASP.net, Java, PHP, C# 等语言的例子代码,在您注册了平台账号后获得开发者标识即可通过简单的调试后,把短信通道接口嵌入到您自己的系统中,快速拥有无线应用,完善您的企业服务!

下载离线文档

1、文档说明

  本文阅读对象:接入信信客涉及的技术架构师,研发工程师,测试工程师,系统运维工程师。

2、准备工作

  接入前请在“开发者设置”中设置“开发者状态”为“启用”,并获取“开发者标识”和“开发者密钥”。为保证信息安全,切勿将开发者信息告知他人。

3、调用流程

  根据接口约定:填充参数 > 生成签名 > 封装 HTTP 请求 > 发起 HTTP 请求 > 得到 HTTP 响应 > 解析 JSON 结果。

4、接口列表

  为防止 API 调用过程中被恶意篡改,调用任何一个 API 都需要携带签名,服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。

  接口规范:

传输方式HTTP
提交方式为避免乱码问题,建议使用 POST 方式发起请求。
字符编码统一采用 UTF-8 字符编码
签名算法
MD5 小写 32 位,示例
4.1、短信发送接口
接口链接http://www.xinxinke.com/api/send
请求参数
点击左侧展开或收缩...
返回结果
点击左侧展开或收缩...
4.2、短信回执接口
接口链接http://www.xinxinke.com/api/report
请求参数
点击左侧展开或收缩...
返回结果
点击左侧展开或收缩...
4.3、短信接收接口
接口链接http://www.xinxinke.com/api/receive
请求参数
点击左侧展开或收缩...
返回结果
点击左侧展开或收缩...
4.4、短信模板接口
接口链接http://www.xinxinke.com/api/template
请求参数
点击左侧展开或收缩...
返回结果
点击左侧展开或收缩...
4.5、帐户信息接口
接口链接http://www.xinxinke.com/api/account
请求参数
点击左侧展开或收缩...
返回结果
点击左侧展开或收缩...
5、状态码说明
状态码描述状态码描述
25010成功45001非法IP
45002开发者标识不合法45003开发者状态异常
45004参数签名(md5)错误45005短信模板代码不合法
45006用户状态不合法45101参数个数不合法
45102扩展子号不合法45103接收号码不能为空
45104不存在有效接收号码45105接收号码过多
45106短信签名不合法45107短信模板不存在
45108短信模板状态异常45109短信参数不合法
45110短信内容过长45111帐户余额不足
45112短信签名不正确45201接收号码不合法
45202号码提交记录索引不合法45301发送号码不合法
45401模板内容格式错误45402模板代码已存在
45403待审核模板过多45404请求动作不合法
55xxx系统异常,请联系技术支持  
6、调用示例

  以下代码仅供学习和研究信信客接口使用,只是为了方便开发者测试而提供的样例代码,开发者可以根据自己的业务需要,按照开发文档编写,并非一定要使用该代码。

请求:Java示例(POST)
请求:C#示例(POST)
请求:PHP示例(POST)
请求:Ruby示例(POST)
请求:Python示例(POST)
请求:ASP示例(POST)
请求:Linux示例(POST)
请求:易语言示例(POST)
7、注意事项

  1、为防止 API 调用过程中被恶意篡改,调用任何一个 API 都需要携带签名,服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。

  2、所有的请求和响应数据编码皆为 UTF-8 格式, URL 里的所有参数名和参数值请做 UTF-8 编码。

  3、参数名与参数值拼装起来的 URL 长度小于 1024 个字符时,可以用 GET 发起请求;拼装好的请求 URL 过长时,必须用 POST 发起请求。所有 API 都可以用 POST 发起请求。

  4、为避免乱码问题,建议使用 POST 方式发起请求。

  5、为保证帐户安全,建议绑定安全 IP 地址。

点击这里给我发消息