Search Specific IVRs

Search specific IVRs from the IVR list.

Request URL

GET {base_url}/{api_path}/ivr/search?access_token={access_token}

Request parameters

Parameter Required Type Description
page No Integer Define which page is displayed.
page_size No Integer Define how many records per page.
sort_by No String Define the sorting field.

Valid value:

  • id
  • number
  • name
order_by No String Define the display order.

Valid value:

  • asc: Ascending order
  • desc: Descending order
search_value No String Search keyword.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
total_number Integer The total number of searched IVRs.
data Array <IVR_List> The information of the IVR.
IVR_List
Parameter Type Description
id Integer The unique ID of the IVR.
number String IVR number.
name String IVR name.
dial_ext_option String Whether to allow callers to dial extensions via the IVR.
  • disable: Prohibit callers from calling any extensions.
  • all: Allow callers to call all extensions.
  • allow: Allow callers to call specified extensions.
  • restrict: Prohibit callers from calling specified extensions.
enb_dial_outb_routes Integer Whether to allow callers to use outbound routes to make outbound calls from the IVR.
  • 0: Disallow.
  • 1: Allow.
client_unique_ringtone String The distinctive ringtone that will be played on extension users' Linkus clients when they receive calls from this IVR.

Examples

Request example

Search for the IVR with the number "6200".

GET /openapi/v1.0/ivr/search?access_token=Jh5d63SPHsNMnv6nzoOgUeKDyXSuOGxg&search_value=6200 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "data": [
        {
            "id": 1,
            "number": "6200",
            "name": "VoiceMenu Navigator",
            "dial_ext_option": "allow",
            "enb_dial_outb_routes": 1,
            "client_unique_ringtone": "Ring1.mp3"
        }
    ]
}