Skip to navigation
Management APIReferenceScenarios

GetScenarios

View as Markdown

Gets the account’s scenarios.

Allowed roles: Owner, Admin, Developer.

Example request: Get two scenarios, but skip the first one.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

scenario_idintegerOptional
The scenario ID to filter
scenario_namestringOptional

The scenario name to filter. Can be used instead of scenario_id. All scenarios containing this param in their names are returned. The parameter is case insensitive

with_scriptbooleanOptionalDefaults to false

Whether to get the scenario text. You must specify the 'scenario_id' too!

countintegerOptionalDefaults to 20
The max returning record count
offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

application_idintegerOptional
ID of the scenario's application
application_namestringOptional
Name of the scenario's application

Response

Successful response
resultlist of objectsOptional
total_countintegerOptional
The total found scenario count
countintegerOptional
The returned scenario count
application_idintegerOptional
ID of the scenario's application
application_namestringOptional
Name of the scenario's application
extended_application_namestringOptional
Application name including the node name