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.

enable_time_condition

Integer

Whether the time condition is enabled.

  • 0: Disabled
  • 1: Enabled

time_condition_type

String

Time condition type.

  • unified: The same time condition applies to all key presses.
  • custom: A custom time condition applies to each key press.

time_base_mode

String

Time-based mode.

  • global_office_time: Based on business hours configured for the time zone.
  • custom_office_time: Based on custom business hours.
  • custom_time_periods: Based on custom time periods.

time_conditions

 Array<Time_Condition>

Time condition configuration.

press_key_option_list

 Array<Keypress_Setting>

IVR key configuration.
Time_Condition
Parameter Type Description

id

Integer

The record ID.

ivr_id

Integer

The IVR ID.

allow_out_record

Integer

 Whether call recording is stopped after the call is routed to the key destination.
  • 0: Disabled.
  • 1: Enabled.
months String The months during which the business hour applies.
  • all: Every month.
  • jan: January.
  • feb: February.
  • mar: March.
  • apr: April.
  • may: May.
  • jun: June.
  • jul: July.
  • aug: August.
  • sep: September.
  • oct: October.
  • nov: November.
  • dec: December.
days_of_week String The days of the week on which the business hour applies.
  • all: Every day.
  • sun: Sunday.
  • mon: Monday.
  • tue: Tuesday.
  • wed: Wednesday.
  • thu: Thursday.
  • fri: Friday.
  • sat: Saturday.
days String The days of the month on which the business hour applies.
  • all: Every day of the month.
  • 1-31: The specified day or days of the month.

office_times

 Array<Time_Period> The list of office time periods.
time_condition_switch Integer Whether the advanced time condition is enabled.
  • 0: Disabled.
  • 1: Enabled.

dest

String

The destination type.

  • end_call: Hang Up.
  • extension: Extension.
  • ext_vm: Extension Voicemail.
  • ivr: IVR.
  • call_flow: Call Flow
  • ai_receptionist: AI Receptionist.
  • ring_group: Ring Group.
  • queue: Queue.
  • group_vm: Group Voicemail.
  • conference: Conference.
  • dial_by_name: Dial by Name.
  • external_num: External Number.
  • play_greeting: Play Prompt and Exit.
  • play_prompt: Play Prompt and Return to IVR.
  • send_sms: Send SMS messages.
  • send_whatsapp: Send WhatsApp messages.

dest_prefix

String

The destination prefix. The value returned depends on the destination type of the key.

  • When the destination type is external_num, the parameter returns the dial-out prefix of the external number.
  • When the destination type is play_greeting or play_prompt, the parameter returns the play count of the prompt.

dest_value

String

 The destination value. The value returned depends on the destination type of the key.
  • When the destination type is play_greeting or play_prompt, this parameter returns the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ext_vm, ivr,call_flow, ring_group, queue, group_vm, or conference, this parameter returns the unique ID of the destination.

    For example, the destination is the extension 2002, then this parameter returns the extension ID 2.

  • When the destination type is external_num, the parameter returns the external number.

dest_caller_id_name

String

 The additional caller ID name for the key.

When a call is routed to a ring group or queue through a key, this name is prepended to the original caller ID name and displayed in the callee's incoming call window.

entity

String

The object with which the time condition is associated.

pos

Integer

The sorting position.

press_key_option_id

Integer

The ID of the keypress option.
Keypress_Setting
Parameter Type Description

id

Integer

The record ID.

ivr_id

Integer

The IVR ID.

allow_out_record

Integer

 Whether call recording is stopped after the call is routed to the key destination.
  • 0: Disabled.
  • 1: Enabled.
months String The months during which the business hour applies.
  • all: Every month.
  • jan: January.
  • feb: February.
  • mar: March.
  • apr: April.
  • may: May.
  • jun: June.
  • jul: July.
  • aug: August.
  • sep: September.
  • oct: October.
  • nov: November.
  • dec: December.
days_of_week String The days of the week on which the business hour applies.
  • all: Every day.
  • sun: Sunday.
  • mon: Monday.
  • tue: Tuesday.
  • wed: Wednesday.
  • thu: Thursday.
  • fri: Friday.
  • sat: Saturday.
days String The days of the month on which the business hour applies.
  • all: Every day of the month.
  • 1-31: The specified day or days of the month.

office_times

 Array<Time_Period> The list of office time periods.
time_condition_switch Integer Whether the advanced time condition is enabled.
  • 0: Disabled.
  • 1: Enabled.

dest

String

The destination type.

  • end_call: Hang Up.
  • extension: Extension.
  • ext_vm: Extension Voicemail.
  • ivr: IVR.
  • call_flow: Call Flow
  • ai_receptionist: AI Receptionist.
  • ring_group: Ring Group.
  • queue: Queue.
  • group_vm: Group Voicemail.
  • conference: Conference.
  • dial_by_name: Dial by Name.
  • external_num: External Number.
  • play_greeting: Play Prompt and Exit.
  • play_prompt: Play Prompt and Return to IVR.
  • send_sms: Send SMS messages.
  • send_whatsapp: Send WhatsApp messages.

dest_prefix

String

The destination prefix. The value returned depends on the destination type of the key.

  • When the destination type is external_num, the parameter returns the dial-out prefix of the external number.
  • When the destination type is play_greeting or play_prompt, the parameter returns the play count of the prompt.

dest_value

String

 The destination value. The value returned depends on the destination type of the key.
  • When the destination type is play_greeting or play_prompt, this parameter returns the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ext_vm, ivr,call_flow, ring_group, queue, group_vm, or conference, this parameter returns the unique ID of the destination.

    For example, the destination is the extension 2002, then this parameter returns the extension ID 2.

  • When the destination type is external_num, the parameter returns the external number.

dest_caller_id_name

String

 The additional caller ID name for the key.

When a call is routed to a ring group or queue through a key, this name is prepended to the original caller ID name and displayed in the callee's incoming call window.

entity

String

The object with which the time condition is associated.

pos

Integer

The sorting position.

press_key_option_id

Integer

The ID of the keypress option.
Time_Period
Parameter Type Description
value String The time period, in the format HH:MM-HH:MM.

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"
        }
    ]
}