Получение списка блоков номеров

Метод	`get.site_blocks`
Описание	Получение списка блоков номеров сайта
Кому доступен	Агент, Клиент

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

Название	Тип	Обязательный	Описание
`access_token`	string	да	Ключ сессии аутентификации
`user_id`	number	нет	Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`limit`	number	нет	Количество возвращаемых записей. См. раздел "Постраничный вывод"
`offset`	number	нет	Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод"
`filter`	object	нет	См. раздел "Критерии фильтрации"
`fields`	array	нет	См. раздел "Представление возвращаемых данных"
`sort`	array	нет	См. раздел "Сортировка данных"

Параметры ответа

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
`id`	number		да		Уникальный идентификатор блока
`name`	string		да		Название блока.
`site_id`	number		да	да	Уникальный идентификатор сайта
`site_domain_name`	string		да		Адрес сайта в интернете. Без указания протокола - "http://" или "https://".
Шаблон для номера
`templates`	array				Шаблон номеров в блоке
`template_id`	number				Уникальный идентификатор шаблона виртуального номера.
`template_type`	enum	image text			Тип шаблона image - В виде картинки; text - В виде текста.
`element_attribute`	enum	id class name selector phone_number			Аттрибут заменяемого элемента на странице сайта id - Идентификатор; class - Класс; name - Название; selector - Селектор; phone_number - Номер на сайте.
`element_attribute_value`	string				Название, значение заменяемого элемента на странице сайта
`phone_number_template`	string				Если параметр `template_type` имеет значение "text", то поле имеет значение. Шаблон отображения номера. В шаблоне можно указывать любой текст, а также специальные теги: {country} - код страны, {city} - код города, {phone} - номер телефона
`phone_number_mask`	string				Если параметр `template_type` имеет значение "text", то поле имеет значение. Поле задает формат отображения {phone} (см. параметр `phone_number_template`) Для обозначения цифр используйте символ #. Длина номера может варьироваться от 5 до 7 символов. В случае, если автоматически выбранный номер окажется длиннее/короче указанной маски, все лишние/недостающие символы будут убраны из начала/добавлены в начало. Например, маска ##-##-## для номера 123456 будет обозначать, что номер на сайте выводится в формате 12-34-56, номер 1234567 будет выводиться как 123-45-67, а номер 12345 будет выводиться как 1-23-45.
Виртуальные номера и рекламные кампании
`phone_numbers`	array		да		Если, блок настроен в рекламной кампании, то он может содержать список виртуальных номеров связанных с блоком
`phone_number`	string				Виртуальный номер
`phone_number_id`	number				Уникальный номер виртуального номера
`campaign_id`	number				Уникальный идентификатор рекламной кампании в которой блок настроен, т.е у блока настроена автоматический выбор номера.
`campaign_name`	string				Название рекламной кампании в которой блок настроен, т.е у блока настроена автоматический выбор номера.
`image_url`	string				Адрес картинки, если параметр `template_type` = `image`

JSON структура запроса

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.site_blocks",
 "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": {
  "metadata": {

  },
  "data": [
   {
    "id": "number",
    "site_id": "number",
    "site_domain_name": "string",
    "templates": [
     {
      "template_id": "number",
      "template_type": "enum",
      "element_attribute": "enum",
      "element_attribute_value": "string",
      "phone_number_template": "string",
      "phone_number_mask": "string"
     }
    ],
    "phone_numbers": [
     {
      "phone_number": "string",
      "phone_number_id": "number",
      "campaign_id": "number",
      "campaign_name": "string",
      "image_url": "string"
     }
    ]
   }
  ]
 }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"