发送短信 API

使用该接口发送文本短信至一个或多个收件人。阅读本文档前请先阅读 API 通用说明

接口定义

  • 接口名:sms.message.send
  • HTTP Method:POST
  • Content-Type:application/json

请求参数 (Body)

参数名类型是否必填描述示例值
tostring | string[]收件手机号,国际手机号使用 E.164 格式18688061234
signaturestring短信签名,2-16 个字符合一短信
contentstring短信正文文本,templateIdcontent二选一您的验证码是9153,15分钟内有效。
templateIdstring短信模板 ID 或自定义模板码,templateIdcontent二选一login_notify
templateDataJSON模板变量{“code”: “9153”, “ttl”: “15”}

* 注:为帮助开发者快速迁移,UniSMS支持使用 content 参数直接传入文本,新接入用户建议优先使用 templateId 传参

请求示例

curl -X POST 'https://uni.apistd.com/?action=sms.message.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "1860571xxxx",
  "signature": "合一短信",
  "templateId": "signup",
  "templateData": {"code": "3241", "ttl": "10"}
}'

响应参数 (Body)

参数名类型描述示例值
codestring返回码105400
messagestring返回信息InsufficientFunds
dataJSON返回结果

返回结果 (data)

参数名类型描述示例值
statusstring发送状态sent
recipientsinteger收件人个数1
messageCountinteger计费消息总条数1
totalAmountnumber总消费金额0.045
payAmountnumber支付消费金额0.045
virtualAmountnumber虚拟消费金额0
messagesJSON[]发送消息报告

发送消息报告 (data.messages)

参数名类型描述示例值
idstring消息标识7cf4b5c12c5ad49379ce07290d9b00bb
tostring收件人手机号 (E.164)+8618688061234
regionCodestring国际代码CN
countryCodestring国际电话区号86
messageCountinteger计费消息总条数1
statusstring发送状态sent
upstreamstring短信上游emay.standard
pricestring消费金额0.040000

响应示例

成功响应示例

Status Code: 200, Response Body:

{
  "code": "0",
  "message": "Success",
  "data": {
    "recipients": 2,
    "messageCount": 2,
    "totalAmount": "0.187500",
    "payAmount": "0.187500",
    "virtualAmount": "0",
    "messages": [
      {
        "id": "4e88293e50aac21d027a9d6c0f33661e",
        "to": "+8618688061234",
        "regionCode": "CN",
        "countryCode": "86",
        "messageCount": 1,
        "status": "sent",
        "upstream": "emay.standard",
        "price": "0.050000"
      },
      {
        "id": "ce02a6c4195c6f8c4b6a7250ccb3b0a1",
        "to": "+12894260331",
        "regionCode": "CA",
        "countryCode": "1",
        "messageCount": 1,
        "status": "sent",
        "upstream": "emay.intl.standard",
        "price": "0.137500"
      }
    ]
  }
}

失败响应示例

Status Code: 400, Response Body:

{
  "code": "105400",
  "message": "InsufficientFunds"
}

Related Posts