Doo Cloud

发送短信

POST

/client-sms/v2/sms/send-single

注意

接口调用前提：获取鉴权秘钥：获取鉴权秘钥

请求参数

Header 参数

Finovy-Access-Token

string

令牌-口令

必需

示例值:

zabAehE5uHaAAGBiPIac3j

Body 参数application/json

mobile

string

短信接收的手机号

必需

短信接收的手机号：发送地区区号 + 手机号, 比如:85259901999。

areaCode

integer

区号

必需

发送地区区号。

content

string

短信内容

必需

最大支持512个字符，使用 UrlEncode 编码 UTF-8的消息内容。

svrType

string

业务类型

必需

描述本条短信的内容类型，capt_cha验证码，marketing营销。

custId

string

用户自定义流水号

可选

用户自定义流水号该条短信在您业务系统内的 ID，比如订单号或者短信发送记录的流水号。

exData

string

自定义扩展资料

可选

额外提供的最大 64 个长度的 ASCII 字符串：字母、数字、底线、减号，作为自定义扩展数据，填写后，状态报告返回时将会包含这部分数据,如不需要则不用提交此字段或填空。

示例

{
  "mobile": "85259901999",
  "areaCode": 852,
  "content": "Welcome%20Code%EF%BC%9A%5B307956%5D%20Enter%20it%20to%20register%20Ignore%20if%20not%20requested%20Thank%20you%20",
  "svrtype": "capt_cha",
  "custId": "50192598235176978",
  "exData": "custom data"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://smsapi-formal.cloud.doo.com/client-sms/v2/sms/send-single' \
--header 'Finovy-Access-Token: zabAehE5uHaAAGBiPIac3j' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mobile":"85259901999",
    "areaCode":852,
    "content":"Welcome%20Code%EF%BC%9A%5B307956%5D%20Enter%20it%20to%20register%20Ignore%20if%20not%20requested%20Thank%20you%20",
    "svrtype":"capt_cha",
    "custId":"50192598235176978",
    "exData":"custom data"
}'

返回响应

🟢200成功

application/json

Body

msgId

string

短信回执流水号

必需

custId

string

用户自定义流水号

可选

示例

成功示例身份认证失败短信发送错误参数绑定异常

{
  "code": 0,
  "success": true,
  "data": {
    "msgId": "uEWOjcXVaasszMe0pkr3Ud",
    "custId": "885245663"
  },
  "msg": "success",
  "traceId": "f3f13645c8df4b02a70713e2b39f652f.2360.17083496334650029"
}

修改于 2025-04-11 03:02:54

错误码

获取短信状态报告