客户接口说明_第1页
客户接口说明_第2页
客户接口说明_第3页
客户接口说明_第4页
已阅读5页,还剩4页未读, 继续免费阅读

付费下载

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

1、客户接口说明客户接口说明1第一章发送接口21.1 请求地址21.2 参数说明21.3 返回值3第二章余额及已发送量查询接口32.1 请求地址32.2 参数说明32.3 返回值4第三章非法关键词查询53.1 请求地址53.2 参数说明53.3 返回值5第四章状态报告接口64.1 请求地址64.2 参数说明64.3 返回值64.4 错误返回值状态报告请求错误返回格式及对应值7第五章上行接口85.1 请求地址85.2 参数说明85.3 返回值85.4 错误返回值回复请求错误返回格式及对应值9第六章密码修改接口错误!未定义书签。6.1 请求地址错误!未定义书签。6.2 参数说明错误!未定义书签。6.3

2、 返回值错误!未定义书签。接口说明:客户接口部分提供http url 方式的接口,根据客户需求可以提供相应接口。第一章发送接口1.1 请求地址请求地址是客户接口程序调用时请求的 url 地址,采用的是 http post 接口,地址是 http:/ 客户端地址 /v2sms.aspx 对应 UTF-8http:/客户端地址 /v2smsGBK.aspx 对应 GB2312入口地址一般不会发生变化,当发生变化的时候,会通知接口用户1.2 参数说明http:/客户端地址 /v2sms.aspxhttp:/客户端地址 /v2smsGBK.aspx参数名称含义说明userid企业 id企业 IDtim

3、estamp时间戳系统当前时间字符串,年月日时分秒,例如:20120701231212sign签名使用 账号 +密码 +时间戳 生成 MD5字符串作为签名。 MD5 生成 32 位,且需要小写例如:账号是 test密码是 mima时间戳是 20120701231212就需要用 testmima20120701231212来生成 MD5 的签名,生成的签名为5cc68982f55ac74348e3d819f868fbe1mobile全部被叫号码发信发送的目的号码.多个号码之间用半角逗号隔开content发送内容短信的内容,内容需要 UTF-8 编码sendTime定时发送时间为空表示立即发送,定

4、时发送格式2010-10-2409:08:10action发送任务命令设置为固定的 :sendextno扩展子号请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多10位数。例如:内容&sendTime=&extno=1.3 返回值在接收到客户端发送的http 请求后,返回以xml 的方式返回处理结果。格式为:status -返回状态值:成功返回Success 失败返回: Faildmessage - 返回信息: 见下表 remainpoint -返回余额taskID-返回本次任务的序列IDsuccessCounts -成功短信数: 当成功后返回提交成功短信数返回信息

5、提示说明ok提交成功用户名或密码不能为空提交的用户名或密码为空发送内容包含 sql 注入字符包含 sql 注入字符用户名或密码错误表示用户名或密码错误短信号码不能为空提交的被叫号码为空短信内容不能为空发送内容为空包含非法字符:表示检查到不允许发送的非法字符对不起,您当前要发送的量大于您当前余额当支付方式为预付费是,检查到账户余额不足其他错误其他数据库操作方面的错误第二章余额及已发送量查询接口2.1 请求地址请求地址是客户接口程序调用的时候请求的url 地址,采用的是http post 接口,地址是http:/客户端地址 /v2sms.aspxhttp:/客户端地址 /v2smsGBK.aspx

6、入口地址一般不会发生变化,当发生变化的时候,会通知接口用户2.2 参数说明参数名称含义说明userid企业 id企业 IDtimestamp时间戳系统当前时间字符串,年月日时分秒,例如:20120701231212sign签名使用 账号 +密码 +时间戳 生成 MD5字符串作为签名。 MD5 生成 32 位,且需要小写例如:账号是 test密码是 mima时间戳是 20120701231212就需要用 testmima20120701231212来生成 MD5 的签名,生成的签名为5cc68982f55ac74348e3d819f868fbe1action任务名称设置为固定的: overage

