Updated on 2023-09-27 GMT+08:00

Subscription Modification

Description

This interface is used by a third-party business client to modify a subscription task.

Interface Method

This interface supports only the POST method.

URI

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

Table 1 Parameter in the URI

No.

Parameter

Value Type

Mandatory

Description

1

serverId

string

Yes

ID of an existing subscription task on the CTI platform, that is, subscription task ID returned by the CTI platform to a third-party business client upon successful subscription.

This parameter cannot be left empty or set to null.

Method Name in Logs

modify

Request Message

  • Message header
    Table 2 Parameters in the message header

    No.

    Parameter

    Value Type

    Mandatory

    Description

    1

    Content-Type

    string

    Yes

    Coding mode of the message body. The default value is application/json; charset=UTF-8.

    2

    Guid

    string

    Yes

    The value of Guid is that returned through the interface in C5 Intelligent Auxiliary Interface Authentication.

  • Message body
    Table 3 Parameters in the message body

    No.

    Parameter

    Value Type

    Mandatory

    Description

    1

    serviceCallBackUri

    string

    Yes

    Event notification callback address.

    The value contains a maximum of 200 characters.

    2

    nlpFlag

    boolean

    Mandatory

    Whether Natural Language Processing (NLP) is used.

    3

    flowAccessCode

    string

    Optional

    Flow access code.

Response Message

Table 4 Parameters in the message body

No.

Parameter

Value Type

Description

1

message

string

Returned message.

2

retcode

string

Result cause code.

The value is an integer.

3

result

object

Returned result. For details about the parameters of this object, see Table 5.

Table 5 Parameter of result

No.

Parameter

Value Type

Description

3.1

serverId

string

Subscription task ID returned by the CTI platform upon successful subscription based on the subscription request sent from a third-party business client to the CTI platform.

Example

  • Message header
    Content-Type:application/json; charset=UTF-8
    Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter
    {
        "serviceCallBackUri": "https://10.10.10.1:8080/rest/cc-ai/nlrresult",
        "nlpFlag": "true",
        "flowAccessCode": "801166010768953344"
    }
  • Response parameter
    {
        "message": "success",
        "retcode": "0"
    }