Перейти к основному содержимому
Версия: 4.12

Описание Public API

Public API for IQChannels

Base URLs:

localhost:8080/public/api/v1

chats

checkIfAudioMessagesEnabled

POST /chats/channel/audio_messages_enabled/{channelName}

checkIfAudioMessagesEnabled

Проверка включены ли голосовые сообщения

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name

Responses

StatusMeaningDescriptionSchema
200OKOKschema.ResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

chats_getBlocker

POST /chats/channel/blocker/{channelName}

chats_channelChat

Description:

Получение настроек заглушки канала

Responses
CodeDescriptionSchema
200OKschema.ResponseApi1
400Bad Requestschema.ResponseApi1
404Not Foundschema.ResponseApi1
500Internal Server Errorschema.ResponseApi1
defaultschema.ResponseApi1

chats_channelChat

POST /chats/channel/chat/{channelName}

chats_channelChat

Информация о чате

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name
bodybodyschema.ChatInfoInputfalseПринимает одно из следующих значений: 'regular' - общий чат, 'personal_manager' - чат с персональным менеджером. Если не указано, по умолчанию считается как 'regular'

Responses

StatusMeaningDescriptionSchema
200OKOKschema.Chat
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

getChatSettings

POST /chats/channel/chat/get_settings/{channelName}

getChatSettings

Получение настроек чата

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name

Responses

StatusMeaningDescriptionSchema
200OKOKschema.SystemChatSettings
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

chats_channelMessages

POST /chats/channel/messages/{channelName}

chats_channelMessages

Получение истории сообщений в чате

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name
bodybodyschema.ChatMessageQuerytrueТело запроса

Responses

StatusMeaningDescriptionSchema
200OKOKschema.ChatMessage
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

chats_channelSend

POST /chats/channel/send/{channelName}

chats_channelSend

Отправка сообщения в чат

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name
bodybodyschema.ChatMessageInputtrueТело запроса

Responses

StatusMeaningDescriptionSchema
200OKOKschema.ResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

systemChats_channelSend

POST /chats/channel/system_chats/send/{channelName}

systemChats_channelSend

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name

Responses

StatusMeaningDescriptionSchema
200OKOKschema.ResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

checkOpenTickets

POST /chats/channel/tickets/existing/{channelName}

checkOpenTickets

Получение существующих открытых обращений

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name
bodybodyschema.CheckOpenTicketsRequesttrueТело запроса

Responses

StatusMeaningDescriptionSchema
200OKOKschema.TicketList
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

chats_channelTyping

POST /chats/channel/typing/{channelName}

chats_channelTyping

Отправка уведомления о том, что пользователь печатает сообщение

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name
bodybodyschema.ChatTypingInputfalseПринимает одно из следующих значений: 'regular' - общий чат, 'personal_manager' - чат с персональным менеджером. Если не указано, по умолчанию считается как 'regular'

Responses

StatusMeaningDescriptionSchema
200OKOKschema.EmptyResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

chats_acceptProduct

POST /chats/messages/accept_product

chats_acceptProduct

Получение услуги

Parameters

NameInTypeRequiredDescription
bodybodyschema.AcceptProductRequesttrueТело запроса

Responses

StatusMeaningDescriptionSchema
200OKOKschema.EmptyResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

chats_declineProduct

POST /chats/messages/decline_product

chats_declineProduct

Отклонить услугу

Parameters

NameInTypeRequiredDescription
bodybodyschema.AcceptProductRequesttrueТело запроса

Responses

StatusMeaningDescriptionSchema
200OKOKschema.EmptyResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

chats_messagesListen

POST /chats/messages/listen

chats_messagesListen

Подтверждение прослушивания сообщений

Parameters

NameInTypeRequiredDescription
bodybodyintegertrueТело запроса

Responses

StatusMeaningDescriptionSchema
200OKOKschema.ResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

chats_messagesRead

POST /chats/messages/read

chats_messagesRead

Подтверждение прочтения сообщений

Parameters

NameInTypeRequiredDescription
bodybodyarray[integer]trueТело запроса

Responses

StatusMeaningDescriptionSchema
200OKOKschema.EmptyResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

chats_messagesReceived

POST /chats/messages/received

chats_messagesReceived

Подтверждение получения сообщений

Parameters

NameInTypeRequiredDescription
bodybodyarray[integer]trueТело запроса

Responses

StatusMeaningDescriptionSchema
200OKOKschema.ResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

chats_Version

POST /chats/version

chats_Version

Получение версии IQChannels

Responses

StatusMeaningDescriptionSchema
200OKOKschema.Version
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients

clients_anonymousAuth

POST /clients/anonymous/auth

clients_anonymousAuth

Авторизация анонимного клиента

Responses

StatusMeaningDescriptionSchema
200OKOKschema.Client
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients_anonymousCreate

POST /clients/anonymous/create

clients_anonymousCreate

Создание анонимного клиента

Parameters

