CancelAiCallDetails - 通信智能体呼叫任务取消呼叫

通信智能体呼叫任务取消呼叫,如明细记录已经进入待呼队列或者正在呼叫,则无法取消。

接口说明

  • 您可调用此接口取消通信智能体呼叫任务,也可在呼叫任务管理>管理>执行记录>待完成界面手动取消通信智能体呼叫任务。

  • 调用此接口之前,请确保您已创建呼叫任务且已导入被叫数据。

  • 若您没有已创建的呼叫任务,可在呼叫任务管理界面创建呼叫任务并导入被叫数据,或通过 CreateAiCallTaskImportTaskNumberDatas 接口创建呼叫任务并导入被叫数据。

  • 通信智能体呼叫任务取消呼叫后,可能会对您的业务造成影响,请谨慎操作。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

任务 ID。在呼叫任务管理界面查看任务 ID 或通过 QueryAiCallTaskPage 接口获取任务 ID。

138************
DetailIdListarray

任务明细 ID 列表,如果指定了该参数,则以该参数为准,BatchId 和 PhoneNumbers 无效。

string

任务明细 ID。在呼叫任务管理>详情>执行记录>已完成>通话详情界面左上角查看任务明细 ID 或通过 QueryAiCallDetailPage 接口获取任务明细 ID。

12131231*****
BatchIdstring

批次 ID。即为导入被叫数据时返回的批次 ID,在呼叫任务管理>详情>执行记录界面查看任务批次 ID 或通过 ImportTaskNumberDatas 接口导入被叫数据时返回的导入批次 ID,如果指定了 DetailIdList,则该参数无效。

4253331213*****
PhoneNumbersarray

手机号列表,如果需要使用该参数,则必须指定 BatchId,否则认为参数无效。

string

手机号。即为需要取消呼叫任务的手机号码,为导入被叫数据时传入的手机号码。

180*******

返回参数

名称类型描述示例值
object
AccessDeniedDetailstring

访问被拒绝的详细原因。

None
Messagestring

状态码描述。

成功
RequestIdstring

请求 ID。

46C98E28-9239-5D95-AC76-648B8FD4889A
Dataobject

返回数据。

TotalCountlong

总量。

50
FailedDetailsobject

失败明细情况。是个 Map,Key 为失败的明细 ID 或者手机号码,Value 为失败原因。

{ "176********": "明细记录当前状态不可取消" }
FailedCountlong

未成功取消是数量。

75
SucceedCountlong

成功取消的数量。

81
ResultCodestring

取消结果。取值:

  • ALL_FAILED:全部取消失败。
  • ALL_SUCCEED:全部取消成功。
  • PART_FAILED:部分取消失败。
PART_FAILED
Codestring

状态码。

OK
Successboolean

调用接口是否成功。取值:

  • true:成功。
  • false:失败。
false

示例

正常返回示例

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
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史