ZT短信平台接口开发文档

SMS接口开发文档

2013-08-24

目录

第一章 移动信息管理系统介绍 ........................................................................................................... 3

1.1. 简介 .............................................................................................................................. 3 1.2. 缩略语清单 .................................................................................................................. 3 1.3. 修订时间 ...................................................................................................................... 3

第二章 API接口说明 ............................................................................................................................ 3

2.1. （HTTP方式）接口 ................................................................................................... 3

1、普通短信 ........................................................................................................................... 4 2、变量短信 ........................................................................................................................... 5 3、余额查询 ........................................................................................................................... 7 4、状态报告 ........................................................................................................................... 8 5、回复内容接口 ................................................................................................................. 10 6、发送量数据报表提取 ..................................................................................................... 12 2.2. (webservice方式)接口 ............................................................................................... 13

1、普通短信 ......................................................................................................................... 13 2、变量短信 ......................................................................................................................... 14 3、余额查询 ......................................................................................................................... 16 4、状态报告 ......................................................................................................................... 16 5、回复内容接口 ................................................................................................................. 17 6、发送量数据报表提取 ..................................................................................................... 17 2.3. （socket方式）接口 ................................................................................................. 18

1、普通短信 ......................................................................................................................... 18 2、变量短信 ......................................................................................................................... 20 3、余额查询 ......................................................................................................................... 21 4、状态报告 ......................................................................................................................... 21 5、回复内容接口 ................................................................................................................. 22 6、发送量数据报表提取 ..................................................................................................... 23

第三章 环境要求 ................................................................................................................................. 24

3.1. 网络拓扑图 ................................................................................................................ 24 3.2. 环境要求 .................................................................................................................... 24

第一章 移动信息管理系统介绍

1.1. 简介

“移动信息管理系统”（以下简称短信平台）是上海琨瑶信息技术有限公司自主研发的SMS综合管理系统，用于实现企业终端客户面向特定会员用户进行快捷高效短信发送及查询管理。本文档为企业终端客户使用API接口，与本系统进行对接而完成。

作为专注于无线增值服务的SP商，我们坚决抵制垃圾短信并严禁将短信资源转租或转售给任何第三方，友情提醒通过我们接口发送的信息仅限发给您的最终授权会员用户。我们承诺永不发展代理商，只为最优质企业全心提供最具价值的资源与服务！为了确保您的稳定高效使用并维护信息发送的良好秩序，请您与我们一起努力，感谢您的理解与配合。

1.2. 缩略语清单

客户端：本文中特指短信平台企业终端客户端。 服务端：本文中特指短信平台企业网关服务端。

1.3. 修订时间

2012-11-30 完成基本内容。

第二章 API接口说明

2.1. （HTTP方式）接口

1、普通短信

提交地址：:8800/sendXSms.do send接口提交方式：GET/POST 功能：发送短信

短信签名（重要）：如果用户发送的内容最后一个字符为 “】”，默认为用户已经增加了签名，否则自动追加用户在平台中设置的签名到发送的内容最后。

格式：“【签名】”，系统自动追加的签名中，会自动增加“【】”，内容为用户设置的内容。

样例：

:8800/sendXSms.do?username=haha&password=888888&mobile=13900000000&content=test&dstime=&productid=61341&xh=

其中：content参数，采用下列方式处理： // String content = "汉字";

// content = URLEncoder.encode(content, "UTF-8");

2、变量短信

一般变量提交地址：:8800/sendManySms.do

变量短信打包提交地址：:8800/sendManySmsPack.do(如果一个连接里所有的内容都一样，则会自动进行打包，打包后相当于群发)

send接口提交方式：POST（get不支持大数据） 功能：发送短信

短信签名（重要）：如果用户发送的内容最后一个字符为 “】”，默认为用户已经增加了签名，否则自动追加用户在平台中设置的签名到发送的内容最后。

格式：“【签名】”，系统自动追加的签名中，会自动增加“【】”，内容为用户设置的内容。变量短信只支持单条多任务发送，不支持群发多任务发送

样例：

:8800/sendManySms.do?username=haha&password=888888&mobile=13900000000,13900000000&content=短信1【签名】※短信2【签名】&dstime=&productid=61341&xh=

手机号与内容的条数必须相同，否则会发送失败。 其中：content参数，采用下列方式处理： // String content = "汉字";

// content = URLEncoder.encode(content, "UTF-8");

3、余额查询

提交地址：:8800/balance.do 余额接口提交方式：GET 功能：查询短信剩余数量

样例：

:8800/balance.do?username=userccc&password=XXXX&productid=677678

4、状态报告

状态报告接口提交方式：GET

功能：ZT平台会实时把发送的消息报告推送到用户配置的下行地址中。用户获取网关发送的数据,接收成功返回0，接收不到数据返回非0

推送后用户方没有返回值，ZT平台默认推送三次后，不再推送 方式1：单条推送方式

此方式需要用户在ZT平台填写下行地址

例如：/getReport.do

我平台每次返回1组内容，客户被动接收状态报告并解析之 推送URL格式：

msgid=xxxxx&mobile=xxxxxx&status=xxxxxxx

