channels
voice
interactive-voice-response
manage-ivr-scenarios

Search Voice IVR Scenarios

This method allows you to search Voice IVR Scenarios by name. To get a list of all IVR Scenarios, make a request without any parameters.

get/voice/ivr/1/scenarios

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Query parameters

pageinteger

Page number you want to see. Default is 1.

pageSizeinteger

Size of the page you want to see. Default is 50.

namestring

The name to search by.

labelstring

The label of scenario to search by.

lastUsageDateSincestring date

Lower limit of last usage date in yyyy-MM-dd format. Note: For scenarios where lastUsageDate is null, filtering matches createTime.

lastUsageDateUntilstring date

Upper limit of last usage date in yyyy-MM-dd format. Note: For scenarios where lastUsageDate is null, filtering matches createTime.

Response

successful response

createTimestring date-time

Creation timestamp.

descriptionstring

Scenario description.

idstring

Scenario key. It is used for launching IVR scenario.

namestring

Scenario name.

notifyUrlstring

The URL on the client's callback server on which the Delivery report will be sent.

notifyContentTypestring

Preferred Delivery report content type. Can be application/json or application/xml.

recordboolean

Indicates if all calls using the scenario should be recorded.

updateTimestring date-time

Update timestamp

lastUsageDatestring date

Last usage date. null for scenarios that are used last time before 2024-01-01.

Changes

No recorded changes to this operation across all 1 revision of this API.