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

Unsubscription

Description

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

Interface Method

This interface supports only the PUT method.

URI

https://IP:Port/agentgateway/resource/config/subscribe/unregister

Method Name in Logs

unregister

Request Message

  • Message header
    Table 1 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 2 Parameters in the request message body

    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.

Response Message

Table 3 Parameters in the response message body

No.

Parameter

Value Type

Description

1

message

string

Returned message.

2

retcode

string

Result cause code.

The value is an integer.

Example

  • Message header
    Content-Type:application/json; charset=UTF-8
    Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter
    {
        "serverId": "20140414172508-001-00101"
    }
  • Response parameter
    {
        "message": "success",
        "retcode": "0"
    }