Querying Access Codes (queryAccessCodeList)

Scenario

Query the access codes, that is, customer service hotlines you provide for customers, of a specified tenant space.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/accessCodeInfo/queryAccessCodeList (For example, the domain name is service.besclouds.com.)

Request Description

Response Description

• Status code: 200

  Table 3 Response body parameters

  No.	Parameter	Type	Mandatory or Not	Description
  1.1	data	Object	No	-
  1.1.1	total	Number	No	Total number of access codes.
  1.1.2	calledRouteList	Array [Object]	No	Access code information list.
  1.1.2.1	id	String	No	Access code ID.
  1.1.2.2	accessCode	String	No	Access code.
  1.1.2.3	mediatypeId	Integer	No	Media type. 2: click-to-dial 5: audio and video 18: video click-to-dial 19: video 53: multimedia
  1.1.2.4	n400Number	String	No	Service number configured on the access code page, which is generally the 400 number mapped by the core network.
  1.1.2.5	description	String	No	Access code description.
  1.1.2.6	numCallAttr	Number	No	Number attribute (3: inbound call and outbound call; 2: outbound call; 1: inbound call)
  1.2	returnCode	String	No	Return code. The options are as follows: 0: success; other values: failure.
  1.3	description	String	No	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: 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:

Content-Type:application/json
Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX
X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX

Request parameters:

{
   "accessCode": "9911411",
   "mediatypeId": 5,
   "description": "access code",
   "limit":10,
    "offset":0
}

Response parameters:

{
    "returnCode": "0",
    "data": {
        "total": 1,
        "calledRouteList": [
            {
                "id": "1124167935465633793",
                "accessCode": "9911411",
                "mediatypeId": 5,
                "n400Number": null,
                "description": null,
                "numCallAttr": 3				
            }
        ]
    },
    "description": "success"
}