Docs
导览

发送短信 API

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

轻松地向全球任意国家的一个或多个收件人发送验证码、事务性和营销短信。该接口提供了简洁、灵活但全面的参数输入方式，以满足各种短信使用场景。

如果您计划使用 Unimatrix 向用户发送短信验证码，我们推荐您选用具有更高集成度的 发送验证码 API，这将进一步提升您的开发效率及终端用户体验。

接口定义

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

请求参数

参数名类型必须描述示例值
tostring | string[]是收件手机号，使用 E.164 格式+8618658000123
signaturestring是短信签名，须为 2-16 个字符合一矩阵
textstring否短信全文
* templateId, text 或 content 须择一传入		【合一矩阵】您的验证码是701522，10分钟内有效。
contentstring否短信正文内容，与签名共同组成短信全文
* templateId, text 或 content 须择一传入		您的验证码是701522，10分钟内有效。
templateIdstring否短信模板 ID 或自定义模板码
* templateId, text 或 content 须择一传入		pub_verif_ttl
templateDataJSON否模板变量，与 templateId 配合使用{"code": "701522", "ttl": "10"}

请求示例

curl -X POST 'https://api-cn.unimtx.com/?action=sms.message.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "+8618658000xxx",
  "signature": "Unimatrix",
  "templateId": "pub_verif_basic",
  "templateData": {"code": "701522", "ttl": "10"}
}'

响应参数

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

返回结果 data

参数名类型描述示例值
recipientsinteger收件人个数1
messageCountinteger计费消息总条数1
currencystring币种CNY
totalAmountstring总消费金额0.045000
messagesJSON[]发送消息报告

消息主体 data.messages

参数名类型描述示例值
idstring消息 IDc9159d19f394833327e43c8e7285a6b3
tostring收件人手机号 (E.164)+8618658000123
isostring国际代码 (ISO-2)CN
ccstring国际电话区号86
partsinteger消息片段数1
pricestring消费金额0.045000

响应示例

成功响应示例

Status Code: 200, Response Body:

{
  "code": "0",
  "message": "Success",
  "data": {
    "recipients": 1,
    "messageCount": 1,
    "totalAmount": "0.045000",
    "messages": [
      {
        "id": "4e88293e50aac21d027a9d6c0f33661e",
        "to": "+8618658000123",
        "iso": "CN",
        "cc": "86",
        "parts": 1,
        "price": "0.045000"
      }
    ]
  }
}

失败响应示例

Status Code: 400, Response Body:

{
  "code": "105400",
  "message": "InsufficientFunds"
}
本页目录