Move an Inbound Route

Moves the position of an inbound route in the route list. The position affects the matching order of the inbound routes.

Request URL

POST {base_url}/uc-cconfig/api/v1/inbound-routes/{id}/move

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer `{access_token}`.
x-tenant-code	Yes	String	The tenant name. Note: You can obtain tenant name using the Query Tenants interface.

Path parameters


Parameter	Required	Type	Description
id	Yes	String	The ID of the inbound route to move. You can obtain the ID using the Search Inbound Routes interface.

Body parameters


Parameter	Required	Type	Description
moveType	Yes	String	The direction to move the inbound route. Valid value: `UP`: Move the route up by one position. `DOWN`: Move the route down by one position. `TOP`: Move the route to the top of the list. `BOTTOM`: Move the route to the bottom of the list.

Response parameters


Parameter	Type	Description
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
code	String	The HTTP status code of the request. `200`: Request succeeded. Non-200 value: Request failed.
message	String	The status message of the request.
detailMessage	String	The detailed error information. When the request is successful, this parameter returns empty.
result	Object<Inbound_Route>	The moved inbound route.

Inbound_Route


Parameter	Type	Description
id	String	The ID of the inbound route.
name	String	The name of the inbound route.
listOrder	Integer	The order of the route in the route list.
description	String	The description of the inbound route.
didMatch	Object<DID_Match_Info>	The DID matching configuration of the route.
callerMatch	Object<Caller_Match_Config>	The caller number matching configuration of the route.
trunkIds	Array<String>	The list of IDs of the trunks that the route binds.
destination	Object<Destination_Config>	The destination configuration of the route.
createdAt	String	The time when the route was created, in millisecond timestamp format.
updatedAt	String	The time when the route was last updated, in millisecond timestamp format.
timeBasedRoutingEnabled	Boolean	Whether time-based routing is enabled. `true` `false`
timeBasedRoutingProfileId	String	The ID of the business hours configuration associated with time-based routing.
timeBasedRoutingConfig	Object<Time_Based_Routing_Config>	The time-based routing configuration.

DID_Match_Info


Parameter	Type	Description
mode	String	The DID matching mode: `DID_PATTERN`: Match by the DID pattern list specified by `patterns`. `PATTERN_TO_EXT`: Match by the pattern with an extension placeholder specified by `patternWithExt`. `RANGE`: Match by the DID range from `didIdStart` to `didIdEnd`. `EXACT`: Match the exact DID-to-user mappings specified by `mappings`.
patterns	Array<String>	The list of DID patterns. This parameter applies when `mode` is `DID_PATTERN`.
patternWithExt	String	The pattern with an extension placeholder. This parameter applies when `mode` is `PATTERN_TO_EXT`.
mappingsCount	Integer	The number of DID-to-user mappings. This parameter applies when `mode` is `EXACT`.
mappings	Array<DID_To_User_Mapping>	The list of DID-to-user mapping details for display. This parameter applies when `mode` is `EXACT`.
didIdStart	String	The ID of the start DID record. This parameter applies when `mode` is `RANGE`; an empty string indicates other modes.
didIdEnd	String	The ID of the end DID record. This parameter applies when `mode` is `RANGE`; an empty string indicates other modes.
defaultDisplayFormatStart	String	The default display format of the start DID.
defaultDisplayFormatEnd	String	The default display format of the end DID.
didNameStart	String	The name of the start DID.
didNameEnd	String	The name of the end DID.
countryCodeStart	String	The country code of the start DID.
countryCodeEnd	String	The country code of the end DID.
didE164Start	String	The E.164 number of the start DID.
didE164End	String	The E.164 number of the end DID.

DID_To_User_Mapping


Parameter	Type	Description
userId	String	The ID of the target user.
extension	String	The extension number of the user, for display.
userName	String	The name of the user, for display.
didId	String	The ID of the referenced DID record, for display. An empty string indicates no reference or an invalid reference.
defaultDisplayFormat	String	The default display format of the DID.
didName	String	The name of the DID.
countryCode	String	The country code of the DID.
didE164	String	The E.164 number of the DID.

Caller_Match_Config


Parameter	Type	Description
patterns	Array<String>	The list of caller number patterns. The upper limit is controlled by the tenant configuration.

Destination_Config


