Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ App Personal Settings/ Querying App Personal Settings (query)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying App Personal Settings (query)

Scenario

This interface provided by the AICC is invoked to query app personal settings for the AppCube.

Method

POST

URI

https://{Domain name}/apiaccess/CC-Management/v1/openapp/agentsettings/query, where, {Domain name} can be service.besclouds.com.

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

X-APP-Key

String

Yes

App key, which is the user ID.

2

Authorization

String

No

Authentication field. The format is Bearer (space){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

userId

String

Yes

User ID.

Value of USER_ID in the t_aicc_pub_appcube_user table.

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1

    id

    String

    No

    Primary key ID.

    2

    callType

    String

    No

    Call type.

    0: direct call

    1: bidirectional call

    2: pass-through call

    3

    callerPresent

    String[]

    No

    Display number of the called party.

    A maximum of five numbers are displayed. Use commas (,) to separate multiple numbers.

    Length limit of each number: string (15)

    4

    callNumber

    String[]

    No

    Agent softphone number.

    A maximum of five numbers are displayed. Use commas (,) to separate multiple numbers.

    Length limit of each number: string (15)

    5

    userId

    String

    No

    User ID

    Value of SUM_USER_ID in the t_aicc_pub_appcube_user table.

    6

    callNumberDefault

    String

    No

    Default softphone number bound to the agent.

    Length limit: string (15)

    7

    callerPresentDefault

    String

    No

    Default display number of the called party.

    Length limit: string (15)

    8

    agentName

    String

    No

    Business account bound to an agent.

    9

    returnCode

    String

    Yes
    • 0: success
    • Other values: failure

    10

    returnDesc

    String

    No

    Response result description.
  • 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:9******************************3  
Authorization:Bearer e******************************e  
Content-Type:application/json
Request parameters: 
{
"userId": "1660270845627002401"
}

Response header:

{
	"connection": "keep-alive",
	"content-type": "application/json;charset=UTF-8"
}

Response parameters:

{
"returnCode": "0",
"callNumber": ["12323","232343","233","239343"],
"callerPresent": ["12323"],
"callNumberDefault": "23232323",
"agentName": "y111",
"id": "1307145259662215169",
"userId": "1660270845627002401",
"callerPresentDefault": "1212121212",
"returnDesc": "query success",
"callType": "1"
}
Parent topic: App Personal Settings