取消订阅
场景描述
第三方业务客户端调用该接口可以取消先前的订阅任务。
接口方法
该接口仅支持PUT方法,不支持GET、POST和DELETE等方法。
接口URI
https://IP:Port/agentgateway/resource/config/subscribe/unregister
日志中的方法名
unregister
请求消息
- 消息头
表1 消息头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。
- 消息体
表2 请求消息体参数说明 序号
名称
参数类型
是否必选
说明
1
serverId
string
True
CTI平台已存在的订阅任务的编号,也就是订阅注册时CTI平台返回给第三方业务客户端的订阅任务编号。
不能设置为空或空白字符串。
响应消息
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
message |
string |
返回消息 |
2 |
retcode |
string |
操作的结果原因码。 取值类型为整数。
|
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
{ "serverId": "20140414172508-001-00101" }
- 响应参数
{ "message": "success", "retcode": "0" }