Работа со звонками
Метод:
POST/GET
URL запроса: api.streamwood.ru/calls
Параметры запроса
Параметр | Значение |
---|---|
Обязательный. Адрес электронной почты, используемый для входа в личный кабинет Streamwood. | |
api_key | Обязательный. Ключ доступа к API Streamwood. |
host_id | Integer. ID сайта в системе Streamwood. |
limit | Integer. Количество записей в ответе. Если не задано: 10. Максимум: 200. |
offset | Integer. Количество записей, которые нужно не включать в ответ для постраничного вывода. По-умолчанию: 0. |
asc |
Integer. Направление сортировки. По-умолчанию: 0. 0 — свежие в начале; 1 — свежие в конце. |
Формат ответа
Параметр | Значение |
---|---|
Data.limit | Integer. Наложенное ограничение на количество извлекаемых записей. |
Data.offset | Integer. Наложенное значение пропуска количества записей. |
Data.total | Integer. Сколько всего записей доступно для извлечения. |
Data.items | Array. Массив содержащий информация о звонках. |
Data.items.*.id | Integer. ID звонка в системе Streamwood. Уникален для каждого звонка. |
Data.items.*.url | String. Адрес страницы, с которой была оставлена заявка на обратный звонок. |
Data.items.*.created_at | String. Дата и время, когда клиент оставил заявка на звонок. |
Data.items.*.call_from |
String. Номер телефона менеджера, которому поступил звонок. Может быть пустым если звонок еще длится. |
Data.items.*.call_to |
String. Номер телефона клиента. Может быть пустым если звонок еще длится. |
Data.items.*.call_state |
String. Статус звонка. Может меняться, если звонок еще идет. SCHEDULED — заказ звонка на определенное время; ERROR — в процессе обработки звонка произошла ошибка; BUSY — телефон менеджера занят; UNANSWERED — клиент не ответил на звонок; ANSWERED — звонок успешно состоялся; NONE — звонок еще длится. |
Data.items.*.duration | Integer. Длительность звонка в секундах. |
Data.items.*.record | String. Ссылка на запись разговора (mp3-файл). |
Data.items.*.host.id | Integer. ID сайта в системе Streamwood, на котором была оставлена заявка на обратный звонок. |
Data.items.*.host.name | String. Имя сайта в системе Streamwood, на котором была оставлена заявка на обратный звонок. |
Data.items.*.session.id | Integer. ID клиента в системе Streamwood. |
Data.items.*.session.expired | True. Содержится в ответе ТОЛЬКО если время жизни сессии клиента в системе Streamwood истекло. Все остальные параметры сессии при этом значении отсутствуют. |
Data.items.*.session.client_name | String. Имя клиента. |
Data.items.*.session.last_visit | String. Дата и время последнего визита клиента на сайт. |
Data.items.*.session.created_at | String. Дата и время первого визита клиента на сайт. |
Data.items.*.session.ip | String. IP-адрес клиента. |
Data.items.*.session.url | String. Адрес последней посещенной страницы на сайта. |
Data.items.*.session.utm_campaign Data.items.*.session.utm_source Data.items.*.session.utm_medium Data.items.*.session.utm_term Data.items.*.session.utm_content |
String. UTM-метки, если они присутствовали при обращении клиента. |