Чтобы запустить сценарий через API, нужно выполнить четыре простых шага:

  1. Получить API-токен
  2. Купить номер телефона или верифицировать собственный
  3. Собрать сценарий в редакторе Voximplant Kit
  4. Запустить сценарий

Разберемся по порядку.

Чтобы использовать API, нужно сгенерировать в личном кабинете API-токен.

Зайдите в “Интеграции”, перейдите в раздел “API-токены” и нажмите на кнопку “Добавить API-токены”. В открывшемся окне введите название для API-токена и нажмите “Сохранить”.

API-токен появится в этом же разделе. Увидеть или скопировать его можно, нажав на соответствующую иконку справа от токена.

Вы можете делать запросы к API, используя параметры авторизации:

  • domain – имя вашего аккаунта
  • access_token – токен API

После этого нужно купить или добавить номер телефона в Voximplant Kit. Это можно сделать в разделе “Номера”.

Теперь переходим к созданию сценария. Перейдите в раздел “Сценарии” в верхнем меню сайта вкладки “Исходящие”. Нажмите кнопку “Новый сценарий”, выберите шаблон или уже готовый сценарий. 

После того, как вы создали сценарий, верифицировали номер телефона и получили API-токен, можно запускать сценарий.

 

Пример кода на PHP

<?php

// Your Voximplant Kit account name
define('KIT_DOMAIN', "YOUR DOMAIN NAME HERE");

// API Token
define('KIT_ACCESS_TOKEN', "YOUR API TOKEN HERE");

// ID of your CallerID number ID
define('KIT_CALLERID_PHONE_ID', "CALLERID PHONE ID HERE");

// Voximplant Kit scenario id
define('KIT_SCENARIO_ID', "SCENARIO ID HERE");

// Voximplant Kit API url
define('KIT_API_URL', "https://kitapi-eu.voximplant.com/api/v3");

// Client data for using in scenario
$client_data = [
    'phone' => 'CLIENT PHONE NUMBER HERE',
    'client_name' => 'CLIENT NAME HERE'
];

// API Request parameters
$run_scenario_data = [
    'domain' => KIT_DOMAIN,
    'access_token' => KIT_ACCESS_TOKEN,
    'scenario_id' => KIT_SCENARIO_ID,
    'phone_number_id' => KIT_CALLERID_PHONE_ID,
    'phone' => $client_data['phone'],
    'variables' => json_encode([
        'client_name' => $client_data['client_name']
    ])
];

// HTTP Request to run the scenario
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, KIT_API_URL . "scenario/runScenario");
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $run_scenario_data);
$returned = curl_exec($ch);
curl_close ($ch);