Querying Call Information Before Answering a Call

Prerequisites

The agent has signed in.
The agent is in a call.

Description

This interface is used by an agent that has signed in to query the call information before answering a call.

Interface Method

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

URI

https://ip:port/agentgateway/resource/calldata/{agentid}/callinfobeforeanswer

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

queryCallInfoBeforeAnswer

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	list	Call information returned after a successful query. For details about the parameters of this object, see Table 4.

**Table 4** Parameter description of **result**
No.	Parameter	Value Type	Description
3.1	callfeature	int	Call type. For details, see Table 1.
3.2	callid	string	Call ID.
3.3	caller	int	Calling number.
3.4	called	int	Called number.
3.5	callskill	string	Call skill description.
3.6	callskillid	int	Call skill ID.
3.7	orgicallednum	string	It is not used.
3.8	calldata	string	Call-associated data.
3.9	begintime	long	Response start time, in milliseconds. The value is a timestamp.
3.10	endtime	long	It is not used.
3.11	userPriority	int	Customer priority.
3.12	trunkNo	int	Trunk number.
3.13	logontimes	int	Total login duration, in seconds.
3.14	mediaType	int	Media type. The options are as follows: 1: text chat 2: click-to-dial call 4: callback request 5: common voice or video call 15: predicted outbound call 16: previewed outbound call 17: message call 19: common video call 51: multimedia web chat 53: social chat
3.15	mediaAbility	int	Media capability. The options are as follows: 1: voice 2: video 3: voice and video
3.16	waitTime	long	Response waiting time, in seconds. The value is a timestamp.
3.17	trace	HWCallDeviceTraceEx	Extended attribute of the call track. This field is reserved and is left empty by default.

Triggered Event

None

Error Code

100-006

Example

Message header

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

Request parameter
None

Response parameter

{
    "message": "",
    "retcode": "0",
    "result": {
        "callfeature": 0,
        "callid": "1476070409-38",
        "caller": "70001",
        "called": "10086",
        "callskill": "voice_jst",
        "callskillid": 3,
        "orgicallednum": "12345678",
        "calldata": "",
        "begintime": 1476070413000,
        "endtime": null,
        "userPriority": 0,
        "trunkNo": 65535,
        "logontimes": 0,
        "mediaType": 5,
        "mediaAbility": 1,
	"waitTime": 0,
        "trace": null
    }
}

Parent topic: Call Data (calldata)

Previous topic: Querying the List of Held Calls

Next topic: Querying Call Information by Call ID