使用ListCallTask查询通话任务状态列表-语音服务-阿里云-语音服务(VS)-阿里云帮助中心

创建语音通话任务后，可以查看通话任务状态，包括：任务ID、任务当前状态、任务所选的模板信息等。

接口说明

QPS 限制

单用户调用频率：100 次/秒。

接口说明

您也可以在语音服务控制台任务中心页面，查看任务状态，并根据需要对任务进行启动、定时启动、编辑、取消任务等操作。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dyvms:ListCallTask

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	当前页码。默认值为 1。	1
PageSize	integer	否	每页显示的任务个数。默认取值为 10。	10
TemplateName	string	否	模板名称。如果是语音通知文本转语音模板，可以在语音服务控制台文本转语音模板页面获取模板名称。如果是语音通知文件模板，可以在语音服务控制台语音通知文件页面获取语音文件名。如果是语音验证码模板，可以在语音服务控制台语音验证码页面获取模板名称。	身份验证
Status	string	否	任务状态。取值： INIT：新建任务，任务未启动。 RELEASE：任务解析中。 RUNNING：任务运行中。 STOP：任务暂停。 SYSTEM_STOP：系统暂停。 CANCEL：任务取消。 SYSTEM_CANCEL：系统取消。 DONE：任务已完成。说明您可以在语音服务控制台任务中心页面，查看任务状态。	INIT
TaskName	string	否	任务名称。您可以在语音服务控制台任务中心页面，查看任务名称。	验证码
TaskId	string	否	任务 ID。通过 CreateCallTask 接口获取任务 ID。在语音服务控制台任务中心页面，查看任务 ID。	18908**
BizType	string	否	任务模板类型。取值： VMS_VOICE_TTS：语音通知文本转语音模板。 VMS_VOICE_CODE：语音通知文件模板。 VMS_TTS：语音验证码模板。	VMS_TTS

返回参数

名称	类型	描述	示例值
	object	返回数据。
Code	string	请求状态码。返回 200 代表请求成功。其他错误码，请参见 API 错误码。	200
PageSize	integer	每页显示的任务个数。	10
PageNumber	integer	当前页码。	1
RequestId	string	请求 ID。	5B0F201F-DCDA-45C2-AA92-1AE177F94991
Total	integer	任务总数。	1
Data	array<object>	任务信息。
	object	任务信息。
Status	string	任务状态。取值： INIT：新建任务，任务未启动。 RELEASE：任务解析中。 RUNNING：任务运行中。 STOP：任务暂停。 SYSTEM_STOP：系统暂停。 CANCEL：任务取消。 SYSTEM_CANCEL：系统取消。 DONE：任务已完成。说明您可以在语音服务控制台任务中心页面，查看任务状态。	INIT
Data	string	返回的任务状态数据。	1
DataType	string	被叫号码类型。在创建通话任务时已选择被叫号码类型。	LIST
TaskName	string	任务名称。	验证码
CompletedCount	integer	已完成任务的个数。	2
TotalCount	integer	被叫号码总数。	6
TemplateName	string	模板名称。	身份验证
StopTime	string	任务暂停时间。	1614332378000
BizType	string	任务模板类型。取值： VMS_VOICE_TTS：语音通知文本转语音模版。 VMS_VOICE_CODE：语音通知文件模版。 VMS_TTS：语音验证码模版。	VMS_TTS
Resource	string	主叫号码。	0571000****
TemplateCode	string	语音模板 ID。	TTS_28292****
FireTime	string	定时启动任务。Unix 时间戳格式，单位：毫秒。	1614330978000
CompleteTime	string	任务完成时间。Unix 时间戳格式，单位：毫秒。	1614330986000
CompletedRate	integer	任务执行进度。	26%
Id	integer	任务 ID。	1605***

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "5B0F201F-DCDA-45C2-AA92-1AE177F94991",
  "Total": 1,
  "Data": [
    {
      "Status": "INIT\n",
      "Data": "1",
      "DataType": "LIST",
      "TaskName": "验证码",
      "CompletedCount": 2,
      "TotalCount": 6,
      "TemplateName": "身份验证",
      "StopTime": "1614332378000",
      "BizType": "VMS_TTS",
      "Resource": "0571000****",
      "TemplateCode": "TTS_28292****",
      "FireTime": "1614330978000",
      "CompleteTime": "1614330986000",
      "CompletedRate": 0,
      "Id": 0
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameters	The parameter is invalid.	无效参数

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。