发送短信接口

v1.0.0

Base URLs:

发送单条短信接口

POST /api/sms/SendSMS

请求参数

名称
位置
类型
必选
说明

appkey

query

string

在后台获取到的appkey

timesTamp

query

string

当前时间戳,精度任意

signature

query

string

计算方法:

signature=md5(appkey+timesTamp+appsecret)

其中,appsecret的值需在管理后台获取,请注意数据安全

mobile

query

string

单个中国大陆手机号

smsSignId

query

string

审核通过的签名id

templateId

query

string

审核通过的签名templateId

subport

query

string

拓展端口,2~6位

最长支持12位,如果最终号码长度超长,会截取扩展码,请根据我司建议位数提交

随机填0,不需要请填写-1 该项需联系客户经理开通

sendTime

query

string

立即发送请填写now或留空

定时发送请填写时间,不小于15分钟(极速通道除外),不超过7天

格式 yyyy-MM-dd HH:mm:ss

body

body

array[string]

如果模板有变量,请按变量顺序填写

Body 请求参数示例

[
  "1234",
  "23564"
]

Header 请求参数

Key
Value

Content-Type

application/json

Accept

text/plain

返回示例

{
  "code": "40000",
  "sms_id": "19cb5fcc8-0cc3-4458-bc00-9052df642664-5459532",
  "receive_status": "0",
  "mobile": "18888888888",
  "port": "55201",
  "receive_code": "2",
  "fee": "1",
  "msg": "成功",
  "send_time": "2023-08-10 03:43:06"
}

返回结果

code
含义
说明
数据模型

40000

成功

Success

string

40004

失败

鉴权失败,请检查signature的值或appsecret的值(如果需要)是否正确

string

40032

失败

未实名

string

40056

失败

手机格式不正确

string

40034

失败

模板状态有误

string

40035

失败

签名状态有误

string

40011

失败

模板不存在

string

40101

失败

port出现非法字符

string

40012

失败

个人用户无法发送营销短信且验证码变量仅可使用7位以内数字或账户状态异常

string

40110

失败

sendTime(发送时间)格式有误,格式:yyyy-MM-dd HH:mm:ss

string

40014

失败

变量错误

string

40015

失败

变量过长,验证码短信变量长度应小于7

string

40013

失败

签名不存在

string

40023

失败

port不能小于0,不需要请填写-1

string

40020

失败

账户余额不足

string

40006

失败

敏感词

string

-1

失败

-1

string

receive_status
含义
数据模型

0

提交失败

string

1

提交成功

string

receive_code
含义
数据模型

0

发送失败

string

1

发送成功

string

2

等待结果返回,可配置异步通知或在后台查看返回值

string

3

定时任务未到达指定发送时间

string

Last updated