当前位置:文档之家› 短信网关socket数据接口通讯协议(V0.1)

短信网关socket数据接口通讯协议(V0.1)

短信网关数据接口通讯协议(V0.1)

1定义

1.1 协议

短信客户端与服务器端通过接口方式传输数据,传输协议为TCP短连接,每次由客户端发起请求,服务器端接收完请求并处理后,返回响应数据,并主动关闭socket连接。

服务器端接口程序采用java开发,客户端由客户自行选择熟悉的方式。

1.2 大小写说明

如无特殊说明,则表示是大小写敏感的。A和a代表不同的含义。

1.3 编码

编码统一采用UTF-8。

2数据类型

2.1 基本数据类型

2.2 消息结构

2.2.1请求消息结构(MessageRequest):

2.2.2响应消息结构(MessageResponse):

3业务接口

3.1 短信发送接口

3.1.1接口说明

网关平台此时作为socket server。

商户系统向SP请求发送短信。用户可以一次发送多条数据。

Msgtype的类型区别:

1、通知短信。网关发送失败后,通知短信会重新尝试发送。发送失败次数超过3

次后,停止发送操作。

2、验证码短信。网关发送失败后,不会重新进行发送。

3.1.2request_body(command_id:A001)

{

[

phone

message

sendtime

msgid

msgtype

]

3.1.3response_body(command_id:B001)

{

status

3.2 短信回执推送接口

3.2.1接口说明

网关平台发送短信成功后,获取运营返回的回执信息,主动将回执信息推送到商户系统。网关平台此时作为socketserver。

超过60秒后,server没有收到response_body,系统将会重新发送回执信息。发送三次后,系统认为信息发送完成,不在进行发送。

3.2.2request_body(command_id:A002)

{

[

msgid

phone

status

sendtime

stat

]

3.2.3response_body(command_id:B002):

3.3 短信状态报告推送接口

3.3.1接口说明

网关平台发送短信成功后,获取运营返回的短信状态报告信息,主动将信状态报告信息推送到商户系统。网关平台此时作为socketserver。

超过60秒后,server没有收到response_body,系统将会重新发送回执信息。发送三次后,系统认为信息发送完成,不在进行发送。

3.3.2request_body(command_id:A003)

{

[

msgid

phone

status

stat

receivetime

submittime

donetime

]

}

3.3.3response_body(command_id:B003):

3.4 短信回执接口

3.4.1接口说明

商户系统主动请求SP系统接口,获取Sp在发送短信成功后,网关的回执信息。网关平台此时作为socket client。

3.4.2request_body(command_id:A004)

{

msgid:

}

3.4.3response_body(command_id:B004):

{

status:

data:{

[

msgid

phone

status

sendtime

stat

]}

3.5 状态报告回执接口

3.5.1接口说明

商户系统主动请求sp系统接口,获取网关返回的状态报告。网关平台此时作为socket client。

3.5.2request_body(command_id:A005)

{

msgid:

3.5.3response_body(command_id:B005)

{status:

data:

{

[

msgid

phone

status

stat

receivetime

submittime

donetime

]

}

}

3.6 上行短信接口

3.6.1接口说明:

网关平台此时作为socket client,将系统接收到的上行短信定时发送给商户系统,功商户系统处理业务

3.6.2request_body(command_id:A006)

[

receiveid

phone

msg

sendtime

destid

]

3.6.3response_body(command_id:B006)

3.7 上行短信查询接口

3.7.1接口说明:

商户系统主动请求SP系统接口,获取上行短信。网关平台此时作为socket client。

3.7.2request_body(command_id:A007)

{

nextId

}

3.7.3response_body(command_id:B007)

{

status:

nextId:

data:

相关主题