Help Center/ Cognitive Engagement Center/ API Reference/ Call Center Configuration Interface Reference/ Agent Management/ Deleting a Specified Agent Account (agentAccount/delete)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Deleting a Specified Agent Account (agentAccount/delete)

Scenario

Delete a specified agent account. Agents in any state can be deleted.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/agentAccount/delete. 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 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.

Parameter

Type

Mandatory or Not

Description

1

requestParams

Object

Yes

Request parameter object.

1.1

userAccount

String

Yes

Agent account. The value contains 6 to 50 characters and cannot contain the following characters: [ `~!@#$%^&*()+=|{}':;',\\[\\].<>/?~@#%……&*——+|{}] |\n|\r|\t. \s indicates any blank character, including spaces, tabs, and form feeds.

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    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"
}

Response parameters:

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