




版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
1、客户接口说明客户接口说明1第一章 发送接口21.1 请求地址21.2参数说明21.3返回值2第二章 余额及已发送量查询接口32.1 请求地址32.2参数说明32.3返回值3第三章 非法关键词查询43.1 请求地址43.2参数说明43.3返回值4第四章 状态报告接口54.1 请求地址54.2参数说明54.3返回值54.4错误返回值状态报告请求错误返回格式及对应值6第五章 上行接口65.1 请求地址65.2参数说明65.3返回值75.4错误返回值回复请求错误返回格式及对应值7接口说明:客户接口部分提供http url方式的接口,根据客户需求可以提供相应接口,接口编码方式采用统一的UTF-8第一章
2、发送接口1.1 请求地址请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是http:/客户端地址/sms.aspx 对应UTF-8http:/客户端地址/smsGBK.aspx 对应GB2312入口地址一般不会发生变化,当发生变化的时候,会通知接口用户1.2参数说明http:/客户端地址/sms.aspxhttp:/客户端地址/smsGBK.aspx参数名称含义说明userid企业id企业IDaccount发送用户帐号用户帐号,由系统管理员password发送帐号密码用户账号对应的密码mobile全部被叫号码发信发送的目的号码.多个号码之间用半角逗号隔开 c
3、ontent发送内容短信的内容,内容需要UTF-8编码sendTime定时发送时间为空表示立即发送,定时发送格式2010-10-24 09:08:10action发送任务命令设置为固定的:sendextno扩展子号请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多5位数。例如:action=send&userid=12&account=账号&password=密码&mobileamp;content=内容&sendTime=&extno=1.3返回值在接收到客户端发送的http请求后,返回以x
4、ml的方式返回处理结果。格式为:<?xml version="1.0" encoding="utf-8" ?><returnsms><returnstatus>status</returnstatus> - 返回状态值:成功返回Success 失败返回:Faild<message>message</message> - 返回信息:见下表<remainpoint> remainpoint</remainpoint> - 返回余额<taskID>tas
5、kID</taskID> - 返回本次任务的序列ID<successCounts>successCounts</successCounts> -成功短信数:当成功后返回提交成功短信数</returnsms>返回信息提示说明ok提交成功用户名或密码不能为空提交的用户名或密码为空发送内容包含sql注入字符包含sql注入字符用户名或密码错误表示用户名或密码错误短信号码不能为空提交的被叫号码为空短信内容不能为空发送内容为空包含非法字符:表示检查到不允许发送的非法字符对不起,您当前要发送的量大于您当前余额当支付方式为预付费是,检查到账户余额不足其他错误其他
6、数据库操作方面的错误第二章 余额及已发送量查询接口2.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是http:/客户端地址/sms.aspxhttp:/客户端地址/smsGBK.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户2.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:overage例如:action=overage&userid=12&account=账号&pass
7、word=密码2.3返回值<?xml version="1.0" encoding="utf-8" ?><returnsms><returnstatus>status</returnstatus>-返回状态值:成功返回Success 失败返回:Faild<message>message</message>-返回信息提示:见下表<payinfo>payinfo</payinfo>-返回支付方式 后付费,预付费<overage>overage</
8、overage>-返回余额<sendTotal>sendTotal</sendTotal>-返回总点数 当支付方式为预付费是返回总充值点数</returnsms>返回信息提示说明返回空查询成功将返回相应的支付方式、账户使用条数、总充值点数用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误第三章 非法关键词查询3.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是http:/客户端地址/sms.aspxhttp:/客户端地址/smsGBK.aspx入口地址一般不会发生变化,当发
9、生变化的时候,会通知接口用户3.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:checkkeywordcontent检测发送内容需要发送的内容例如:action=checkkeyword&userid=12&account=账号&password=密码&content=内容3.3返回值<?xml version="1.0" encoding="utf-8" ?><returnsm
10、s><message>message</message>-返回信息提示:见下表</returnsms>返回信息提示说明用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误包含非法字符检查出来包含非法关键词未包含非法字符未检查出非法关键词第四章 状态报告接口4.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是http:/客户端地址/statusApi.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户4.2参数说明参数名称含义说明userid企业id企业IDac
11、count用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:query例如:action=query&userid=12&account=账号&password=密码4.3返回值<?xml version="1.0" encoding="utf-8" ?> <returnsms><statusbox><mobile>lt;/mobile>-对应的手机号码<taskid>1212</
12、taskid>-同一批任务ID<status>10</status>-状态报告-10:发送成功,20:发送失败<receivetime>2011-12-02 22:12:11</receivetime>-接收时间<errorcode>MK:0011</errorcode>-状态返回值</statusbox><statusbox><mobile>lt;/mobile><taskid>1212</taskid><status&
13、gt;20</status><receivetime>2011-12-02 22:12:11</receivetime><errorcode>DELIVRD</errorcode>-状态返回值</statusbox></returnsms>4.4错误返回值状态报告请求错误返回格式及对应值<?xml version="1.0" encoding="utf-8" ?> <returnsms><errorstatus><error>
14、;1</error>-错误码<remark>用户名或密码不能为空</remark>-错误描述</errorstatus></returnsms>1:用户名或密码不能为空2:用户名或密码错误3:该用户不允许查看状态报告4:参数不正确第五章 上行接口5.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是http:/客户端地址/callApi.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户5.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户
15、帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:query例如:action=query&userid=12&account=账号&password=密码5.3返回值<?xml version="1.0" encoding="utf-8" ?> <returnsms><callbox><mobile>lt;/mobile>-对应的手机号码<taskid>1212</taskid>-同一
16、批任务ID<content>你好,我不需要</content>-上行内容<receivetime>2011-12-02 22:12:11</receivetime>-接收时间</callbox><callbox><mobile>lt;/mobile><taskid>1212</taskid><content>你好,本次活动路线是怎么的</content><receivetime>2011-12-02 22:12:11</receivetime></callbox></returnsms>5.4错误返回值回复请求错误返回格式及对应值<
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 宁波市鄞州区公立学校招聘考试真题2024
- 行政管理的公共关系学国际视角试题及答案
- 2025年工程项目管理实战试题及答案
- 工程项目协调能力考核试题及答案
- 工程项目的预算审核过程试题及答案
- 公共关系学对品牌公信力的影响及试题及答案
- 学习方法2025年中级经济师试题及答案
- 高校学子职途规划争霸
- 公共关系角色转换与适应性试题及答案
- 第21课 《三黑和土地》 课件
- 三年级小机灵杯试题(常用版)
- 2022年中国热带农业科学院分析测试中心高层次人才及博士招聘笔试备考题库及答案解析
- 闪存存储技术应对大数据挑战
- 科普项目申报书-中国科协
- 食蚜蝇课件完整版
- 主题班会《中国梦我的梦》课件
- 义务教育数学新课程标准选择题题库测试卷精选450题(2022版)含答案
- 古诗词诵读《客至》-统编版高中语文选择性必修下册
- 建筑材料分类整理
- YY/T 0801.2-2010医用气体管道系统终端第2部分:用于麻醉气体净化系统的终端
- GB/T 31349-2014节能量测量和验证技术要求中央空调系统
评论
0/150
提交评论