您的位置:首页 >  接口中心 > 国际短信接口说明
  国际短信接口说明
 

定时短

1. 请求

(1) 求地址:

https://u.smsyun.cc/sms-partner/access/{用户帐号}/sendsms

注意:为了确保数据隐私和安全,用户需要通过Https Post方式请求,消息格式:json表达式。

(2) Https标准包头字段:

Accept:application/json;

Content-Type:application/json;charset=utf-8;

(3) 体:

属性

类型

约束

clientid

String

必选

帐号,6位,

如:a00012,b00012

password

String

必选

密码,8-12位,MD5加密后32位,写,

如:1bbd886460827015e5d605ed44252251

mobilelist

String

必选

发送手机号码,

国内短信不要加前缀,国际短信号码前须带相应的国家区号,如日本:0081,

支持多号码,号码之间用英文逗号隔开,最多10万个。

国内手机号码如:18612341234

国际号码如:0085265656565

接起来以后用compress_type中指定压缩类型压缩,然后用base64编码压缩后的数据

smstype

String

短信类型,

"0":通知短信,"4":验证码短信,"5":营销短信

content

String

必选

【签名】+ 短信内容,UTF-8编码,

信内容最长500个字(包括英文字母),其签名2-12(包括英文字母)

sendtime

String

 

时发送时间

定时发送格式2016-11-11 09:00:00,

定时发送时间距当前时间应该大于5分钟以上

extend

String

自扩展端口,

1-4位,只能为数字,可以为空

(注:请先询问配置的通道是否支持自扩展端口,如果不支持,请填空)

uid

String

用户透ID,

状态报告返回,最长60

compress_type

String

可选

默认为gzip压缩

"0": gzip压缩

① extend字段用于客户传送由客户自行分配给子客户的扩展端口,用于上行短信回来与之对应。

如:某客户下有A、B、C三个子客户,并且该客户获得某通道两位自扩展,分别对其子客户自行分配的扩展端口依次为子客户A01,子客户B:02,子客户C:03

若子客户A在发送下行短信时将该扩展端口01填入此字段即可,上行短信将会把此字段的扩展端口01发给客户,用于客户区分哪个子客户的上行短信,子客户A可根据上行短信中的电话号码对应之前的下行手机号码;

② uid字段用户在单、群发短信时,由用户生成并下发到平台的序列号(最长不超过60位),该uid将在应答状态报告中返回给客户,用于客户区分或对应单、群发短信的批次。

 

定时短信一次最多设置10万个号码(目前不支持多内容组发)。

(4) JSON请求示例:

{

"clientid":"test",

"password":"6918d0046aab6a1ee290f751e02bd0b2",

"mobilelist":"H4sICGUEPloAA3Bob25lLmxpc3QATdo7bmNJEEXBDbUxWZW/2v/GmmxgwJCjpPD0rncMIuK/fz.",

"smstype":"4",

"content":"云通讯您的验证码为1234",

"sendtime":"2018-11-11 09:00:00",

"extend":"00",

"uid":"00",

"compress_type":"0"

}

 

包头/包体

实例

备注

Header

POST /sms-partner/access/test/timer_send_sms HTTP/1.1

Accept-Encoding:identity

Content-Length:191

Host:172.16.5.20:9999

Accept:application/json

Content-Type:application/json;charset=utf-8

色字体为可变部分

保证路径正确,采用HTTPSPOST方式发送

Body

{"clientid":"test","password":"6918d0046aab6a1ee290f751e02bd0b2","mobilelist":"H4sICGUEPloAA3Bob25lLmxpc3QATdo7bmNJEEXBDbUxWZW/2v/GmmxgwJCjpPD0rncMIuK/fz","smstype":"4" ,"content":"云通讯】您的验证码为1234","sendtime":"2018-11-11 09:00:00", "extend":"00", "uid":"00","compress_type":"0"}

色字体为可变部分

 

2. 

(1) 响应包体:

属性

类型

约束

total_fee

Int

必选

短信发送的计费总条数

sid2

String

短信标识符(sid + 手机用于匹配状态报告),

定时短信手机号对应一个sid

uid3

String

用户透ID,

状态报告返回

comporess_type

String

可选

返回号码列表使用的压缩算法

默认gzip:

0: gzip

data



送的详细情况

code

Int

必选

短信请求响应返回码

参考请求响应返回定义的返回码

(详见第九章第1节)

msg

String

必选

短信请求响应返回中文描述,

参考请求响应返回定义的中文描述

(详见第九章第1节)

mobilelist

String

code=-7或code=-30时存在,表示code对应号码列表(同样使用compress_type指定类型压缩+base64编码);

code为其它时无此

mobilecnt

Int

code=0code=-7或code=-30时存在,表code对应的号码个数

code为其它时无此

① total_fee表示单短(长)短信总共计费的条数,该条数等于单条短信计费条数X所有成功返回的号码数

② sid是短信平台产生的唯一标示与后面返回的状态报告中的sid+手机号一一对应用于下发短息与状态报告相对应

③ uid字段返回内容和第一章第1节请求中的“用户透ID”一致用于客户区分或对应单、群发短信的批次;

(2) JSON响应示例

{

"total_fee":200,

"sid":"08faf6-5728-438d-95ed-e0e0cec4fd37",

"uid":"1234",

"data":[

    {

    "code":0,

"msg":"成功",

"mobilecnt":200

},

    {

    "code":-7,

"msg":"手机号码格式错误",

"mobilelist":"H4sICGUEPloAA3Bob25lLmxp.",

"mobilecnt":4

}

   ]

}

 

包头/包体

实例

备注

Header

HTTP/1.1 200 OK

Accept-Encoding:identity

Content-Length:424

Host:172.16.5.21:45302

Accept:application/json

Content-Type:application/json;charset=utf-8

色字体为可变部分

Body

{"total_fee":200,"sid":"08faf6-5728-438d-95ed-e0e0cec4fd37","uid":"1234",data":[{"code":0,"msg":"发送成功", "mobilecnt":200},{"code":-7,"msg": "手机号码格式错误","fee":0,"mobilelist":"1843123454,1843123454,22344433,21822222","mobilecnt":4]}

色字体为可变部分