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

Querying the Account Sign-in Result (queryAgentLoginParams)

Description

Query the unified account of the mobile app and PC business system.

Method

POST

URI

https://Domain name/apiaccess/CC-Management/v1/queryAgentLoginParams (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.)
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

password

String (100)

Yes

Sign-in password.

1.2

account

String (100)

Yes

Sign-in account.

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

message

String (1024)

No

Account verification information.

1.2

returnCode

String (10)

No

Account verification return code.

0: success

1: failure

1.3

results

Object

No

Query result.
Table 4 Results parameter structure

No.

Parameter

Type

Mandatory or Not

Description

1.1

workNo

String (5)

No

Agent ID.

1.2

password

String (100)

No

Password for an agent to sign in to the platform before encryption.

1.3

sipAccount

String (24)

No

SIP softphone number.

1.4

sipPwd

String (100)

No

SIP softphone password before encryption.

1.5

sipServerInfo

Array [SIPServerInfo]

No

SIP service information.
Table 5 SIPServerInfo parameter structure

No.

Parameter

Type

Mandatory or Not

Description

1.1

sipServiceIp

String (50)

No

Softphone registration address.

1.2

sipServicePort

String (5)

No

Agent sign-in service port.

1.3

node

String (10)

No

SIP service node.

1.4

type

String (10)

No

SIP service type. The default type is SIP.

0: SIP

1: WebRTC
  • 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":"e******************************a",  
"Authorization":"Bearer e******************************8"
"Content-Type":"application/json;charset=UTF-8",  
"Connection":"keep-alive"

  

  
Request parameters:

  
{
	"account": "ls120201",
	"password": "S*****x"
}

  
Response parameters:

  
{
	"returnCode": "0",
	"results": {
		"sipServerInfo": [{
			"sipServiceIp": "10.10.10.11",
			"sipServicePort": "33",
			"type": "0"
		}],
		"password": "11****8Q",
		"sipAccount": "88887818",
		"workNo": "1516"
},
	"message": "verify Account or password success."
}

 





 

  

   Parent topic: Agent Management