Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Configuration Data Query/ Querying Information About All Agents by Tenant Space ID
Updated on 2023-12-19 GMT+08:00
View PDF

Querying Information About All Agents by Tenant Space ID

Description

This interface is used to query information about all agents of a tenant based on the tenant space ID.

Interface Method

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

Request URL

https://ip:port/rest/cmsapp/v1/openapi/tenant/querytenantdetail

In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.In a non–public cloud environment where the NSLB service is configured, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.

Request Description

Table 1 Parameters in the request header

No.

Parameter

Type

Mandatory

Description

1

Content-Type

String

Yes

The value is fixed to application/json; charset=UTF-8.

2

Authorization

String

Yes

For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.
Table 2 Parameters in the message body

Parameter

Type

Mandatory

Description

tenantId

String

Yes

Tenant space ID.

ccId

Integer

No

ID of a call center.

  • In the integration environment, the default value is the value of Call Center ID on the Configuration Center > System Management > CMS System Configuration page after a system administrator signs in to the AICC. If this parameter is empty, the data whose sys_key is default_cc_id and sys_type is cms_system_config in the t_cms_sysparam database table is used.
  • In the independent deployment environment, the default value is the value of Default Call Center ID on the Configuration Center > System Management > Parameter Settings page after a system administrator signs in to the AICC.

Response Message

Table 3 Parameters in the response message body

Parameter

Type

Description

resultCode

String

Query result. The options are as follows:

  • 0100000: success
  • Other values: failure

For details about the failure causes, see Error Code Reference.

resultDesc

Array

Object array in the returned result after a successful query.

For details about the parameters of the object in this array, see Table 4.
Table 4 Parameters of resultDesc

Parameter

Type

Description

ccId

Integer

ID of a call center.

tenantId

String

Tenant space ID.

tenantSpaceName

String

Tenant space name.

vdnId

Integer

ID of a VDN.

accessCodes

Array

Access number list.

For details about the parameters of the object in this array, see Table 4 Parameters of accessCodes.

agents

Array

Agent list. For details about the parameters of agents, see Table 5 Parameters of agent.
Table 5 Parameters of accessCodes

Parameter

Type

Description

accessCode

String

Access code.

isDefault

Boolean

Default access code ID. This parameter can be set to true, false, or left empty.
Table 6 Parameters of agents

Parameter

Type

Description

workNo

Integer

Agent ID.

sipAccount

String

Softphone number.

accountCode

String

Agent account.

agentType

Integer

Agent type.

4: voice agent; 5: multimedia agent; 11: video agent. This field is returned only during integrated deployment.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters
    {
 "tenantId": "202008142460",
 "ccId": 1
}
  • Response parameters
    {
    "resultCode": "0100000",
    "resultDesc": [
        {
            "ccId": 3,
            "vdnId": 47,
            "tenantId": "202008142460",
            "accessCodes": [
                {
                    "accessCode": "202008191",
                    "isDefault": true
                }
            ],
            "tenantSpaceName": "fjw081401",
            "agents": [{
                "workNo": 111, 
                "sipAccount": "88880001",
                "accountCode": "123",
                "agentType": 4
            }]
        }
    ]
}
Parent topic: Configuration Data Query