企业信使开发文档

2018-07-29 15:35:49 guanliyuan 210

短信接口即企业短信平台接口(API版)是面向有一定技术开发能力的企业用户而单独研发的短信(sms)接口。接口采用了通用的 HTTP,WEBSERVICE,SGIP,CMPP,SMGP等形式,可以支持各种操作系统和开发语言,支持二次开发,可把短信接口嵌入到您自己的系统 中,快速拥有无线应用,完善企业服务。SGIP接口形式为联通采用的标准接口协议。SMGP接口形式为电信采用的标准接口协议,CMPP为移动采用的协议 标准,这几个标准的营商接口协议也分好几个版本,如CMPP分2.0 和3.0标准。

客户接口说明

由于目前短信轰炸机的出现,不少网站都会被其影响,所以建议客户在对接短信验码的同时做好相关限制。
这里推荐几种限制方法:
1,IP限制,如:一个IP一天只发5条
2,时间限制,如:一分钟同一个号码只能发一条
3,手机号的限制 如:一个手机号码一天只能发条
4,增加图型验证码,能有效杜绝短信轰炸机

相关文档

动态短信验证码安全解决方案

如何防止恶意点击手机短信验证码


接口DEMO源码下载

注:示例是根据1.0接口协议写的,如使用2.0接口,请自行根据2.0接口文档说明替换



HTTP 及WEBSERVICE接口文档下载
 

短信接口Http1.0.doc     短信接口Http2.0.doc     短信接口WebService.doc

请求地址

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

入口地址 http://sms.37037.com   注:无www

注:入口地址一般不会发生变化,当发生变化的时候,会通知接口用户 
如域名发送出现提交失败或其它原因,更换为IP地址,联系相关负责工作人员

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

第一章 发送接口

1.1 请求地址

http://sms.37037.com/sms.aspx          对应UTF-8http://37037.com/smsGBK.aspx 对应GB2312
接口2.0调用地址:(务必下载短信接口Http2.0.doc 进行参考调用)
http://sms.37037.com/v2sms.aspx 对应UTF-8

http://sms.37037.com/v2smsGBK.aspx 对应GB2312

1.2 参数说明

参数名称含义说明userid企业id企业IDaccount发送用户帐号用户帐号,(建议使用英文或数字)password发送帐号密码用户账号对应的密码mobile全部被叫号码发信发送的目的号码.多个号码之间用半角逗号隔开content发送内容短信的内容sendTime定时发送时间为空表示立即发送,定时发送格式2010-10-24 09:08:10action发送任务命令设置为固定的:sendcheckcontent是否检查内容包含非法关键字当设置为1时表示需要检查,默认0为不检查

发送短信示例 http://sms.37037.com/sms.aspx?action=send&userid=企业ID&account=账 号&password=密码&mobile=13708989179,13212345678&content=内容& sendTime=&checkcontent=1
登录平台后,左侧点击 客户管理 → 我的信息 如下图所示 ID ,帐号,密码

我的信息

1.3 返回值

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

短信返回值

 

返回信息提示说明ok提交成功用户名或密码不能为空提交的用户名或密码为空发送内容包含sql注入字符包含sql注入字符用户名或密码错误表示用户名或密码错误短信号码不能为空提交的被叫号码为空短信内容不能为空发送内容为空包含非法字符:表示检查到不允许发送的非法字符对不起,您当前要发送的量大于您当前余额当支付方式为预付费是,检查到账户余额不足其他错误其他数据库操作方面的错误

第二章 余额及已发送量查询接口

2.1 请求地址

http://sms.37037.com/sms.aspx

2.2 参数说明

参数名称含义说明userid企业id>企业IDaccount用户帐号用户帐号,(建议使用英文或数字)password帐号密码用户账号对应的密码action发送任务命令设置为固定的:overage

查询余额示例 http://sms.37037.com/sms.aspx?action=overage&userid=企业ID&account=账号&password=密码

2.3 返回值

短信返回值

 

返回信息提示说明返回空查询成功将返回相应的支付方式、账户使用条数、总充值点数用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误

第三章 非法关键词查询

3.1 请求地址

http://sms.37037.com/sms.aspx

3.2 参数说明

参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,(建议使用英文或数字)password帐号密码用户账号对应的密码action任务名称设置为固定的:checkkeywordcontent检测发送内容需要发送的内容

关键词查询示例 http://sms.37037.com/sms.aspx?action=checkkeyword&userid=企业ID&account=账号&password=密码&content=内容

3.3 返回值

返回值

 

返回信息提示说明用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误包含非法字符检查出来包含非法关键词未包含非法字符未检查出非法关键词

第四章 状态报告接口

4.1 请求地址

http://sms.37037.com/statusApi.aspx

4.2 参数说明

参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,(建议使用英文或数字)password帐号密码用户账号对应的密码action任务名称设置为固定的:query

状态报告查询 http://sms.37037.com/statusApi.aspx?action=query&userid=企业ID&account=账号&password=密码

4.3 返回值

返回值

4.4 错误返回值——状态报告请求错误返回格式及对应值

错误返回值

 

信息提示说明1用户名或密码不能为空2用户名或密码错误3该用户不允许查看状态报告4参数不正确

第五章 上行接口

5.1 请求地址

http://sms.37037.com/callApi.aspx

5.2 参数说明

查询上行回复短信 http://sms.37037.com/callApi.aspx=action=query&userid=12×tamp=20120701231212&sign =5cc68982f55ac74348e3d819f868fbe1

5.3 返回值


15023239810-------------对应的手机号码

1212-------------同一批任务ID

你好,我不需要---------上行内容

2011-12-02 22:12:11-------------接收时间

01----子号,即自定义扩展号

15023239811

1212

你好,本次活动路线是怎么的

2011-12-02 22:12:11

01


5.4 错误返回值——回复请求错误返回格式及对应值


1-------------错误码

用户名或密码不能为空-------------错误描述




 

信息提示说明1用户名或密码不能为空2用户名或密码错误3该用户不允许查看状态报告4参数不正确

第六章 其它问题

问:为什么要提供ip地址?
答:为了避免各种原因的帐号盗用情况,造成贵公司短信被滥用,所以我们的系统有ip验证功能,只发送您这边认可的ip地址提交的短信。

问:可以提供在线管理平台吗?
答:有的,可以登录平台查询余额、修改密码、发送短信等。网站:http://sms.37037.com

问:有些公司需要报备短信模板,我们需要报备不?
答:不需要报备,我们会有人工审核机制,如果验证码及行业应用类,我们是24小时免审。
问:为什么验证码刚测试几条可以收到,后来收不到了?
答:为了防止不法份子用短信轰炸别人,同一个号码1小时只让发3次,一天10次。

空格问题

接口是根据用户提交的短信内容进入全字符匹配的,所有要注意空格的问题
乱码问题
造成发送收到乱码问题,一般都是编码问题引起的,请调整编码。

http://sms.37037.com/sms.aspx         对应UTF-8http://sms.37037.com/smsGBK.aspx 对应GB2312