短信验证码 / 通知 API 接口文档

1、概要

1.1 文档说明

本文档主要提供给亿互通平台的用户对接接口的使用说明，开发者可以利用亿互通平台提供的 HTTP 接口，调用亿互通平台的短信验证码 / 通知服务。

1.2 接口内容

本文档包含短信发送、余额查询、发送回执推送、上行回复推送等。

1.3 提交方式

GET / POST

1.4 加密方式

• 采用 HTTPS 协议提交请求
• 通过 MD5 动态签名方式加密

1.5 API ID / API KEY

登录用户中心，进入【验证码通知短信】模块，在产品总览页面右上角即可查看 APIID 与 APIKEY。

1.6 短信模版

短信模板是对您将要发送的短信进行相似性提取后的内容。举个例子，A 用户在您平台注册会员，需要发送一条短信，内容如下：

同时，B 用户也在您的平台注册会员，发送了如下短信：

我们提取相似度以后，可以制作以下短信模板，其中变量是可变的，可以是数字、字母、汉字。

1.7 短信签名

短信签名是加在短信的开头或结尾，在【】加上您的公司名称或店铺名称的标识符，例如：【亿互通】。根据电信基础运营商的规定，每条短信必须附加短信签名，否则将无法正常发送。

2、短信发送

2.1 接口描述

通过 POST、GET 方式进行短信提交，数据编码采用 utf-8 格式，24 小时全天发送。

2.2 请求地址

2.3 请求参数

提交请求后，服务器返回 SubmitResult，结构说明如下：

2.4 响应示例

<?xml version="1.0" encoding="utf-8"?>
<SubmitResult xmlns="106.ihuyi.com">
  <code>2</code>
  <msg>提交成功</msg>
  <smsid>14745625541233112231</smsid>
</SubmitResult>

<?xml version="1.0" encoding="utf-8"?>
<SubmitResult xmlns="106.ihuyi.com">
  <code>405</code>
  <msg>用户名或密码不正确</msg>
  <smsid>0</smsid>
</SubmitResult>

2.5 响应参数（code 状态码）

2.6 请求示例

3、余额查询

3.1 接口描述

通过接口可以方便地查询你的账户验证码通知短信剩余条数。

3.2 请求地址

3.3 请求参数

返回 GetNumResult，结构说明如下：

3.4 响应示例

<?xml version="1.0" encoding="utf-8"?>
<GetNumResult xmlns="106.ihuyi.com">
  <code>2</code>
  <msg>查询成功</msg>
  <num>856</num>
</GetNumResult>

<?xml version="1.0" encoding="utf-8"?>
<GetNumResult xmlns="106.ihuyi.com">
  <code>405</code>
  <msg>用户名或密码不正确</msg>
  <num>0</num>
</GetNumResult>

3.5 响应参数

3.6 GET 请求示例

4、发送回执推送

4.1 接口描述

用户先提供数据接收地址，然后绑定到亿互通系统后台，平台会以 POST 方式实时将回执信息推送到此地址。

4.2 推送参数

5、上行回复推送

5.1 接口描述

用户先提供数据接收地址，然后绑定到亿互通系统后台，平台会以 POST 方式实时将用户回复信息推送到此地址。

5.2 推送参数

6、生成动态密码方式

以 PHP 为例，提交短信的动态密码生成方式：

$time     = time();
$password = md5($account.$apikey.$mobile.$content.$time);

例如：

结果：md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx您的验证码是：2546。请不要把验证码泄露给其他人。1451544941')

Unix 时间戳参考地址：tool.chinaz.com/Tools/unixtime.aspx