You need to enable JavaScript to run this app.
文档中心
语音服务

语音服务

复制全文
下载 pdf
任务管理
任务列表(QueryTaskList)
复制全文
下载 pdf
任务列表(QueryTaskList)
任务列表(QueryTaskList)

1. 接口说明

用于分页查询当前登录账号下的语音通知任务列表,支持按任务关键字、任务状态、话术类型、话术标识和手机号等维度筛选。

  • 请求方式:POST

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

Header

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

Authorization

String

是

HMAC-SHA256 Credential***

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

ServiceNameString是vms服务名称。语音服务的服务名称为vms。
RegionString是cn-north-1区域名称。
Content-TypeString是application/x-www-form-urlencoded指定请求消息体的结构化格式。

Query

参数数据类型是否必填示例值描述
ActionString是QueryTaskList接口名称。该接口固定值为QueryTaskList。
VersionString是2022-01-01接口版本。

2. Body(form-data)

参数名类型必填默认值说明
Limitinteger否10每页大小,最小 1,最大 100。
Offsetinteger否0偏移量,从 0 开始。常见用法:第一页传 0,第二页传 Limit。
Keywordstring否-关键字搜索。服务端会优先按任务 ID 查询,若未命中,再按任务名称查询。
Statearray<integer>否-任务状态列表,支持多选。传空数组时服务端按未筛选处理。
ResourceTypeinteger否-话术类型。
Resourcestring否-任务话术标识。通常为资源 key / 资源唯一标识。
Phonestring否-被叫手机号。按完整手机号精确匹配,服务端会先加密后再查询关联任务。

2.1 State 取值说明

值含义
0未开始
1进行中
2已结束
3用户暂停
4工作时间暂停
5禁呼状态中
6拨打完结束
7已终止(kill)

2.2 ResourceType 取值说明

值含义
0语音通知文件
1TTS 模板文件
2IVR 流程
3TTS 文本
98音需达 IVR
99快宝 IVR

3. 请求示例

{
  "Limit": 10,
  "Offset": 0,
  "Keyword": "task_202608",
  "State": [1, 3],
  "ResourceType": 1,
  "Resource": "tts_tpl_123456",
  "Phone": "13800138000"
}

4. 返回说明

Result.Records 中每条记录的核心字段通常包括:

字段名类型说明
TaskOpenIdstring任务 OpenId
Namestring任务名称
Resourcestring话术 key / 资源标识
ResourceTypeinteger话术类型
ResourceNamestring话术名称
Stateinteger任务状态
StartTimestring开始时间,格式:yyyy-MM-dd HH:mm:ss
EndTimestring结束时间,格式:yyyy-MM-dd HH:mm:ss
ListNuminteger名单数
CalledNuminteger呼叫数
ThroughNuminteger接通次数
ThroughRatenumber接通率
FinishRatenumber任务进度

5. 返回示例

{
  "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
      }
    ]
  }
}

6. 使用说明与注意事项

  1. Keyword 不是模糊组合搜索,而是服务端先按任务 ID 查询,未命中时再按任务名称查询。
  2. Phone 查询依赖号码加密后的精确匹配;如果手机号不存在于当前账号的任务中,会直接返回空列表。
  3. body实际接入时应传 {} 或完整请求体,不建议传空请求。
最近更新时间:2026.08.14 13:50:34
这个页面对您有帮助吗?
有用
有用
无用
无用