Search Inbound Routes

Searches inbound routes in a tenant.

Request URL

POST {base_url}/uc-cconfig/api/v1/inbound-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
name	No	String	The name of the inbound route to search for.
trunkIds	No	Array<String>	The list of trunk IDs to filter by.
didPattern	No	String	The DID pattern to search for.
callerIdPattern	No	String	The caller ID pattern to search for.
keyword	No	String	The keyword used to search for inbound routes.
businessHoursProfile	No	String	The business hours profile to filter by.
pageNumber	No	Integer	The page number to retrieve.
pageSize	No	Integer	The number of records to retrieve per page.
sorts	No	Array<Sort_Condition>	The sort conditions.

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


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<Search_Result>	The search result of inbound routes.

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<Inbound_Route_Item>	The list of inbound routes on the current page.

Inbound_Route_Item


Parameter	Type	Description
id	String	The ID of the inbound route.
name	String	The name of the inbound route.
listOrder	Integer	The position of the inbound route in the route list.
didMatchInfo	Object<DID_Match_Info>	The DID match configuration of the inbound route.
callerMatch	Object<Caller_Match>	The caller number match configuration of the inbound route.
destinationInfo	Object<Destination_Info>	The destination of the inbound route.
timeBasedRouting	String	The status of time-based routing. `Disabled` indicates that time-based routing is disabled.
businessHoursProfileName	String	The name of the business hours profile that time-based routing references.
businessHoursDestination	Object<Destination_Info>	The destination during business hours.
outsideBusinessHoursDestination	Object<Destination_Info>	The destination outside business hours.
holidaysDestination	Object<Destination_Info>	The destination on holidays.
currentDestination	Object<Destination_Info>	The current effective destination according to the current time.

DID_Match_Info


Parameter	Type	Description
mode	String	The DID match mode: `DID_PATTERN` `PATTERN_TO_EXT` `RANGE` `EXACT`
patterns	Array<String>	The list of DID number patterns. This parameter is returned only when mode is `DID_PATTERN`.
patternWithExt	String	The DID pattern with the `{{.Ext}}` placeholder. This parameter is returned only when mode is `PATTERN_TO_EXT`.
mappingsCount	Integer	The number of DID mappings.
mappings	Array<DID_Mapping_Detail>	The DID mappings. This parameter is returned only when mode is `EXACT`.
didIdStart	String	The start ID of the DID record range. This parameter is returned only when mode is `RANGE`, and an empty string is returned in other modes.
didIdEnd	String	The end ID of the DID record range. This parameter is returned only when mode is `RANGE`, and an empty string is returned in other modes.
defaultDisplayFormatStart	String	The default display format of the DID at the range start.
defaultDisplayFormatEnd	String	The default display format of the DID at the range end.
didNameStart	String	The name of the DID at the range start.
didNameEnd	String	The name of the DID at the range end.
countryCodeStart	String	The country code of the DID at the range start.
countryCodeEnd	String	The country code of the DID at the range end.
didE164Start	String	The E.164 number of the DID at the range start.
didE164End	String	The E.164 number of the DID at the range end.

DID_Mapping_Detail


Parameter	Type	Description
userId	String	The ID of the user that the DID number is mapped to.
extension	String	The extension number of the user.
userName	String	The name of the user.
didId	String	The ID of the DID record. An empty string indicates that the DID reference is missing or invalid.
defaultDisplayFormat	String	The default display format of the DID number.
didName	String	The name of the DID number.
countryCode	String	The country code of the DID number.
didE164	String	The E.164 number of the DID.

Caller_Match


Parameter	Type	Description
patterns	Array<String>	The list of caller number patterns.

Destination_Info


Parameter	Type	Description
type	String	The type of the route destination: `HANGUP` `USER` `MATCH_SELECTED_USERS` `MATCH_USER_RANGE` `DID_TO_SPECIFIC_USER` `IVR` `EXTERNAL_NUMBER` `RING_GROUP` `QUEUE` `USER_VOICEMAIL` `GROUP_VOICEMAIL` `PLAY_PROMPT`
value	String	The value of the destination.
displayName	String	The display name of the destination.
extension	String	The extension number of the destination.
extensionStart	String	The start of the extension range. This parameter is returned only when type is `MATCH_USER_RANGE`.
extensionEnd	String	The end of the extension range. This parameter is returned only when type is `MATCH_USER_RANGE`.
allowedUsers	Array<Allowed_User>	The list of allowed users. This parameter is returned only when type is `MATCH_SELECTED_USERS`.
mappings	Array<DID_Mapping_Detail>	The DID mappings. This parameter is returned only when type is `DID_TO_SPECIFIC_USER`.

Allowed_User


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

Example

Request example

POST /uc-cconfig/api/v1/inbound-routes/search-page 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
{
  "name": "ir-doc-test",
  "pageNumber": 1,
  "pageSize": 5
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "047298e422b9864f2d03e9317d7bb069",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 5,
    "pageNumber": 1,
    "count": 1,
    "results": [
      {
        "id": "374469838063886336",
        "name": "ir-doc-test-1",
        "listOrder": 3,
        "didMatchInfo": {
          "mode": "DID_PATTERN",
          "patterns": [
            "6000"
          ],
          "patternWithExt": "",
          "mappingsCount": 0,
          "mappings": [],
          "didIdStart": "",
          "didIdEnd": "",
          "defaultDisplayFormatStart": "",
          "defaultDisplayFormatEnd": "",
          "didNameStart": "",
          "didNameEnd": "",
          "countryCodeStart": "",
          "countryCodeEnd": "",
          "didE164Start": "",
          "didE164End": ""
        },
        "callerMatch": {
          "patterns": []
        },
        "destinationInfo": {
          "type": "IVR",
          "value": "342969063155736576",
          "displayName": "6200",
          "extension": "6200",
          "extensionStart": "",
          "extensionEnd": "",
          "allowedUsers": [],
          "mappings": []
        },
        "timeBasedRouting": "Disabled",
        "businessHoursProfileName": "-",
        "businessHoursDestination": null,
        "outsideBusinessHoursDestination": null,
        "holidaysDestination": null,
        "currentDestination": {
          "type": "IVR",
          "value": "342969063155736576",
          "displayName": "6200",
          "extension": "6200",
          "extensionStart": "",
          "extensionEnd": "",
          "allowedUsers": [],
          "mappings": []
        }
      }
    ]
  }
}