Parameter	Type	Description
type	String	The destination type: `HANGUP`: Hang up. `USER`: Extension. `MATCH_SELECTED_USERS`: The users specified by `allowedUserIds`. `MATCH_USER_RANGE`: The users in the extension range specified by `extensionStart` and `extensionEnd`. `DID_TO_SPECIFIC_USER`: The user mapped from the DID. `IVR`: IVR. `EXTERNAL_NUMBER`: External number. `RING_GROUP`: Ring group. `QUEUE`: Queue. `USER_VOICEMAIL`: User voicemail. `GROUP_VOICEMAIL`: Group voicemail. `PLAY_PROMPT`: Play the prompt.
value	String	The destination value, such as the resource ID or number, which is interpreted according to the value of `type`.
prefix	String	The dial-out prefix, up to 7 characters. This parameter applies only when `type` is `EXTERNAL_NUMBER`.
allowedUserIds	Array<String>	The list of allowed user IDs. This parameter applies only when `type` is `MATCH_SELECTED_USERS`.
extensionStart	String	The start of the extension range. This parameter applies only when `type` is `MATCH_USER_RANGE`.
extensionEnd	String	The end of the extension range. This parameter applies only when `type` is `MATCH_USER_RANGE`.
repeatCount	Integer	The number of playback times, ranging from 1 to 5. The value `0` means not set. This parameter applies only when `type` is `PLAY_PROMPT`.

Time_Based_Routing_Config


Parameter	Type	Description
holidayHandling	String	The holiday handling mode: `route`: Route calls to the holiday destination. `play_prompt`: Play the prompt. `ignore`: Ignore holidays and follow the normal routing.
businessHoursDestination	Object<Destination_Config>	The destination during business hours.
outsideDestination	Object<Destination_Config>	The destination outside business hours.
holidayDestination	Object<Destination_Config>	The destination on holidays.

Example

Request example

POST /uc-cconfig/api/v1/inbound-routes/{id}/move HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM2OTMwNCwiaWF0IjoxNzkzMzQ3NzA0LCJqdGkiOiJmMzVlZDk0MC01MDEyLTRjMjctOGE0NS0wM2EzYTVhZTFmMjUiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.XOFg1WgfepDISEY6GwoJLoh2fclbzYlN1T0KABLNw2scP9Ew_OHvMHNBIqVmjnfj-L5tUDzRJ1jMUtUUWKOAXShaKl1IORVQDV2FwJYv7fqnrjW_HFCDmTGDim47PD99ZgRqUrU1-zCXrO9a4_fov2W_3rlSrPVVb2DGxoq4pE1PQ94SUsQ9JnPC4NaLY_RnoUeNmlFJ8_3PUVLIKgxYuhDt1YSR6qX9Qy4r9cEkMidG5Ae1rDceDk1rsnxddMOaoFzTu0WS0FJTRf8w5SnKVLueIh6LkRaIgdFRO4L3-DmseAj-ZaYgEATExvVAB3M_5q8oemiIqQepbtq66yW06g
x-tenant-code: jint
Content-Type: application/json
{
  "moveType": "UP"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "feb4c78a5371c5b7b5fe25c3ad04059a",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "374470182353330176",
    "name": "ir-move-probe2",
    "listOrder": 3,
    "description": "",
    "didMatch": {
      "mode": "DID_PATTERN",
      "patterns": [
        "6998"
      ],
      "patternWithExt": "",
      "mappingsCount": 0,
      "mappings": [],
      "didIdStart": "",
      "didIdEnd": "",
      "defaultDisplayFormatStart": "",
      "defaultDisplayFormatEnd": "",
      "didNameStart": "",
      "didNameEnd": "",
      "countryCodeStart": "",
      "countryCodeEnd": "",
      "didE164Start": "",
      "didE164End": ""
    },
    "callerMatch": {
      "patterns": []
    },
    "trunkIds": [
      "367177966216302592"
    ],
    "destination": {
      "type": "HANGUP",
      "value": "",
      "allowedUserIds": [],
      "extensionStart": "",
      "extensionEnd": ""
    },
    "createdAt": "0",
    "updatedAt": "0",
    "timeBasedRoutingEnabled": false,
    "timeBasedRoutingProfileId": "",
    "timeBasedRoutingConfig": {}
  }
}