Search IVRs

Search IVRs in a tenant.

Request URL

POST {base_url}/uc-cconfig/api/v1/ivrs/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
pageNumber Yes Integer The page number to retrieve.
pageSize Yes Integer The number of records to retrieve per page.
keyword No String The keyword used to search for IVRs by extension number or name.
extension No String The extension number used to search for IVRs.
name No String The name used to search for IVRs.
enableDialOutbound No Boolean

Whether to filter IVRs by their outbound route permission setting.

Valid value:
  • true: Enabled
  • false: Disabled
dialUserModes No Array<String> The direct dialing modes used to filter IVRs.

Valid value:

  • ALL: Allow callers to reach all users.
  • ALLOWED: Allow callers to reach only the specified users.
  • RESTRICTED: Allow callers to reach all users except the specified users.
  • DISABLED: Direct dialing is disabled.
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.

Valid value:

  • id
  • extension
  • name
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 results of IVRs.
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.
limit Integer The maximum number of IVRs that can be added.
results Array<IVR_Item> The list of matching IVRs.
IVR_Item
Parameter Type Description
id String The unique identifier of the IVR.
extension String The extension number of the IVR.
name String The name of the IVR.
dialUserStatus String The direct dialing mode of the IVR.
  • ALL: Allow callers to reach all users.
  • ALLOWED: Allow callers to reach only the specified users.
  • RESTRICTED: Allow callers to reach all users except the specified users.
  • DISABLED: Direct dialing is disabled.
enableDialOutbound Boolean Whether direct dialing via outbound routes is enabled.
  • true: Enabled
  • false: Disabled

Example

Request example

POST /uc-cconfig/api/v1/ivrs/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc3Mzc4NSwiaWF0IjoxNzkwNzUyMTg1LCJqdGkiOiI0ZDkyZTY1Mi00ZGY3LTQ1YzEtYTEyMy1lM2M4NTQ1NzU3MGQiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.QuOwtCNqOWcSHwH2n1MaDIrkJWnidV11bgrBfvTueqDahurTqkEKPRZRDEIkx41NbK65gDZOtGZRPkD1k9riERFobWiYcUBfHiAsc_inLBf41PXXltIV0awmHvG7wYdjpqWttPNrwB81mZJB40DzIPBIif7HvZcv_gqrxd4A_oVxGOGM2xqFwJQe8fkhNWTfcUH143hqpT7NNU7dDTFAGxLckQohu5POfzSMXZeJD0BQ7T4M9KihkmKUQegW5PwiroxzHa1-0bplkJOYN37uRXOAMal6f9viVJc_zdY9nkXqeq7wNvawlFookB4S-jpBTEPmw3v6wfdoXqLYRNlD2A
Content-Type: application/json
x-tenant-code: jint
{
  "pageNumber": 1,
  "pageSize": 5
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "80a3533f40c4286cdb6e5ad269172630",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 5,
    "pageNumber": 1,
    "count": 1,
    "results": [
      {
        "id": "361032823083233280",
        "extension": "6200",
        "name": "6200",
        "dialUserStatus": "DISABLED",
        "enableDialOutbound": false
      }
    ],
    "limit": 32
  }
}