1.创建模版

协议说明

Options:

Url: https://vip.veesing.com/mmsApi/create
Method: post
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

#	参数	类型	必填	描述	示例
1	appId	String	是	账户标识。平台分配给用户的接口调用账户标识，登录平台首页账号信息栏可查看。	2RYN7CQHL1M*****
2	appKey	String	是	账户密钥。平台分配给用户的接口调用密钥，登录平台首页账号信息栏，校验身份后可查看。	WVNA4A0*****
3	title	String	是	彩信标题(最大15个字符)	云讯106双十一大促
4	content	String	是	彩信内容 (内容格式请看下方说明)	5,jpg\|4AAR...gABAg;

彩信内容:

彩信支持图片、视频、音频和文字，图片编码格式为 base64 ，文字编码格式为 gbk编码后转base64
彩信最多支持 15帧，帧与帧之间用英文分号 ;分隔，彩信总大小不能超过 80Kb
彩信每帧需包含帧播放时间、文件类型、文件内容，文件内容可以为图片 jpg/gif、视频 mp4、音频mp3、文字用txt格式存储，编码格式为gbk
同一帧最多允许一段文字和一种媒体文件（即同一帧中只允许展现视频、图片、音频中的一种媒体文件），多个媒体文件请分别放置在多帧中
彩信完整数据报文格式：
播放时间,文件类型|文件内容,文件类型|文件内容;播放时间,文件类型|文件内容,文件类型|文件内容;
帧播放时间作为该帧报文前置字段，每帧可以包含多个文件，多个文件用(,)分隔，每个文件由格式和内容组成，格式和内容用(|)分隔。
彩信完整数据报文示例：
5,jpg|4AAQSkZJR...gABAgA,txt|云讯106双十一大促;3,gif|ExghIhcXG...RcXIiQdIB,txt|欢迎莅临采购
彩信标准展现样式示例：

接入示例

正常响应

异常响应

2.批量群发

协议说明

Options:

Url: https://vip.veesing.com/mmsApi/send
Method: post
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

#	参数名称	类型	是否必填	描述	示例值
1	appId	String	是	账户标识。平台分配给用户的接口调用账户标识，登录平台首页账号信息栏可查看。	2RYN7CQHL1M*****
2	appKey	String	是	账户密钥。平台分配给用户的接口调用密钥，登录平台首页账号信息栏，校验身份后可查看。	WVNA4A0*****
3	mmsId	String	是	彩信ID。创建彩信接口返回的ID或平台创建彩信生成的ID。	1000
4	phone	String	是	手机号码，多个手机号码用英文逗号 `,` 分隔。	156**1090,156**1091
5	sendTime	String	是	定时时间。留空则表示立即发送，时间格式为：`yyyy-MM-dd HH:mm:ss`	2018-08-21 14:00:00

请求示例

正常响应

异常响应

3.审核推送

触发条件

彩信提交到平台，平台审核后，将立即推送审核结果。每审核一批，则推送一次。

使用说明

审核结果由短信平台主动推送到用户设置的地址上，接收数据需遵循标准化数据格式定义。

协议说明

Options:

Url: 用户设置
Method: post
Content-Type: application/x-www-form-urlencoded;charset=utf-8

推送数据定义

#	参数名称	类型	是否必填	描述	示例值
1	taskId	String	是	发送批次ID	123
2	returnStatus	String	是	彩信审核结果：0 拒绝，1 通过	1
3	message	String	是	审核结论。审核拒绝时，将通过此字段告知客户端拒绝原因。	内容不合规

用户接收推送成功，无需返回任何信息,彩信平台根据http_status=200自动判断

4.回执推送

触发条件

运营商产生短信回执后，触发回执数据推送，每产生一条回执，则推送一条。

使用说明

回执数据，由短信平台主动推送到用户设置的地址上，数据格式需遵循标准化数据格式。

协议说明

Options:

Url: 用户设置
Method: post
Content-Type: application/x-www-form-urlencoded;charset=utf-8

推送数据定义

#	参数名称	类型	是否必填	描述	示例值
1	mobile	String	是	用户手机号码	1508092****
2	taskid	String	是	发送批次ID	123
3	status	String	是	回执状态 1.发送成功 0.发送失败	1
4	receivetime	String	是	回执产生时间 yyyy-MM-dd HH:mm:ss	2019-07-23 17:00:00

用户接收推送成功，无需返回任何信息,彩信平台根据http_status=200自动判断

5.余额查询

协议说明

Options:

Url: https://vip.veesing.com/mmsApi/getBalance
Method: get

请求参数

#	参数名称	类型	是否必填	描述	示例值
1	appId	String	是	账户标识。平台分配给用户的接口调用账户标识，登录平台首页账号信息栏可查看。	2RYN7CQHL1M*****
2	appKey	String	是	账户密钥。平台分配给用户的接口调用密钥，登录平台首页账号信息栏，校验身份后可查看。	WVNA4A0*****

请求示例

正常响应

异常响应

全局状态码

returnStatus	message
1	提交成功
0	账号或密码错误
0	缺少参数
0	您的账户已被锁定，请联系您的专属客服
0	未知原因，请联系客服
0	IP受限