第一章 视频彩信报备接口
1.1 请求地址
请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是
http://112.74.36.247/mms.aspx 对应UTF-8
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
1.2参数说明
参数名称 | 含义 | 说明 |
account | 发送用户帐号 | 用户帐号,由系统管理员 |
password | 发送帐号密码 | 用户密码,由系统管理员 |
subject | 主题 | 彩信的主题 |
content | 发送内容 | 彩信内容,tms文件的base64编码。 元素1名称(即元素1的文件名,包括文件名扩展名)+一个字符串结束符(ASCII为0)+元素1的二进制内容大小(整形)+元素1的二进制内容+元素2名称(即元素2的文件名,包括文件名扩展名)+一个字符串结束符(ASCII为0)+元素2的二进制内容大小(整形)+元素2的二进制内容+元素3名称(即元素3的文件名,包括文件名扩展名)+一个字符串结束符(ASCII为0)+元素3的二进制内容大小(整形)+元素3的二进制内容+。。。。。。。所有元素以此类推 |
action | 发送任务命令 | 设置为固定的:save |
例如:
http://112.74.36.247/sms.aspx?action=save&mmstype=&userid=&account=账号&password=密码&content=内容&sendTime=
1.3返回值
在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus> ---------- 返回状态值:成功返回Success 失败返回:Faild
<message>message</message> ---------- 相关的错误描述
<mmsid>657789</mmsid> ----------- 返回彩信ID
</returnsms>
第二章 视频彩信发送接口
2.1 请求地址
请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是
http://112.74.36.247/mms.aspx 对应UTF-8
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
2.2参数说明
参数名称 | 含义 | 说明 |
account | 发送用户帐号 | 用户帐号,由系统管理员 |
password | 发送帐号密码 | 用户密码,由系统管理员 |
mobile | 全部被叫号码 | 发信发送的目的号码.多个号码之间用半角逗号隔开 |
mmsid | 彩信ID | 彩信资源报备成功后返回来的彩信ID |
sendTime | 定时发送时间 | 为空表示立即发送,定时发送格式2010-10-24 09:08:10 |
action | 发送任务命令 | 设置为固定的:mmsidsend |
extno | 扩展子号 | 请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多5位数。 |
例如:
http://112.74.36.247/mms.aspx?action=send&account=账号&password=密码&mobile=15023239810,13527576163&mmsid=88769&sendTime=&extno=
2.3返回值
在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus> ---------- 返回状态值:成功返回Success 失败返回:Faild
<message>message</message> ---------- 相关的错误描述
<taskID>taskID</taskID> ----------- 返回本次任务的序列ID
</returnsms>
第三章 视频彩信报备状态查询接口
3.1 请求地址
请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是
http://112.74.36.247/mms.aspx 对应UTF-8
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
3.2参数说明
参数名称 | 含义 | 说明 |
account | 用户帐号 | 用户帐号,由系统管理员 |
password | 帐号密码 | 用户密码,由系统管理员 |
mmsid | 彩信ID | 彩信资源报备成功后返回来的彩信ID |
action | 任务名称 | 设置为固定的:savereport |
例如:
action=savereport&account=账号&password=密码&mmsid=99887
3.3返回值
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>T</returnstatus>-------返回状态值:审核通过:T 审核失败:F 待审核:R
<message>message</message>--------------状态描述:见下表
</returnsms>
返回信息提示 | 说明 |
审核通过 | 表示审核通过 |
审核失败 | 表示审核失败 |
待审核 | 表示等待审核 |
第四章 视频彩信发送状态查询接口
4.1 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://112.74.36.247/statusApi.aspx(返回值为xml格式)
http://112.74.36.247/statusJsonApi.aspx(返回值为json格式)
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
4.2参数说明
参数名称 | 含义 | 说明 |
account | 用户帐号 | 用户帐号,由系统管理员 |
password | 帐号密码 | 用md5加密方式,md5彩用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03
|
statusNum | 每次取得号码数 | 必须为数字,默认4000,可不填 |
action | 任务名称 | 设置为固定的:query |
taskid | 批次编号 | 可选项,如果传此参数,则只查询该批次的状态。 |
例如:
action=query&account=账号&password=密码& taskid =1523516
4.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>01</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>
4.4错误返回值——状态报告请求错误返回格式及对应值
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<errorstatus>
<error>1</error>-------------错误码
<remark>用户名或密码不能为空</remark>-------------错误描述
</errorstatus>
</returnsms>
1:用户名或密码不能为空
2:用户名或密码错误
3:该用户不允许查看状态报告
4:参数不正确
4.5Json返回值
错误时:{"error":"1005","remark":"密码错了","statusbox":[]}
正确时:{"error":"1",
"remark":"成功",
"statusbox":[
{"mobile":"15510331875",
"taskid":"123",
"receivetime":"2015-01-01 00:00:00",
"errorcode":"dEv"
},{
"mobile":"13483728958",
"taskid":"124",
"receivetime":"2015-02-01 00:00:00",
"errorcode":"back"}
]
}
第五章 视频彩信报备推送状态
5.1 绑定推送地址
客户需要提供一个可以在公网访问的http接口地址,由管理员配置到账户中。
在返回状态或上行时,系统会调用该地址,将状态或上行以xml形式,推送给客户方,客户应该获取整个post内容(而并非某个参数值),来取得xml内容。
c#取得xml内容示例:
StreamReader reader = new StreamReader(Request.InputStream, Encoding.UTF8);
String xmlContent = reader.ReadToEnd();
java取得xml内容示例:
DocumentBuilderFactory buildFactory=DocumentBuilderFactory.newInstance();
DocumentBuilder build=buildFactory.newDocumentBuilder();
Document document=build.parse(request.getInputStream());
5.2状态报告请求参数值
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<statusbox>
<status>T</status>---------状态报告----T:审核成功,F:审核失败,R:等待审核
<msg>审核成功</msg>-------------状态值描述
<mmsid>887690</mmsid>-------------彩信ID
</statusbox>
</returnsms>
5.3推送返回说明
如果客户成功接收状态或上行,请返回”1”字符串。
如果客户处理失败,请返回“error”字符串,系统将会尝试再次推送。最多尝试3次。
如果客户未返回值或返回其它值,当作成功处理。
如果调用时出现网络异常,则当作失败,继续重试。
第六章 视频彩信发送状态推送接口
6.1绑定推送地址
客户需要提供一个可以在公网访问的http接口地址,由管理员配置到账户中。
在返回状态或上行时,系统会调用该地址,将状态或上行以xml形式,推送给客户方,客户应该获取整个post内容(而并非某个参数值),来取得xml内容。
c#取得xml内容示例:
StreamReader reader = new StreamReader(Request.InputStream, Encoding.UTF8);
String xmlContent = reader.ReadToEnd();
java取得xml内容示例:
DocumentBuilderFactory buildFactory=DocumentBuilderFactory.newInstance();
DocumentBuilder build=buildFactory.newDocumentBuilder();
Document document=build.parse(request.getInputStream());
php取得xml内容示例:
$raw_post_data = file_get_contents('php://input', 'r');
$doc = new DOMDocument();
$doc->loadXML($raw_post_data);
6.2状态报告请求参数值
<?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>01</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>
状态报告json请求参数值
{
"statusbox":[
{"mobile":"15510331875",
"taskid":"123",
"receivetime":"2019-09-01 00:00:00",
"errorcode":"dEv"
},{
"mobile":"13483728958",
"taskid":"124",
"receivetime":"2019-09-01 00:00:00",
"errorcode":"back"}
]
}
6.3推送返回说明
如果客户成功接收状态或上行,请返回”1”字符串。
如果客户处理失败,请返回“error”字符串,系统将会尝试再次推送。最多尝试3次。
如果客户未返回值或返回其它值,当作成功处理。
如果调用时出现网络异常,则当作失败,继续重试。
ResultCode定义
错误代码 | 定义 | 说明 |
1 | OK | 操作成功 |
1001 | ParamError | 参数错误 |
1002 | UserNameEmpty | 用户名为空 |
1003 | PasswordEmpty | 密码为空 |
1004 | UserNameError | 用户名错误 |
1005 | PasswordError | 密码错误 |
1006 | BindIpError | IP绑定错误 |
1007 | UserStop | 帐户已停用 |
1008
| UserIdError
| UserId参数错误,该值必需要是数字,由供应商提供。 |
1009
| Text64Error
| Text64参数错误, 错误的可能有: 不是有效的base64编码, Des解密失败, 解析json时出错。 |
1010
| StampError
| 时间戳错误,可能是格式不对,或是时间偏差太大(应该在5分钟以内)。 |
2001 | ContentEmpty | 内容为空 |
1103 | MsisdnEmpty | 手机号码为空 |
1104 | ExtNumberError | 扩展错误 |
2105 | ContentLong | 内容太长 |
1106 | NoChannel | 没有发送通道 |
2107 | SensitiveWords | 敏感词汇 |
1108 | MsisdnError | 错误的手机号码 |
1109 | MsisdnBlack | 黑名单的手机号码 |
1110 | MsisdnNoChannel | 没有通道的手机号码 |
1111 | AmountNotEnough | 额度不足 |
1112 | NoProduct | 没有配置产品 |
1114 | ExtNumberError | 扩展错误 |
1115 | BalanceNotEnough | 余额不足 |
1116 | ChannelTypeError | 通道类型错误 |
1117 | TemplateError | 报备模板为空 |
1118 | FrequentOperation | 操作频繁 |
1119 | NoEnabled | 功能未启用 |
1120 | TemplateIdError | 模板id错误 |
2113 | RequiredSuffix | 需要签名 |
2114 | SuffixError | 签名错误 |
3001 | SubjectEmpty | 主题为空 |
9999 | InternalError | 系统内部错误 |