-
消息收发接口规范
(HTTP
方式
)
目
录
一
概述
<
/p>
.
............................
..................................................
..................................................
............
1
二
名词定义
.
...........................
..................................................
..................................................
.....
1
2.1
下行消息
.
..................................................
..................................................
.......................
1
2.2
上行消息
< br>.
...................................
..................................................
......................................
1
2.3
状态报告
.
..................................................
..................................................
.......................
1
三
HTTP
方法
.
.....................................
..................................................
..........................................
1
3.1
发
送接口
/
修改密码
/
< br>查询余额
/GET
[Submit/QxtSetOperPass/surplus]
...................................
1
3.1.1
接口协议
.
..................................
..................................................
.............................
1
3.1.2
接口命名
.
..................................................
..................................................
............
2
3.1.3
请求参数
.
..................................
..................................................
.............................
2
3.1.4
应答内容
.
..................................................
..................................................
............
3
3.1.5
使用范例
.
.................................
..................................................
.............................
3
3.2
发送接口
/POST
[Submit]
.
..................
..................................................
..............................
4
3.2.1
接口协议
.
..................................................
..................................................
............
4
3.2.3
请求参数
.
..................................
..................................................
.............................
5
3.1.4
应答内容
.
..................................................
..................................................
............
5
3.1.5
使用范例
.
..................................
..................................................
.............................
6
3.3
转发接口
[Deliver] ..............
..................................................
.............................................
7
3.3.1
接口协议
.
..................................................
..................................................
............
7
3.3.2
接口命名
.
.................................
..................................................
.............................
7
3.3.3
参数
.
....................................
..................................................
...................................
7
五
说明
.
..
..................................................
..................................................
......................................
8
- i -
一
概述
本接口规范定义了企信通短信平台(服务方)与客户系统(客
户方)之间的
数据传输协议及使用方法。通过这个接口规范可以实现客户系统
(
通过企信通
)
与
手机终端之间的消息传送。
二
名词定义
2.1
下行消息
< br>下行消息又称
MT
消息,
是指由
业务系统送到企信通短信平台
,
再转发到运营
< br>商的网关,并最终发送到手机终端上的文字信息。
2.2
上行消息
< br>上行消息又称
MO
消息,
是指由
手机终端发送至企信通短信平台并最终送到
客户系统的文字信息。
2.3
状态报告
状态报告是一条特殊上行消息,用于报告下行消息的投递情况。状态报告分
为
二种:
提交状态报告与接收状态报告。
并不是每一条下行消息都
会有对应的状
态报告。
提交状态报告:消息被提交到运营商消息网关后返回的消息。
接收状态报告:消息被送达到手机终端后返回的消息。
三
HTTP
方法
3.1
发送接口
/
修改密码
/
查询余额
/GET
[Submit/QxtSetOperPass/surplus]
3.1.1
接口协议
企信通短信平台的短信发送接口协议使用
HTTP
协议
,短信平台接口提供访
问的
URL
,用
户使用
HTTP
GET
方法发送请求
并得到应答内容
,
用户作为短信平台
的
HTTP
客户端,
短信平台作为用户的
HTTP
服务器。
提交时如果使用
p>
HTTP Get
方法,
- 1 -
则同步返回包中将包含
msgid
,
用户接到转发接口发来的
状态报告时,
可以根据这里的
msgid
对下行短信进行勾兑。
3.1.2
接口命名
功能
接口名
发送
QxtFirewall
消息
修
改
QxtSetOperPass
密码
查
询
surplus
余额
3.1.3
请求参数
注:该请求参数仅针对发送接口,修改密码和查询余额参数请以
3.15
的使用范例为准。
调用方式
http://221.1
79.180.158:9002/QxtSms/QxtFirewall
http
://221.179.180.158:9002/QxtSms/QxtSetOperPa
ss
http://221.179.180.158:9002/QxtS
ms/surplus
说明
部
p>
署
在
企
信通平台<
/p>
部
署
在
企
信通平台
部
p>
署
在
企
信通平台<
/p>
在向短信平台发起调用请求时,需要提供下表所列参数:
参数名称
OperID
OperPass
SendTime
ValidTime
AppendID
DesMobile
是否必须
(1
是
0
否
)
1
1
0
0
0
1
参数说明
业务标识
操作密码
发送时间
消息存活有效期
附加号码
接收手机号集合
取值说明
已开通的帐号名称
与帐号名称对应的密码
YYYYMM
DDHHMMSS
格式
,
为空表示立即
发送
YYYYMMDDHHMMSS
格式
见注
1
1.
发送单条消息时,此字段填写
11
位<
/p>
的手机号码。
2.
< br>群发消息时,
此字段为使用逗号分隔
的手机号码串。
p>
3.
每
批发<
/p>
送的
手机
号数
量
不
得超
过
200
个
最长
70 -
签名个字符
取值有
< br>15
和
8
。
15
:以普通短信形式下
发
,8<
/p>
:以长短信形式下发
,
默认为
:15
Content
ContentType
1
1
发送消息内容
消息类型
注
1
:例如用户在企信通短信平台的短信身份标识为
13
,若
附加号码
(AppendID)
为
0000
,
则接收号码
收到的短信显示为来自
spnumber+13+0000,
否
则不填附加短信标识,
则显示
为
spn
umber+13
。
并且:
spnum
ber+
企信通短信平台的短信身份标识
+
AppendID
的总长度
不能大于
20.
注
2
:
如果需要发送批量短信,
则将手机号码用
英文的逗号
分隔填写进
DesMobile
字段,
DesMobile
字段包含的最多手机号不能超过
200
个。如超过
则视为非法包丢弃。
注
3
:短信内容(
Content
< br>)发起请求前必须进行
URL
转码。例如对于短信内容为
“中文
短信
abc
”
< br>,
转码过程(
java
语言)如
下:
(
中文短信
< br>abc
结果为:
%D6%D0%
CE%C4%B6%CC%D0%C5abc
- 2 -
3.1.4
应答内容
同步应答返回串为
XML
串,
父节点名
response
response
节点名
code
message
参数说明
短信提交状态
短信单元
取值说明
参照(四
.
状态报告错误码)
帐户正常情况下,一个应答包中至少包
含一个
message
单元,否则只有
code
节点来表明帐户状态。
为用户提交的
11
位手机号码
短信
ID
(
20
位)
,由服务端生成,用户
勾兑状态报告时按照此
ID
勾兑。
message
message
desmobile
msgid
提交手机号
短信
id
3.1.5
使用范例
例:
1.
单条完整的
GET
方法请求
URL
为:
< br>
http://221.179.180.158:9002/QxtSms/
QxtFirewall?OperID=test&Oper
Pass=test&S
endTime=&ValidTime=&AppendID=1234&DesMobile=139000
00
000&Content=%D6%D0%CE%C4%B6%CC%D0%C5a
bc&ContentType=15
同步返回应答包如下:
03
其中
元
素表示用户提交到企信通平台的状态报告,具体见
4.1
2.
群发
完整的
GET
方法请求
URL
为:
http://221.179.180
.158:9002/QxtSms/QxtFirewall?OperID=test&Ope
rPass=test&SendTime=&ValidTime=&AppendID=1234
&DesMobile=139000
00000,,,&Content=%D6%D
0%CE%C4
%B6%CC%D0%C5abc&ContentType=15
p>
同步返回的应答包为:
01
- 3 -
-
-
-
-
-
-
-
-
-
上一篇:MIPS体系结构
下一篇:四年级上册科学大象版复习资料