文档首页/云客服/API参考/外呼类接口参考/预约外呼接口/删除预约外呼活动
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

删除预约外呼活动

前置条件

  • 已经申请了开发者账号。

场景描述

通过该接口删除预约外呼任务。

接口方法

该接口仅支持POST方法。

接口URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/appoint/delete

其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。

表1 URL中携带的参数说明

序号

参数名

参数类型

是否必选

说明

1

vdnId

int

True

虚拟呼叫中心ID。

取值的类型为整数，取值范围为1～9999。

请求说明

表2 请求消息头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。

表3 请求消息体参数说明

序号

参数名

参数类型

是否必选

说明

1

appointId

String

True

待删除预约外呼活动id

响应说明

表4 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

原因码。0200000表示成功，其他表示失败。

具体见表5。

2

resultDesc

String

描述。

3

returnCode

String

原因码。0200000表示成功，其他表示失败。

具体见表5。

4

returnDesc

String

描述。

触发事件

无

错误结果码

表5 错误原因码说明

序号

错误码

说明

1

0200001

参数异常，异常详情在resultDesc中描述。

2

0200006

数据库操作异常。

3

02000001

参数值为空

4

04000004

预约活动不存在

5

04000005

已经执行呼叫的预约任务不能删除

报文样例

  • 该接口的请求消息体举例如下： 
    {
    "appointId" :"174730004495053249845286302552"
}
  • 该接口的响应消息体举例如下： 
    {
    "returnCode": "0200000",
    "resultCode": "0200000",
    "resultDesc": "success",
    "returnDesc": "success"
}
父主题：预约外呼接口