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

Rejecting a Call

Prerequisites

  • The agent has signed in.
  • An agent has enabled the phone linkage.
  • An agent has received the AgentOther_PhoneAlerting event.
  • Currently, only eSpace 7910 IP phones are supported.

Description

After receiving the phone ringing event (AgentOther_PhoneAlerting) in phone linkage state, an agent can invoke this interface to reject the call.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

URI

https://ip:port/agentgateway/resource/voicecall/{agentid}/phonehangup

In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.

Table 1 Parameter in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

Method Name in Logs

phonehangup

Request Description

  • Message header
    Table 2 Parameters in the request message header

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    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

    GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).

  • Message body

    None

Response Description

Table 3 Parameters in the message body

No.

Parameter

Value Type

Description

1

message

string

Description.

2

retcode

string

Error code. The options are as follows:

0: success

Other values: failure

3

result

object

Reserved field.

Triggered Event

  • AgentOther_PhoneRelease
  • AgentEvent_No_Answer

Error Code

  • 100-006
  • 100-007

Example

  • Message header
    Content-Type:application/json; charset=UTF-8
    Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter

    None

  • Response parameter
    {
      "result": {},
      "message": "success",
      "retcode": "0"
    }