Этот веб-сайт использует файлы cookie, чтобы обеспечить Вам лучший опыт
Понятно
Close

Документация по API



Добавление звонка:

Добавлять звонок можно с помощью GET или POST параметров:

https://calltools.ru/lk/cabapi_external/api/v1/phones/call/?public_key=your_public_key&phone=customer_phonenumber&campaign_id=your_campaign_id

где

Ответ при добавлении звонка:

{"call_id": 1365898635, "balance": "1069.750000", "phone": "+79999999999", "created": "2017-09-22T16:53:12.267Z"}

Результат прозвона (по номеру):

https://calltools.ru/lk/cabapi_external/api/v1/phones/calls_by_phone/?public_key=your_public_key&campaign_id=your_campaign_id&phone=customer_phonenumber&from_created_date=from_created_date&to_created_date=to_created_date&from_updated_date=from_updated_date&to_updated_date=to_updated_date

где

  • your_public_key - ключ доступа, можно сгенерировать в профиле
  • your_campaign_id - ID телефонной кампании, можно увидеть в списке кампаний
  • customer_phonenumber - номер клиента в формате +79999999999 (международный формат), не забывайте про кодирование параметров в урле запроса, если GET.
  • from_created_date (необязателен) - дата создания звонка в формате 2017-12-23 23:59:59
  • to_created_date (необязателен) - дата в формате 2017-12-23 23:59:59
  • from_updated_date (необязателен) - дата обновления статуса звонка в формате 2017-12-23 23:59:59
  • to_updated_date (необязателен) - дата в формате 2017-12-23 23:59:59

Ответ при запросе статуса по номеру:

[
    {
        "phone": "+79999999999",
        "status_display": "Пользовательский IVR",
        "recorded_audio": "https://calltools.ru/lk/cdr/record/263939440/1506099207.4251/?key=6c64c603bd4b0ec216881934b742f340",
        "status": "user",
        "dial_status_display": null,
       "dial_status": null,
        "call_id": 170925203120219,
        "user_choice": null,
        "updated": "2017-09-22T16:53:12.267Z",
        "user_choice_display": "Смс заказчику на номер +79999999999",
        "action_type": "sms_to_owner",
        "created": "2017-09-22T16:53:12.267Z",
        "button_num": 1,
        "action_type": "sms_to_client",
        "completed": "2017-09-22T16:53:12.267Z",
        "duration": 20,
    }
]

Посмотрите: Расшифровка статусов


Результат прозвона (по call_id):

https://calltools.ru/lk/cabapi_external/api/v1/phones/call_by_id/?public_key=your_public_key&call_id=your_call_id

где

  • your_public_key - ключ доступа, можно сгенерировать в профиле
  • your_call_id - ID звонка (в формате 170925203120219), которое вы получили через API при создании звонка

Ответ при запросе статуса по call_id:

[
     {
        "phone": "+79999999999",
        "status_display": "Пользовательский IVR",
        "recorded_audio": "https://calltools.ru/lk/cdr/record/263939440/1506099207.4251/?key=6c64c603bd4b0ec216881934b742f340",
        "status": "user",
        "dial_status_display": null,
       "dial_status": null,
        "call_id": 170925203120219,
        "user_choice": null,
        "updated": "2017-09-22T16:53:12.267Z",
        "user_choice_display": "Смс заказчику на номер +79999999999",
        "action_type": "sms_to_owner",
        "created": "2017-09-22T16:53:12.267Z",
        "button_num": 1
        "action_type": "sms_to_client",
        "completed": "2017-09-22T16:53:12.267Z",
        "duration": 20,
    }
]

Посмотрите: Расшифровка статусов


Добавление звонка с генерацией ролика:

Добавлять звонок с генерацией ролика можно с помощью GET или POST параметров:

https://calltools.ru/lk/cabapi_external/api/v1/phones/call/?public_key=your_public_key&phone=customer_phonenumber&campaign_id=your_campaign_id&text=your_text&speaker=your_speaker

где


Удаление звонка из прозвона по номеру или по call_id:

В процессе запущенной кампании есть возможность удалить номер из прозвона, если соответствующий звонок не был завершён:

https://calltools.ru/lk/cabapi_external/api/v1/phones/remove_call/?call_id=your_call_id&public_key=your_public_key&phone=customer_phonenumber&campaign_id=your_campaign_id

где

  • your_public_key - ключ доступа, можно сгенерировать в профиле
  • customer_phonenumber (необязателен, если указан your_call_id) - номер клиента в формате 89999999999
  • your_campaign_id - ID телефонной кампании, можно увидеть в списке кампаний
  • your_call_id (необязателен, если указан customer_phonenumber) - ID звонка (в формате 170925203120219), которое вы получили через API при создании звонка

Ошибки при обзвоне

При добавлении звонка и получении статуса прозвона, API может возвращать ошибки:

Примеры:

* При добавлении звонка:

{"status": "error", "data": "Campaign by id=123456789 dnot found"}
{"status": "error", "data": "Calls count to camp_id:123456789, +79000000000 is excess (limit 5/30sec)"}

* При получении статуса:

{"status": "error", "data": "Campaign by id=123456789 dnot found"}
{"status": "error", "data": "Call by ats_call_id=123456789 dnot found"}
{"status": "error", "data": "Phone by val=+79000000000 dnot found"}