Help Center/ Cognitive Engagement Center/ API Reference/ Call Center Configuration Interface Reference/ Agent Management/ Querying Softphone Information of All Agents, Including Business Accounts (queryAgentInfo)
Updated on 2023-09-27 GMT+08:00
View PDF

Querying Softphone Information of All Agents, Including Business Accounts (queryAgentInfo)

Scenario

Query agent information.

Method

GET

URI

https://Domain name/apiaccess/CC-Management/v1/queryAgentInfo (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

X-APP-Key

String

No

App key.

2

Authorization

String

Yes

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)

Response Description

  • Status code: 200
Table 2 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

sipServicePort

String

No

Softphone registration port. The value ranges from 1 to 65535.

Length limit: string (5)

1.2

sipServiceIp

String

No

Softphone registration address, in IPv4 format.

Length limit: string (50)

1.3

agents

Array [Object]

No

Agent set.

1.3.1

workNo

Integer

Yes

Agent ID, ranging from 101 to 59999.

1.3.2

sipAccount

String

No

SIP softphone number.

Length limit: string (24)

1.3.3

sipPwd

String

No

SIP softphone password before encryption.

Length limit: string (24)

1.3.4

accountCode

String

No

Associated sign-in account of the Service Cloud.

Length limit: string (100)
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation.

    1. Check whether you have purchased related services.

    2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Request header: 
{
	"x-app-key": "f******************************f",
	"Authorization": "Bearer 0******************************8"
}
{
	"connection": "keep-alive",
	"content-type": "application/json;charset=UTF-8"
}

Response header:

Response parameters:

{
    "sipServiceIp": "10.10.96.98",
    "sipServicePort": 5060,
    "agents": [
        {
            "workNo": 1522,
            "accountCode": "aaaa",
            "sipAccount": "88881619",
            "sipPwd": "***"
        },
        {
            "workNo": 1523,
            "sipAccount": "88881620",
            "sipPwd": "***"
        }
    ]
}
Parent topic: Agent Management