NameInTypeRequiredDescription
bodybodyschema.ClientInputtrueТело запроса

Responses

StatusMeaningDescriptionSchema
200OKOKschema.ClientAuth
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients_anonymousSignup

POST /clients/anonymous/signup

clients_anonymousSignup

Регистрация анонимного клиента

Parameters

NameInTypeRequiredDescription
bodybodyschema.ClientAnonSignuptrueТело запроса

Responses

StatusMeaningDescriptionSchema
200OKOKschema.ClientAuth
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients_auth

POST /clients/auth

clients_auth

Авторизация пользователя по сессии

Parameters

NameInTypeRequiredDescription
bodybodyschema.ClientAuthInputtrueТокен внутренний сессии на сервере чата

Responses

StatusMeaningDescriptionSchema
200OKOKschema.ClientAuth
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients_integrationAuth

POST /clients/integration_auth

clients_integrationAuth

Авторизация клиента через внешнюю систему. Например, авторизация клиента, информация о котором есть в ДБО или CRM.

Parameters

NameInTypeRequiredDescription
bodybodyschema.ClientAuthCRMInputtrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.ClientAuth
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients_integrationAuthInProject

POST /clients/integration_auth_in_project

clients_integrationAuthInProject

Авторизация клиента через внешнюю систему в проекте. Например, авторизация клиента, информация о котором есть в ДБО или CRM.

Parameters

NameInTypeRequiredDescription
bodybodyschema.ClientAuthCRMInputtrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.ClientAuth
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients_refresh

POST /clients/integration_refresh

clients_refresh

Актуализация клиента

Parameters

NameInTypeRequiredDescription
bodybodyschema.CredentialsRequesttrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.Client
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients_me

POST /clients/me

clients_me

Информация о текущем клиенте

Responses

StatusMeaningDescriptionSchema
200OKOKschema.Client
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients_online

POST /clients/online

clients_online

Отметить клиента как онлайн

Responses

StatusMeaningDescriptionSchema
200OKOKschema.EmptyResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients_signup

POST /clients/signup

clients_signup

Регистрация анонимного пользователя

Parameters

NameInTypeRequiredDescription
bodybodyschema.ClientInputNametrueИмя клиента


Responses

StatusMeaningDescriptionSchema
200OKOKschema.ClientAuth
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

clients_signupInProject

POST /clients/signup_in_project

clients_signupInProject

Регистрация анонимного пользователя в проекте

Parameters

NameInTypeRequiredDescription
bodybodyschema.ClientInputProjecttrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.ClientAuth
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

files

files_get_uid

POST /files/get/{fileId}

files_get

Ссылка на файл

Parameters

NameInTypeRequiredDescription
fileIdpathintegertrueFile Id


Responses

StatusMeaningDescriptionSchema
200OKФайл с правильным Content-Typestring
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

files_image_uid

POST /files/image/{fileId}

files_image

Ссылка на изображение. В отличии от ссылки на файл позволяет получить изображение в уменьшенном размере.

Parameters

NameInTypeRequiredDescription
fileIdpathintegertrueFile Id


Responses

StatusMeaningDescriptionSchema
200OKФайл с изображением в нужном размереstring
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

files_meta_uid

POST /files/meta/{fileId}

files_meta

Информация о файле

Parameters

NameInTypeRequiredDescription
fileIdpathintegertrueFile Id


Responses

StatusMeaningDescriptionSchema
200OKOKstring
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

files_token_uid

POST /files/token

files_token

Получение токена файла

Parameters

NameInTypeRequiredDescription
bodybodyschema.FileTokenRequesttrueАйди файла


Responses

StatusMeaningDescriptionSchema
200OKOKschema.TokenResponse
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

files_upload_uid

POST /files/upload

files_upload

Загрузка файла

Responses

StatusMeaningDescriptionSchema
200OKOKstring
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

info_requests

ignoreInfoRequest

POST /info_requests/ignore

ignoreInfoRequest

Parameters

NameInTypeRequiredDescription
bodybodyschema.RequestIdRequesttrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.ResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

respondToInfoRequest

POST /info_requests/respond

respondToInfoRequest

Parameters

NameInTypeRequiredDescription
bodybodyschema.InfoResponsetrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.InfoRequest
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

personal_managers

personal_managers_getMy

POST /personal_managers/get_my

personal_managers_getMy

Информация о персональном менеджере

Responses

StatusMeaningDescriptionSchema
200OKИнформация о персональном менеджере текущего клиентаschema.PersonalManagerResponse
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

push

push_APNS_uid

POST /push/apns

push_APNS

Регистрация APNs токена

Parameters

NameInTypeRequiredDescription
bodybodyschema.PushTokenInputtrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.EmptyResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

push_channelAPNS_uid

POST /push/channel/apns/{channelName}

push_channelAPNS

Регистрация APNS пуш-токена

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name
bodybodyschema.PushTokenInputtrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.EmptyResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

push_channelFCM_uid

