You need to enable JavaScript to run this app.
导航
添加号码(BatchAppend)
最近更新时间:2023.08.17 20:58:57首次发布时间:2023.02.28 20:31:38

添加号码(BatchAppend)

为任务批量添加号码

接口说明

  • 请求方式:POST

  • 接口地址:https://cloud-vms.volcengineapi.com?Action=BatchAppend&Version=2022-01-01

请求参数

Header

参数数据类型是否必填示例值描述
X-DateString20201103T104027Z鉴权字段。请参考文档中心-火山引擎

Authorization

String

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎

ServiceNameStringvms服务名称。语音服务的服务名称为vms
RegionStringcn-north-1区域名称。
Content-TypeStringapplication/json指定请求消息体的结构化格式。

Query

参数数据类型是否必填示例值描述
ActionStringBatchAppend接口名称。该接口固定值为BatchAppend
VersionString2022-01-01接口版本。

Body

参数数据类型是否必填示例值描述
TaskOpenIdString123任务唯一标识符

PhoneList

List

[{"Phone":"15233345567"}]

号码列表,参照数据结构中PhoneParam描述,单次最多1w条

PhoneParam

参数数据类型是否必填示例值描述
PhoneString15277889900手机号码

PhoneParam

Map<String, Object>

{"key1":"test1"}

变量参数,TTS模板类型任务需要

TtsContentString你好啊TTS文本,TTS类型任务需要,长度限制250
ExtString用户自定义参数,长度限制250

SmsParam

Map<String,String>

{"name":"张三"}

挂机短信模板参数,会和 PhoneParam 中的参数合并,如果重复以 SmsParam 为准。
例子:
PhoneParam 配了 {"k1": "p1", "k2": "p2"}
SmsParam 配了
{"k1": "s1", "k3": "s3"}
最终 SmsParam 会变成:
{"k1": "s1", "k2": "p2", "k3": "s3"}

TtsOptions

Map<String, String>

{"key1":"test1"}

TTS配置

返回参数

参数数据类型描述
ResponseMetadataResponseMetadataResponseMetadata
ResultResult见下方

Result

参数数据类型示例值描述
TaskOpenIdString123任务唯一标识符
FailListList["Index":0,"Phone":"15233334444"]添加失败的号码

FailItem

参数数据类型示例值描述
IndexInteger0失败项索引
PhoneString"15233334444"失败项的号码
TypeString"NO_PERMISSION"失败项的失败类型,也即错误码

请求示例

{
    "TaskOpenId":"123",
    "PhoneList":[
        {
            "Phone":"17052992739"
        }, 
        {
            "Phone":"17052992733"
        }
    ]
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"BatchAppend",
        "Version":"2022-01-01",
        "Service":"vms",
        "Region":"cn-north-1"
    },
    "Result":{
        "TaskOpenId":77,
        "FailList":[

        ]
    }
}