短信接口API下载

2016-02-25 17:41:00
zhangjian
原创
8812
摘要:短信接口,API文档下载


目    录

 

1、 引言 2

1.1. 目的 2

1.2. 名称解释 2

2、 短信 3

2.1. http接口 3

2.1.1. 短信发送 3

2.1.2. 短信接收 4

2.1.3. 查询状态报告 5

2.1.4. 状态报告(主动推送) 5

2.1.5. 短信接收(主动推送) 6

 

 

附录:公共错误代码定义 10

 


1、 引言

1.1. 目的

该接口手册编写目的在于描述企业信息系统(以下简称EMS)具体的接口协议,供接口用户进行接口的对接开发。

备注:本接口默认以GBK编码,如需其他要求则提供其他地址。

 

 

 

1.2. 名称解释

缩略语

英文全名

中文全名

EMS

Enterprise Message System

企业信息系统

SMS

Short Messaging Service

短消息服务

MMS

Multimedia Message Service

多媒体消息

API

Application Programming Interface

应用程序编程接口

MO

Message Original

消息上行

MT

Message Terminal

消息下行

SP

Service Provider

服务提供商

CP

Content Provider

内容提供商

 

2、 短信

2.1. http接口

2.1.1. 短信发送(MT)

功能:发送短信

地址: http://115.28.143.178:8080/sms/Send.do 

支持GETPOST

 

备注:建议采用post方法提交请求,采用GBK编码,可以支持单条和批量发送,发送会 绑定客户IP地址。

 

 

请求参数定义如下: 

参数名称

描述

字段值

spId

企业ID

由系统开户设置,系统分配。不允许为空

loginName

登录名

String,不允许为空。系统开户设置登录名 

 

password

登录密码

String,不可以为空。

subPort

扩展端口

String,可以为空。空表示不再扩展,若扩展必须是数字如:000102…

若扩展输入00则手机收到端口号为:10657*****00,根据收到接入号进行扩展,不能超过20位。

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

content

短信内容

String 不可以为空 

mobiles

接收手机号码

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

13500000000,13000000000,15100000000

reserve

保留字段

可以为空,可根据客户需求定制

 

 

 

 

返回结果以 字符串 格式形式返回,详细参数及示例如下:

参数名称

描述

description

提交描述

result

提交返回结果状态,详细状态码详见附录:公共错误代码定义

smsId

消息id,用于配对状态报告,每个包提交返回消息id唯一。

失败返回结果样例:

result=1002&description=账号无效或未开户

成功返回结果样例:

result=1000&description=发送短信成功&smsId=1531927

 

GET示例(直接输入到IE浏览器地址栏中)

http://115.28.143.178:8080/sms/Send.do?spId=123&loginName=xxxxx&password=xxxx&content=1233&mobiles=13712345678&subPort=

2.1.2. 短信接收(MO)

功能:短信接收

地址:http://115.28.143.178:8080/sms/reply.do

备注:支持GETPOST

建议采用post方法提交请求。已被取出的上行信息下次不会再重复提取,若调用接口返回上行记录数不为0,则取完可继续提取。一旦返回结果上行记录为0,则20秒后再发送上行信息提取请求,否则连续系统会返回空的信息数据。

 

请求参数定义如下: 

参数名称

描述

字段值

spId

企业ID

由系统开户设置,系统分配。不允许为空

loginName

登录名

String,不允许为空。系统开户设置登录名 

 

password

登录密码

String,不可以为空。

 

 

返回结果以String 字符串形式返回,详细参数及示例如下:

参数名称

描述

result 

0为获取成功

confirm_time

上行确认时间

id

该条回复信息的编号

replys(多个以分号分隔,单个则以英文逗号分割)

 上行消息体

callmdn :上行的接入号 (逗号分割第1)

mdn:手机号码  (逗号分割第2)

content:上行内容  (逗号分割第3)

reply_time:回复时间 (逗号分割第4)

subPort:提交短信的端口号 (逗号分割第5)

 

失败返回结果样例:

result=1001

 

成功返回结果样例:

result=1000&confirm_time=2014-05-13 23:44:35&id=62427&replys=1065817803903206032,13712312312,辣椒60,洗发水20,2014-04-23 12:43:32,56681;1065817803903206877,13712312312,,2014-04-23 12:43:33,56682;

没有数据会返回:

result=0&confirm_time=2014-05-10 10:49:40

