短信HTTP接口说明文档
- 格式:doc
- 大小:78.50 KB
- 文档页数:3
Web Service接入模式Web Service 发送短信模式Web Service 路径:/WS/LinkWS.asmx系统提供8个接口: 注册接口Reg、更改密码接口UpdPwd、修改注册信息UpdReg、查询余额接口SelSum、发送信息接口Send、群发短信接口 BatchSend 、短信报告接口 GetReportSMS、接收短信Get注册接口Reg输入参数:参数说明类型LoginName代理商账号StringLoginPwd 代理商密码StringCorpName 企业名称StringLinkMan 联系人StringTel 联系电话StringMobile 联系人手机StringEmail 邮件StringMemo 其他备注StringCorpID 用户账号StringPass 用户密码String输出参数:输出返回值参数状态说明OK 注册成功错误文本失败C# 实例:try{Dxt.LinkWS LinkWs=new dxt.LinkWS();String ReS=LinkWs.Reg(LoginName, LoginPwd, CorpName, LinkMan, Tel, Mobile, Email, CorpID, Pass);if(ReS=="OK"){MessageBox.Show("注册成功" );}else{MessageBox.Show("注册失败!" );}}catch (.WebException WebExcp){MessageBox.Show("网络错误,无法连接到服务器!" );}更改密码UpPwd输入参数参数说明类型CorpID 帐号StringPwd 密码StringNewPwd 新密码String输出参数:输出返回值参数状态说明0 密码修改成功–1 账号未注册–2 其他错误–3 密码错误C# 实例:try{Dxt.LinkWS LinkWs=new Dxt.LinkWS();intUpdPwd=LinkWs.Reg(CorpID.Text.Trim(),Pwd.Text.Trim(),NewPwd.Text.Trim());if(ReS==0){MessageBox.Show("密码修改成功" );}else if(ReS==-1){MessageBox.Show("账号未注册" );}else if(ReS==-2){MessageBox.Show("其他错误!" );}else if(ReS==-3){MessageBox.Show("密码错误!" );}}catch (.WebException WebExcp){MessageBox.Show("网络错误,无法连接到服务器!" );修改注册信息 UpdReg输入参数:参数说明类型CorpID 账号String Pwd 密码String CorpName 企业名称String LinkMan 联系人String Tel 联系电话String Mobile 联系人手机String Email 邮件String Memo 其他备注String输出参数:输出返回值参数状态说明0 修改成功–1 账号未注册–2 其他错误–3 密码错误C# 实例:try{Dxt.LinkWS LinkWs=new dxt.LinkWS();ReS=LinkWs.UpdReg(CorpID.Text.Trim(),Pwd.Text.Trim(),CorpName.Text.Trim(),LinkMan.Text.Tr im(),Tel.Text.Trim(),Mobile.Text.Trim(),Email.Text.Trim(),Memo.Text.Trim());if(ReS==0){MessageBox.Show("成功修改注册信息" );}else if(ReS==-1){MessageBox.Show("帐号未注册!" );}else if(ReS==-2){MessageBox.Show("其他错误!" );}else if(ReS==-3){MessageBox.Show("帐号密码不匹配!" );}}catch (.WebException WebExcp){MessageBox.Show("网络错误,无法连接到服务器!" );查询余额SelSum输入参数参数说明类型CorpID 帐号StringPwd 密码String输出参数:输出返回值参数状态说明0 剩余条数–1 账号未注册–2 其他错误–3 密码错误C# 实例:try{Dxt.LinkWS LinkWs=new dxt.LinkWS();int ReS=LinkWs.SelSum(CorpID.Text.Trim(),Pwd.Text.Trim());if(ReS>=0)MessageBox.Show("还剩"+ReS.ToString()+"条" );}else if(ReS==-1){MessageBox.Show("帐号未注册!" );}else if(ReS==-2){MessageBox.Show("其他错误!" );}else if(ReS==-3){MessageBox.Show("帐号密码不匹配!" );}}catch (.WebException WebExcp){MessageBox.Show("网络错误,无法连接到服务器!" );}发送短信 Send(返回状态报告ID)输入参数:参数说明类型CorpID 账号StringPwd 密码StringMobile 发送手机号码StringContent 发送内容(需要UrlEncode)StringCell 子号StringSendTime 定时发送时间String 2012/2/6 17:02:00 输出参数:输出返回值参数状态说明大于0的数字发送成功(得到大于0的数字、作为取报告的id)–1 账号未注册–2 其他错误–3 密码错误–4 手机号格式不对–5 余额不足–6 定时发送时间不是有效的时间格式–7 禁止10小时以内向同一手机号发送相同短信-10 需要审核的信息C# 实例:try{Dxt.LinkWS LinkWs=new Dxt.LinkWS();intReS=LinkWs.Send2(CorpID.Text.Trim(),Pwd.Text.Trim(),SendMobile.Text.ToString().Trim(),Sen dContent.Text.ToString().Trim(),"",SendTime.Text.ToString().Trim());if (ReS == 0){MessageBox.Show("发送成功!" );}else if(ReS==-1){MessageBox.Show("帐号未注册!") ;}else if(ReS==-2){MessageBox.Show("其他错误!") ;}else if(ReS==-3){MessageBox.Show("帐号密码不匹配!") ;}else if(ReS==-4){MessageBox.Show("手机号码不正确!") ;}else if(ReS==-5){MessageBox.Show("余额不足!") ;}else if(ReS==-6){MessageBox.Show("定时发送时间不是有效时间!") ;}else if(ReS==-7){MessageBox.Show("禁止10小时之内向同一手机发送相同内容") ;}}catch (.WebException WebExcp){MessageBox.Show("网络错误,无法连接到服务器!" );}群发短信 BatchSend(返回状态报告ID)输入参数:备注:相同内容的号码尽量一个包提交(一次性最多支持600个号码)。
一信通企业信息服务平台接口手册目录一信通企业信息服务平台 (1)1.概述 (3)1.1编制目的 (3)1.2容概述 (3)1.3名称解释 (3)1.4参考文献 (3)2.短信 (4)2.1HTTP接口 (4)2.1.1消息协议 (4)2.1.2发送短信 (4)2.1.3回执接口 (5)2.1.4剩余短信条数查询 (6)2.1.5回复容接口 (7)2.2W EBSERVICE接口 (7)2.2.1消息协议 (7)2.2.2发送短信 (8)2.2.3回执接口 (9)2.2.4上行回复容查询接口 (9)2.2.5上行回复容确认接口 (10)2.2.6容审核 (11)修改历史1.概述1.1编制目的该接口文档手册编写在于描述易派企业信息服务平台UMS(以下简称UMS)具体的接口协议,供第三方系统能够顺利接入一信通短信网关。
1.2容概述本规主要讲了第三方系统接入短信通系统的协议要求,协议三大状态和协议指令的格式和响应信息。
1.3名称解释1.4参考文献2.短信2.1http接口2.1.1消息协议接口地址: guangdong.ums86.:8899/sms/Api/通过接口提交参数时, 参数容必须为GB2312 编码, 且经过url编码后的容。
例如:“您好”的url编码为“%C4%FA%BA%C3”接口返回的容是一些键值对的字符串集合,形式为:“k1=v1&k2=v2&k3=v3…”返回容中的键值显示为url编码形式, 经过url解码后的键值是GB2312编码的字符串。
例如:返回容“result=0&description=%B7%A2%CB%CD%B3%C9%B9%A6&faillist=”表示的实际容为“result=0&description=发送成功&faillist=”2.1.2发送短信功能描述:短信发送调用格式:对 guangdong.ums86.:8899/sms/Api/Send.do进行post返回格式: result=&description=错误描述&faillist=失败列表post参数说明:实际返回容为“result=0&description=发送成功”2.1.3回执接口功能描述:短信回执调用方式:ftp返回格式:文本文件ftp服务信息:返回文本文件格式:文件名:arrive_000139_25288_00f_6一行容:SPID=197258 MESSAGEID=910320f1 ID=2432901361 CALLMDN=2501 MDN= RESULT=0 DESC=DELIVRD ARRIVE_TIME=402Java解析这行的方法// 解析一行记录public static Properties parse(String line) {String parsePattern="([^=\t]+)=([^\t]*)";Matcher m = pile(parsePattern).matcher(line);Properties result = new Properties();while (m.find()) {String key = m.group(1).trim();String value = m.group(2).trim();result.put(key.toUpperCase(), value);}return result;}如果要获取取接受短信的则使用:String mdn= (String)result.get("MDN");即可其他字段类似方式2.1.4剩余短信条数查询功能描述:剩余短信条数查询接口调用格式:对guangdong.ums86.:8899/sms/Api/SearchNumber.do进行post返回格式: result=&description=错误描述&faillist=失败列表2.1.5回复容接口功能描述:将上行回复的容通过http协议进行post到企业方调用格式: url由企业方提供,然后对该url进行post,post的格式为xml,格式如下: <packet><reply><mdn></mdn><callmdn>111</callmdn><msg>回复容测试</msg><replytime>2012-01-01 00:00:00</replytime></reply></packet>返回格式:返回格式为xml,格式如下:<returncode>0</returncode>post参数说明:返回值:2.2Webservice接口2.2.1消息协议接口地址:guangdong.ums86.:8899/sms_hb/services/Sms?wsdl2.2.2发送短信功能描述:短信发送调用格式:利用webservice客户端进行http请求返回格式:SmsResponseSmsRequest请求参数说明:SmsResponse返回值:实际返回容为“result=0&description=发送成功”2.2.3回执接口功能描述:短信回执调用方式:利用webservice客户端进行http请求返回格式: ReportResponseReportRequest请求参数说明:ReportResponse返回值:实际返回容为“001,,0; 001,,0;001,,0;”2.2.4上行回复容查询接口功能描述:上行回复容查询调用方式:利用webservice客户端进行http请求返回格式: ReplyResponseReplyResponse返回值:2.2.5上行回复容确认接口功能描述:上行回复容查询调用方式:利用webservice客户端进行http请求返回格式: ReplyConfirmResponse ReplyConfirmRequestReplyConfirmResponse返回值:2.2.6容审核功能描述:短信发送调用格式:利用webservice客户端进行http请求返回格式:AuditingResponseAuditingRequest请求参数说明:AuditingResponse返回值:实际返回容为“result=0&description=短信容审核通过”。
云MAS平台SDK1.0.1(HTTP版)用户手册作者:中国移动通信有限公司政企客户分公司完成日期:2015-12-7签收人:签收日期:修改情况记录:1云MAS平台HTTP开发说明1.1简介云MAS平台SDK HTTP版接口说明文档1.2背景系统名称:云MAS平台项目开发者:中国移动通信集团政企客户分公司1.3定义MT Message Terminal——下行短信,即向手机终端发送短信MO Message Original——上行短信,即手机用户向特服号码发送短信1.4环境服务器具有直连访问互联网的能力。
并且提供HTTP Server接收比较报告,状态报告,上行短信。
1.5云MAS平台与HTTP客户端数据交互流程HTTP客户端云MAS服务端云MAS消息队列云MAS审核服务云MAS发送服务行业网关1.HTTP客户端提交短信至云MAS2.服务端提交消息至消息队列2.服务端提交消息至审核服务3.审核不通过4.返回审核结果数据结构见2.13.审核通过,消息队列提交客户封包至发送服务4.提交短信至行业网关5.返回短信回复6.返回短信回复8.返回短信回执9.返回短信回执7.返回短信回复数据结构见2.210.返回短信回执数据结构见2.34.通知删除待发内容4.返回审核状态HTTP服务端2:返回状态码和后台生成的UUID,SDK收到的返回值说明:➢“1.返回提交状态”,说明云MAS是否收到HTTP提交的数据;数据还未提交行业网关;➢“4.返回审核结果”,说明云MAS已经对提交内容进行了审核;数据还未提交行业网关;➢“7.返回短信回复”,短信已经提交网关;➢“10.返回短信回执”,短信已被网关下发;*因平台有流控设置,需要进行多条短信连续提交时,为保证提交速度和效率,请按照“1.返回提交状态”返回值判断是否提交下一条;2数据结构说明2.1MT提交报告数据结构●类型(TYPE):JSON●用途用于内部,跟踪短信状态,不能用于判断短信是否正确送达,2.2MT状态报告数据结构●类型(TYPE):JSON●用途保存状态报告接口函数返回的短信内容,不能用于判断短信2.3MO数据结构●类型(Type):JSON3功能介绍及使用3.1身份验证●功能介绍企业必须通过身份验证才能进行短信发送,身份验证用户名、密码和集团客户名称完成。
短信上行接口
一、程序调用地址:合作方提供
二、调用方式:
MO接口采用HTTP GET方式
IP:61.135.159.23和61.135.159.155和61.135.158.233(如需IP鉴权用此ip) 参数说明:字段及解释
1.mobile------手机号
2.send_time------用户上行时间(YYYY-MM-DD HH:MM:SS)
3.msg------------用户发送内容 (会做urlencode,GB2312)
4.linkid-----------内部参数,关联上下行的(如需要则提供,否则可以不用)
5.longnum---------上行长代码
6.feecode------------------- 资费(资费,以分为单位)
注:URLEncode:一般为地址栏中的中文字加密时使用,转换后,原明文的汉字将变成加密字符串,但可被浏览器识别。
因为上行内容中有可能有空格或者中文什么的,怕传输有问题,所以我们这边先做encode传输
短信MR接口
一、程序调用地址:合作方提供
二、调用方式:
MR接口采用HTTP GET方式
IP:61.135.159.23 (如需IP鉴权用此ip)
传递参数包括三个:
1. linkid 匹配下行用的linkid
2.mobile 手机号
3. status 状态报告(0成功,1失败) 成功入库返回OK。
云MAS平台SDK1.0.1(HTTP版)用户手册作者:中国移动通信有限公司政企客户分公司完成日期:2015-12-7签收人:签收日期:修改情况记录:1云MAS平台HTTP开发说明1.1简介云MAS平台SDK HTTP版接口说明文档1.2背景系统名称:云MAS平台项目开发者:中国移动通信集团政企客户分公司1.3定义MT Message Terminal——下行短信,即向手机终端发送短信MO Message Original——上行短信,即手机用户向特服号码发送短信1.4环境服务器具有直连访问互联网的能力。
并且提供HTTP Server接收比较报告,状态报告,上行短信。
1.5云MAS平台与HTTP客户端数据交互流程SDK收到的返回值说明:➢“1.返回提交状态”,说明云MAS是否收到HTTP提交的数据;数据还未提交行业网关;➢“4.返回审核结果”,说明云MAS已经对提交内容进行了审核;数据还未提交行业网关;➢“7.返回短信回复”,短信已经提交网关;➢“10.返回短信回执”,短信已被网关下发;*因平台有流控设置,需要进行多条短信连续提交时,为保证提交速度和效率,请按照“1.返回提交状态”返回值判断是否提交下一条;2数据结构说明2.1MT提交报告数据结构●类型(TYPE):JSON●用途用于内部,跟踪短信状态,不能用于判断短信是否正确送达,2.2MT状态报告数据结构●类型(TYPE):JSON●用途保存状态报告接口函数返回的短信内容,不能用于判断短信2.3MO数据结构●类型(Type):JSON3功能介绍及使用3.1身份验证●功能介绍企业必须通过身份验证才能进行短信发送,身份验证用户名、密码和集团客户名称完成。
●请求申明测试环境:.13:80/app/http/authorize正式环境:.cn/app/http/authorize●●3.2发送普通短信HTTP客户端向云MAS平台发送请求,带上相应的请求参数,云MAS 平台接收请求,并进行验证,验证通过后进行短信发送。
XXX短信二次开发接口说明(HTTP接口)用户:XXX密码:XXXX更改密码ChangePassword输入参数输出参数:调用方式:http://XXXXX:8080/ChangePassword.asp?Account=***&Password=***&NewPassword=*** 查询余额GetBalance输入参数输出参数:调用方式:http://XXXX:8080/GetBalance.asp?Account=***&Password=***&Channel=*** Channel代码:1 - 106全网广告通道2 - 0713全网广告通道3 - 1069全网行业应用通道4 - 1065全网行业应用通道群发短信 SendSMS(返回状态报告ID)输入参数:输出参数:备注:这个功能执行成功返回的id号作为批号,记录后,使用GetReport功能可以获取到该发送批号和这批内的各手机号的状态报告。
调用方式:http://XXXX:8000/SendSms.asp?Account=***&Password=***&Phones=***&Content=***&Channel=***& SendTime=*Channel代码:1 - 106全网广告通道2 - 0713全网广告通道3 - 1069全网行业应用通道4 - 1065全网行业应用通道接收短信发送状态报告接口 GetReport输入参数输出参数:返回格式为:ID+'$$$$'+号码+''$$$$'+时间+'$$$$'+报告标志+'$$$$'+报告+'||||' ID+'$$$$'+号码+''$$$$'+时间+'$$$$'+报告标志+'$$$$'+报告+'||||'……调用方式:http://XXXX:8000/GetReport.asp?Account=***&Password=***接收短信 GetMessage输入参数输出参数:返回格式为:手机号$$$$上行内容$$$$发送时间||||手机号$$$$上行内容$$$$发送时间||||……调用方式:http://XXX:8000/GetMessage.asp?Account=***&Password=***。
发送短信稳定的短信API来啦稳定的短信API,99%到达率,及时响应,请务必添加图片验证码等防恶意攻击的机制,以防短信轰炸。
!注意:同1个号码同1个签名的内容30秒内只能发1条,1分钟内只能发2条,30分钟内只能发3条,详细请参考:/news/index/id/50接口名称:短信api接口平台:聚合数据接口地址:/sms/send支持格式:json/xml请求方式:http get请求示例:/sms/send?mobile=手机号码&tpl_id=短信模板ID&tpl_value=%23code%23%3D654654&key=请求参数说明:名称类型必填说明mobile string 是接收短信的手机号码tpl_id int 是短信模板ID,请参考个人中心短信模板设置tpl_value string 是变量名和变量值对,如:#code#=431515,整串值需要urlencode。
如果你的变量名或者变量值中带有#&=中的任意一个特殊符号,请先分别进行utf-8 urlencode编码后再传递key string 是应用APPKEY(应用详细页查询)dtype string 否返回数据的格式,xml或json,默认json 返回参数说明:名称类型说明error_code int 返回码reason string 返回说明短信api调用JSON返回示例:/****失败示例**/{"reason": "错误的短信模板ID,请通过后台确认!!!","result": [],"error_code": 205402}/****成功示例**/{"reason": "短信发送成功","result": {"count": 1, /*发送数量*/"fee": 1, /*扣除条数*/"sid": 2029865577 /*短信ID*/ },"error_code": 0 /*发送成功*/}。
HTTP接口说明文档
接口地址:http://203.171.227.208:9876/plan/Api/
请先读这里:
通过API提交参数时, 参数内容编码必须为GB2312, 且经过url编码
例如:“您好”的url编码为“%C4%FA%BA%C3”
API返回的内容是一些键值对的字符串集合,形式为:“k1=v1&k2=v2&k3=v3…”
返回内容中的键值显示为url编码形式, 经过url解码后的键值是GB2312编码的字符串
例如:
返回内容“result=0&description=%B7%A2%CB%CD%B3%C9%B9%A6&faillist=”表示的实际内容为“result=0&description=发送成功&faillist=”
1、发送短信
功能描述:短信发送
调用格式:http://203.171.227.208:9876/plan/Api/Send.aspx?username=用户名&password=密码&mobiles=手机号码&content=内容&f=1
返回格式:result=&description=错误描述&faillist=失败号码列表
注:faillist 列表中的号码间隔为英文”,”
返回值:
2、修改密码
功能描述:修改密码
调用格式:http://203.171.227.208:9876/plan/Api/ChgPwd.aspx?username=用户名&password=密码&newpwd=新密码
返回格式:result=&description=错误描述
参数说明:
返回值:
3、查询余额
功能描述:查询余额
调用格式:http://203.171.227.208:9876/plan/Api/Query.aspx?username=用户名&password=密码
返回格式:result=返回值&balance=条数&description=错误描述
注意: 当返回值为0时才同时返回条数
参数说明:
返回值:
4.短信接收
功能描述:收取回复的短信,账号需开通回复功能。
调用格式:http://203.171.227.208:9876/plan/Api/recv.aspx?username=用户名&password=密码&from=起始日期&read=状态
返回格式:result=状态码&description=状态码说明&count=短信数量&itemi=内容
I的取值:0-count的数量,即:item1,item2,item3分别表示第一,第二,第三条回复的短信。
注意: 当返回值为0时才同时返回回复短信。