




版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
1、客户接口说明客户接口说明1第一章 发送接口21.1 请求地址21.2参数说明21.3返回值2第二章 余额及已发送量查询接口32.1 请求地址32.2参数说明32.3返回值4第三章 非法关键词查询43.1 请求地址43.2参数说明43.3返回值5第四章 状态报告接口54.1 请求地址54.2参数说明54.3返回值54.4错误返回值状态报告请求错误返回格式及对应值6第五章 上行接口75.1 请求地址75.2参数说明75.3返回值75.4错误返回值回复请求错误返回格式及对应值8第六章 密码修改接口86.1 请求地址86.2参数说明86.3返回值9接口说明:客户接口部分提供http url方式的接口,
2、根据客户需求可以提供相应接口。第一章 发送接口1.1 请求地址请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是25:5577/sms.aspx 对应UTF-825:5577/smsGBK.aspx 对应GB2312入口地址一般不会发生变化,当发生变化的时候,会通知接口用户1.2参数说明25:5577/sms.aspx25:5577/smsGBK.aspx参数名称含义说明userid企业id企业IDaccount发送用户帐号用户帐号
3、,由系统管理员password发送帐号密码用户账号对应的密码mobile全部被叫号码发信发送的目的号码.多个号码之间用半角逗号隔开 content发送内容短信的内容,内容需要UTF-8编码sendTime定时发送时间为空表示立即发送,定时发送格式2010-10-24 09:08:10action发送任务命令设置为固定的:sendextno扩展子号请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多10位数。例如:action=send&userid=12&account=账号&password=密码&mobile/p>
4、amp;content=内容&sendTime=&extno=1.3返回值在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:<?xml version="1.0" encoding="utf-8" ?><returnsms><returnstatus>status</returnstatus> - 返回状态值:成功返回Success 失败返回:Faild<message>message</message> - 返回信
5、息:见下表<remainpoint> remainpoint</remainpoint> - 返回余额<taskID>taskID</taskID> - 返回本次任务的序列ID<successCounts>successCounts</successCounts> -成功短信数:当成功后返回提交成功短信数</returnsms>返回信息提示说明ok提交成功用户名或密码不能为空提交的用户名或密码为空发送内容包含sql注入字符包含sql注入字符用户名或密码错误表示用户名或密码错误短信号码不能为空提交的被叫号码为空短
6、信内容不能为空发送内容为空包含非法字符:表示检查到不允许发送的非法字符对不起,您当前要发送的量大于您当前余额当支付方式为预付费是,检查到账户余额不足其他错误其他数据库操作方面的错误第二章 余额及已发送量查询接口2.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是25:5577/sms.aspx25:5577/smsGBK.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户2.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系
7、统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:overage例如:action=overage&userid=12&account=账号&password=密码2.3返回值<?xml version="1.0" encoding="utf-8" ?><returnsms><returnstatus>status</returnstatus>-返回状态值:成功返回Sucess (注意:此处是Sucess,和其它接口返回的Success不同)失败返回
8、:Faild<message>message</message>-返回信息提示:见下表<payinfo>payinfo</payinfo>-返回支付方式 后付费,预付费<overage>overage</overage>-返回余额<sendTotal>sendTotal</sendTotal>-返回总点数 当支付方式为预付费是返回总充值点数</returnsms>返回信息提示说明返回空查询成功将返回相应的支付方式、账户使用条数、总充值点数用户名或密码不能为空提交的用户名或密码为空用户名或
9、密码错误表示用户名或密码错误第三章 非法关键词查询3.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是25:5577/sms.aspx25:5577/smsGBK.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户3.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:checkkeywordcontent检测发送内容需要发送的内容例如:act
10、ion=checkkeyword&userid=12&account=账号&password=密码&content=内容3.3返回值<?xml version="1.0" encoding="utf-8" ?><returnsms><message>message</message>-返回信息提示:见下表</returnsms>返回信息提示说明用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误包含非法字符检查出来包含非法关键词没有包含屏
11、蔽词未检查出非法关键词第四章 状态报告接口4.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是25:5577/statusApi.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户注意:相同的状态报告,只能获取一次。4.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码statusNum每次取得号码数必须为数字,默认4000,可不填action任务名称设置为固定的:query例如:action=query&
12、amp;userid=12&account=账号&password=密码4.3返回值<?xml version="1.0" encoding="utf-8" ?> <returnsms><statusbox><mobile>lt;/mobile>-对应的手机号码<taskid>1212</taskid>-同一批任务ID<status>10</status>-状态报告-10:发送成功,20:发送失败<recei
13、vetime>2011-12-02 22:12:11</receivetime>-接收时间<errorcode>DELIVRD</errorcode>-上级网关返回值,不同网关返回值不同,仅作为参考<extno>01</extno>-子号,即自定义扩展号</statusbox><statusbox><mobile>lt;/mobile><taskid>1212</taskid><status>20</status>&
14、lt;receivetime>2011-12-02 22:12:11</receivetime><errorcode>2</errorcode><extno></extno></statusbox></returnsms>4.4错误返回值状态报告请求错误返回格式及对应值<?xml version="1.0" encoding="utf-8" ?> <returnsms><errorstatus><error>1<
15、/error>-错误码<remark>用户名或密码不能为空</remark>-错误描述</errorstatus></returnsms>1:用户名或密码不能为空2:用户名或密码错误3:该用户不允许查看状态报告4:参数不正确第五章 上行接口5.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是25:5577/callApi.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户注意:相同的上行回复,只能获取一次。5.2参数说明参数名称含义说明use
16、rid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:query例如:action=query&userid=12&account=账号&password=密码5.3返回值<?xml version="1.0" encoding="utf-8" ?> <returnsms><callbox><mobile>lt;/mobile>-对应的手机号码<taskid&g
17、t;1212</taskid>-同一批任务ID<content>你好,我不需要</content>-上行内容<receivetime>2011-12-02 22:12:11</receivetime>-接收时间<extno>01</extno>-子号,即自定义扩展号</callbox><callbox><mobile>lt;/mobile><taskid>1212</taskid><content>你好,本次活
18、动路线是怎么的</content><receivetime>2011-12-02 22:12:11</receivetime><extno>01</extno></callbox></returnsms>5.4错误返回值回复请求错误返回格式及对应值<?xml version="1.0" encoding="utf-8" ?> <returnsms><errorstatus><error>1</error>-错误码<remark>用户名或密码不能为空</remark>-错误描述</errorstatus></returnsms>1:用户名或密码不能为空2:用户名或密码错误3:该用户不允许查看状态报告4:参数不正确第六章 密码修改接口6.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是25:5577/sms.aspx25:5577/sm
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 资产配置中的信用风险管理技术与策略应用考核试卷
- 汽车制造产能调整策略考核试卷
- 船舶改装项目施工过程中的质量保障措施优化考核试卷
- 藤编家具行业人才培养与技术创新体系建设战略考核试卷
- 运动服装的智能纤维技术与发展趋势考核试卷
- 电机在电力市场运营中的应用考核试卷
- 连续搬运设备环境适应性设计方法研究进展考核试卷
- 艺术家作品的艺术风格演变与文化传承考核试卷
- 电气工程项目管理与协调考核试卷
- 电动机制造中的电机热保护技术考核试卷
- 换药术课件完整版本
- 中复神鹰碳纤维西宁有限公司年产14000吨高性能碳纤维及配套原丝建设项目环评报告
- 质量管理小组活动准则TCAQ10201-2020
- GB/T 43293-2022鞋号
- YC/T 215-2007烟草行业联运通用平托盘
- JJF 1751-2019菌落计数器校准规范
- GB/T 40805-2021铸钢件交货验收通用技术条件
- 中考历史-世界近现代国际关系复习课件
- 报价单模板及范文(通用十二篇)
- 五年级异分母分数加减法第一课时课件
- 幼儿绘本故事:什么都行的哈力船长
评论
0/150
提交评论