易信通平台接口手册电信用户.docx

EMS平台接口手册

产品名称

EMS平台

发布日期

2023/7/20

目录

TOC\o1-3\h\z1、 引言 3

1.1. 目的 3

1.2. 修改历史记录 3

1.3. 名称解释 3

2、 短信 4

2.1. http接口 4

2.1.1. 短信发送 4

2.1.2. 短信接受 5

2.1.3. 查询状态报告 6

2.1.4. 查询余额 8

2.1.5. 查询关键字 9

2.2. WebService接口 10

2.2.1. 短信发送 10

2.2.2. 短信接受 11

2.2.3. 查询状态报告 13

2.2.4. 查询余额 14

2.2.5. 查询关键字 15

附录：公共错误代码定义 16

引言

目的

该接口手册编写目的在于描述公司信息系统（以下简称EMS）具体的接口协议，供接口用户进行接口的对接开发。

修改历史记录

版本

修改人

日期

描述

V

陈林

2023-07-20

创建文档。

V

陈林

2023-11-19

增长2.1.2及2.2.2一对一批量发送，同时增长两个错误代码值13，14

V

陈林

2023-12-10

增长2.3节DB接口

V

陈林

2023-03-09

增长错误代码15署名未报备

V

陈林

2023-04-14

DB接口升级：增长监控，路由功能

V

陈林

2023-04-28

增长错误代码16单位时间内该号码最大发送限制

V

陈林

2023-05-20

增长错误代码17校验署名时署名长度及格式非法

名称解释

缩略语

英文全名

中文全名

EMS

EnterpriseMessageSystem

公司信息系统

SMS

ShortMessagingService

短消息服务

MMS

MultimediaMessageService

多媒体消息

API

ApplicationProgrammingInterface

应用程序编程接口

MO

MessageOriginal

消息上行

MT

MessageTerminal

消息下行

SP

ServiceProvider

服务提供商

CP

ContentProvider

内容提供商

短信

http接口

短信发送

功能：发送短信

地址：

备注：建议采用post方法提交请求。

请求参数定义如下：

参数名称

描述

字段值

enterpriseID

公司ID

由系统开户设立,系统分派。不允许为空

loginName

登录名

String，不允许为空。系统开户设立登录名

password

登录密码

String，不可认为空。密码采用32位小写MD5加密.

smsId

消息id

String，可认为空。消息id是这个包唯一标记，若为空则系统随机分派一个唯一标记值。若不为空，由用户自己设立一个唯一标记值。该值做为应答及状态报告中的消息id一一相应。

subPort

扩展端口

String,可认为空。空表达不再扩展，若扩展必须是数字如：00，01，02…

若扩展输入00则手机收到端标语为：10657*****00

(备注：扩展必须此帐户配置通道支持)

content

短信内容

String不可认为空，内容采用utf-8编码

mobiles

接罢手机号码

String，不可认为空。支持移动，联通，电信混合提交;多个号码中间采用半角逗号分隔,每个包最大支持100个号码。例：

,,

sendTime

定期发送时间

String,可认为空。为空表达立即发送，定期时间格式为：

yyyy-MM-ddHH:mm:ss

返回结果以xml形式返回，具体参数及示例如下：

参数名称

描述

Response

根节点

Result

提交返回结果状态，具体状态码详见附录：公共错误代码定义

SmsId

消息id,用于配对状态报告,每个包提交返回消息id唯一。若发送时设立消息id，则返回是设立消息id值。

失败返回结果样例：

?xmlversion=1.0encoding=UTF-8?

Response

Result1/Result

/Response

成功返回结果样例：

?xmlversion=1.0encoding=UTF-8?

Response

Result0/Result

SmsId/SmsId

/Response

一对一批量发送

功能：发送短信

地址：

备注：建议采用post方法提交请求。

请求参数定义如下：

参数名称

描述

字段值

enterpriseID

公司ID

由系统开户设立,系统分派。不允许为空

loginName

登录名

String，不允许为空。系统开户设立登录