400-820-3031
support@c8686.com
021-33772385
八优短信网2.0隆重推出!

短信接口文档

接口语言 SDK包 接口语言 SDK包
Java接口 下载 Python接口 下载
C#接口 下载 PHP接口 下载
kotlin接口 下载 NodeJs接口 下载
golang接口 下载 Ruby接口 下载
ExcelVBA接口 下载 VB6.0接口 下载
Win c/c++接口 下载 Groovy接口 下载

接口说明:

关键项 说明
http提交方式 提交推荐试用POST方式 如果使用GET方式则只能转化到字符集GB2312
Content-Type application/x-www-form-urlencoded
支持字符集: 接口支持:utf8/gbk/gb2312
提交参数: 提交参数使用key=value&key1=value方式
返回数据: 返回数据为XML结构

提交短信接口概述:

关键项 说明
提交方式: http post
支持字符集: utf8/gbk/gb2312
提交链接:
  • https://sms.c8686.com/smsapi/Send/gb2312
  • https://sms.c8686.com/smsapi/Send/utf8
  • https://sms.c8686.com/smsapi/Send/gbk

说明:提交链接支持的字符集不同,具体根据链接尾部来区分,/gb2312支持字符集GB2312,其他依次类推

参数名称 提交参数说明 必填
apikey 平台方提供 Y
timestamp unix时间戳(从1970年1月1日00:00:00到当前格林威治时间段的秒数)

不同语言函数及计算方式有所不同,参考个语言sdk

Y
mobiles 要发送短信手机号码,多个用英文逗号隔开,每次提交的号码个数控制在300内 Y
message 发送的短信内容 Y
sendtime 发送短信到接收方的时间,如果不设置该参数,短信会立即方。 格式: yyyyMMddHHmmss N
digest 提交加密签名 生成规则: MD5(APISECRET+MOBILES+TIMESTAMP)

APPSECRET为平台方提供,MOBILES 是提交参数mobiles,TIMESTAMP是提交参数 timestamp , 具体参数SDK。

Y
返回信息说明:
正确返回:
<?xml version=\"1.0\" encoding=\"gb2312\"?>
<response>
  <errorcode>0</errorcode>
  <errordescription>成功</errordescription>
  <msgcount>剩余条数</msgcount>
  <time>2019-09-18 10:00:00</time>
  <orderno>c975938470914e7482df9b65fb203af5</orderno>
</response>
                          

说明:正确返回错误码 errocode 为: 0
orderno是本次提交的唯一标识,用来后续更新状态。 平台在推送状态时,将推送 orderno 与 相应的手机号码,参考 状态推送

失败返回:
<?xml version=\"1.0\" encoding=\"gb2312\"?>
<response>
  <errorcode>错误码</errorcode>
  <errordescription>错误描述内容</errordescription>
  <time>2019-09-18 11:00:00</time>
  <msgcount>0</msgcount>
</response>

说明: 失败返回 错误码: 非0,错误信息在errordescription节点有说明

删除定时接口概述:

关键项 说明
提交方式: http post
支持字符集: utf8/gbk/gb2312
提交链接:
  • https://sms.c8686.com/smsapi/deleteTimer/utf8
  • https://sms.c8686.com/smsapi/deleteTimer/gbk
  • https://sms.c8686.com/smsapi/deleteTimer/gb2312
参数名称 提交参数说明 必填
apikey 平台方提供 Y
timestamp unix时间戳(从1970年1月1日00:00:00到当前格林威治时间段的秒数)

不同语言函数及计算方式有所不同,参考个语言sdk

Y
orderno 提交短信时返回的订单号 参考 提交短信 Y
digest 提交加密签名 生成规则: MD5(APISECRET+ORDERNO+TIMESTAMP)

APPSECRET为平台方提供,ORDERNO 是提交短信返回的订单号(对应本次提交参数 orderno),TIMESTAMP是提交参数 timestamp , 具体参数SDK。

Y
返回信息说明:
正确返回:
<?xml version=\"1.0\" encoding=\"gb2312\"?>
<response>
  <errorcode>0</errorcode>
  <errordescription>删除成功</errordescription>
  <time>2019-09-18 10:00:00</time>
</response>
                          

说明:正确返回错误码 errocode 为: 0

失败返回:
<?xml version=\"1.0\" encoding=\"gb2312\"?>
<response>
  <errorcode>错误码</errorcode>
  <errordescription>错误描述内容</errordescription>
  <time>2019-09-18 11:00:00</time>
  <msgcount>0</msgcount>
</response>

说明: 失败返回 错误码: 非0,错误信息在errordescription节点有说明

推送状态概述:

关键项 说明
提交方式: http post
支持字符集: 用户后台设置
提交链接: 接收方提供 (用户后台设置)
推送内容:
<xml>
  <orders>
    <order>
      <mobile>手机号</mobile>
      <orderno>提交返回的订单号</orderno>
      <errorcode>0成功,其他失败</errorcode>
      <errormsg>成功或失败信息</errormsg>
      <smscount>短信条数</smscount>
    </order>
    <order>
      <mobile>手机号2</mobile>
      <orderno>提交返回的订单号2</orderno>
      <errorcode>0成功,其他失败</errorcode>
      <errormsg>成功或失败信息</errormsg>
      <smscount>短信条数</smscount>
    </order>
    </orders>
</xml>
                    

短信状态有一个或多个

接收返回信息
正确返回: success
失败返回: fail

推送上行(用户回复)概述:

关键项 说明
提交方式: http post
支持字符集: 用户后台设置
提交链接: 接收方提供 (用户后台设置)
推送内容:
<xml>
  <replies>
    <reply>
      <username>用户名</username>
      <mobile>手机号码</mobile>
      <msg>短信内容</msg>
      <receivetime>时间</receivetime>
    </reply>
    <reply>
      <username>用户名</username>
      <mobile>手机号码</mobile>
      <msg>短信内容</msg>
      <receivetime>时间</receivetime>
    </reply>
  </replies>
</xml>
                    

回复内容有一个或多个

接收返回信息
正确返回: success
失败返回: fail