You need to enable JavaScript to run this app.
导航
BatchAppend - 追加号码
最近更新时间:2025.07.11 17:27:23首次发布时间:2025.07.11 17:27:23
我的收藏
有用
有用
无用
无用

为任务批量添加号码

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

BatchAppend

要执行的操作,取值:BatchAppend。

Version
String

2022-01-01

API的版本,取值:2022-01-01。

PhoneList
Array of Object

[{"Phone":"12345678"}]

号码列表

TaskOpenId
String

123456

任务id

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
TaskOpenId
String

123

任务id

FailList
Array of Object

[{"Index":0,"Phone":"123456","Type":"REDUPLICATED_ITEM","Desc":"重复项目"}]

添加失败的号码

请求示例

POST /?Action=BatchAppend&Version=2022-01-01 HTTP/1.1
Host: https://cloud-vms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250527T121323Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250527/cn-beijing/vms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "PhoneList": [
    {
      "PhoneParamJson": "{\"key1\":\"value1\",\"key2\":\"value2\"}\n",
      "SmsParamJson": "{\"key1\":\"value1\",\"key2\":\"value2\"}\n",
      "Ext": "123456",
      "Phone": "wxPMEBlKa",
      "PhoneParam": "{\"key1\":\"test1\"}",
      "TtsContent": "Hs0",
      "SmsParam": "VlyYIQM"
    }
  ],
  "TaskOpenId": "123456"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202505272013301360031651658A86D7",
    "Action": "BatchAppend",
    "Version": "2022-01-01",
    "Service": "vms",
    "Region": "cn-beijing"
  },
  "Result": {
    "TaskOpenId": "123",
    "FailList": [
      {
        "Index": 658,
        "Type": "wQmRh37",
        "Phone": "Szy",
        "Desc": "重复项目"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
MissingParameter

The required parameter %s is missing.

400
InvalidParameter

The specified parameter %s is invalid.

400
OperationDenied

Operation is denied because the specified resource is in use.

400
QuotaExceeded

%s has exceeded the quota. example: The memory size of the specified disk has exceeded the quota.

400
IdempotentParameterMismatch

Parameters mismatch the previous request with a same ClientToken.

400
DryRunOperation

The request is validated by a dryrun operation.

400
MissingAction

The request is missing an action.

400
InvalidAction

The specified action is invalid.

500
InternalError

The request has failed due to an unknown error.

503
ServiceUnavailable

The request has failed due to a temporary failure of the server.