Rejecting an Inbound Call

Prerequisites

• The agent has signed in.
• The agent has received the AgentEvent_Ringing event.

Description

This interface is used by an agent to reject a call request.

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}/reject

In the URL, ip indicates the IP address of the CC-Gateway, port indicates the HTTPS port number of the CC-Gateway, and {agentid} indicates the ID of an agent.

Method Name in Logs

reject

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

  Table 3 Parameters in the message body

  No.	Parameter	Value Type	Mandatory (Yes/No)	Description
  1	callid	string	No	Call ID.
  2	mode	int	Yes	Call rejection mode. The options are as follows: 1: The call is returned to the original queue and the agent is busy; 2: The call is released and the agent is idle. The call rejection mode applies to common scenarios (for example, an agent rejects an inbound call from a user). In complex scenarios, for example, internal help and call transfer, the call rejection effect needs to be determined based on the specific scenario.

Response Description

Triggered Event

• AgentEvent_No_Answer
• AgentEvent_SetNotReady_Success (triggered only when mode is set to 1)
• AgentOther_PhoneRelease
• AgentState_Ready (triggered only when mode is set to 2)

Error Code

• 100-006
• 100-007
• 200-002
• 200-037
• 200-038
• 200-039

Example

• Message header

  Content-Type:application/json; charset=UTF-8
  Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1

• Request parameter

  {
      "callid": "1455885056-1095",
      "mode": "1"
  }

• Response parameter

  {
    "result": {},
    "message": "success",
    "retcode": "0"
  }