用于分页查询当前登录账号下的语音通知任务列表,支持按任务关键字、任务状态、话术类型、话术标识和手机号等维度筛选。
请求方式:POST
接口地址:https://cloud-vms.volcengineapi.com?Action=QueryTaskList&Version=2022-01-01
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| X-Date | String | 是 | 20201103T104027Z | 鉴权字段。请参考文档中心-火山引擎。 |
Authorization | String | 是 | HMAC-SHA256 Credential*** | 鉴权字段。请参考文档中心-火山引擎。 |
| ServiceName | String | 是 | vms | 服务名称。语音服务的服务名称为vms。 |
| Region | String | 是 | cn-north-1 | 区域名称。 |
| Content-Type | String | 是 | application/x-www-form-urlencoded | 指定请求消息体的结构化格式。 |
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | QueryTaskList | 接口名称。该接口固定值为QueryTaskList。 |
| Version | String | 是 | 2022-01-01 | 接口版本。 |
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
Limit | integer | 否 | 10 | 每页大小,最小 1,最大 100。 |
Offset | integer | 否 | 0 | 偏移量,从 0 开始。常见用法:第一页传 0,第二页传 Limit。 |
Keyword | string | 否 | - | 关键字搜索。服务端会优先按任务 ID 查询,若未命中,再按任务名称查询。 |
State | array<integer> | 否 | - | 任务状态列表,支持多选。传空数组时服务端按未筛选处理。 |
ResourceType | integer | 否 | - | 话术类型。 |
Resource | string | 否 | - | 任务话术标识。通常为资源 key / 资源唯一标识。 |
Phone | string | 否 | - | 被叫手机号。按完整手机号精确匹配,服务端会先加密后再查询关联任务。 |
State 取值说明 | 值 | 含义 |
|---|---|
0 | 未开始 |
1 | 进行中 |
2 | 已结束 |
3 | 用户暂停 |
4 | 工作时间暂停 |
5 | 禁呼状态中 |
6 | 拨打完结束 |
7 | 已终止(kill) |
ResourceType 取值说明 | 值 | 含义 |
|---|---|
0 | 语音通知文件 |
1 | TTS 模板文件 |
2 | IVR 流程 |
3 | TTS 文本 |
98 | 音需达 IVR |
99 | 快宝 IVR |
{ "Limit": 10, "Offset": 0, "Keyword": "task_202608", "State": [1, 3], "ResourceType": 1, "Resource": "tts_tpl_123456", "Phone": "13800138000" }
Result.Records 中每条记录的核心字段通常包括:
| 字段名 | 类型 | 说明 |
|---|---|---|
TaskOpenId | string | 任务 OpenId |
Name | string | 任务名称 |
Resource | string | 话术 key / 资源标识 |
ResourceType | integer | 话术类型 |
ResourceName | string | 话术名称 |
State | integer | 任务状态 |
StartTime | string | 开始时间,格式:yyyy-MM-dd HH:mm:ss |
EndTime | string | 结束时间,格式:yyyy-MM-dd HH:mm:ss |
ListNum | integer | 名单数 |
CalledNum | integer | 呼叫数 |
ThroughNum | integer | 接通次数 |
ThroughRate | number | 接通率 |
FinishRate | number | 任务进度 |
{ "Code": 0, "Message": "success", "Result": { "Limit": 10, "Offset": 0, "Total": 1, "Records": [ { "TaskOpenId": "v_task_xxxxx", "Name": "8月回访任务", "Resource": "tts_tpl_123456", "ResourceType": 1, "ResourceName": "回访模板A", "State": 1, "StartTime": "2026-08-12 10:00:00", "EndTime": "2026-08-12 18:00:00", "ListNum": 100, "CalledNum": 60, "ThroughNum": 25, "ThroughRate": 0.4167, "FinishRate": 0.6 } ] } }
Keyword 不是模糊组合搜索,而是服务端先按任务 ID 查询,未命中时再按任务名称查询。Phone 查询依赖号码加密后的精确匹配;如果手机号不存在于当前账号的任务中,会直接返回空列表。{} 或完整请求体,不建议传空请求。