迈远彩信接口
1. 概述
1.通讯协议是HTTP的(POST方式提交内容)。
2.请求应答过程中使用的中文编码格式为UTF-8。
3.应答为状态码,每个接口下定义具体的状态码
2. 接口定义
2.1. 彩信下发接口
2.1.1. 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://xxxxx:8888/sendmms.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
2.1.2. 参数说明
参数名称 | 含义 |
action | 该参数填写send |
userid | 用户ID 有管理分配账号的时候生成 |
account | 账号 |
password | 密码 |
mobile | 下发信息的手机号码,可以是多个手机号,手机号之间用逗号分隔 |
title | 彩信标题 |
starttime | 定时发送时间 如2011-07-11 00:00:00 若不想填写表示立即发送 |
content | 彩信中包含的文字信息需要使用gb2312编码格式后再转换base64 内容资源,资源内容包含的帧顺序按照由先至后的顺序,比如1帧=>n帧 帧与帧之间用半角分号(;)分隔。 每个资源内部包含多个类型信息,分别是:播放时间,类型 | 内容(按字节码base64编码), 类型 | 内容(按字节码base64编码),每一帧资源类型和内容之间以 | 隔开,每一个帧可以有多个资源类型和内容,同一帧之间用半角逗号(,)分隔。 |
完整彩信下行中POSTDATA例子:
action=send&userid=12&account=zhouyang&password=123456&mobile=138********,135********&title=adadadaadad&starttime=&content=3,txt|zsSxvg==,jpg|4AAQSkZJRgABAgAAZABk; 3,gif|ExghIhcXGRcXIiQdIB8fIB0kJCssLywrJDk5Pj45OUFBQ
说明:
1:目前的资源类型只支持:文本(txt),GIF图片(gif),JPG图片(jpg)
2:彩信标题(title)加上base64解码后彩信内容(content)总长度不能超过100K
3:文字内容使用gb2312编码
2.1.3. 返回值
状态码:
状态,消息唯一编号:处理成功后,返回的余额和这个消息的唯一标识。
余额:任务ID
(例子:100:27349872349823)
失败后只返回错误码
0 表示 参数不对
1 表示用户名或密码不能为空
2 表示用户名或密码错误
3 表示号码为空
4 表示内容为空
5 表示单次提交号码不能超过2000个
6 表示余额不足
7 表示提交任务失败
8 表示其他错误
9 表示彩信文件大于100K
10 表示该用户不支持彩信
2.2. 余额查询接口
2.2.1. 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://xxxxx:8888/sendmms.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
2.2.2. 参数说明
参数名称 | 含义 | 说明 |
userid | 企业id | 企业ID |
account | 用户帐号 | 用户帐号,由系统管理员 |
password | 帐号密码 | 用户账号对应的密码 |
action | 任务名称 | 设置为固定的:overage |
例如:
action=overage&userid=12&account=账号&password=密码
2.2.3. 返回值
<?xml version="1.0" encoding="utf-8" ?> <returnsms> <returnstatus>status</returnstatus>-------返回状态值:成功返回Success 失败返回:Faild <message>message</message>--------------返回信息提示:见下表 <payinfo>payinfo</payinfo>--------------返回支付方式 后付费,预付费 <overage>overage</overage>-------------返回余额 <sendTotal>sendTotal</sendTotal>----返回总点数 当支付方式为预付费是返回总充值点数 </returnsms>
返回信息提示 | 说明 |
返回空 | 查询成功 将返回相应的支付方式、账户使用条数、总充值点数 |
用户名或密码不能为空 | 提交的用户名或密码为空 |
用户名或密码错误 | 表示用户名或密码错误 |
2.3. 状态报告接口
2.3.1. 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://xxxxx:8888/mmsStatusApi.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
注意:相同的状态报告,只能获取一次。
2.3.2. 参数说明
参数名称 | 含义 | 说明 |
userid | 企业id | 企业ID |
account | 用户帐号 | 用户帐号,由系统管理员 |
password | 帐号密码 | 用户账号对应的密码 |
statusNum | 每次取得号码数 | 必须为数字,默认4000,可不填,最大不可超过10000 |
action | 任务名称 | 设置为固定的:query |
例如:
action=query&userid=12&account=账号&password=密码
2.3.3. 返回值
<?xml version="1.0" encoding="utf-8" ?> <returnsms> <statusbox> <mobile>15023239810</mobile>-------------对应的手机号码 <taskid>1212</taskid>-------------同一批任务ID <status>10</status>---------状态报告----10:发送成功,20:发送失败 <receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间 <errorcode>DELIVRD</errorcode>-上级网关返回值,不同网关返回值不同,仅作为参考 <extno></extno> </statusbox> <statusbox> <mobile>15023239811</mobile> <taskid>1212</taskid> <status>20</status> <receivetime>2011-12-02 22:12:11</receivetime> <errorcode>2</errorcode> <extno></extno> </statusbox> </returnsms>
2.3.4. 错误返回值——状态报告请求错误返回格式及对应值
<?xml version="1.0" encoding="utf-8" ?> <returnsms> <errorstatus> <error>1</error>-------------错误码 <remark>用户名或密码不能为空</remark>-------------错误描述 </errorstatus> </returnsms>
1:用户名或密码不能为空
2:用户名或密码错误
3:该用户不允许查看状态报告
4:参数不正确
附迈远彩信接口下载:
留言评论
暂无留言