方式2：批量推送方式（客服设置）间隔5秒/次 此方式需要用户在ZT平台填写下行地址

我平台每次返回50(最大)组内容，客户被动接收状态报告并解析之 推送URL格式：例如：/getReport.do?param=xxx Param参数规则如下：消息ID,手机号码,状态,时间; 消息ID,手机号码,状态,时间

说明：每一组中由消息ID，手机号码，状态，时间组成，并由英文,分开，每一组之间又由英文;

分开

方式3：主动提取状态报告 （客服设置）

我平台每次返回50(最大)组内容，客户被动接收状态报告并解析之，时间间隔最好定为1分钟左右，输入参数包括用户名和密码

提取URL地址：例如：:8800/batchreportget.do?

username=xxx& password=xxxx

说明：每一组中由消息ID，手机号码，状态，时间组成，并由英文,分开，每一组之间又由英文;分开

5、回复内容接口

回复接口提交方式：GET

功能：获取上行内容，ZT平台会自动实时的推送用户手机回复的内容到上行地址中。推送后用户方没有返回值，ZT平台默认推送三次后，不再推送

方式1：推送方式

此方式需要在ZT短信平台中填写上行地址

例如：/getreCover.do 推送URL格式：

mobile=xxxx&content=xxxxx&msgid=xxxxx&xh=xxxxx;

一次推送一个号码，mobile指手机号，content指回复的内容，msgid指上行对应的msgid，xh代表扩展号码。

用户接收回复内容成功，需要返回 ZT平台0。

回复内容接口推送的内容样例：13012345678,内容,12121209876512,1023； 方式2：主动提取

时间间隔最好定为1分钟左右,此方式需要在ZT短信平台中填写上行地址，地址一定要标记为：initiative-grab-reply

输入参数包括用户名和密码，提取地址：:8800/ batchreplyget.do? username=xxx& password=xxxx

说明：返回格式为：手机号，内容，消息ID，小号，他们之间以[r]分开，分组之间以[p]分开，最大返回50组内容。,只能取一次

6、发送量数据报表提取

查询地址：提交地址：:8800/submitStatistics.do 功能说明：

主要是查询用户发送的短信条数数据，根据时间查询（报表系统已经生成，所以

不会变化,数据非当天的），查询数据包含用户自己及下面的子用户或终端 输入参数：

输出参数：

2.2. (webservice方式)接口

提交地址：:8800/ztws/SendsmsWebService?wsdl

1、普通短信

调用方法： sendSms(String username,String password,String oldMobile,String content,String

返回结果：

2、变量短信

调用方法：sendChangeSms(String username,String password,String content,String mobile,String

product_number,String dstime,String xh)

返回结果：

3、余额查询

调用方法：getBalanceApi(String username, String password,String product_number)

功能：查询短信剩余数量

查询结果

4、状态报告

调用方法：getBatchReport(String username, String password) 功能：批量提取状态报告

我平台每次返回50(最大)组内容，客户被动接收状态报告并解析之，时间间隔最好定为1分钟左右，输入参数包括用户名和密码

说明：每一组中由消息ID，手机号码，状态，时间组成，并由英文,分开，每一组之间又由英文;分开

5、回复内容接口

调用方法：getReplyData(String username, String password) 功能：批量提取状态报告

时间间隔最好定为1分钟左右,此方式需要在ZT短信平台中填写上行地址，地址一定要标记为：initiative-grab-reply

6、发送量数据报表提取

调用方法：getSubmitStatistics(String username,String password,String dstime)

功能说明：

主要是查询用户发送的短信条数数据，根据时间查询（报表系统已经生成，所以

不会变化,数据非当天的），查询数据包含用户自己及下面的子用户或终端 输入参数：

输出参数：

2.3. （socket方式）接口

1、普通短信

提交地址：:8800

端口号：2030

专 有 文 件

注 意 保 密

Proprietary and Confidential

content dstime productid xh process_type

发送内容(必填) 定时时间，为空时表示立即发送(选填) 格式：20130202120212 产品 id(必填) 扩展的小号(选填),必须为数字，没有请留空 0,普通发送，1 变量发送，2 查询余额信息，3 取回 复信息，4 取状态报告信息(必填)

返回参数 -1 1,xxxxxxxx 0,xxxxxxxx 2 3 5,xxxxxxxx 6 7 8 9 10 11 12 13 15 19 20 用户名或者密码不正确

描述

1 代表发送短信成功,xxxxxxxx 代表消息编号 0 发送短信失败,xxxxxxxx 代表消息编号 余额不够 扣费失败(请联系客服) 短信定时成功, xxxxxxxx 代表消息编号 有效号码为空 短信内容为空 无签名，必须，格式：【签名】 没有 Url 提交权限 发送号码过多,最多支持 200 个号码 产品 ID 异常 参数异常 12 小时重复提交 Ip 验证失败 短信内容过长，最多支持 500 个 定时时间不正确：格式：20130202120212(14 位数字)

版权所有 上海琨瑶信息技术有限公司

2、变量短信

3、余额查询

功能：查询短信剩余数量

查询结果

4、状态报告

功能：批量提取状态报告

本文来源：https://www.bwwdw.com/article/g7jj.html