SMS SMPP
2022-04-07
https://en.wikipedia.org/wiki/Short_Message_Peer-to-Peer
https://smpp.org/
Short Message Peer-to-Peer (SMPP) 是一种开放的短信协议。虽然名字中带有 P2P 的字样,但 SMPP 实际上是一种 C/S 协议。
移动 CMPP 协议,联通 SGIP 协议,电信 SMGP 协议,据说他们之间交换信息都是走 SMPP 协议。
常用版本:
根据维基百科的资料,SMPP 之前由 SMS 论坛开发,但是 2007 年,SMS 论坛已经解散了。
数据格式
数据包(PDU (protocol data units, or packets))格式:
header
(必需)
command_length
4B
command_id
4B
command_status
4B
sequence_number
4B
body
(可选)
'command_length', (60) ... 00 00 00 3C
'command_id', (4) ... 00 00 00 04
'command_status', (0) ... 00 00 00 00
'sequence_number', (5) ... 00 00 00 05
'service_type', () ... 00
'source_addr_ton', (2) ... 02
'source_addr_npi', (8) ... 08
'source_addr', (555) ... 35 35 35 00
'dest_addr_ton', (1) ... 01
'dest_addr_npi', (1) ... 01
'dest_addr', (555555555) ... 35 35 35 35 35 35 35 35 35 00
'esm_class', (0) ... 00
'protocol_id', (0) ... 00
'priority_flag', (0) ... 00
'schedule_delivery_time', (0) ... 00
'validity_period', (0) ... 00
'registered_delivery', (0) ... 00
'replace_if_present_flag', (0) ... 00
'data_coding', (3) ... 03
'sm_default_msg_id', (0) ... 00
'sm_length', (15) ... 0F
'short_message', (Hello Wikipedia) ... 48 65 6C 6C 6F 20 57 69 6B 69 70 65 64 69 61
名词
- SMSC:short message service center,服务器端
或者叫 Messaging Center,简写作 MC
- ESME:extended short message entity,客户端
命令
Command ID |
Value |
generic_nack |
0x80000000 |
bind_receiver |
0x00000001 |
bind_receiver_resp |
0x80000001 |
bind_transmitter |
0x00000002 |
bind_transmitter_resp |
0x80000002 |
query_sm |
0x00000003 |
query_sm_resp |
0x80000003 |
submit_sm |
0x00000004 |
submit_sm_resp |
0x80000004 |
deliver_sm |
0x00000005 |
deliver_sm_resp |
0x80000005 |
unbind |
0x00000006 |
unbind_resp |
0x80000006 |
replace_sm |
0x00000007 |
replace_sm_resp |
0x80000007 |
cancel_sm |
0x00000008 |
cancel_sm_resp |
0x80000008 |
bind_transceiver |
0x00000009 |
bind_transceiver_resp |
0x80000009 |
Reserved |
0x0000000A / 0x8000000A |
outbind |
0x0000000B |
Reserved |
0x0000000C - 0x00000014 / 0x8000000B - 0x80000014 |
enquire_link |
0x00000015 |
enquire_link_resp |
0x80000015 |
Reserved |
0x00000016 - 0x00000020 / 0x80000016 - 0x80000020 |
submit_multi |
0x00000021 |
submit_multi_resp |
0x80000021 |
Reserved |
0x00000022 - 0x000000FF / 0x80000022 - 0x800000FF |
Reserved |
0x00000100 |
Reserved |
0x80000100 |
Reserved |
0x00000101 / 0x80000101 |
alert_notification |
0x00000102 |
Reserved |
0x80000102 |
data_sm |
0x00000103 |
data_sm_resp |
0x80000103 |
Reserved for SMPP extension |
0x00000104 - 0x0000FFFF / 0x80000104 - 0x8000FFFF |
Reserved |
0x00010000 - 0x000101FF / 0x80010000 - 0x800101FF |
Reserved for SMSC Vendor |
0x00010200 - 0x000102FF / 0x80010200 - 0x800102FF |
Reserved |
0x00010300 - 0xFFFFFFFF |
总结:
RequestCommandID |
ComandValue |
十进制 |
说明 |
bind_receiver |
0x00000001 |
1 |
建立接收会话(接收上行) |
bind_transmitter |
0x00000002 |
2 |
建立发送会话(提交下行) |
query_sm |
0x00000003 |
3 |
查询 |
submit_sm |
0x00000004 |
4 |
提交 |
deliver_sm |
0x00000005 |
5 |
下发(状态报告或上行) |
unbind |
0x00000006 |
6 |
中断连接 |
replace_sm |
0x00000007 |
7 |
替换已提交消息 |
cancel_sm |
0x00000008 |
8 |
取消 |
bind_transceiver |
0x00000009 |
9 |
建立会话(发送 + 接收) |
outbind |
0x0000000B |
11 |
通知客户端建立连接(bind_receiver ) |
enquire_link |
0x00000015 |
21 |
心跳 |
submit_multi |
0x00000021 |
33 |
批量提交(多个收件人) |
alert_notification |
0x00000102 |
258 |
- |
data_sm |
0x00000103 |
259 |
submit/deliver 的替代方案 |
- 响应:对应请求 +
0x80000000
outbind
,alert_notification
没有对应响应
- 此外,还有
generic_nack
是通用拒绝响应(0x80000000
)
- outbind 的场景是服务器端需要推送信息或状态给客户端
SMS 网络编程 CMPP
2022-03-29
术语
- ISMG: Internet Short Message Gateway
- SMPP: Short Message Peer to Peer
一个国际上比较通用的短信网关协议
CMPP 可能兼容 SMPP,因为 Wireshark 会将 CMPP 会话识别成 SMPP
- CMPP: China Mobile Peer to Peer
中国移动开发的的短信网关协议
- SMC: Short Message Center
- GNS: Gateway Name Server
相当于 CMPP 网络的路由器
- SP: Service Provider
- SMC: Short Message Control
- ISMG_Id: 网关代码
- SP_Id: SP 企业代码
- SP_Code: SP 服务代码
- Service_Id: SP 业务类型
- MO: 手机发送 Originate
- MT: 手机接收 Terminated
网络连接
CMPP 基于 TCP 协议。可以长连接,也可以短连接。
长连接支持一次连接发送多次 CMPP 消息,没有消息的时候需要维持心跳。
短连接则是一次 CMPP 通信之后就断开连接。
关于心跳:
建议每 3 分钟一次心跳,如果 60 秒内没有心跳响应,应该再次心跳,总共 3 次没有响应就断开连接。
关于重试(网关与 SP 之间,网关之间):
60 秒之后没有响应,立即重试,总共 3 次没有响应就停发。
消息采用并发方式发送,加以滑动窗口流量控制,窗口大小参数 W 可配置,现阶段建议为 16,即接收方在应答前一次收到的消息最多不超过 16 条。
关于短连接:
60 秒超时,重试 2 次。
端口
- 7890 长连接(SP 与网关之间)
- 7900 短连接(SP 与网关之间,网关之间)
- 7930 长连接(网关之间)
- 9168 短连接(网关与 GNS 之间)
数据类型
var Total_Length uint32 // 消息总长度
var Command_Id uint32 // 命令或响应类型
var Sequence_Id uint32 // 消息流水号, 递增, 步长为 1, 循环使用
命令 |
Command_Id |
CMPP_CONNECT |
0x00000001 |
CMPP_TERMINATE |
0x00000002 |
CMPP_SUBMIT |
0x00000004 |
CMPP_DELIVER |
0x00000005 |
CMPP_QUERY |
0x00000006 |
CMPP_CANCEL |
0x00000007 |
CMPP_ACTIVE_TEST |
0x00000008 |
CMPP_FWD |
0x00000009 |
CMPP_MT_ROUTE |
0x00000010 |
CMPP_MO_ROUTE |
0x00000011 |
CMPP_GET_ROUTE |
0x00000012 |
CMPP_MT_ROUTE_UPDATE |
0x00000013 |
CMPP_MO_ROUTE_UPDATE |
0x00000014 |
CMPP_PUSH_MT_ROUTE_UPDATE |
0x00000015 |
CMPP_PUSH_MO_ROUTE_UPDATE |
0x00000016 |
RESP Command_Id 则是对应的 Command_Id 最高 4 位为 8,即 0x8X
。
SP 与 ISMG 之间的通信
对于一般开发来说就这 7 个接口。
- 建立连接 CMPP_CONNECT
- 断开连接 CMPP_TERMINATE
- 提交信息 CMPP_SUBMIT
- 获取状态 CMPP_DELIVER
- 撤回信息 CMPP_CANCEL
- 查询信息 CMPP_QUERY
只是一些统计信息,我想不到这个接口的应用场景
- 链路检测 CMPP_ACTIVE_TEST
连接 CMPP_CONNECT
var Source_Addr [6]byte // SP_Id
var AuthenticatorSource [16]byte // SP_Code
// md5(Source_Addr + 9 字节 0 + shared secret + timestamp)
// timestamp: MMDDHHMMSS, 月日时分秒, 补 0
var Version uint8 // 版本号, 高 4 位表示主版本号, 低 4 位表示次版本号, 最大 15.15
var Timestamp uint32 // 时间戳, 默认为 0
CMPP_CONNECT_RESP
var Status uint8 // 状态, 0 正确, 1 结构错误, 2 非法源地址, 3 认证错误, 4 版本错误, 5 其他错误
var AuthenticatorISMG [16]byte // ISMG 认证码
// md5(Status + AuthenticatorSource + shared secret)
// 如果认证错误, 此项为空
var Version uint8 // 服务器支持的最大版本号
断开连接 CMPP_TERMINATE
无请求消息体,无响应消息体
提交信息 CMPP_SUBMIT
var Msg_Id uint64 // 消息标识, 网关负责自主生成,SP 留空
var Pk_total uint8 // 消息总条数, 从 1 开始
var Pk_number uint8 // 消息序号, 从 1 开始
var Registered_Delivery uint8 // 是否要求返回状态确认报告, 0 不需要, 1 需要, 2 产生 SMC 话单 (该类型短信仅供网关计费使用,不发送给目的终端)
var Msg_level uint8 // 信息级别, 0 低, 1 中, 2 高
var Service_Id [10]byte // 业务类型
var Fee_UserType uint8 // 计费用户类型, 0 普通用户, 1 行业用户, 2 用户组
var Fee_terminal_Id [32]byte // 被计费用户的号码
var TP_pid uint8 // GSM协议类型, 0 GSM 03.40, 1 CDMA, 2 WCDMA, 3 CDMA2000, 4 联通移动TD专用协议
var TP_udhi uint8 // GSM协议类型
var Msg_Fmt uint8 // 信息格式, 0 ASCII 串, 3 短信写卡操作, 4 二进制, 8 UCS2 编码, 15 含 GB 汉字
var Msg_src [6]byte // 消息发送者, SP_Id
var FeeType [2]byte // 资费类别
var FeeCode [6]byte // 资费代码, 以分为单位
var ValId_Time [17]byte // 存活有效期,格式遵循 SMPP3.3 协议
var At_Time [17]byte // 定时发送时间, YYMMDDhhmmsstnnp, t 是 1/10 秒,nn 是与 UTS 时间的差值 00-48,p `+/-`
var Src_Id [21]byte // 源号码
// SP 的服务代码或前缀为服务代码的长号码,
// 网关将该号码完整的填到 SMPP 协议 Submit_SM 消息相应的 source_addr 字段
// 该号码最终在用户手机上显示为短消息的主叫号码
var DestUsr_tl uint8 // 接收信息的用户数量, 小于 100
var Dest_terminal_Id [][21]byte // 接收短信的用户号码 (MSISDN), 21 * DestUsr_tl
var Msg_Length uint8 // 短消息长度
var Msg_Content []byte // 短消息内容
var Reserve [8]byte // 保留
注意:关于短信群发的问题,若 SP 对于群发消息不要求状态报告的回送时,才可以考虑群发,否则必须逐条发送。
关于 TP_udhi 的解释:
如果 = 1,则需要在 Msg_Content 中加入一个 udhi 头,定义如下:
- 六字节
05 00 03 开头,分别表示剩余 5 字节,xxx,剩余标识长度为 3
第四字节,唯一标识
第五字节,短信条数
第六字节,序号
- 七字节
06 08 04 开头,分别表示剩余 6 字节,xxx,剩余标识长度为 4
第四五字节,唯一标识
第六字节,短信条数
第七字节,序号
CMPP_SUBMIT_RESP
var Msg_Id uint64 // 消息表示, SP 自主生成
var Result uint8 // 结果, 0 正确, 1 消息结构错, 2 命令字错, 3 消息序号重复, 4 消息长度错,
// 5 资费代码错, 6 超过最大信息长, 7 业务代码错, 8 流量控制错, 9~ 其他错误
- MMDDHHMMSS,26 位
月份 4 位, 1-12
日期 5 位, 1-31
小时 5 位, 0-23
分钟 6 位, 0-59
秒钟 6 位, 0-59
- 网关代码,22 位
- 序列号,16 位,递增, 步长为 1, 循环使用
查询 CMPP_QUERY
var Time [8]byte // YYYYMMDD
var Query_Type uint8 // 查询类型, 0 总数查询, 1 按业务类型查询
var Query_Code [10]byte // 查询码, 查询类型为 0 时无效, 查询类型为 1 时此处为业务类型
var Reserve [8]byte // 保留
CMPP_QUERY_RESP
var Time [8]byte
var Query_Type uint8
var Query_Code [10]byte
var MT_TLMsg uint32 // 接收消息总数
var MT_TLusr uint32 // 接收用户总数
var MT_Scs uint32 // 转发成功总数
var MT_WT uint32 // 待转发总数
var MT_FL uint32 // 转发失败总数
var MO_Scs uint32 // 发送成功总数
var MO_WT uint32 // 待发送总数
var MO_FL uint32 // 发送失败总数
送交短信 CMPP_DELIVER
从网关发送出来的消息
var Msg_Id uint64
var Dest_Id [21]byte // 目的号码
var Service_Id [10]byte
var TP_pid uint8
var TP_udhi uint8
var Msg_Fmt uint8
var Src_terminal_Id [21]byte // 源号码
var Registered_Delivery uint8
var Msg_Length uint8
var Msg_Content []byte // Msg_Length
var Reserved [8]byte
var Msg_Id uint64
var Stat [7]byte
// DELIVRD 送达
// EXPIRED 过期
// DELETED 删除
// UNDELIV 未送达
// ACCEPTD 接收
// UNKNOWN 非法
// REJECTD 拒绝
var Submit_time [10]byte
var Done_time [10]byte
var Dest_terminal_Id [21]byte
var SMSC_sequence uint32
SP 等待状态报告 48 小时。
CMPP_DELIVER_RESP
var Msg_Id uint64
var Result uint8
删除短信 CMPP_CANCEL
var Msg_Id uint64
CMPP_CANCEL_RESP
var Success_Id uint8 // 0 成功, 1 失败
链路检测 CMPP_ACTIVE_TEST
无消息体。
CMPP_ACTIVE_TEST_RESP
var Reserved [8]byte