更新时间:2023-09-27 GMT+08:00

订阅修改

场景描述

第三方业务客户端调用该接口可以修改先前的订阅任务

接口方法

该接口仅支持POST方法,不支持GET、PUT和DELETE等方法。

接口URI

https://IP:Port/agentgateway/resource/config/subscribe/modify?serverId=xxx

表1 URI携带的参数说明

序号

名称

参数类型

是否必选

说明

1

serverId

string

True

CTI平台已存在的订阅任务的编号,也就是订阅注册时CTI平台返回给第三方业务客户端的订阅任务编号。

不能设置为空或空白字符串。

日志中的方法名

modify

请求消息

  • 消息头
    表2 消息头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式,缺省值:application/json; charset=UTF-8

    2

    Guid

    string

    True

    Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。

  • 消息体
    表3 消息体参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    serviceCallBackUri

    string

    True

    事件通知回调地址。

    最大长度200。

    2

    nlpFlag

    boolean

    必填

    是否语义智能分析

    3

    flowAccessCode

    string

    选填

    流程接入码

响应消息

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

返回消息

2

retcode

string

操作的结果原因码。

取值类型为整数。

3

result

object

返回结果。该对象参数说明请参见表5

表5 result对象参数说明

序号

名称

参数类型

说明

3.1

serverId

string

业务客户端向CTI平台发起订阅注册请求且成功注册后,CTI平台返回的订阅任务编号。

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "serviceCallBackUri": "https://10.10.10.1:8080/rest/cc-ai/nlrresult",
        "nlpFlag": "true",
        "flowAccessCode": "801166010768953344"
    }
  • 响应参数
    {
        "message": "success",
        "retcode": "0"
    }