Описание методов создания и управления номерами системы кол-трекинг.
Маршруты и аутентификация
Для обеспечение интеграции со внешними системами, необходимо настроить отправку запросов на адрес сервера кол-трекинг. Адрес сервера выдается по запросу технической командой кол-трекинг.
| Тип данных | Способ получения |
| URL | Выдается по запросу, технической службой кол-трекинг |
Для обеспечения аутентификации используется токен аутентификации и имя провайдера:
| Параметр | Способ получения |
| provider_auth_token | Выдается по запросу, технической службой кол-трекинг |
| provider_name | Выдается по запросу, технической службой кол-трекинг |
Структура запросов
В работе с номерами в API используются запросы двух типов:
- ct_phones_import - для добавления новых телефонов
- ct_phones_read - для получения списка телефонов
- ct_phones_delete - для удаления телефонов
Данные передаются в формате JSON. Ниже представлено описание основных параметров, которые должны быть включены в запрос:
ct_phones_import
POST /api/v1/ct_phones
*Все параметры являются обязательными.
Пример запроса:
{
"provider_name": "Provider",
"provider_auth_token": "123dflmsdvpm123",
"user_uid": "180d6265-f3f3-40d1-9de7-ddec10f2af9d",
"numbers_to_add": ["+375291010101","+375291010102","+375291010103"]
}Пример ответа:
{
"status_code": 201,
"status": "Created",
"numbers_amount": 3
} ct_phones_read
GET /api/v1/ct_phones
*Все параметры являются обязательными.
Пример запроса:
api/v1/ct_phones/fe434415-0bf1-4d89-bb6e-91ffb5ec1098?provider_name=NAME&provider_auth_token=TOKEN
Пример ответа:
{
"status_code": 200,
"status": "OK",
"external_uuid": "45655",
"user_uid": "180d6265-f3f3-40d1-9de7-ddec10f2af9d",
"active_numbers": ["+375291010102", "+375291010103"],
"inactive_numbers": ["+375291010101"],
"disabled_numbers": ["+375291010102"]
}ct_phones_delete
DELETE /api/v1/ct_phones
*Все параметры являются обязательными.
Пример запроса:
{
"provider_name": "Provider",
"provider_auth_token": "123dflmsdvpm123",
"user_uid": "180d6265-f3f3-40d1-9de7-ddec10f2af9d",
"numbers_to_delete": ["+375291010101","+375291010102","+375291010103"]
}Пример ответа:
{
"status_code": 200,
"status": "OK",
"delete_info": [
{"number": ''+375291010101", "status": "deleted"},
{"number": ''+375291010102", "status": "deleted"},
{"number": ''+375291010103", "status": "used in active campaign"}
]
}