文档

ListCallTask - 获取通话任务状态列表

更新时间:

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

QPS 限制

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dyvms:ListCallTaskList
  • acs:dyvms:*:{#accountId}:*

请求参数

名称类型必填描述示例值
PageNumberinteger

当前页码。默认值为 1

1
PageSizeinteger

每页显示的任务个数。默认取值为 10

10
TemplateNamestring

模板名称。

  • 如果是语音通知文本转语音模板,可以在语音服务控制台文本转语音模板页面获取模板名称

  • 如果是语音通知文件模板,可以在语音服务控制台语音通知文件页面获取语音文件名

  • 如果是语音验证码模板,可以在语音服务控制台语音验证码页面获取模板名称

身份验证
Statusstring

任务状态。取值:

  • INIT:新建任务,任务未启动。
  • RELEASE:任务解析中。
  • RUNNING:任务运行中。
  • STOP:任务暂停。
  • SYSTEM_STOP:系统暂停。
  • CANCEL:任务取消。
  • SYSTEM_CANCEL:系统取消。
  • DONE:任务已完成。
说明 您可以在语音服务控制台任务中心页面,查看任务状态。
INIT
TaskNamestring

任务名称。

您可以在语音服务控制台任务中心页面,查看任务名称。

验证码
TaskIdstring

任务 ID。

18908**
BizTypestring

任务模板类型。取值:

  • VMS_VOICE_TTS:语音通知文本转语音模板。
  • VMS_VOICE_CODE:语音通知文件模板。
  • VMS_TTS:语音验证码模板。
VMS_TTS

返回参数

名称类型描述示例值
object

返回数据。

Codestring

请求状态码。

  • 返回 200 代表请求成功。
  • 其他错误码,请参见 API 错误码
200
PageSizelong

每页显示的任务个数。

10
PageNumberlong

当前页码。

1
RequestIdstring

请求 ID。

5B0F201F-DCDA-45C2-AA92-1AE177F94991
Totallong

任务总数。

1
Dataobject []

任务信息。

Statusstring

任务状态。取值:

  • INIT:新建任务,任务未启动。
  • RELEASE:任务解析中。
  • RUNNING:任务运行中。
  • STOP:任务暂停。
  • SYSTEM_STOP:系统暂停。
  • CANCEL:任务取消。
  • SYSTEM_CANCEL:系统取消。
  • DONE:任务已完成。
说明 您可以在语音服务控制台任务中心页面,查看任务状态。
INIT
Datastring

返回的任务状态数据。

1
DataTypestring

被叫号码类型。

创建通话任务时已选择被叫号码类型。

LIST
TaskNamestring

任务名称。

验证码
CompletedCountlong

已完成任务的个数。

2
TotalCountlong

被叫号码总数。

6
TemplateNamestring

模板名称。

身份验证
StopTimestring

任务暂停时间。

1614332378000
BizTypestring

任务模板类型。取值:

  • VMS_VOICE_TTS:语音通知文本转语音模版。
  • VMS_VOICE_CODE:语音通知文件模版。
  • VMS_TTS:语音验证码模版。
VMS_TTS
Resourcestring

主叫号码。

0571000****
TemplateCodestring

语音模板 ID。

TTS_28292****
FireTimestring

定时启动任务。Unix 时间戳格式,单位:毫秒。

1614330978000
CompleteTimestring

任务完成时间。Unix 时间戳格式,单位:毫秒。

1614330986000
CompletedRateinteger

任务执行进度。

26%
Idlong

任务 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错误码错误信息描述
400InvalidParametersThe parameter is invalid.无效参数

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

变更历史

变更时间变更内容概要操作
2022-06-27OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)