Help Center/ Cognitive Engagement Center/ API Reference/ Call Center Configuration Interface Reference/ Agent Management/ Querying Agent Information by Sign-in Account (queryAgentInfoByAccount)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Agent Information by Sign-in Account (queryAgentInfoByAccount)

Scenario

Query agent information by the sign-in account.

Method

POST

URI

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

Request Description

Table 1 Request header parameters

No.

Name

Type

Mandatory or Not

Description

1

X-APP-Key

String

No

App key, which is the user ID.

2

Authorization

String

No

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

No.

Name

Type

Mandatory or Not

Description

1.1

accountCode

String (64)

Yes

Sign-in account, which can contain a maximum of 64 strings.

1.2

password

String (64)

No

Password of the authentication user, which can contain a maximum of 64 strings.

1.3

username

String (64)

No

Authentication user name, which can contain a maximum of 64 strings.

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Name

Type

Mandatory or Not

Description

1.1

returnCode

String

Yes

Return code. The value 0 indicates success. The value 1 indicates failure.

1.2

description

String

Yes

Description.

1.3

data

Object

No

Returned data. When data fails to be returned, an empty string is returned for the workNo parameter.

1.3.1

workNo

Integer

No

Agent ID.

1.3.2

agentType

Integer

No

Agent type.

1.3.3

agentStatus

String

No

Agent status. The default value is 0.
  • 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: 403

    Authentication fails.

  • 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**********************************e  
Authorization:Bearer a******************************2

    Request parameters:

    {
	"accountCode": "Agents"
}

    Response parameters:

    {
	"returnCode": "0",
	"data": {
		"workNo": 7094,
		"agentType": 5,
		"agentStatus": "0"
	},
	"description": "query success"
}
  • Scenario: A user signs in using the user name and password.

    Request header:

    Content-Type:application/json

    Request parameters:

    {
	"accountCode": "Agents",
	"username": "itau_group",
	"password": "****************"
}

    Response parameters:

    {
	"returnCode": "0",
	"data": {
		"workNo": 7094,
		"agentType": 5,
		"agentStatus": "0"
	},
	"description": "query success"
}
Parent topic: Agent Management