创建语音通话任务后,可以查看通话任务状态,包括:任务ID、任务当前状态、任务所选的模板信息等。
调试
您可以在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 |
TaskName | string | 否 | 任务名称。 您可以在语音服务控制台任务中心页面,查看任务名称。 | 验证码 |
TaskId | string | 否 | 任务 ID。
| 18908** |
BizType | string | 否 | 任务模板类型。取值:
| VMS_TTS |
返回参数
示例
正常返回示例
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. | 无效参数 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-06-27 | OpenAPI 错误码发生变更 | 查看变更详情 |