發送短信，使用前須注冊簽名和模板。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求語法
POST /api/v2/messages
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 請求參數的主體信息。 | |
| GroupId | string | 否 | 人群 ID，用于關聯人群。 | 10ed87f5-3ca8-4a43-9d83-b30519be7241 |
| OutIds | array | 否 | 外部拓展字段，示例：["1234567890"]。 | |
| string | 否 | 1234567890 | ||
| PhoneNumbers | array | 否 | 手機號，每個手機號對應一個模板變量、上行拓展碼和外部拓展字段，號碼個數最大為 1000，示例：["1234567890"]。 | |
| string | 否 | 1234567890 | ||
| ScheduleId | string | 否 | 發送計劃 ID，用于關聯發送計劃。 | 08d19262-bd76-48fd-80e8-6a225ac388c1 |
| SignName | string | 否 | 簽名名稱。 | PAI通知 |
| SignatureId | string | 否 | 簽名 ID，同時只能指定簽名名稱或簽名 ID 其中之一。 | 5480e3e7-f578-42d2-8ce8-217dec75f2e6 |
| SmsUpExtendCodes | array | 否 | 短信上行拓展碼，示例：["1234567890"]。 | |
| string | 否 | 1234567890 | ||
| TemplateCode | string | 否 | 模板 Code。 | SMS_123456 |
| TemplateId | string | 否 | 模板 ID，同時只能指定模板 Code 或模板 ID 其中之一。 | b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3 |
| TemplateParams | array | 否 | 短信模板變量對應的實際值，JSON 格式。支持傳入多個參數，示例：[{"name":"張三","number":"15038****76"}]。 | |
| string | 否 | {"name":"張三","number":"15038****76"} | ||
| PaymentType | string | 否 | 計費類型（為空時默認后付費）。
| PayAsYouGo |
返回參數
示例
正常返回示例
JSON格式
{
"Data": {
"Messages": [
{
"Id": "0a54e195-03e2-40bd-869d-b71cb302783e",
"PhoneNumber": "1234567890"
}
],
"RequestId": "62a72a20-8a9b-4060-a510-0c30a9340cba"
},
"ErrorCode": 0,
"ErrorMessage": "OK",
"RequestId": "f8651828-609d-4de8-ab49-ab781d7fd85a"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 | ||
|---|---|---|---|---|
| 2023-03-09 | API 內部配置變更，不影響調用 | 看變更集 | ||
| ||||
| 2022-02-21 | OpenAPI 返回結構發生變更 | 看變更集 | ||
| ||||
| 2022-02-21 | OpenAPI 返回結構發生變更 | 看變更集 | ||
| ||||
| 2022-02-21 | OpenAPI 返回結構發生變更 | 看變更集 | ||
|