7、例如:action=overage&userid=12×tamp=20120701231212&sign=5cc68982f55ac74348e3d819f868fbe12.3 返回值status- 返回状态值:成功返回Sucess,和其它接口返回的Success不同 )失败返回: FaildSucess (注意:此处是message- 返回信息提示:见下表payinfo-返回支付方式后付费,预付费overage- 返回余额sendTotal-返回总点数当支付方式为预付费是返回总充值点数返回信息提示说明返回空用户名或密码不能为空查询成功将返回相应的支付方式、账户使用条数、总充值点数提

8、交的用户名或密码为空用户名或密码错误表示用户名或密码错误第三章非法关键词查询3.1 请求地址请求地址是客户接口程序调用的时候请求的url 地址,采用的是http post 接口,地址是http:/客户端地址 /v2sms.aspxhttp:/客户端地址 /v2smsGBK.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户3.2 参数说明参数名称含义说明userid企业 id企业 IDtimestamp时间戳系统当前时间字符串,年月日时分秒,例如:20120701231212sign签名使用 账号 +密码 +时间戳 生成 MD5字符串作为签名。 MD5 生成 32 位,且需要小

9、写例如:账号是 test密码是 mima时间戳是 20120701231212就需要用 testmima20120701231212来生成 MD5 的签名,生成的签名为5cc68982f55ac74348e3d819f868fbe1action任务名称设置为固定的: checkkeywordcontent检测发送内容需要发送的内容例如:内容3.3 返回值message-返回信息提示:见下表返回信息提示说明用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误包含非法字符检查出来包含非法关键词没有包含屏蔽词未检查出非法关键词第四章状态报告接口4.1 请求地址请求地址是客户

10、接口程序调用的时候请求的url 地址,采用的是http post 接口,地址是http:/客户端地址 /v2statusApi.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户注意: 相同的状态报告,只能获取一次。4.2 参数说明参数名称含义说明userid企业 id企业 IDtimestamp时间戳系统当前时间字符串,年月日时分秒,例如:20120701231212sign签名使用 账号 +密码 +时间戳 生成 MD5字符串作为签名。 MD5 生成 32 位,且需要小写例如:账号是 test密码是 mima时间戳是 20120701231212就需要用 testmima20

11、120701231212来生成 MD5 的签名,生成的签名为5cc68982f55ac74348e3d819f868fbe1statusNum每次取得号码数必须为数字,默认 4000,可不填action任务名称设置为固定的: query例如:=5cc68982f55ac74348e3d819f868fbe14.3 返回值对应的手机号码1212-同一批任务ID10- 状态报告 -10 :发送成功, 20:发送失败2011-12-02 22:12:11-接收时间DELIVRD-上级网关返回值,不同网关返回值不同,仅作为参考01-子号,即自定义扩展号1212202011-12-02 22:12:11

12、24.4 错误返回值状态报告请求错误返回格式及对应值1-错误码 用户名或密码不能为空-错误描述1:用户名或密码不能为空2:用户名或密码错误3:该用户不允许查看状态报告4:参数不正确第五章上行接口5.1 请求地址请求地址是客户接口程序调用的时候请求的url 地址,采用的是http post 接口,地址是http:/客户端地址 /v2callApi.aspx入口地址一般不会发生变化,当发生变化的时候,会通知接口用户注意: 相同的上行回复,只能获取一次。5.2 参数说明参数名称含义说明userid企业 id企业 IDtimestamp时间戳系统当前时间字符串,年月日时分秒,例如:20120701231212sign签名使用 账号 +密码 +时间戳 生成 MD5字符串作为签名。 MD5 生成 32 位,且需要小写例如:账号是 test密码是 mima时间戳是 20120701231212就需要用 testmima20120701231212来生成 MD5 的签名,生成的签名为5cc68982f55ac74348e3d819f868fbe1action任务名称设置为固定的: query例如:=5cc68982f55ac74348e3d819f868fbe1

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论