2.1.3. 查询状态报告

功能:查询状态报告

地址: http://115.28.143.178:8080/sms/report.do

备注:支持GETPOST

建议采用post方法提交请求。已被取出的状态报告信息下次不会再重复提取,若调用接口返回状态报告记录数不为0,则取完可继续提取。一旦返回结果状态报告记录为0,则20秒后再发送状态报告提取请求,否则否则返回空数据。

 

 

请求参数定义如下: 

参数名称

描述

字段值

spId

企业ID

由系统开户设置,系统分配。不允许为空

loginName

登录名

String,不允许为空。系统开户设置登录名 

 

password

登录密码

String,不可以为空。

 

 

 

 

返回结果以String 字符串形式返回,详细参数及示例如下:

参数名称

描述

result

提交返回结果状态,详细状态码详见附录:公共错误代码定义

reports (多个以分号分隔,单个则已逗号分割)

smsId:信息编号,跟提交短信返回的编号一致(第1个)

mdn:手机号码 (第2个)

status: 0 为到达成功,非0都是到达失败 (第3个)

statdesc:回执错误编码,可参考CMPP,SMGP.SGIP协议文档 (第4个)

arrive_time:到达时间 (第5个)(yyyyMMddHHmmss 格式)

失败返回结果样例:

result=1001

成功返回结果样例:

当回执数据为空时:

result=1000&reports=

不为空时:

result=1000&reports=11535,13712312312,0,DELIVRD,20140421105134;11798,13712312312,0,DELIVRD,20140421113041;12224,13712312312,0,DELIVRD,20140421120510;16529,13712312312,0,DELIVRD,20140422133113;

 

2.1.4. 推送状态报告

功能:推送状态报告

地址:http://客户提供IP地址:端口/服务名称

备注:POST 推送

 

以String 字符串形式推送,详细参数及示例如下:

参数名称

描述

result

提交返回结果状态,详细状态码详见附录:公共错误代码定义

reports

包含多个状态报告信息,以英文分号分隔,单个回执报告体以英文逗号分隔。

1 smsId (提交返回时的任务编号),

2 mdn(提交返回时的手机号码),

3 status   0 为到达成功,非0都是到达失败,

4 statdesc 回执错误编码,可参考CMPP,SMGP.SGIP协议文档,

5arrive_time:收到回执时间。

 

例子:

 http://客户提供IP地址:端口/服务名称?result=1000&reports=1173496,15912312312,0,DELIVRD,

20140510003507;1163699,15912312316,0,DELIVRD,20140510003509

 

客户端接收成功,返回OK

 

 

 

 

 

 

2.1.5. 推送上行回复(MO)

功能:推送状态报告

 

备注:POST 推送

地址:http://客户提供IP地址:端口/服务名称

以String 字符串形式推送,详细参数及示例如下:

参数名称

描述

result 

0为获取成功

confirm_time

上行确认时间

id

该条回复信息的编号

replys 

包含多个回复信息,以英文分号分隔,单个回复信息体以英文逗号分隔

1 callmdn :上行的接入号,

2 mdn:手机号码,

3  content:上行内容,

4 reply_time:回复时间,

5subPort::提交短信的端口号

 

例子:

 

http://客户提供IP地址:端口/服务名称?  result=1000&replys=1069123123,15912312312,test,2014-05-10 10:35:02,61271;1069123124,15912312313,test1,2014-05-10 10:35:02,61272

客户端接收成功,返回OK

 

2.1.6. 查询余额

功能:查询余额

地址:http://115.28.143.178:8080/sms/SearchNumber.do

 

接口参数详细描述:  

参数名称

描述

字段值

spId

企业ID

由系统开户设置,系统分配。不允许为空

loginName

登录名

String,不允许为空。系统开户设置登录名 

 

password

登录密码

String,不可以为空。

 

 

返回结果以字符串格式形式返回,详细参数及示例如下:

参数名称

描述

result

提交返回结果状态,详细状态码详见附录:公共错误代码定义

leftover

剩余条数

失败返回结果样例:

result=1002

成功返回结果样例:

result=1000&leftover=32

 

最后编辑:roadmzhang 于 2016-03-09 14:05:52

关键字

发表评论
评论通过审核后显示。
文章分类
联系我们
联系人: 鲁女士
电话: 021-50388652
Email: service@roadm.cn
QQ: 2861036237
地址: 上海市浦东新区懿德路519弄6号楼