Получение списка сайтов
| Метод | get.sites |
|---|---|
| Описание | Получение списка сайтов |
| Кому доступен | Агент, Клиент |
Параметры запроса
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
|
filter |
object | нет | См. раздел "Критерии фильтрации" |
fields |
array | нет | См. раздел "Представление возвращаемых данных" |
sort |
array | нет | См. раздел "Сортировка данных" |
Параметры ответа
| Название | Тип | Допустимые значения | Фильтрация | Сортировка | Описание |
|---|---|---|---|---|---|
id |
number | да | Уникальный идентификатор сайта | ||
domain_name |
string | да | Адрес сайта в интернете. Без указания протокола - "http://" или "https://". | ||
name |
string | да | Имя сайта для отображения в фильтре сайтов ЛК, обзорном отчете и списке сайтов. | ||
default_phone_number |
string | E164 формат | да | Номер телефона по умолчанию, на который будут переадресованы звонки, поступающие через сайтфон, а также на номера аналитики, используемые в рекламных кампаниях. | |
default_scenario |
object | Сценарий по умолчанию, по которому будут обработаны звонки на номера без активных настроек. По умолчанию none. | |||
scenario_id |
number | Уникальный идентификатор сценария | |||
scenario_name |
string | да | Название сценария | ||
app_key |
string |
Общий ключ кода вставки для клиента
Этот параметр необходимо вставить в шаблон вместо параметра `{app_key}`
Копировать
|
|||
site_key |
string |
Ключ кода вставки для сайта
Этот параметр необходимо вставить в шаблон вместо параметра `{site_key}`
Копировать
|
|||
creation_date |
iso8601 | YYYY-MM-DD hh:mm:ss | да | Дата создания сайта | |
target_call_min_duration |
number | да | По умолчанию "30". Минимальное время звонка после которого он считается целевым. Значение задается в секундах. | ||
track_subdomains |
boolean | false, true | да | По умолчанию "true". Сбор статистики со всех поддоменов (статистика с соответствующего основному домену сайта поддомена «www» собирается всегда, вне зависимости от проставленного флага). | |
cookie_lifetime |
number | да | По умолчанию "90". Время жизни "cookie". Время задается в днях. | ||
campaign_lifetime |
number | да | По умолчанию "90". Время жизни рекламной компании. Время задается в днях. | ||
sales_enabled |
boolean | false, true | да | По умолчанию "false". Учитывать ли продажи | |
second_communication_period |
number | 1, 3, 7, 30 | да | По умолчанию "1". Период повторного обращения. Задается в днях. | |
services_enabled |
boolean | false, true | да | По умолчанию "true". Возможность деактивировать сервис для одного конкретного сайта. В деактивированном состоянии производится только сбор статистики сайта, все сервисы (колл-трекинг, онлайн-консультант) отключены и не работают. | |
replacement_dynamical_block_enabled
|
boolean | false, true | Подменять номера в динамически подгружаемых блоках. (По умолчанию False) | ||
widget_link |
object | нет | При активации опции, на формах заявок, чата и запроса анкетных данных появится ссылка, по клику на которую посетитель сайта будет перенаправлен на заданный URL. | ||
enabled |
boolean | Ссылка на виджетах | |||
text |
string | Текст ссылки (Не более 100 символов) | |||
url |
string | URL | |||
state |
string | new, disable, error, work | Статус сайта | ||
industry_id |
number | Уникальный идентификатор отрасли сайта | |||
industry_name |
string | Название отрасли сайта | |||
| Показывать идентификатор посетителя на сайта | |||||
show_visitor_id |
object | Отобразив идентификатор посетителя на сайте и узнав его у посетителя при звонке, вы сможете связать данные о посещении со звонком и тем самым узнать полные данные о звонящих (например, по каким конкретно поисковым запросам приходят посетители, которые вам звонят). | |||
enabled |
boolean | false, true | По умолчанию "false". Активируем отображение посетителя на сайте. | ||
element_id_value |
string |
Для того чтобы на сайте появился идентификатор посетителя, в этом поле необходимо указать идентификатор (id) HTML-элемента сайта.
На месте размещения идентификатора посетителя на страницах сайта необходимо добавить контейнер с данным id
(например, <div id="comagicID"></div>).
|
|||
message |
string | Задает текст, который будет выводиться рядом с номером посетителя на сайте. | |||
length_visitor_id |
string | от 1 до 20 | По умолчанию 6. Количество цифр идентификатора посетителя. | ||
| Список блоков номеров сайта | |||||
site_blocks |
array | да | Массив блоков идентификаторов. По умолчанию при создании сайта создается один блок. | ||
site_block_id |
number | Уникальный идентификатор блока | |||
site_block_name |
string | Название блока. | |||
| Подключенные интеграции | |||||
connected_integrations |
array |
|
Интеграции подключенные на уровне сайта. | ||
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.sites",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
}
}
JSON структура ответа
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"meta_data": {},
"data": [
{
"id": "number",
"domain_name": "string",
"name": "string",
"default_phone_number": "string",
"default_scenario": {
"scenario_id": "number",
"scenario_name": "string"
},
"app_key": "string",
"site_key": "string",
"industry_id": "number",
"industry_name": "string",
"target_call_min_duration": "number",
"track_subdomains": "boolean",
"cookie_lifetime": "number",
"campaign_lifetime": "number",
"sales_enabled": "boolean",
"second_communication_period": "number",
"services_enabled": "boolean",
"replacement_dynamical_block_enabled": "boolean",
"widget_link": {
"enabled": "boolean",
"text": "string",
"url": "string"
},
"show_visitor_id": {
"enabled": "boolean",
"element_id_value": "string",
"message": "string",
"length_visitor_id": "number"
},
"site_blocks": [
{
"site_block_id": "number",
"site_block_name": "string"
}
],
"connected_integrations": []
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"