国内短信

短信发送接口

POST

http://xxx/api/v2/send

用户通过HTTP(或HTTPS)的POST方式提交短信发送请求。编码采用UTF-8编码。
请求头定义: Content-Type:application/x-www-form-urlencoded;charset=utf-8.

请求参数

Body 参数application/x-www-form-urlencoded

accesskey

string

必需

平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看。

示例值:

xxxxxxxxxx

secret

string

必需

平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看。

示例值:

yyyyyyyyyy

sign

string

必需

平台上申请的短信签名内容或者签名ID（须审核通过）。

示例值:

【测试签名】

templateId

string

可选

平台上申请的短信模板Id（须审核通过）。注：如果templateId不填写，则content字段必须是完整短信内容，否则发送后会进入人工审核。

示例值:

123456

mobile

string

必需

接收短信的手机号码，多个号码以半角逗号,隔开。注：最大支持5万。

示例值:

13900000000,13900000001

content

string

可选

发送的短信内容是模板变量内容，多个变量中间用##或者$$隔开，单个变量限制为1-20个字。

示例值:

先生##9:40##快递公司##1234567 （示例模板：{1}您好，您的订单于{2}已通过{3}发货，运单号{4}）

data

string

可选

该字段用于发送个性短信，mobile和content字段不需要填写，该字段json字符串，json的key是手机号，value是短信内容变量，等同于上面的content 包含多个变量中间用##或者$$隔开，最大支持1万，单个变量限制为1-20个字。

示例值:

{"13700000001":"女士##10:10##物流公司##000000","13700000000":"先生##9:40##快递公司##1234567"}

scheduleSendTime

string

可选

短信定时发送时间，格式为：2018-01-01 18:00:00；参数如果为空表示立即发送。

示例值:

2018-01-01 18:00:00

reqNo

string

可选

接口账户回传参数，用户自定义。

示例值:

abc123

extNo

string

扩展码。

可选

示例值:

1234

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://xxx/api/v2/send' \
--data-urlencode 'accesskey=xxxxxxxxxx' \
--data-urlencode 'secret=yyyyyyyyyy' \
--data-urlencode 'sign=【测试签名】' \
--data-urlencode 'templateId=123456' \
--data-urlencode 'mobile=13900000000,13900000001' \
--data-urlencode 'content=先生##9:40##快递公司##1234567 （示例模板：{1}您好，您的订单于{2}已通过{3}发货，运单号{4}）' \
--data-urlencode 'data={"13700000001":"女士##10:10##物流公司##000000","13700000000":"先生##9:40##快递公司##1234567"}' \
--data-urlencode 'scheduleSendTime=2018-01-01 18:00:00' \
--data-urlencode 'reqNo=abc123' \
--data-urlencode 'extNo=1234'

返回响应

🟢200成功

application/json

Body

code

string

请求状态

必需

0表示请求成功，非0表示请求失败

msg

string

状态说明

可选

batchId

string

批次id

可选

示例

{
    code: "0",
    msg: "SUCCESS",
    batchId:""
}

修改于 2024-01-25 08:26:20

平台短信回执状态码

获取短信状态接口