批量发送短信SendBatchSms

短信服务方可调用SendBatchSms接口向多个不同的手机号发送不同内容的短信。

接口说明

• 请求方式：POST

• 接口地址：https://sms.volcengineapi.com?Action=SendBatchSms&Version=2021-01-01

• 注意事项：一次调用中最多支持设置 200 个手机号。

请求参数

Header

Query

Body

Messages

返回参数

请求响应数据以JSON格式返回，以下仅列出了短信业务逻辑相关的字段，其他公共返回参数详见返回结果。

ResponseMetadata

Result

Error

示例

请求示例

{
    "SmsAccount": "A123****",
    "Sign": "短信服务",
    "TemplateID": "ST_6f8c****",
    "Messages": [
        {
            "PhoneNumber": "188********",
            "TemplateParam": "{\"aaa\":\"模版中内容\"}"
        },
        {
            "PhoneNumber": "152********",
            "TemplateParam": "{\"aaa\":\"模版中内容\"}"
        }
    ],
    "Tag": "send return"
}

返回示例

正确返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022120916033501021217204009606B8E",
        "Action": "SendBatchSms",
        "Version": "2021-01-01",
        "Service": "volcSMS",
        "Region": "cn-north-1"
    },
    "Result": {
        "MessageID": [
            "3e5c0bb8-a1a6-4e86-bb73-3e8120badb03",
            "03821294-76d4-4490-b395-4b35a73f4a22"
        ]
    }
}

错误返回示例

{
    "ResponseMetadata": {
        "RequestId": "202211221050270101330310****",
        "Action": "SendSms",
        "Version": "2020-01-01",
        "Service": "volcSMS",
        "Region": "cn-north-1",
        "Error": {
            "Code": "ZJ10101",
            "Message": "SmsAccount not exist."
        },
	    "Result": {
	        "MessageID": [
	            "31283de5-9ef6-5e11-abcd-69659****",
	            "03821294-76d4-4490-b395-4b35a73f****"
	        ]
	    }
    }
}

错误码

如果您在返回结果中遇到错误消息，可以使用下表作为详细信息和解决方案的指南。其中火山引擎网关公共错误码请参考火山引擎网关公共错误码。