短信营销API接口文档下载：  点击下载

1、概要

1.1 文档说明

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

1.2 接口内容

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

1.3 提交方式

GET / POST

1.4 加密方式

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

1.5 API ID / API KEY

登录用户中心，进入【短信营销】模块，在【产品总揽】页面右上角

1.6 短信模版

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

您好，您的验证码是：666666

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

您好，您的验证码是：888888

我们提取相似度以后，可以制作以下短信模板：

您好，您的验证码是：【变量】

其中，变量是可变的，可以是 数字、字母、汉字。

注意：付费用户可以通过左侧导航【短信营销】-【短信发送】-【模版管理】新增短信模板，运营商审核通过之后即可正式使用。

1.7 短信签名

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

2、短信发送

2.1 接口描述

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

2.2 请求地址

http://api.yx.ihuyi.com/webservice/sms.php?method=Submit

2.3 请求参数

用户通过http 或 https提交发送短信请求到服务器后，服务器会返回一串xml格式的字符串，SubmitResult结构说明如下：

2.4 响应示例

示例（成功）

 2 提交成功 14745625541233112231 

示例（失败）

 405 用户名或密码不正确 0 

2.5 响应参数

2.6 请求示例

http://api.yx.ihuyi.com/webservice/sms.php?method=Submit&account=APIID&password=APIKEY&mobile=手机号码&content=短信内容【签名】

3、余额查询

3.1 接口描述

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

3.2 请求地址

http://api.yx.ihuyi.com/webservice/sms.php?method=GetNum

3.3 请求参数

用户通过http 或 https提交帐户余额查询请求到服务器后，服务器会返回一串xml格式的字符串，GetNumResult结构说明如下：

3.4 响应示例

示例（成功）

 2 查询成功 856 

示例（失败）

 405 用户名或密码不正确 0 

3.5 响应参数

3.6 GET请求示例

http://api.yx.ihuyi.com/webservice/sms.php?method=GetNum&account=APIID&password=APIKEY 

4、发送回执推送

4.1 接口描述

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

4.2 推送参数

注意: 成功接收请输出字符 "success" （不包含引号）结束推送，否则以接收失败处理。每个回执最多推送3次。每次间隔叠加60秒。

5、上行回复推送

5.1 接口描述

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

5.2 推送参数

注意: 成功接收请输出字符 "success" （不包含引号）结束推送，否则以接收失败处理。每个回执最多推送3次。每次间隔叠加60秒。

6、生成动态密码方式

以PHP为例，提交短信的生成方式：

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

例如：

APIID： test
APIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d
手机号：138xxxxxxxx
内容：尊敬的会员，您好，夏季新品已上市，请关注。退订回TD【互亿通信】
time：1451544941
结果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx尊敬的会员，您好，夏季新品已上市，请关注。退订回TD【互亿通信】1451544941');

注意：因为短信内容会包含中文，所以字符编码统一为UTF-8

查询剩余条数的生成方式：

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

例如：

APIID： test
APIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d
手机号：138xxxxxxxx
time：1451544941
结果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');

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