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

Querying the Current Call Statistics of an Agent (Extended)

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 current call statistics information about an agent.

The performance of this interface is better than that of the interface for querying the current call statistics of an agent.

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

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

queryCallStatisticsInfoEx

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

Current call statistics information about an agent, which is 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

talktime

long

Total talking duration after sign-in, in seconds.

3.2

answernums

int

Number of answered calls after sign-in.

3.3

calloutnums

int

Number of outbound calls after sign-in.

Triggered Event

  • None

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
    {
        "message": "",
        "retcode": "0",
        "result": {
            "talktime": 4328,
            "answernums": 5,
            "calloutnums": 0
        }
    }