接口说明:客户接口部分提供http url方式的接口,根据客户需求可以提供相应接口,接口编码方式采用统一的UTF-8(IP地址请联系QQ索取)

发送接口

1,请求地址

请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址分别是:

UTF-8:

  1. http://xxx.xxx.xxx.xxx:xxxx/sms.aspx

GB2312

  1. http://xxx.xxx.xxx.xxx:xxxx/smsGBK.aspx

2,参数说明

参数名称

含义

参数说明

userid

企业id

企业ID,在我的信息里查看,找不到请联系客服

account

发送用户帐号

用户帐号

password

发送帐号密码

用户账号对应的密码

mobile

全部被叫号码

发信发送的目的号码.多个号码之间用半角逗号隔开

content

发送内容

短信的内容,内容需要UTF-8编码

sendTime

定时发送时间

为空表示立即发送,定时发送格式2010-10-24 09:08:10

action

发送任务命令

设置为固定的:send

extno

扩展子号

请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多5位数。

 

3,接口举例

  1. action=send&userid=12&account=账号&password=密码&mobile=13812341234,13912341234&content=您的订单已发货,请注意查收【XX网】&sendTime=&extno=

4,返回值

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

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <returnsms>
  3. <returnstatus>status</returnstatus> ---------- 返回状态值:成功返回Success 失败返回:Faild
  4. <message>message</message> ---------- 返回信息:见下表“接口返回信息”
  5. <remainpoint> remainpoint</remainpoint> ---------- 返回余额
  6. <taskID>taskID</taskID>  -----------  返回本次任务的序列ID
  7. <successCounts>successCounts</successCounts> --成功短信数:当成功后返回提交成功短信数
  8. </returnsms>

 

接口返回信息

返回信息提示

说明

OK

提交成功

用户名或密码不能为空

提交的用户名或密码为空,检查是否漏写

发送内容包含sql注入字符

内容里包含一些特殊符号

用户名或密码错误

用户名密码有错,请检查

短信号码不能为空

提交的被叫号码为空,没有填写号码

短信内容不能为空

发送内容为空,没有填写内容

包含非法字符

表示检查到不允许发送的非法字符

对不起,您当前要发送的量大于您当前余额

余额不足,请联系充值

其他错误

其他数据库操作方面的错误

 

余额及已发送量查询接口

1,请求地址

UTF-8:

  1. http://xxx.xxx.xxx.xxx:xxxx/sms.aspx

GB2312

  1. http://xxx.xxx.xxx.xxx:xxxx/smsGBK.aspx

入口地址一般不会发生变化,当发生变化的时候,会通知接口用户

 

2,举例

  1. action=overage&userid=123&account=账号&password=密码

 

3,参数说明

参数名称

含义

参数说明

userid

企业id

企业ID

account

用户帐号

用户帐号

password

帐号密码

用户账号对应的密码

action

任务名称

设置为固定的:overage

 

4,返回值

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <returnsms>
  3. <returnstatus>status</returnstatus>-------返回状态值:成功返回Success 失败返回:Faild
  4. <message>message</message>--------------返回信息提示:见下表
  5. <payinfo>payinfo</payinfo>--------------返回支付方式  后付费,预付费
  6. <overage>overage</overage>-------------返回余额
  7. <sendTotal>sendTotal</sendTotal>----返回总点数  当支付方式为预付费是返回总充值点数
  8. </returnsms>

 

返回信息提示

说明

返回空

查询成功,将返回相应的支付方式、账户使用条数、总充值点数

用户名或密码不能为空

提交的用户名或密码为空,检查是否漏写

用户名或密码错误

用户名密码有错,请检查

 

非法关键词查询

1,请求地址

UTF-8:

  1. http://xxx.xxx.xxx.xxx:xxxx/sms.aspx

GB2312

  1. http://xxx.xxx.xxx.xxx:xxxx/smsGBK.aspx

入口地址一般不会发生变化,当发生变化的时候,会通知接口用户

 

2,参数说明

参数名称

含义

参数说明

userid

企业id

企业ID

account

发送用户帐号

用户帐号

password

发送帐号密码

用户账号对应的密码

action

任务名称

设置为固定的:checkkeyword

content

检测发送内容

需要发送的内容

 

3,举例

  1. action=checkkeyword&userid=12&account=账号&password=密码&content=内容

 

4,返回值

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <returnsms>
  3. <message>message</message>--------------返回信息提示:见下表
  4. </returnsms>

返回信息提示

说明

OK

提交成功

用户名或密码不能为空

提交的用户名或密码为空,检查是否漏写

用户名或密码错误

用户名密码有错,请检查

包含非法字符

检查出来包含非法关键词

未包含非法字符

未检查出非法关键词

 

 

状态报告接口

1,请求地址

请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是

  1. http://xxx.xxx.xxx.xxx:xxxx/statusApi.aspx

入口地址一般不会发生变化,当发生变化的时候,会通知接口用户

 

2,参数说明

参数名称

含义

参数说明

userid

企业id

企业ID

account

用户帐号

用户帐号

password

帐号密码

用户账号对应的密码

action

任务命令

设置为固定的:query

 

3,举例

  1. action=query&userid=12&account=账号&password=密码

4,返回值

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <returnsms>
  3. <statusbox>
  4. <mobile>13800000000</mobile>-------------对应的手机号码
  5. <taskid>1234</taskid>-------------同一批任务ID
  6. <status>10</status>---------状态报告----10:发送成功,20:发送失败
  7. <receivetime>2016-12-02 22:12:11</receivetime>-------------接收时间
  8. <errorcode>DELIVRD</errorcode>-上级网关返回值,不同网关返回值不同,仅作为参考
  9. </statusbox>
  10. </returnsms>

更多网关返回值可以参考

常见短信网关错误代码对照查询表

电信联通移动短信网关错误代码大全

中国移动MK类短信网关错误代码表

 

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

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <returnsms>
  3. <errorstatus>
  4. <error>1</error>-------------错误码
  5. <remark>用户名或密码不能为空</remark>-------------错误描述
  6. </errorstatus>
  7. </returnsms>

error可能情况

1:用户名或密码不能为空

2:用户名或密码错误

3:该用户不允许查看状态报告

4:参数不正确

 

上行接口

1,请求地址

请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是

  1. http://xxx.xxx.xxx.xxx:xxxx/callApi.aspx

入口地址一般不会发生变化,当发生变化的时候,会通知接口用户

 

2,参数说明

参数名称

含义

参数说明

userid

企业id

企业ID

account

用户帐号

用户帐号

password

帐号密码

用户账号对应的密码

action

任务命令

设置为固定的:query

 

3,举例

  1. action=query&userid=12&account=账号&password=密码

 

4,返回值

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <returnsms>
  3. <callbox>
  4. <mobile>13912345678</mobile>-------------对应的手机号码
  5. <taskid>1065</taskid>-------------同一批任务ID
  6. <content>谢谢,我报名</content>---------上行内容
  7. <receivetime>2016-10-02 22:12:11</receivetime>-------------接收时间
  8. </callbox>
  9. </returnsms>

 

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

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <returnsms>
  3. <errorstatus>
  4. <error>1</error>-------------错误码
  5. <remark>用户名或密码不能为空</remark>-------------错误描述
  6. </errorstatus>
  7. </returnsms>

错误码:

1:用户名或密码不能为空

2:用户名或密码错误

3:该用户不允许查看状态报告

4:参数不正确

 

参照以上接口内容基本上可以轻松完成对接,这里也贴出不同语言下的实例供大家参考,翻下页即可

PHP实例参考

  • onesmser短信平台API接口说明已关闭评论
  • 340
    A+