Skip to navigation

BindScenario

View as Markdown

Bind the scenario list to the rule. You should specify the application_id or application_name if you specify the rule_name. Please note, the scenario and the routing rule need to be within the same application.

Allowed roles: Owner, Admin, Developer.

Example request: Bind the scenarios 1, 2 and 3 with the rule 1.

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_idlist of integersOptional

The scenario ID list separated by semicolons (;). Required unless scenario_name is provided.

scenario_namelist of stringsOptional

The scenario name list separated by semicolons (;). Required unless scenario_id is provided.

rule_idintegerOptional

The rule ID to bind the scenario. The rule and the scenario need to be in the same application. Required unless rule_name is provided.

rule_namestringOptional

The rule name. Required unless rule_id is provided.

application_idintegerOptional

The application ID. Required unless application_name is provided.

application_namestringOptional

The application name. Required unless application_id is provided.

bindbooleanOptionalDefaults to true

Whether to bind or unbind (set true or false respectively)

Response

Successful response
resultintegerOptional
Returns 1 if the request has been completed successfully