POST /push/channel/fcm/{channelName}

push_channelFCM

Регистрация GCM/FCM пуш-токена

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name
bodybodyschema.PushTokenInputtrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.EmptyResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

push_userFCM_uid

POST /push/user_fcm

push_userFCM

Регистрация FCM пуш-токена для приложения операторов

Parameters

NameInTypeRequiredDescription
bodybodyschema.UserPushTokenInputtrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.EmptyResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

push_userHCM

POST /push/channel/hcm/:channelName

Регистрация HCM пуш-токена

Parameters
NameLocated inDescriptionRequiredSchema
inputbodyТело запросаYesschema.PushTokenInput
Responses
CodeDescriptionSchema
200OKschema.EmptyResponseApi1
400Bad Requestschema.ResponseApi1
404Not Foundschema.ResponseApi1
500Internal Server Errorschema.ResponseApi1
defaultschema.ResponseApi1

push_HCM

POST/push/hcm

Регистрация HCMs пуш-токена для приложения операторов

Parameters
NameLocated inDescriptionRequiredSchema
inputbodyТело запросаYesschema.PushTokenInput
Responses
CodeDescriptionSchema
200OKschema.EmptyResponseApi1
400Bad Requestschema.ResponseApi1
404Not Foundschema.ResponseApi1
500Internal Server Errorschema.ResponseApi1
defaultschema.ResponseApi1

ratings

finishPoll_uid

POST /ratings/finish_poll

finishPoll

Завершить опрос

Parameters

NameInTypeRequiredDescription
bodybodyschema.FinishRatingPollRequesttrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.ResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

ignoreRating_uid

POST /ratings/ignore

ignoreRating

Проигнорировать оценку оператора.

Parameters

NameInTypeRequiredDescription
bodybodyschema.RatingIdRequesttrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.Rating
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

queryPoll_uid

POST /ratings/query_poll

queryPoll

Получить опрос

Parameters

NameInTypeRequiredDescription
bodybodyschema.QueryRatingPollRequesttrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.RatingPollResponse
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

rateRating_uid

POST /ratings/rate

rateRating

Дать оценку оператору

Parameters

NameInTypeRequiredDescription
bodybodyschema.RatingRequesttrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.Rating
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

sendPoll_uid

POST /ratings/send_poll

sendPoll

Отправить ответ на вопрос из опроса

Parameters

NameInTypeRequiredDescription
bodybodyschema.SendRatingPollRequesttrueТело запроса


Responses

StatusMeaningDescriptionSchema
200OKOKschema.ResponseApi1
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

sse

sse_chatsChannelEvents

POST /sse/chats/channel/events/{channelName}

sse_chatsChannelEvents

События в чате

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name


Responses

StatusMeaningDescriptionSchema
200OKOKschema.ChatEvent
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

sse_chatsChannelUnread

POST /sse/chats/channel/unread/{channelName}

sse_chatsChannelUnread

Количество непрочитанных сообщений

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name


Responses

StatusMeaningDescriptionSchema
200OKOKinteger
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

widget

widgetGreetings

POST /widget/greetings/{channelName}

widgetGreetings

Получение приветствия

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name


Responses

StatusMeaningDescriptionSchema
200OKOKschema.GreetingResponse
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

widgetStyles

POST /widget/styles.css

widgetStyles

Получение кастомных стилей для виджета, заданных в IQChannels

Responses

StatusMeaningDescriptionSchema
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication

widgetPersonalDataForm

POST /widget/personal\_data\_form/{channelName}

widgetPersonalDataForm

Получение формы запроса персональных данных

Responses
CodeDescriptionSchema
200OKschema.Form
400Bad Requestschema.ResponseApi1
404Not Foundschema.ResponseApi1
500Internal Server Errorschema.ResponseApi1
defaultschema.ResponseApi1

widgetCustomFiles

POST /widget/customs/{channelName}/{fileName}

widgetCustomFiles

Получение файлов кастомизации

Responses
CodeDescriptionSchema
200OKos.File
400Bad Requestschema.ResponseApi1
404Not Foundschema.ResponseApi1
500Internal Server Errorschema.ResponseApi1
defaultschema.ResponseApi1

ws

ws_chatsChannelEvents

POST /ws/chats/channel/events/{channelName}

ws_chatsChannelEvents

События в чате

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name


Responses

StatusMeaningDescriptionSchema
200OKOKschema.ChatEvent
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

ws_chatsChannelUnread

POST /ws/chats/channel/unread/{channelName}

ws_chatsChannelUnread

Количество непрочитанных сообщений

Parameters

NameInTypeRequiredDescription
channelNamepathstringtrueChannel name


Responses

StatusMeaningDescriptionSchema
200OKOKinteger
400Bad RequestBad Requestschema.ResponseApi1
404Not FoundNot Foundschema.ResponseApi1
500Internal Server ErrorInternal Server Errorschema.ResponseApi1
defaultDefaultnoneschema.ResponseApi1

This operation does not require authentication