Get Available Outbound Routes for IVRs

Retrieve the outbound routes that can be selected when adding or updating an IVR.

Request URL

GET {base_url}/uc-cconfig/api/v1/ivrs/outbound-routes

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.

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_Options> The list of available outbound routes.
Outbound_Route_Options
Parameter Type Description
routes Array<Outbound_Route> The list of available outbound routes.
Outbound_Route
Parameter Type Description
id String The unique identifier of the outbound route.
name String The name of the outbound route.

Example

Request example

GET /uc-cconfig/api/v1/ivrs/outbound-routes HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc3Mzg0NSwiaWF0IjoxNzkwNzUyMjQ1LCJqdGkiOiIwODdjMzkyNS0yMjU3LTRlOTMtOGJlYS0zZjg0NDRmZWFjZTciLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.uThx_0gcb83u-i-zjDfTh-a-O-awJXx3TzGsVBno6M_qdiyisg3PFAf-wIsKZTfnDnweAJLrsZ_hUA4qB0p3jiCrtuqjrSbdmsjJsO-QEF4_8jT8jFt3rkAqFAG9mK6J4esaoZCBDDw_wRMIDkd9DhWyVw-i1_T59mq_MMZPh4cVLbYpoObsUPPPpNSZ-JFXwnB7ZWR6z78lwBuBJKlWN8Qg2b80FG3IPwyUwkg6KsgAMHAaGc6RaKldzGOwJPgQyAJgU-NvcfazXcMCcsZnHWPPBJZytcKrqWlbxPZZp4_-5POHNC6J3e8-_Y59LBqEnkiPA7A1aSa0QRWBBJTcJw
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
    "requestId": "e961847ecbe1f92921df6b9e9a3c27b6",
    "code": "200",
    "message": "SUCCESS",
    "detailMessage": "",
    "result": {
        "routes": [
            {
                "id": "347922401343070208",
                "name": "domestic_call"
            }
        ]
    }
}