彩信/视频短信 - API文档

1.概要

1.1 文档说明

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

1.2 接口内容

本文档包含彩信批量提交、余额查询、彩信模板提交、回执推送、上行推送、模板审核推送。

1.3 提交方式

POST

1.4 加密方式

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

1.5 api id / api key

登录用户中心，进入“营销彩信”模块，在产品概览页面右侧获取，如下图所示：

1.6 彩信模版

彩信模板是对您将要发送的彩信进行相似性提取后的内容。

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

1.7 彩信签名

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

2. 公共请求参数(json格式)

3. 彩信批量提交接口

3.1 协议说明

3.2 请求地址

https://api.ihuyi.com/mms/v1/batchSend

3.3 请求参数（json格式，需要包含公共请求参数）

3.4 返回参数(json格式)

4. 余额查询接口

4.1 请求地址

https://api.ihuyi.com/mms/v1/balance

4.2 请求参数（json格式,需要包含公共请求参数）

4.3 返回参数(json格式)

示例：

5. 彩信模板提交接口

5.1 协议说明

5.2 请求地址

https://api.ihuyi.com/mms/v1/templateCreate

5.3 请求参数(json格式，需要包含公共请求参数)

5.4返回参数(json格式)

6. 回执推送

6.1 协议说明

6.2 回执数据定义

响应说明:

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

7. 模板审核推送

7.1 协议说明

7.2 模板审核数据定义

8. 参数示例说明

8.1 内容格式定义

1) 支持视频、图片、音频和文字，图片编码格式为二进制后base64，文字编码格式为utf-8；
2) 彩信由多帧组成，同一帧中元素最多允许一段文字和一种媒体文件（即同一帧中只允许展现视频、图片、音频中的一种媒体文件），多个媒体文件请分别放置在多帧中；
3) 内容类型(con_type)支持：text(文本)、image(图片)、audio(音频)、video(视频)；
4) 文件扩展名(ext_type)支持：jpg、jpeg、png、gif、mp3、mp4。

内容格式json格式参考如下：

[[{"con_type":"text","ext_type":"txt","data":"这是测试文本内容1"},{"con_type":"image","ext_type":"jpg","data":"这是base64内容"}],[{"con_type":"text","ext_type":"txt","data":"这是测试文本内容2"},{"con_type":"video","ext_type":"mp4","data":"这是base64内容"}],[{"con_type":"image","ext_type":"jpg","data":"这是base64内容"},{"con_type":"text","ext_type":"txt","data":"这是测试文本内容3"}],[{"con_type":"audio","ext_type":"mp3","data":"test"},{"con_type":"text","ext_type":"txt","data":"这是base64内容"}]]

9.错误码查询