GET
/channels/{id}/widget Доступно#Настройки чат-виджета
Оформление чат-виджета канала web_chat вашего аккаунта: ассистент, ожидание оператора, подпись, файлы посетителя, цвет и прочее. Канал другого типа или чужой — not_found.
Параметры
| Поле | Тип | Описание |
|---|---|---|
id | string обязательное | Где: path. Идентификатор канала web_chat. |
Тело ответа
| Поле | Тип | Описание |
|---|---|---|
channel_id | string обязательное | Идентификатор канала web_chat. |
name | string обязательное | Имя канала. |
is_active | boolean обязательное | Канал включён. |
assistant_name | string обязательное, может быть null | Имя ассистента в шапке; по умолчанию — имя канала. До 60 знаков. |
assistant_subtitle | string обязательное, может быть null | Подзаголовок ассистента. До 80 знаков. |
assistant_avatar_url | string обязательное, может быть null | Иконка ассистента (шапка и лента). Только https:// или путь вашего сайта на этой ячейке, начинающийся с «/». До 500 знаков. |
queue_title | string обязательное, может быть null | Заголовок шапки, пока диалог ждёт оператора. До 60 знаков. |
queue_subtitle | string обязательное, может быть null | Подзаголовок ожидания оператора. До 80 знаков. |
queue_icon_url | string обязательное, может быть null | Иконка ожидания оператора. Только https:// или путь вашего сайта на этой ячейке, начинающийся с «/». До 500 знаков. |
powered_by | ChannelWidgetPoweredBy обязательное | |
files | ChannelWidgetFiles обязательное | |
color | string обязательное, может быть null | Цвет виджета: #rrggbb. |
greeting | string обязательное, может быть null | Приветствие. До 500 знаков. |
position | string обязательное, может быть null | Угол кнопки. Значения: bottom-right bottom-left |
theme | string обязательное, может быть null | Тема. Значения: light dark |
bubble_text | string обязательное, может быть null | Подсказка у кнопки. До 60 знаков. |
delay | integer обязательное, может быть null | Задержка показа, секунды. |
consent_text | string обязательное, может быть null | Текст согласия перед первым сообщением. До 600 знаков. |
consent_url | string обязательное, может быть null | Ссылка на документ согласия: только https://. |
Примеры
Запрос
curl -X GET 'https://formula-cream.pro/api/public/v1/channels/EXAMPLE_ID/widget' \
-H 'Authorization: Bearer '"$API_KEY"Ответ 200
{
"channel_id": "EXAMPLE_ID",
"name": "string",
"is_active": false,
"assistant_name": "string",
"assistant_subtitle": "string",
"assistant_avatar_url": "https://example.com/hooks/sapport",
"queue_title": "string",
"queue_subtitle": "string",
"queue_icon_url": "https://example.com/hooks/sapport",
"powered_by": {
"mode": "default",
"text": "string",
"url": "https://example.com/hooks/sapport"
},
"files": {
"visitor_upload": false,
"max_mb": 1
},
"color": "string",
"greeting": "string",
"position": "bottom-right",
"theme": "light",
"bubble_text": "string",
"delay": 0,
"consent_text": "string",
"consent_url": "https://example.com/hooks/sapport"
}Пример ошибки
{
"type": "https://formula-cream.pro/developers/errors#scope_missing",
"title": "Scope is missing",
"status": 403,
"code": "scope_missing",
"detail": "EXAMPLE",
"request_id": "req_EXAMPLE"
}Примеры иллюстративны: ключ в них условный (EXAMPLE), значения полей выдуманы.
Возможные ошибки
invalid_api_key wrong_cell integration_inactive tenant_inactive ip_not_allowed feature_not_in_plan rate_limited wallet_suspended service_unavailable internal_error scope_missing not_found