You need to enable JavaScript to run this app.
导航
单次发送(SingleBatchAppend)
最近更新时间:2024.05.09 15:26:13首次发布时间:2023.02.28 20:31:38

单次发送(SingleBatchAppend)

批量创建单次发送任务

接口说明

  • 请求方式:POST

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

请求参数

Header

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

Authorization

String

HMAC-SHA256 Credential***

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

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

Query

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

Body

参数数据类型是否必填示例值描述
ListList追加请求列表

SingleParam

参数数据类型是否必填示例值描述
PhoneString13333334444号码
TypeInteger0类型:0-录音文件(默认), 1-TTS模板,2-IVR流程

Resource

String

3cf1c12fc6c842faa451b23ad02324f1

话术资源id,比如语音文件id、tts模版id、ivr流程id

NumberPoolNoStringNP160084061100694433号码池编号
NumberListList["13344445555","13255556666"]设置用于拨打的主叫号码列表,不填则走号码池选号逻辑,建议不填写
RingAgainTimesInteger1重呼次数,默认0
RingAgainIntervalInteger5重呼间隔,最小5分钟,默认5

NumberType

Integer

0

号码池选号选择情况,0代表从整个号码池选号, 1代表从NumberList中选号,按照号码选号时需要设置,按照规则选号不设置该值

ExtString测试用户自定义参数
PhoneParamMap<String,Object>tts模板的参数、ivr流程的变量值
TriggerTimeDate2021-09-23 11:11:11发送时间
SingleOpenIdString842faaecd用户定义的唯一ID,用于幂等,重复的OpenId不会呼叫
SelectNumberRuleInteger5选号规则,目前仅支持5(根据被叫归属地选号),强烈建议走被叫归属地选号
CallRecordPostUrlStringhttp:xxxx话单推送地址
AudioPostUrlStringhttp:xxxx录音推送地址
ForbidTimeListList[{"Times":["10:00-11:00"],"Weekdays":[3]}]禁呼时间设置

SmsConfig

SmsConfig

{"Items":[{"TemplateId":"xxxxx","Sign":"xxxxxx","StatusSet":[1,2,3]}],"Param":{}}

挂机短信配置

ForbidTimeItem

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

Weekdays

Set

[1,2]

1表示周日,2表示周一,以此类推,该参数不传代表每天都生效

TimesList["09:00-10:00","15:00-16:00"]禁呼时间段

SmsConfig

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

Items

List

[{"TemplateId":"xxxxx","Sign":"xxxxxx","StatusSet":[1,2,3]}]

挂机短信配置项

Param

Map<String,String>

{"name":"张三"}

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

SmsConfigItem

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

TemplateId

String

ST_712d9312

模板id

SignString测试签名内容
StatusSetSet[1,2,3,4]呼叫状态,1 已接通,2 未接通,3 呼叫失败,4 未拨打

返回参数

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

Result

参数数据类型示例值描述
SuccessListList成功列表
FailListList失败列表

SingleResult

参数数据类型示例值描述
PhoneString18928398389手机号
SingleOpenIdString842faaecd用户定义的唯一ID,用于幂等,重复的SingleOpenId不会呼叫
ExtString测试用户自定义参数
TypeStringNO_PERMISSION失败类型,如果成功则为 null

请求示例

{
    "List": [
    {
      "Ext": "1234",
      "NumberList": [
        "0571123455"
      ],
      "NumberPoolNo": "NP123456",
      "NumberType": "1",
      "Phone": "13344445555",
      "Resource": "123",
      "RingAgainInterval": 5,
      "RingAgainTimes": 1,
      "TriggerTime": "2021-09-23 11:40:05",
  "OpenId": "842faaecd"
    }
  ]
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"SingleBatchAppend",
        "Version":"2022-01-01",
        "Service":"vms",
        "Region":"cn-north-1"
    },
    "Result":{
        "SuccessList":[
            {
                "Phone":"13344444444"
                "SingleOpenId":"1233333",
                "Ext": "1234"
            }
        ],
        "FailList":[
                "Phone":"13344444444"
                "Type":"手机号格式错误"
        ]
    }
}