1. References
  2. HTTP API
  3. Scenarios
Rate this page:

Scenarios

Methods

AddScenario

Copy URL

Adds a new scenario. Please use the POST method.

AddScenario example
Copy

AddScenario example

Add a new scenario: var s='hello';

Parameters

  • scenario_name:

    string

    The scenario name. The length must be less than 30

  • scenario_script:

    string

    Optional

    The scenario text. The length must be less than 128 KB

  • rule_id:

    number

    Optional

    The rule ID

  • rule_name:

    string

    Optional

    The rule name that can be used instead of rule_id

  • rewrite:

    boolean

    Optional
    Defaults on:  false

    Rewrite the existing scenario

Returns

  • result:

    number

    1

  • scenario_id:

    number

    The new scenario ID

DelScenario

Copy URL

Deletes the scenario.

DelScenario example
Copy

DelScenario example

Delete the scenario 1 and 3.

Parameters

  • scenario_id:

    intlist

    The scenario ID list separated by the ';' symbol or the 'all' value

  • scenario_name:

    stringlist

    The scenario name list separated by the ';' symbol. Can be used instead of scenario_id

Returns

  • result:

    number

    1

BindScenario

Copy URL

Bind the scenario list to the rule. You should specify the application_id or application_name if you specify the rule_name.

BindScenario example
Copy

BindScenario example

Bind the scenarios 1, 2 and 3 with the rule 1.

Parameters

  • scenario_id:

    intlist

    The scenario ID list separated by the ';' symbol

  • scenario_name:

    stringlist

    The scenario name list separated by the ';' symbol. Can be used instead of scenario_id

  • rule_id:

    number

    The rule ID

  • rule_name:

    string

    The rule name that can be used instead of rule_id

  • application_id:

    number

    The application ID

  • application_name:

    string

    The application name that can be used instead of application_id

  • bind:

    boolean

    Optional
    Defaults on:  true

    Bind or unbind (set true or false respectively)

Returns

  • result:

    number

    1

GetScenarios

Copy URL

Gets the account's scenarios.

GetScenarios example
Copy

GetScenarios example

Get two scenarios, but skip the first one.

Parameters

  • scenario_id:

    number

    Optional

    The scenario ID to filter

  • scenario_name:

    string

    Optional

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

  • with_script:

    boolean

    Optional
    Defaults on:  false

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

  • count:

    number

    Optional
    Defaults on:  20

    The max returning record count

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records will be skipped in the output

Returns

  • result:

    [ScenarioInfoType]

  • total_count:

    number

    The total found scenario count

  • count:

    number

    The returned scenario count

SetScenarioInfo

Copy URL

Edits the scenario. Please use the POST method.

SetScenarioInfo example
Copy

SetScenarioInfo example

Add a new scenario: var s='hello';

Parameters

  • scenario_id:

    number

    The scenario ID

  • required_scenario_name:

    string

    The name of the scenario to edit, can be used instead of scenario_id

  • scenario_name:

    string

    Optional

    The new scenario name. The length must be less than 30

  • scenario_script:

    string

    Optional

    The new scenario text. The length must be less than 128 KB

Returns

  • result:

    number

    1

ReorderScenarios

Copy URL

Configures the order of scenarios that are assigned to the specified rule.

ReorderScenarios example
Copy

ReorderScenarios example

Set the scenario loading order: 17, 15, 20.

Parameters

  • rule_id:

    number

    The rule ID

  • rule_name:

    string

    The rule name that can be used instead of rule_id

  • scenario_id:

    intlist

    Optional

    The scenario ID list separated by the ';' symbol

Returns

  • result:

    number

    1

StartScenarios

Copy URL

Runs JavaScript scenarios on a Voximplant server. The scenarios run in a new media session.

StartScenarios example
Copy

StartScenarios example

Start the scripts from the account.

Parameters

  • user_id:

    number

    Optional

    The user ID. Run the scripts from the user if set

  • user_name:

    string

    Optional

    The user name that can be used instead of user_id. Run the scripts from the user if set

  • application_id:

    number

    Optional

    The application ID

  • application_name:

    string

    Optional

    The application name that can be used instead of application_id

  • rule_id:

    number

    The rule ID

  • script_custom_data:

    string

    Optional

    The script custom data (like a script argument). Can be accessed in JS scenario via the VoxEngine.customData() method

  • reference_ip:

    string

    Optional

    Specifies the IP from the geolocation of predicted subscribers. It allows selecting the nearest server for serving subscribers

Returns

  • result:

    number

    1

  • media_session_access_url:

    string

    The URL to control a created media session. It can be used for arbitrary tasks such as stopping scenario or passing additional data to it. Making HTTP request on this URL will result in the AppEvents.HttpRequest VoxEngine event being triggered for scenario, with HTTP request data passed to it

  • media_session_access_secure_url:

    string

    The URL to control a created media session. It can be used for arbitrary tasks such as stopping scenario or passing additional data to it. Making HTTPS request on this URL will result in the AppEvents.HttpRequest VoxEngine event being triggered for scenario, with HTTP request data passed to it

StartConference

Copy URL

Runs a session for video conferencing or joins the existing video conference session.

When a session is created by calling this method, a scenario assigned to the specified rule_id will run on one of the servers dedicated to video conferencing. All further method calls with the same rule_id won't create a new video conference session, but join the already existing one.

Use the StartScenarios method for creating audio conferences.

StartConference example
Copy

StartConference example

Start the conference from the account.

Parameters

  • conference_name:

    string

    The conference name. The name length must be less than 50 symbols

  • rule_id:

    number

    The rule ID

  • user_id:

    number

    Optional

    The user ID. Run the scripts from the user if set

  • user_name:

    string

    Optional

    The user name that can be used instead of user_id. Run the scripts from the user if set

  • application_id:

    number

    Optional

    The application ID

  • application_name:

    string

    Optional

    The application name that can be used instead of application_id

  • script_custom_data:

    string

    Optional

    The script custom data (like a script argument). Can be accessed in JS scenario via the VoxEngine.customData() method

  • reference_ip:

    string

    Optional

    Specifies the IP from the geolocation of predicted subscribers. It allows selecting the nearest server for serving subscribers

Returns

  • result:

    number

    1

  • media_session_access_url:

    string

    The URL to control a created media session. It can be used for arbitrary tasks such as stopping scenario or passing additional data to it. Making HTTP request on this URL will result in the AppEvents.HttpRequest VoxEngine event being triggered for a scenario, with an HTTP request data passed to it

  • media_session_access_secure_url:

    string

    The URL to control a created media session. It can be used for arbitrary tasks such as stopping scenario or passing additional data to it. Making HTTPS request on this URL will result in the AppEvents.HttpRequest VoxEngine event being triggered for a scenario, with an HTTP request data passed to it