Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Control/ Call Data (calldata)/ Querying Call IDs of a Specified Agent
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Call IDs of a Specified Agent

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 call IDs of a specified 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}/allcallinfoEx/{workno}

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 Parameters in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

2

workno

string

Yes

ID of the agent to be queried. The value ranges from 101 to 59999.

The agent ID must belong to the same VDN as the value of agentid.

Method Name in Logs

queryAllCallInfoByAgentWorkNoEx

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

Indicates the return result of a successful query, that is, a list of call IDs of a specified agent.

No result is returned if the query fails.

Triggered Event

  • None

Error Code

  • 100-006
  • 100-007
  • 100-011
  • 900-002

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": [
        "1456297722-1253",
        "1456297463-1249"
    ]
}
Parent topic: Call Data (calldata)