Logo bacba200a5462d19729abc05fe72e4eae3dcb1742d8a25d81deb8878c7299023API Documentation

4. Objects — объекты трекинга.


4.1 Index — список объектов.

Ответ

{
  "objects": {
    "ID_ОБЪЕКТА": {
      "object_id": "ID_ОБЪЕКТА",
      "alias": "asdru",
      "country": {
        "id": 203,
        "name": "Россия"
      },
      "city": {
        "id": 1396,
        "name": "Санкт-Петербург"
      },
      "current_city_only": true,
      "title": null,
      "site_url": "http://asd.ru",
      "phone_number": "74951115923",
      "sip_uri": null,
      "use_sip": false,
      "is_tracking": true,
      "status": "active",
      "payment_plan": {
        "name": "pro_30k",
        "title": "Про 30k",
        "price": "$149.00",
        "sessions": 30000,
        "numbers": 15
      },
      "expiration_date": "12.09.2014 10:01:09",
      "sessions_reset_date": null,
      "sessions_used": 0,
      "is_upgradable": true,
      "needs_renewing": false,
      "needs_increasing": false,
      "calls_count": 0
    }
    ...
  },
  "offset": 0,
  "limit": 20,
  "count": 13,
  "total": 13
}

4.2 Show — информация об одном объекте.

Ответ

{
  "object": {
    "object_id": "ID_ОБЪЕКТА",
    "alias": "asdru",
    "country": {
      "id": 203,
      "name": "Россия"
    },
    "city": {
      "id": 1384,
      "name": "Москва"
    },
    "current_city_only": true,
    "title": null,
    "site_url": "http://asd.ru",
    "phone_number": "74951115923",
    "sip_uri": null,
    "use_sip": false,
    "is_tracking": true,
    "status": "active",
    "payment_plan": {
      "name": "pro_30k",
      "title": "Про 30k",
      "price": "$149.00",
      "sessions": 30000,
      "numbers": 15
    },
    "expiration_date": "12.09.2014 10:01:09",
    "sessions_reset_date": null,
    "sessions_used": 0,
    "is_upgradable": true,
    "needs_renewing": false,
    "needs_increasing": false,
    "calls_count": 0
  }
}

4.3 Create — создание объекта.

Тело запроса

{
  "object": {
    "phone_number": "74951234567",
    "city_id": ID_ГОРОДА,
    "site_url": "http://www.mysite.ru",
    "title": "API test #123",
    "use_sip": true,
    "sip_uri": "user@sip.mysite.ru",
    "forward_caller_id": true,
    "current_city_only": true
  }
}

Ответ

{
  "object_id": "ID_ОБЪЕКТА"
}

4.3.1 Create — создание объекта расширенное.

Тело запроса

{
  "object": {
    "phone_number": "74951234567",
    "city_id": ID_ГОРОДА,
    "site_url": "http://www.mysite.ru",
    "title": "API test #123",
    "use_sip": true,
    "sip_uri": "user@sip.mysite.ru",
    "forward_caller_id": true,
    "current_city_only": true,
    "payment_plan": "НАЗВАНИЕ_ТАРИФА",
    "tariff_items_ids":[<ID_ОПЦИИ_ТАРИФА>,<ID_ОПЦИИ_ТАРИФА>,...,<ID_ОПЦИИ_ТАРИФА>]
  }

}

Ответ

{
  "object_id": "ID_ОБЪЕКТА"
}

4.4 Update — редактирование объекта.

Тело запроса

{
  "object": {
    "phone_number": "74951234568",
    "city_id": ID_ГОРОДА,
    "site_url": "http://www.mysite.ru",
    "title": "API test #123",
    "use_sip": true,
    "sip_uri": "user@sip.mysite.ru",
    "forward_caller_id": true,
    "current_city_only": true
  }
}

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.

4.5 Delete — удаление объекта.

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.

4.6 JS code — получение JavaScript-кода объекта для установки на страницу.

Ответ

{
  "js_code": "..."
}

4.7 Send JS code — отправка на почту JavaScript-кода объекта для установки на страницу.

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.

4.8 Disable — временное отключение трекинга объекта.

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.

4.9 Enable — включение отключенного трекинга объекта.

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.

4.10 Callback — задание параметров колбека.

Тело запроса

{
  "callback_config": {
    "callback": "+74951234567",
    "from": "+74958901234",
    "time_zone": "Moscow",
    "time_from": "10:00",
    "time_to": "22:00",
    "attempts": "1",
    "call_delay": "30"
  }
}

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.

4.11 Callback disable — отключение коллбэка.

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.

4.12 Callback enable — включение коллбэка.

Ответ

В случае успеха будет получен пустой ответ с кодом статуса HTTP “200 OK”.