Help Center/ Cognitive Engagement Center/ API Reference/ Call Center Configuration Interface Reference/ Agent Management/ Modifying Information About an Agent Account (agentAccount/update)
Updated on 2023-09-27 GMT+08:00
View PDF

Modifying Information About an Agent Account (agentAccount/update)

Scenario

Modify information about an agent account. The skills parameter is related to the skill queue. The skill queue information can be obtained by invoking the interface for querying skill queues.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/agentAccount/update. 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 field, which is the user ID. Contact the operation personnel to obtain the 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.

Name

Type

Mandatory or Not

Description

1

requestParam

Object

No

Request parameter object.

1.1

userAccount

String

Yes

Agent account, which is used to query agents and cannot be modified.

1.2

userName

String

No

Agent name. The value contains a maximum of 20 bytes and does not contain the following special characters: "[]=;<>

1.3

email

String

No

Email address (complying with RFC 2882).

The value of localPart contains a maximum of 64 characters, and the value of domainPart contains a maximum of 255 characters. The first part of domainPart dot contains a maximum of 63 characters.

1.4

phone

String

No

Phone number, which is optional and can contain a maximum of 25 characters.

1.5

agentType

Integer

No

Agent type.

4: audio agent

11: video agent

5: multimedia agent

99: versatile agent

1.6

ccRoleId

Integer

No

Agent role ID.

2: agent

3: inspector

4: outbound call agent

1.7

skills

Array [Object]

No

When this parameter exists, the skillId, agentWeight, and skillWeight parameters must be set. The skill queue type must be the same as the value of agenttype.

1.7.1

skillId

Integer

No

Skill queue ID, which is obtained using the querySkills interface.

1.7.2

agentWeight

Integer

No

Agent weight. A larger weight indicates a higher priority. The minimum value is 1.

1.7.3

skillWeight

Integer

No

Skill queue weight. The minimum value is 1.

1.8

oldPassWord

String

No

Current password of an agent. This parameter is mandatory when the agent password is changed. If the input current password is incorrect for three consecutive times, the account will be locked for 30 minutes, and you need to log in to the system as a tenant administrator to unlock the account. The password can be changed only once within 24 hours.

1.9

newPassWord

String

No

Password. The value is a string of eight characters (default password rule group). By default, four types of characters are required: uppercase letters, lowercase letters, digits, and special characters (~`!@#$%^*()-+_=\¦,./<>?;':"[]{}\&).

The password validity period is 90 days. Change the password within 90 days.

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Name

    Type

    Mandatory or Not

    Description

    1

    schema

    Object

    Yes

    Successful request.

    1.1

    resultCode

    String

    Yes

    The options are 0 (success) and 1 (failure).

    1.2

    resultMessage

    String

    Yes

    Returned message.
  • 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: XXXXXXXXXXXXXXXXXXXXXXX
Content-Type: application/json
Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX

Request parameters:

{
    "userAccount":"test123456",
    "userName":"test123",
    "email":"Test@****.com",
	"phone":"184****5555",
    "agentType":5,
    "ccRoleId":2,
    "skills":[{
	"skillId":1,
	"agentWeight":1,
       "skillWeight":1
	}],
 "oldPassWord":"xxxxx",
		"newPassWord":"xxxxxxx"
}

Response parameters:

{
  "resultCode": "0",
  "resultMessage": "edit success"
}
Parent topic: Agent Management