Skip to content

Latest commit

 

History

History
209 lines (136 loc) · 7.96 KB

ScenariosApi.md

File metadata and controls

209 lines (136 loc) · 7.96 KB
Raw

VoximplantKit\ScenariosApi

All URIs are relative to https://kitapi-eu.voximplant.com/api/v3

Method HTTP request Description
getScenarioVariables POST /scenario/getScenarioVariables
runScenario POST /scenario/runScenario
searchScenarios GET /scenario/searchScenarios

getScenarioVariables

\VoximplantKit\Model\GetScenarioVariablesResponseType getScenarioVariables($scenario_id, $required_only)

Get variables of the specified scenario.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = VoximplantKit\Configuration::getDefaultConfiguration();
$config->setHost('https://kitapi-{{region}}.voximplant.com/api/v3');

// Configure API key authorization: access_token
$config->setApiKey('access_token', 'your_access_token');


// Configure API key authorization: domain
$config->setApiKey('domain', 'your_domain');



$kitApi = new VoximplantKit\VoximplantKitClient($config);

$scenario_id = 56; // int | 
$required_only = true; // bool | 

try {
    $result = $kitApi->ScenariosApi->getScenarioVariables($scenario_id, $required_only);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling $kitApi->ScenariosApi->getScenarioVariables: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
scenario_id int [optional]
required_only bool [optional]

Return type

\VoximplantKit\Model\GetScenarioVariablesResponseType

Authorization

access_token, domain

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

runScenario

\VoximplantKit\Model\InlineResponse200 runScenario($scenario_id, $phone, $variables, $caller_id)

Run the specified scenario.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = VoximplantKit\Configuration::getDefaultConfiguration();
$config->setHost('https://kitapi-{{region}}.voximplant.com/api/v3');

// Configure API key authorization: access_token
$config->setApiKey('access_token', 'your_access_token');


// Configure API key authorization: domain
$config->setApiKey('domain', 'your_domain');



$kitApi = new VoximplantKit\VoximplantKitClient($config);

$scenario_id = 56; // int | 
$phone = "phone_example"; // string | 
$variables = "variables_example"; // string | 
$caller_id = "caller_id_example"; // string | 

try {
    $result = $kitApi->ScenariosApi->runScenario($scenario_id, $phone, $variables, $caller_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling $kitApi->ScenariosApi->runScenario: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
scenario_id int
phone string
variables string
caller_id string

Return type

\VoximplantKit\Model\InlineResponse200

Authorization

access_token, domain

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

searchScenarios

\VoximplantKit\Model\SearchScenariosResponseType searchScenarios($id, $folder_id, $scenario_type, $title, $with_campaigns, $with_phones, $sort, $page, $per_page)

Search for the scenarios. The method without specifying the parameters returns the last 20 scenarios created.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = VoximplantKit\Configuration::getDefaultConfiguration();
$config->setHost('https://kitapi-{{region}}.voximplant.com/api/v3');

// Configure API key authorization: access_token
$config->setApiKey('access_token', 'your_access_token');


// Configure API key authorization: domain
$config->setApiKey('domain', 'your_domain');



$kitApi = new VoximplantKit\VoximplantKitClient($config);

$id = 56; // int | Scenario ID. The ID can be retrieved via the **searchScenarios** method
$folder_id = 56; // int | ID of the scenario's folder
$scenario_type = 56; // int | Scenario type to search for. (<b>example:</b> scenario_type = 1 — displays only outgoing call scenarios, scenario_type = 2 — shows only incoming call scenarios)
$title = "title_example"; // string | Scenario title to search for
$with_campaigns = 56; // int | Set '1' to include campaigns in the search results
$with_phones = 56; // int | Set '1' to include phone numbers in the search results
$sort = "sort_example"; // string | Sorting data by field(s), add '-' to DESC sort, (<b>example:</b> ‘sort=id’ or ‘sort=-id’). <br /><b>IMPORTANT: the parameter can be used only in GET requests</b>
$page = 56; // int | Page to show as a response: the first one, second, etc. API methods return 20 records (one page) by default. <br /><b>IMPORTANT: the parameter can be used only in GET requests</b>
$per_page = 56; // int | Number of records per page (default value is 20, min = 1, max = 50). <br /><b>IMPORTANT: the parameter can be used only in GET requests</b>

try {
    $result = $kitApi->ScenariosApi->searchScenarios($id, $folder_id, $scenario_type, $title, $with_campaigns, $with_phones, $sort, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling $kitApi->ScenariosApi->searchScenarios: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int Scenario ID. The ID can be retrieved via the searchScenarios method [optional]
folder_id int ID of the scenario's folder [optional]
scenario_type int Scenario type to search for. (<b>example:</b> scenario_type = 1 — displays only outgoing call scenarios, scenario_type = 2 — shows only incoming call scenarios) [optional]
title string Scenario title to search for [optional]
with_campaigns int Set '1' to include campaigns in the search results [optional]
with_phones int Set '1' to include phone numbers in the search results [optional]
sort string Sorting data by field(s), add '-' to DESC sort, (<b>example:</b> ‘sort=id’ or ‘sort=-id’). <br /><b>IMPORTANT: the parameter can be used only in GET requests</b> [optional]
page int Page to show as a response: the first one, second, etc. API methods return 20 records (one page) by default. <br /><b>IMPORTANT: the parameter can be used only in GET requests</b> [optional]
per_page int Number of records per page (default value is 20, min = 1, max = 50). <br /><b>IMPORTANT: the parameter can be used only in GET requests</b> [optional]

Return type

\VoximplantKit\Model\SearchScenariosResponseType

Authorization

access_token, domain

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]