Help Center/ Cognitive Engagement Center/ API Reference/ Call Center Configuration Interface Reference/ Number Management/ Modifying a Binding Relationship Between an Access Code, Skill Queue, and IVR (modifyCalledRoute)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Modifying a Binding Relationship Between an Access Code, Skill Queue, and IVR (modifyCalledRoute)

Scenario

Modify a binding relationship between an access code, skill queue, and IVR.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/calledRoute/modifyCalledRoute. 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.1

id

String

Yes

ID of a called party.

1.2

devicetype

Integer

Yes

Device type. The options are as follows: 1: skill queue; 3: IVR.

1.3

deviceId

Integer

Yes

Current device ID (skill queue ID or IVR ID).

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1.1

    returnCode

    String

    No

    Return code. The options are as follows: 0: success; other values: failure.

    1.2

    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:

{
    "id": "1125397061153369092", 
    "devicetype": 1, 
    "deviceId": 1
}

Response parameters:

{
    "returnCode": "0",
    "description": "data update success"
}
Parent topic: Number Management