Search Outbound Routes

Request URL

POST {base_url}/uc-cconfig/api/v1/outbound-routes/search-page

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.

Body parameters

Parameter	Required	Type	Description
keyword	No	String	The keyword used to search for outbound routes, which matches the name, the outbound caller ID, or the dial pattern.
name	No	String	The name of the outbound route to search for.
outboundCallerId	No	String	The outbound caller ID to search for.
dialPattern	No	String	The dial pattern to search for.
trunkName	No	String	The trunk name to filter by.
userName	No	String	The name or extension number of the user to filter by.
pageNumber	Yes	Integer	The page number to query, starting from 1.
pageSize	Yes	Integer	The number of records per page, ranging from 1 to 500.
sorts	No	Array<Sort_Condition>	The sort conditions. The supported fields include id, name, list_order, created_at, and updated_at.

Sort_Condition

Parameter	Required	Type	Description
property	No	String	The name of the field to sort by.
direction	No	String	The sort order. Valid value: asc: Sort in ascending order. desc: Sort in descending order.

Response parameters

Search_Result

Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
count	String	The total number of matching records.
results	Array<Outbound_Route_List_Item>	The list of outbound routes on the current page.

Outbound_Route_List_Item

Parameter	Type	Description
id	String	The ID of the outbound route.
name	String	The name of the outbound route.
listOrder	Integer	The position of the outbound route in the route list.
outboundCallerId	String	The outbound caller ID of the outbound route.
outboundCallerIdInDid	String	The ID of the DID used as the outbound caller ID. The value 0 indicates that it is not configured.
dialPatterns	Array<Dial_Pattern>	The dial pattern list of the outbound route.
trunks	Array<String>	The list of names of the trunks bound to the outbound route.
users	Array<User_Item>	The list of authorized users of the outbound route.

Dial_Pattern

Parameter	Type	Description
pattern	String	The dial pattern, which supports the wildcards X, Z, N, [], ., and !.
strip	String	The number of leading digits to strip. The value is an empty string or a number from 0 to 16.
prepend	String	The prefix number to prepend. The maximum length is 31 characters.

User_Item

Parameter	Type	Description
id	String	The ID of the user.
extension	String	The extension number of the user.
name	String	The name of the user.

Example

Request example

POST /uc-cconfig/api/v1/outbound-routes/search-page 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: jint
Content-Type: application/json
{
  "pageNumber": 1,
  "pageSize": 5
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "c060b6685b993550a78a6b872d8e7e5b",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 5,
    "pageNumber": 1,
    "count": 2,
    "results": [
      {
        "id": "347922401343070208",
        "name": "domestic_call",
        "listOrder": 1,
        "outboundCallerId": "5503301",
        "outboundCallerIdInDid": "0",
        "dialPatterns": [
          {
            "pattern": "1.",
            "strip": "",
            "prepend": ""
          }
        ],
        "trunks": [
          "TenantX-Dedicated"
        ],
        "users": [
          {
            "id": "338136731335409664",
            "extension": "1000",
            "name": "Leo Ball"
          },
          {
            "id": "342552093490561024",
            "extension": "1001",
            "name": "Terrell Smith"
          },
          {
            "id": "338855950145581056",
            "extension": "1002",
            "name": "Philip Huff"
          }
        ]
      },
      {
        "id": "371138030393634816",
        "name": "to122",
        "listOrder": 2,
        "outboundCallerId": "",
        "outboundCallerIdInDid": "0",
        "dialPatterns": [
          {
            "pattern": "6.",
            "strip": "1",
            "prepend": ""
          }
        ],
        "trunks": [
          "ccctest"
        ],
        "users": [
          {
            "id": "338136731335409664",
            "extension": "1000",
            "name": "Leo Ball"
          },
          {
            "id": "342552093490561024",
            "extension": "1001",
            "name": "Terrell Smith"
          },
          {
            "id": "338855950145581056",
            "extension": "1002",
            "name": "Philip Huff"
          },
          {
            "id": "345441128009715712",
            "extension": "1003",
            "name": "Troy Daniel"
          },
          {
            "id": "345860923599089664",
            "extension": "1004",
            "name": "Example Lee"
          },
          {
            "id": "355531919887114240",
            "extension": "1005",
            "name": "w x"
          }
        ]
      }
    ]
  }
}