发送短信，使用前须注册签名和模板。
调试
您可以在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 返回结构发生变更 | 看变更集 | ||
|