客服热线 10000 Page 1 of 11 广东电信短信接入 API使用手册（JAVA接口）中国电信股份有限公司 广东互联网及增值业务运营中心 2009 年 10 月名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页，共 11 页 - - - - - - - - - 客服热线 10000 Page 2 of 11 目 录 一、引言.31.1 编写目的.31.2 背景说明.31.3 术语定义.3二、概述.42.1 接口功能.42.2 接口组成.4三、接口介绍.53.1 网络结构.53.2 运行环境.63.3 连接方式 .63.4 开发接口函数使用.63.4.1 接口函数说明.63.4.2 接口函数调用流程图.63.4.3 SmsClient类 .73.4.3.1 Login .73.4.3.2 SendSms .83.4.3.3 SendLongSms .83.4.3.4 RecvSms .93.4.3.5 RecvSmsReport .93.4.3.6 Disconnect .10四、部分 SMGP 常见错误代码及短信状态.104.1 常见错误代码含义，其它的请参考SMGP 标准协议 .104.2 常见短信状态定义，其它的请参考SMGP 标准协议 .11名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页，共 11 页 - - - - - - - - - 客服热线 10000 Page 3 of 11 一、引言 1.1 编写目的 广东电信提供了强大的短信接入机制。 本手册用于指导客户利用广东电信提供的短信接口进行其他需要短信功能的新系统开发或原有系统的短信功能扩展。 本手册的阅读对象为需要采用广东电信短信接入 API完成客户开发的设计人员与编码人员。 1.2 背景说明 本手册适用于广东电信SMGP协议（V3.0.2）短信网关接入。 1.3 术语定义 广东电信 SMGP 协议 全称“广东电信短消息网关协议SMGP”，本文特指其V3.0.2 版本，集团客户需接入广东电信短信网关时，必须使用此协议进行程序开发， 本文中简称“SMGP”或 “SMGP协议”。 MT短信 通过短信接口发往手机终端的短信。 MO 短信 从手机终端发往短信接口接收队列的短信。 短信回执 有时也称“状态报告”，对于MT 短信，手机终端收到后会返回短信回执给短信接口。回执包含MT 短信是否成功提交到特定手机终端的信息。 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页，共 11 页 - - - - - - - - - 客服热线 10000 Page 4 of 11 二、概述 2.1 接口功能 广东电信短信接入API是根据广东电信SMGP协议开发的，封装后的用户开发接口。接口可降低用户接入开发的难度，提升接入效率。 接口主要功能包括： 支持 MT 短信的发送。 支持 MO 短信的接收。 支持短信回执的接收。 2.2 接口组成 广东电信短信接入API包括如下部分： 组成部分 功能说明 各种语言包 用于各种语言的 API调用， 支持目前主流的语言， 如： C+，DotNet，Java ，ASP，VB，PowerBuilder，Delphi等。 数据库接口 用于其他系统直接通过访问数据库来进行短信的收发。 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页，共 11 页 - - - - - - - - - 客服热线 10000三、接口介绍 3.1 网络结构 网络结构说明： 1、行业短信网关接入模块：提供到各地短信中心的接入功能，同时与全国行业应用平台实现互连； 2、行业短信平台业务处理模块：主要完成短信上行和下行的业务处理，短信下发，无论是单发，还是群发，无论是单个用户，还是多个用户，都采用下发任务机制实现。 3、行业短信网关置于电信机房，集团客户端可通过互联网或专线与其连接。4、集团客户端的各类信息系统是通过向接口数据库进行数据读写操作，实现短信上、下行。 Page 5 of 11 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 5 页，共 11 页 - - - - - - - - - 客服热线 100003.2 运行环境 Java 接口程序支持 WINDOWS NT/XP/2003/VISTA/Linux/Unix等支持 java 虚拟机的操作系统。 3.3 连接方式 互联网或专线，帐号、密码确认登录。 3.4 开发接口函数使用 3.4.1 接口函数说明 Login初始化接口并与短信服务器连接 SendSms发送短信 SendLongSms发送长短信 RecvSms 返回接收队列中短信 RecvSmsReport 返回接收队列中短信状态报告 Disconnect 释放资源, 断开与服务器的连接 3.4.2 接口函数调用流程图 Login SendSms RecvSms RecvSmsReporDisconnect Page 6 of 11 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 6 页，共 11 页 - - - - - - - - - 客服热线 10000 Page 7 of 11 3.4.3 SmsClient 类 短信发送、短信接收、回执接收类。 方法如下： 3.4.3.1 Loginint Login(String ipAddress, int port, String userName, String pwd, int timeout)功能 连接 SMGP 服务器并登录 ipAddress 服务器 ip 地址 port 端口号 userName 登录帐号 pwd 密码 入参 timeout 连接或发送短消息时的等待超时时间(秒)，建议值30 0 初始化成功 返回 -1 连接服务器失败 注意 初始化成功后，可以不断进行其它操作，如发送短消息，接收短消息等。程序启动后，只需要初始化一次即可，没有必要每发送一条短信进行一次连接。接口自带心跳检测功能，当断线后会自动重连。 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 7 页，共 11 页 - - - - - - - - - 客服热线 10000 Page 8 of 11 3.4.3.2 SendSmsint SendSms(String srcNo, String destNo,String content, booleanisNeedReport, StringBuilder msgID) 功能 发送指定的短信，它能自动分段发送, 每段信息最大长度为70个字 srcTermID源号码 destTermID目标号码 content 需要发送的消息 isNeedReport是否需要回执报告，false为不需要，true为需要 入参 msgID 服务器返回的 msgID int 数组，表示各分段短信返回的结果集合 0 发送成功 -1 发送失败 -2 未初始化 返回 其他 请查看错误代码含义 3.4.3.3 SendLongSmsint SendLongSms(String srcNo, String destNo,String content, booleanisNeedReport, StringBuilder msgID) 功能 发送长短信，它能自动分段发送, 每段信息最大长度为67个字，手机收到一条完整短信。 srcTermID源号码 入参 destTermID目标号码 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 8 页，共 11 页 - - - - - - - - - 客服热线 10000 Page 9 of 11 content 需要发送的消息 isNeedReport是否需要回执报告，false为不需要，true为需要 msgID 服务器返回全部分段短信的msgID集合 int 数组，表示各分段短信返回的结果集合 0 发送成功 -1 发送失败 -2 未初始化 返回 其他 请查看错误代码含义 3.4.3.4 RecvSmsint RecvSms(ArrayList smsRecList)功能 返回接收队列中短信。 (此接收队列为中心端主动向客户端推送，取状态报告时只是从队列中获取，不占用资源。请及时收取，断电、关机、接口断开后数据丢失） 入参 smsRecList 返回短信息列表 0 取回复短信成功，短信内容在smsRecList 中 返回 -1 短信队列为空，取短信失败 3.4.3.5 RecvSmsReportint RecvSmsReport(ArrayList smsReportList)功能 返回接收队列中状态报告。(此接收队列为中心端主动向客户端推送， 取状态报告时只是从队列中获取，不占用资源。请及时收取，断电、关机、接口断开后数据丢名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 9 页，共 11 页 - - - - - - - - - 客服热线 10000 Page 10 of 11 失） 入参 smsReportList 返回状态报告列表 0 取状态报告成功，状态报告内容在smsReportList中 返回 -1 状态报告队列为空，取状态报告失败 3.4.3.6 Disconnectvoid Disconnect()功能 断开与服务器之间的连接。 四、部分 SMGP常见错误代码及短信状态 4.1 常见错误代码含义，其它的请参考SMGP标准协议 编号 含义 0 成功 3 消息格式错 4 非法短消息长度 7 非法业务代码 8 系统忙 10 非法 SP编号 15 非法计费号码 16 非法目标号码 20 连接短消息网关失败 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 10 页，共 11 页 - - - - - - - - - 客服热线 10000 Page 11 of 11 46 非法发送用户号码 4.2 常见短信状态定义，其它的请参考SMGP标准协议 状态 含义 DELIVRD 短消息转发成功 EXPIRED 短消息超过有效期 DELETED 短消息已经被删除 UNDELIV 短消息是不可转发的 ACCEPTD 短消息已经被最终用户接收 UNKNOWN 未知短消息状态 REJECTD 短消息被拒绝 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 11 页，共 11 页 - - - - - - - - -