CMPP_DOC

接口说明:客户接口部分提供http url方式的接口,根据客户需求可以提供相应接口,接口编码方式采用统一的UTF-8或者GBK

接口参数:
服务器地址:IP
端口:PORT
用户账号:
用户密码:
通信认证密码:

第一章 余额

1.1 请求地址

请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是

http://服务器地址:端口/service/httpService/httpInterface.do

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

1.2参数说明

http://服务器地址:端口/service/httpService/httpInterface.do?method=getAmount

参数名称 含义 说明
method 查询余额 查询余额,固定为getAmount
username 用户账号 用户账号
password 用户密码 用户密码
veryCode 通信认证密码
例如:
http://IP:PORT/service/httpService/httpInterface.do?method=getAmount&username=JSM40001&password=123456&veryCode=453245

1.3返回值

在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:



0		------返回状态值:成功返回0 失败返回:失败代码
5000	------当status为0时,会出现该属性


     
返回值说明:
名称 说明
status 返回状态值,具体参照状态码说明
account 余额,条数
状态码说明:
返回码 描 述
0 查询成功
100 查询余额失败
101 用户账号不存在或密码错误
102 账号已禁用
103 参数不正确
105 认证码错误
117 未开通此接入方式
数字account 短信余额

第二章 发送接口

2.1 请求地址

请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址:
http://服务器IP:端口/service/httpService/httpInterface.do?method=sendMsg
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户

指定字符编码提交地址,无需携带code参数
Utf8编码:
http://服务器IP:端口/service/httpService/httpInterface.do?method=sendUtf8Msg
GBK编码
http://服务器IP:端口/service/httpService/httpInterface.do?method=sendGbkMsg

2.2参数说明

参数名称

含义

说明

method

发送短信(必填)

发送短信,固定为sendMsg

username

用户账号(必填)

用户账号

password

用户密码(必填)

用户密码

veryCode

通信认证密码(必填)
mobile 手机号码(必填) 手机号码(群发短信时,最多100个,英文逗号,隔开)
content 短信内容(必填) 短信内容(最多300个汉字),特殊字符需要转义;如果使用模板短信发送,此参数用来传递模板短信的变量和值,参数之间以逗号隔开
extcode 扩展码 用户自己分配的小号(即显示在接收手机上的主叫尾号,可用于上行信息匹配)例:我们给合作方开的特服号是106905994140010,然后合作方在发送信息的时候可以随意填写扩展号ext=8888(最大支持4位),那么用户收到信息时显示的下发号码就是1069059941400108888
sendtime 定时时间 定时短信的定时时间,格式为: (yyyyMMddhhmmss),例如:20140504111010 代表2014年5月4日 11时10分10秒,短信会在指定的时间发送出去 sendTime值为空时,为即时发送短信 sendTime值不为空时,为定时发送短信

msgtype

短信类型(必填)

短信类型。1-普通短信,2-模板短信。

signtag

短信签名序号

短信签名序号,如果帐号报备多个签名,此参数指定使用第几个签名(由于运营商要求,帐号只允许单一签名,此参数可以省略)

signtext

自定义签名

自定义签名,帐号支持自定义签名该参数才生效

tempid

模板短信编号

模板编号,(msgtype=2时参数必填)
code 编码格式 编码方式(utf-8,gbk),默认:gbk;指定字符编码提交地址时无需赋值
说明:

1) IP:如果用户开账户时指定IP,则接口只接收该IP发送请求。

例如:
1发送即时短信示例:
http://IP:PORT/service/httpService/httpInterface.do?method=sendMsg&username=JSM40001&password=123456&veryCode=&mobile=1595****097&content=您好!您本次验证码为:174687,请勿告知他人&msgtype=1&code=gbk
2 发送预约短信示例:
http://IP:PORT/service/httpService/httpInterface.do?method=sendMsg&username=JSM40001&password=123456&veryCode=453245&mobile=1595****097&content=您好!您本次验证码为:174687,请勿告知他人&msgtype=1&code=gbk&sendtime=20150501093030
3 短信多签名示例:(已作废)

如帐号报备签名:【美圣001】|【美圣002】|【美圣003】

http://IP:PORT/service/httpService/httpInterface.do?method=sendMsg&username=JSM40001&password=123456&veryCode=453245&mobile=1595****097&content=您好!您本次验证码为:174687,请勿告知他人&extcode&msgtype=1&signtag=2&tempid=&code=gbk

发送短信内容:【美圣002】您好!您本次验证码为:174687,请勿告知他人

