通信智能体呼叫任务取消呼叫,如明细记录已经进入待呼队列或者正在呼叫,则无法取消。
接口说明
-
您可调用此接口取消通信智能体呼叫任务,也可在呼叫任务管理>管理>执行记录>待完成界面手动取消通信智能体呼叫任务。
-
调用此接口之前,请确保您已创建呼叫任务且已导入被叫数据。
-
若您没有已创建的呼叫任务,可在呼叫任务管理界面创建呼叫任务并导入被叫数据,或通过 CreateAiCallTask 、 ImportTaskNumberDatas 接口创建呼叫任务并导入被叫数据。
-
通信智能体呼叫任务取消呼叫后,可能会对您的业务造成影响,请谨慎操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TaskId | string | 是 | 任务 ID。在呼叫任务管理界面查看任务 ID 或通过 QueryAiCallTaskPage 接口获取任务 ID。 | 138************ |
DetailIdList | array | 否 | 任务明细 ID 列表,如果指定了该参数,则以该参数为准,BatchId 和 PhoneNumbers 无效。 | |
string | 否 | 任务明细 ID。在呼叫任务管理>详情>执行记录>已完成>通话详情界面左上角查看任务明细 ID 或通过 QueryAiCallDetailPage 接口获取任务明细 ID。 | 12131231***** | |
BatchId | string | 否 | 批次 ID。即为导入被叫数据时返回的批次 ID,在呼叫任务管理>详情>执行记录界面查看任务批次 ID 或通过 ImportTaskNumberDatas 接口导入被叫数据时返回的导入批次 ID,如果指定了 DetailIdList,则该参数无效。 | 4253331213***** |
PhoneNumbers | array | 否 | 手机号列表,如果需要使用该参数,则必须指定 BatchId,否则认为参数无效。 | |
string | 否 | 手机号。即为需要取消呼叫任务的手机号码,为导入被叫数据时传入的手机号码。 | 180******* |
返回参数
示例
正常返回示例
JSON
格式
{
"AccessDeniedDetail": "None",
"Message": "成功",
"RequestId": "46C98E28-9239-5D95-AC76-648B8FD4889A",
"Data": {
"TotalCount": 50,
"FailedDetails": {
"176********": "明细记录当前状态不可取消"
},
"FailedCount": 75,
"SucceedCount": 81,
"ResultCode": "PART_FAILED"
},
"Code": "OK",
"Success": false
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|