添加号码（BatchAppend）--语音服务-火山引擎

文档中心

立即注册

导航

添加号码（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-Date	String	是	20201103T104027Z	鉴权字段。请参考文档中心-火山引擎。
Authorization	String	是	HMAC-SHA256 Credential***	鉴权字段。请参考文档中心-火山引擎。
ServiceName	String	是	vms	服务名称。语音服务的服务名称为`vms`。
Region	String	是	cn-north-1	区域名称。
Content-Type	String	是	application/json	指定请求消息体的结构化格式。

Query

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

Body

参数	数据类型	是否必填	示例值	描述
TaskOpenId	String	是	123	任务唯一标识符
PhoneList	List	是	[{"Phone":"15233345567"}]	号码列表，参照数据结构中PhoneParam描述，单次最多1w条

PhoneParam

参数	数据类型	是否必填	示例值	描述
Phone	String	是	15277889900	手机号码
PhoneParam	Map<String, Object>	否	{"key1":"test1"}	变量参数，TTS模板类型任务需要
TtsContent	String	否	你好啊	TTS文本，TTS类型任务需要，长度限制250
Ext	String	否		用户自定义参数，长度限制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配置

返回参数

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	见 ResponseMetadata
Result	Result	见下方

Result

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

FailItem

参数	数据类型	示例值	描述
Index	Integer	0	失败项索引
Phone	String	"15233334444"	失败项的号码
Type	String	"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":[

        ]
    }
}