Help Center/ Customer Engagement Center/ API Reference/ Agent Operation Interface Reference/ Agent Conference: agentconf/ Querying Conference Information in Batches
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Querying Conference Information in Batches

Prerequisites

  • The agent has signed in.

Description

This interface is used to query conference information in batches.

  • An inspector can query information about all conferences in the VCC to which the inspector belongs in batches.
  • A common agent can query only the information about the conference to which the common agent belongs.

Interface Method

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

URI

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/queryconfinfos

If the CC-Gateway is deployed in single-node mode, set IP address to the CC-Gateway server address and Port number to the HTTPS port number of the CC-Gateway server (the default value is 8043). If the CC-Gateway is deployed in cluster mode, set IP address to the NSLB address and Port number to the default value 8043.

For the CC-Gateway port number on the NSLB, log in to any NSLB node as the nslb user and run the ./nslbctl l command to query the port number. In the query result, the following port is opened by the CC-Gateway to third-party systems through the NSLB.

In the SaaS scenario, contact O&M personnel to obtain the values of IP address and Port number.

Table 1 Parameter in the URI

No.

Parameter

Value Type

Mandatory (Yes/No)

Description

1

agentid

String

Yes

Agent ID. The value ranges from 101 to 999999.

Method Name in Logs

queryConfInfos

Request Description

  • Message header
    Table 2 Parameters in the message body

    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 Parameter in the message body

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    confIds

    Array

    Yes

    Conference ID array.

    The maximum length of the array is 20.

Response Description

Table 4 Parameters in the message body

No.

Parameter

Value Type

Description

1

message

String

Description.

NOTE:

If the error message Unknown ERROR._***** is displayed, ***** indicates a CTI error result code. For details, see Table 2.

2

retcode

String

Error code. The options are as follows:

0: success

Other values: failure

3

result

Array

For details, see Table 5.
Table 5 Conference information

No.

Parameter

Value Type

Description

3.1

confId

Long

Conference ID.

3.2

confState

Integer

Conference status. The options are as follows:

0: normal conference call

1: conference announcement playing

3.3

startTime

Long

Conference start time, in milliseconds. The value is a timestamp.

3.4

applyConfTime

Integer

Applied conference duration, in minutes.

3.5

confHaveBeenTime

Integer

Time elapsed since a conference starts, in minutes.

3.6

addresses

Array

Participant list. For details, see Table 6.
Table 6 Participant information

No.

Parameter

Value Type

Description

3.6.1

addressType

String

3: address type.

6: phone number

9: agent ID

3.6.2

address

String

Address ID.

3.6.3

deviceCallType

Integer

User-defined device call type. For details, see Table 3.

3.6.4

deviceType

Integer

User-defined device type. For details, see Table 2.

3.6.5

channelAttrib

Integer

Conference attribute.

1: listening only

2: speaking only

3: listening and speaking

3.6.6

channelState

Integer

Conference channel status. The options are as follows:

0: The conference call is in progress.

1: The conference call is held.

2: The announcement is played.

3.6.7

role

Integer

Conference role. The options are as follows:

0: participant

1: chairperson

3.6.8

enterTime

Long

Time when a user joins a conference. The value is a timestamp, in milliseconds.

Triggered Event

None

Error Code

  • 000-002
  • 100-006
  • 100-007

Example

  • Message header 
    Content-Type:application/json; charset=UTF-8
Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter 
    {
    "confIds": [
        1029888,
        1029889
    ]
}
  • Response parameter 
    {
    "message": "",
    "retcode": "0",
    "result": {
        "confs": [
            {
                "confId": 1029888,
                "confState": 0,
                "startTime": 1475745454000,
                "applyConfTime": 60,
                "confHaveBeenTime": 29,
                "addresses": [
                    {
                        "addressType": "6",
                        "address": "70005",
                        "deviceCallType": 0,
                        "deviceType": 0,
                        "channelAttrib": 3,
                        "channelState": 0,
                        "role": 0,
                        "enterTime": 1475745464000
                    },
                    {
                        "addressType": "9",
                        "address": "153",
                        "deviceCallType": 0,
                        "deviceType": 6,
                        "channelAttrib": 3,
                        "channelState": 0,
                        "role": 1,
                        "enterTime": 1475745454000
                    }
                ]
            }
        ]
    }
}