4 使用自定义签名:(作废)
http://IP:PORT/service/httpService/httpInterface.do?method=sendMsg&username=JSM40001&password=123456&veryCode=453245&mobile=1595****097&content=您好!您本次验证码为:174687,请勿告知他人&msgtype=1&signtext=美圣004&code=gbk

发送短信内容:【美圣004】您好!您本次验证码为:174687,请勿告知他人

5模板短信示例:

登录综合信息管理系统客户端后,菜单:短信中/短信模版,详细操作流程请查看《综合信息管理系统_使用手册(客户端).docx》

如客户定义的编号为JSM4001-0001模板短信为:
尊敬的@1@@2@,您在江苏美圣网站(www.jsmsxx.com),注册的手机验证码为@3@,请在验证页面及时输入。

http://IP:PORT/service/httpService/httpInterface.do?method=sendMsg&username=JSM40001&password=123456&veryCode=453245&mobile=1595****097&content=@1@=李先生,@2@=您好,@3@=928371 &msgtype=2 &tempid= JSM4001-000&code=gbk

发送短信内容:【江苏美圣】尊敬的李先生你好,您在江苏美圣网站(www.jsmsxx.com),注册的手机验证码为928371,请在验证页面及时输入。

Content变量为模版中各变量对应的变量值,多个变量以英文逗号隔开 content=@1@=李先生,@2@=您好,@3@=928371

2.3返回值




0   
816f333305664fb9bdd8c1bc96ae12b8  
    

返回值说明
名称 说明
status 返回状态值,具体参照状态码说明
msgid 消息id,和状态报告内msgid匹配的
状态码说明:
返回码 描 述
0 提交成功
100 发送失败
101 用户账号不存在或密码错误
102 账号已禁用
103 参数不正确
105 短信内容超过300字或为空、或内容编码格式不正确
106 手机号码超过100个或有错误号码
108 余额不足
109 ip错误
110#(敏感词A,敏感词B) 短信内容存在系统保留关键词,如有多个词,使用逗号分隔:110#(李老师,XX,成人)
114 模板短信编号不存在
115 短信签名标签序号不存在
116 认证码不正确
117 未开通此接入方式

第三章 状态报告接口

3.1 请求地址

请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://服务器地址:端口/service/httpService/httpInterface.do?method=queryReport,
只能查询当天的,已获取的状态报告后续不会再获取
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户。
建议访问频率:3分钟一次

参数名称 含义 说明
method 获取状态报告(必填) 固定为queryReport
username 用户账号(必填) 用户账号
password 用户密码(必填) 用户密码
veryCode 通信认证密码(必填)
例如:

http://IP:PORT/service/httpService/httpInterface.do?method=queryReport&username=JSM40001&password=123456&veryCode=453245

3.3返回值




1595****097			
7506751276725633025	
MA:0006				
		
						
	

1595****097
7506751276725633026
MA:0006


	

1595****097
7507418680283693057
DELIVRD


	

返回值说明:
名称 说明
mobile 返回状态值,具体参照状态码说明
msgid 消息id,和发送接口内msgid匹配的
status 返回状态码,具体参照状态码说明
time 状态报告的时间
extno 扩展码
状态码说明:
返回码 描 述
DELIVRD 发送成功,返回其他请参照失败状态码

3.4错误返回值


 





返回值说明:
名称 说明
status 返回状态码,具体参照状态码说明
状态码说明:
返回码 描 述
100 获取状态报告失败
101 用户账号不存在或密码错误
102 账号已禁用
103 参数不正确
104 暂无短信状态报告
105 认证码错误
117 未开通此接入方式

第四章 上行接口

4.1 请求地址

请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://服务器地址:端口/service/httpService/httpInterface.do?method=queryMo
只能查询当天的,已获取的上行短信后续不会再获取
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
建议访问频率:3分钟一次

4.2参数说明

参数名称 含义 说明
method 获取上行短信(必填) 固定为queryMo
username 用户账号(必填) 用户账号
password 用户密码(必填) 用户密码
veryCode 通信认证密码(必填)
例如:

http://IP:PORT/service/httpService/httpInterface.do?method=queryMo&username=testss&password=123456&veryCode=453245

4.3返回值


 


15951****97				
106905994140001		
江苏美圣信息技术有限公司
			 


15951****97				
106905994140001		
4006000699				
			


返回值说明:
名称 说明
mobile 对应的手机号码
recvcode 接受号码
content 回复内容
time 接收时间

4.4错误返回值


 





    
返回值说明:
名称 说明
status 返回状态码,请参照状态码说明
状态码说明:
返回码 描 述
100 获取上行短信失败
101 用户账号不存在或密码错误
102 账号已禁用
103 参数不正确
104 暂无上行短信
105 认证码错误
117 未开通此接入方式
联系我们
QQ咨询

返回