API телефонии

Запросы из Gootax

1. Отзвоны по заказу (уведомление клиента о смене статуса заказа)

Когда меняется статус заказа, если в настройках Уведомления клиенту указано, что на это событие надо сделать отзвон клиенту, то Gootax шлет HTTP-запрос на ваш сервер телефонии. В запросе передаются параметры заказа, ваш сервер телефонии по ним проговаривает клиенту информацию. 

Параметры запроса

POST {Url}/integration/gootaxpro/notify
гдe Url — адрес вашего телефонного сервера, куда необходимо отправлять запрос, подставляется из поля в Настройки → Внешние АТС.

В headers отправляем

• api-key — токен, который подставляется из поля “Токен для модуля «Голосовой информатор»” разделе в Настройки → Внешние АТС (string)

Данные по заказу отправляем в теле POST-запроса в формате JSON (Content-type: application/json)

• id — идентификатор заказа (string)
• status — статус заказа (string)* (список возможных вариантов смотрите ниже)
• car_time — приблизительное время подачи авто до клиента в минутах (integer)
• car_model — модель авто (string)
• car_mark — марка авто (string)
• car_color — цвет авто (string)
• car_number — гос номер авто (string)
• driver_phones — массив номеров телефонов водителя (array)
• client_phones — массив номеров телефонов клиента, которому надо позвонить и проговорить текущий статус заказа (array)

Если какое то значение неизвестно, то мы отправляем  null, кроме driver_phones и client_phones в этом случае отправляем пустой массив ([]).

Пример запроса 
{
    "id":"72424",
    "car_time":5,
    "car_model":"Mazda",
    "car_mark":"CX-5",
    "car_color":"Белый",
    "car_number":"М555ЕР18",
    "driver_phones":[],
    "client_phones":["79221231010"],
    "status":"new"
}

2. Связь клиент-исполнитель или исполнитель-клиент

Когда клиент и исполнитель в приложении нажимают на кнопку связаться, то Gootax шлет запрос на ваш сервер телефонии, вы получая 2 номера, им звоните и соединяете их.

Параметры запроса

POST {Url}integration/gootaxpro/callback
гдe Url — адрес вашего телефонного сервера, куда необходимо отправлять запрос, подставляется из поля в Настройки → Внешние АТС.

В headers отправляем

• api-key — токен, который подставляется из поля «Интеграционный токен» разделе в Настройки → Внешние АТС (string)

Данные по заказу отправляем в теле POST-запроса в формате JSON (Content-type: application/json)

• from — кто хочет позвонить (string) (client / driver)
• to — кому хотят позвонить (string) (driver / client)
• driver_phones — массив номеров телефонов водителя (array)
• client_phones — массив номеров телефонов клиента (array)

Все поля обязательны для заполнения.

Пример запроса
{
    "from":"client",
    "to":"driver",
    "client_phones":[79123456789],
    "driver_phones":[79123456789]
}

Запросы в Gootax

1. Получить информацию о клиенте/водителе

Параметры запроса

GET https://ats.gootax.pro/{providerName}/tenants/{tenantId}/{clients/worker}/{phone}/incoming

• providerName — имя провайдера (runtel/common)
• tenantId — идентификатор заказчика
• {clients/worker} — о ком информацию получить: о клиенте или о исполнителе
• phone — телефон клиента

Ответ приходит в формате JSON (Content-type: application/json)

• id — идентификатор заказа
• status — статус заказа (string)* (список возможных вариантов смотрите ниже)
• car_time — приблизительное время подачи авто до клиента в минутах
• car_model — модель авто
• car_mark — марка авто
• car_color — цвет авто
• car_number — гос номер авто
• driver_phones — телефон водителя
• client_phones — телефон клиента
• multi — единственный ли рабочий(со статусом “В работе”) заказ клиента (true, false)

* Статусы заказа (поле status)

• new — новый
• outdated_order — просроченный заказ
• new_pre_order — новый предварительный заказ
• worker_accepted_pre_order — водитель принял предварительный заказ
• worker_assigned_on_pre_order — водитель назначен на пред заказ
• worker_refused_order - исполнитель отказался от заказа
• car_assigned — автомобиль назначен
• worker_late — исполнитель опаздывает
• execution_pre_order — выполнение пред заказа
• car_at_place — автомобиль приехал
• executing — в работе
• complited_paid — завершен, оплачен
• rejected — отмененный
• unknown_status — неизвестный статус