Move an Outbound Route

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

Request URL

POST {base_url}/uc-cconfig/api/v1/outbound-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 outbound route to move. You can obtain the ID using the Search Outbound Routes interface.
Body parameters
Parameter Required Type Description
moveType Yes String

The direction to move the outbound route.

Valid value:

  • TOP: Move the route to the top of the list.
  • UP: Move the route up by one position.
  • DOWN: Move the route down by one position.
  • BOTTOM: Move the route to the bottom of the list.

If not specified, TOP is used.

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<Outbound_Route> The moved outbound route.
Outbound_Route
Parameter Type Description
id String The ID of the outbound route.
name String The name of the outbound route.
listOrder Integer The order of the route in the route list.
dialPatterns Array<Dial_Pattern> The list of dial patterns.
authorizedExtensions Object<Authorized_Extensions> The list of authorized extension users.
trunkSequence Array<String> The sequence of trunks that the route uses.
outboundCallerId String The outbound caller ID of the route.
passwordMode String

The password mode:

  • DISABLED: Password is disabled.
  • SINGLE_PIN: A single PIN is required.
  • PIN_LIST: A PIN from the PIN list is required.
rrmemoryHunt Boolean

Whether round-robin with memory hunt is enabled.

  • true
  • false
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.
singlePin String The single PIN, returned in plain text.
pinListId String The ID of the PIN list. This parameter takes effect only when the value of passwordMode is PIN_LIST.
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.
outboundCallerIdInDid String The ID of the DID used as the outbound caller ID. The value 0 indicates that it is not configured.
Dial_Pattern
Parameter Type Description
pattern String The dial pattern, which supports the wildcard characters X, Z, N, [], ., !.
strip String The number of digits to strip from the dialed number. An empty string or a value from 0 to 16.
prepend String The prefix to prepend to the dialed number, up to 31 characters.
Authorized_Extensions
Parameter Type Description
ids Array<String> The list of authorized extension user IDs.
Time_Based_Routing_Config
Parameter Type Description
allowBusinessHours Boolean

Whether outbound calls are allowed during business hours.

  • true: Allowed.
  • false: Not allowed.
allowOutside Boolean

Whether outbound calls are allowed outside business hours.

  • true: Allowed.
  • false: Not allowed.
allowHoliday Boolean

Whether outbound calls are allowed on holidays.

  • true: Allowed.
  • false: Not allowed.

Example

Request example

POST /uc-cconfig/api/v1/outbound-routes/374474380541255680/move HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM3MDQ0OCwiaWF0IjoxNzkzMzQ4ODQ4LCJqdGkiOiI3YTJiZTNiMC0yN2VmLTQ3YzItOGUwMi1mNTBmYmZjMTc5YTMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.jeynFNhyqaacwFl9HGXpvqNiAXidgYCilS88KrgJl5CpX3DqngfMiN6QdpBKigLpaA5ck0U1FAjBoFAUiSko4E32G8bDLjq4bcezA0h-d6kRBy6vF_cYVhNy2uYpHLFCHFS0dV4bxEc7bPZY2WVhcdQ6cX7fE-Ul9ULl8W1XUlaZQBGyQr1TsS_qBG8k43yn-ctK2Ms4NgF2jmOq_z-jDTEhAZBiKmqe2ZiVsNeZgzeVFoaEi6m-2TzNNJgomBb1UtpuDPUUfKzbv5Hc2WliZCFGxN4aYLl_tUZyNy2ot1NWdufAwbylbZ1CcJMzUSA69TsvD3bid3XkaTwJrX_TIQ
x-tenant-code: colortest2
Content-Type: application/json
{
  "moveType": "TOP"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "275696c1ec80647123e2fe675476f045",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "374474380541255680",
    "name": "ob-doc-test-1-upd",
    "listOrder": 3,
    "dialPatterns": [
      {
        "pattern": "X.",
        "strip": "",
        "prepend": ""
      }
    ],
    "authorizedExtensions": {
      "ids": [
        "338136731335409664"
      ]
    },
    "trunkSequence": [
      "367177966216302592"
    ],
    "outboundCallerId": "5500",
    "passwordMode": "DISABLED",
    "rrmemoryHunt": true,
    "createdAt": "0",
    "updatedAt": "0",
    "singlePin": "",
    "pinListId": "0",
    "timeBasedRoutingEnabled": false,
    "timeBasedRoutingProfileId": "",
    "timeBasedRoutingConfig": {
      "allowBusinessHours": false,
      "allowOutside": false,
      "allowHoliday": false
    },
    "outboundCallerIdInDid": "0"
  }
}