接口文档

企信通大客户接口说明

修订记录

目录

企信通大客户接口说明 (1)

1. 前言 (4)

2. 企信通对外接口概述 (4)

3. 发送接口 (4)

3.1 入口地址 (4)

3.2 输入参数 (4)

3.3 请求URL样例 (5)

3.4 代码样例 (5)

3.5 返回值 (5)

4. 状态报告接收接口 (6)

4.1 状态报告接收地址配置 (6)

4.2 参数列表 (6)

4.3 发送格式 (7)

4.4 返回值 (7)

4.5 状态报告说明 (7)

5. 状态报告查询接口 (7)

5.1 入口地址 (7)

5.2 输入参数 (8)

5.3 返回的结果 (8)

5.4 说明 (8)

6. 补充说明 (9)

6.1 下发内容管理 (9)

6.2 账户余量查询 (9)

1.前言

企信通接口是一个面向企信通大客户的接口，适用于通过网络实现企业短信的实时发送。本文档以下内容包含的是实现“企信通接入”的技术接口说明，包含：发送接口、状态报告接收接口、状态报告查询接口以及补充说明。

特别注意：本服务需要得到审批才能使用。

2.企信通对外接口概述

企信通对外接口分为两种，一种是接受外部请求的接口，如发送接口，余量查询接口等，这种类型的接口需要客户端的程序主动发出请求，企信通才能为客户提供服务。另外一种是能够主动通知客户系统的接口，如状态报告接收接口，这种类型的接口需要客户提供相应的地址，然后由企信通主动请求这些地址，来为客户提供状态的更新等服务。

3.发送接口

3.1 入口地址

发送接口是由客户主动调用的，入口地址是客户接口程序调用时的请求地址，采用HTTP 方式，地址是：http://202.99.67.178:8080/tjgt/SendSMSServlet

注意：入口地址一般不会发生变化，当发生变化的时候，会通知接口用户。

3.2 输入参数

注：Base64与MD5编码文件会随同本说明一起发送。

3.3 请求URL 样例

http://202.99.67.178:8080/tjgt/SendSMSServlet?USER=xxx&PASSWORD=XXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXX&SRCTERMID=&DESTTERMID=XXXXXXXXXXX&CONTENT=bXh0IOa1i%2B ivlSB0ZXN0

3.4 代码样例

public String getURL() throws Exception { String url = "http://202.99.67.178:8080/tjgt/SendSMSServlet";// 入口地址 String user = "xxx";//用户名 String password = "xxx";//密码

password = new MD5().getMD5ofStr(password);//得到MD5编码 String desttermid = "XXXXXXXXXXX";//目的号码 String content = "测试新接口";//

发送内容 content = new String(Base64.encode(content.getBytes("UTF-8")), "UTF-8"); url += "?SRCTERMID=&USER=" + URLEncoder.encode(user, "UTF-8") + "&PASSWORD=" + URLEncoder.encode(password, "UTF-8")

+ "&DESTTERMID=" + URLEncoder.encode(desttermid, "UTF-8")

+ "&CONTENT=" + URLEncoder.encode(content, "UTF-8");

return url;

}

注意：每发送的时候，发送的字符总数最好不要太长，一般号码为每次50个为适宜，多了可分批发送

3.5 返回值

4.状态报告接收接口

4.1 状态报告接收地址配置

状态报告接收接口是由企信通提供的一套基于HTTP协议的主动向合作伙伴发送有关状态报告等状态同步通知的基础服务设施。

用户在发送下行完毕后，状态报告会通过HTTP接口自动返回。这要求接口用户提供一个HTTP接口，接受传过来的参数，因此需要接口用户告诉自己的的接口地址。此地址由企信通管理人员统一管理，在管理平台上统一配置。

4.2 参数列表

4.3 发送格式

url?COUNT=1&REPORT= mtid,stat

4.4 返回值

在接收到企信通平台推送的每条状态报告后，需向企信通平台返回ok，用来确认已收到状态报告，否则企信通平台会按照一定的时间策略重新推送状态报告，在推送超过一定次数后，则停止推送。

4.5 状态报告说明

在采用此模式时，将不对错误的状态报告封装成F，一律返回原始的状态报告结果。

5.状态报告查询接口

5.1 入口地址

状态报告查询接口是由客户主动调用的，可以查询短信状态的接口，采用的是HTTP 方式，入口地址是：http://202.99.67.178:8080/tjgt/ ReceivMtStatus

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户。

5.2 输入参数

5.3 返回的结果

返回的的是xml格式的响应，如果成功，错误码是0，格式如下：

5.4 说明

每个用户只能有一种状态报告的获取方式，要么是推送，要么是查询。建议用户选用推送方式。但是如果无法提供外网地址，可以使用查询接口。已经有了推送地址的客户，无法使用状态报告查询接口。