# livedigital

> livedigital documentation portal (public build)


## search

- [Search the documentation](/search.md)

## docs


### android-sdk

- [Отправка аналитики](/docs/android-sdk/analytics.md): В процессе работы SDK отправляет на сервер livedigital анонимные аналитические данные, которые помогают нам находить ошибки и улучшать его работу.
- [Обмен дополнительными данными](/docs/android-sdk/appdata.md): В процессе звонка участники могут отправлять друг другу произвольные данные. Для этого каждый участник при подключении к серверу указывает один объект JSONObject, который могут прочитать другие участники. Этот объект может быть изменён в любое время.
- [Системные разрешения Android](/docs/android-sdk/call-permissions.md): Ниже приведён полный список разрешений, которые могут потребоваться для различных сценариев работы приложения.
- [Настройка качества](/docs/android-sdk/encoding.md): При трансляции видео и аудио SDK получает медиапоток с устройства и кодирует его перед передачей другим участникам звонка.
- [Введение](/docs/android-sdk/intro.md): livedigital Android SDK позволяет интегрировать ваше Android-приложение с сервисом livedigital для участия в видеозвонках с мобильного устройства.
- [Звонки на телефон](/docs/android-sdk/phone-calls.md): Есть два способа реализации телефонных звонков с помощью livedigital SDK:
- [Android SDK Reference](/docs/android-sdk/sdk-reference.md): Актуальная версия

### category

- [API](/docs/category/moodhood-api.md): livedigital common API
- [Push Registration API](/docs/category/push-registration-api.md): Push Registration API
- [Авторизация](/docs/category/авторизация.md)
- [Дополнительная информация](/docs/category/дополнительная-информация.md)
- [Доступ пользователей](/docs/category/доступ-пользователей.md)

### docs

- [Руководство администратора](/docs/docs/admin_manual.md): <iframe
- [Перечень внешних и внутренних сторонних компонентов/систем, используемых в программе и/или необходимых для ее функционирования](/docs/docs/components.md): <iframe
- [Функциональные характеристики](/docs/docs/functional_charachteristics.md): <iframe
- [Оглавление](/docs/docs/intro.md): - Руководство администратора
- [Документация, содержащая описание процессов, обеспечивающих поддержание жизненного цикла программного обеспечения](/docs/docs/lifecycle_docs.md): в том числе устранение неисправностей, выявленных в ходе эксплуатации программного обеспечения, а также информация о персонале, необходимом для обеспечения такой поддержки
- [On-Premise установка стенда ВКС](/docs/docs/onpremise.md): Инструкция по установке экземпляра программного обеспечения
- [Описание технических средств хранения исходного текста и объектного кода программного обеспечения](/docs/docs/source_docs.md): а также технических средств компиляции исходного текста в объектный код программного обеспечения
- [Руководство пользователя](/docs/docs/user_manual.md): <iframe

### ios-sdk

- [Пример интеграции](/docs/ios-sdk/example-project.md): Репозиторий https://github.com/VLprojects/livedigital-ios-sdk-binary содержит папку Example с проектом демонстрирующим интеграцию и использование livedigital SDK. Example проект выполнен в минималистичном духе и не должен рассматриваться с точки зрения удобства UX, красоты кода и архитектуры, надёжности решений и т.д.
- [Начало работы](/docs/ios-sdk/getting-started.md): Подготовка комнаты
- [Работа с входящим медиа](/docs/ios-sdk/inbound-media-tracks.md): Описанные методы вызываются у объекта сессии ChannelSession.
- [Подключение SDK](/docs/ios-sdk/installation.md): Доступны два способа подключения через менеджеры зависимостей — CocoaPods и SwiftPM. Мы рекомендуем использовать SwiftPM как более актуальное и современное решение.
- [Введение](/docs/ios-sdk/intro.md): livedigital SDK — клиент сервиса livedigital, поставляемый в формате толстого бинарного XCFramework.
- [Работа с исходящим медиа](/docs/ios-sdk/outbound-media-tracks.md): Для начала вещания медиа приложение должно совершить три действия:
- [Звонки на телефон](/docs/ios-sdk/phone-calls.md): При on-premise развёртывании наших сервисов, включая SIP-шлюз и CRS API, livedigital SDK позволяет реализовать входящие и исходящие телефонные звонки.
- [iOS SDK Reference](/docs/ios-sdk/sdk-reference.md): Актуальная версия
- [Что внутри](/docs/ios-sdk/whats-inside.md): Приложение изолировано от всех деталей реализации видео-связи, однако чтобы понимать возможности и ограничения livedigital SDK, может быть полезно понимать на основе чего он построен.
- [Работа с сессией](/docs/ios-sdk/working-with-session.md): После подготовки, создания и старта сессии (см. раздел Начало работы) клиент (код приложения отвечающий за управление звонком) получает объект ChannelSession. Клиент должен зарегистрировать себя как делегат и наблюдатель сессии:

### moodhood-api

- [Activate an invite](/docs/moodhood-api/v1/activate-invite.md): Activate an invite
- [Activate room access-link for currently authenticated client](/docs/moodhood-api/v1/activate-room-access-link.md): Activate room access-link for currently authenticated client
- [Activate subscription link for current account](/docs/moodhood-api/v1/activate-subscription-link.md): Activate subscription link for current account
- [Calls for analytics metrics](/docs/moodhood-api/v1/analytics-calls.md): Calls for analytics metrics
- [Get an analytical report based on room polls in JSON format](/docs/moodhood-api/v1/analytics-room-polls.md): Get an analytical report based on room polls in JSON format
- [Authenticate user by phone number (creates a new user account if the user authenticates for the first time).](/docs/moodhood-api/v1/authenticate-user-by-phone.md): Authenticate user by phone number (creates a new user account if the user authenticates for the first time).
- [Change user role](/docs/moodhood-api/v1/change-user-role.md): Change user role
- [Clear a room chat history.](/docs/moodhood-api/v1/clear-a-room-chat-history.md): Clear a room chat history.
- [Count available rooms](/docs/moodhood-api/v1/count-available-rooms.md): Count available rooms
- [Create a new poll](/docs/moodhood-api/v1/create-a-new-poll.md): Create a new poll
- [Create action authorization ticket by verification code](/docs/moodhood-api/v1/create-action-authorization-ticket.md): Create action authorization ticket by verification code
- [Register a new user. Client accessToken must be provided.](/docs/moodhood-api/v1/create-new-user.md): Register a new user. Client accessToken must be provided.
- [Create a new oauth2-client](/docs/moodhood-api/v1/create-oauth-2-client.md): Create a new oauth2-client
- [Create a new participant](/docs/moodhood-api/v1/create-participant.md): Create a new participant
- [Create participant signaling token](/docs/moodhood-api/v1/create-participant-signaling-token.md): Create participant signaling token
- [Create a new playback](/docs/moodhood-api/v1/create-playback.md): Create a new playback
- [Create a new playback event](/docs/moodhood-api/v1/create-playback-event.md): Create a new playback event
- [Create room for quick call](/docs/moodhood-api/v1/create-quick-call.md): Create room for quick call
- [Create a new room](/docs/moodhood-api/v1/create-room.md): Create a new room
- [Create a new room access-link](/docs/moodhood-api/v1/create-room-access-link.md): Create a new room access-link
- [Create a new room invite](/docs/moodhood-api/v1/create-room-invite.md): Create a new room invite
- [Create a new space and grant an owner role for the space creator](/docs/moodhood-api/v1/create-space.md): Create a new space and grant an owner role for the space creator
- [Create a new space invite](/docs/moodhood-api/v1/create-space-invite.md): Create a new space invite
- [Create upload asset signature with upload URL](/docs/moodhood-api/v1/create-upload-room-asset-signature.md): Create upload asset signature with upload URL
- [Create a new space webhook](/docs/moodhood-api/v1/create-web-hook.md): Create a new space webhook
- [Delete a room record. The empty folder will be deleted as well](/docs/moodhood-api/v1/delete-a-room-record-the-empty-folder-will-be-deleted-as-well.md): Delete a room record. The empty folder will be deleted as well
- [Delete breakout rooms](/docs/moodhood-api/v1/delete-breakout-rooms.md): Delete breakout rooms
- [Delete HelpRequest](/docs/moodhood-api/v1/delete-help-request.md): Delete HelpRequest
- [Delete an invite](/docs/moodhood-api/v1/delete-invite.md): Delete an invite
- [Delete a space oauth2-client](/docs/moodhood-api/v1/delete-oauth-2-client.md): Delete a space oauth2-client
- [Delete participant](/docs/moodhood-api/v1/delete-participant.md): Delete participant
- [Delete a single playback by its ID](/docs/moodhood-api/v1/delete-playback-by-id.md): Delete a single playback by its ID
- [Delete a single playback event by its ID](/docs/moodhood-api/v1/delete-playback-event-by-id.md): Delete a single playback event by its ID
- [Erase playback timeline history by playback ID](/docs/moodhood-api/v1/delete-playback-timeline.md): Erase playback timeline history by playback ID
- [Delete a room](/docs/moodhood-api/v1/delete-room.md): Delete a room
- [Delete room access-link](/docs/moodhood-api/v1/delete-room-access-link.md): Delete room access-link
- [Delete room asset by id](/docs/moodhood-api/v1/delete-room-asset.md): Delete room asset by id
- [Delete a room call announcement](/docs/moodhood-api/v1/delete-room-call-announcement.md): Delete a room call announcement
- [Delete a space](/docs/moodhood-api/v1/delete-space.md): Delete a space
- [Delete user](/docs/moodhood-api/v1/delete-user.md): Delete user
- [Delete user image](/docs/moodhood-api/v1/delete-user-image.md): Delete user image
- [Delete a space webhook](/docs/moodhood-api/v1/delete-web-hook.md): Delete a space webhook
- [Download playback timeline by playback ID](/docs/moodhood-api/v1/download-playback-timeline.md): Download playback timeline by playback ID
- [Finish room call for everyone](/docs/moodhood-api/v1/finish-call-for-everyone.md): Finish room call for everyone
- [Get a room chat history by call id](/docs/moodhood-api/v1/get-a-room-chat-history-by-call-id.md): Get a room chat history by call id
- [Get a room polls](/docs/moodhood-api/v1/get-a-room-polls.md): Get a room polls
- [Get a room records](/docs/moodhood-api/v1/get-a-room-records.md): Get a room records
- [Getting an AccessToken for a client application or user. All requests to resources requiring authentication must be signed with an accessToken passed in Bearer auth header or get-parameter.](/docs/moodhood-api/v1/get-access-token.md): Getting an AccessToken for a client application or user. All requests to resources requiring authentication must be signed with an accessToken passed in Bearer auth header or get-parameter.
- [Get an active room call with call data](/docs/moodhood-api/v1/get-active-room-call-data.md): Get an active room call with call data
- [Get and search for records (for account)](/docs/moodhood-api/v1/get-and-search-for-records-for-account.md): Get and search for records (for account)
- [Get breakout room cached allocation](/docs/moodhood-api/v1/get-breakout-room-allocation.md): Get breakout room cached allocation
- [Get breakout rooms help requests](/docs/moodhood-api/v1/get-breakout-rooms-help-requests.md): Get breakout rooms help requests
- [Breakout rooms list](/docs/moodhood-api/v1/get-breakout-rooms-list.md): Breakout rooms list
- [Get current plan of a space from spaceId as a guest or from account as owner](/docs/moodhood-api/v1/get-current-plan.md): Get current plan of a space from spaceId as a guest or from account as owner
- [Get current room record](/docs/moodhood-api/v1/get-current-room-record.md): Get current room record
- [Get current room streaming](/docs/moodhood-api/v1/get-current-room-streaming.md): Get current room streaming
- [Get overridden space user permissions](/docs/moodhood-api/v1/get-overridden-space-permissions.md): Get overridden space user permissions
- [Get room participation history of the signed in user](/docs/moodhood-api/v1/get-own-rooms-participation.md): Get room participation history of the signed in user
- [Get public user meta of the signed in user](/docs/moodhood-api/v1/get-own-user-meta.md): Get public user meta of the signed in user
- [Get participants information. User accessToken must be provided.](/docs/moodhood-api/v1/get-participants.md): Get participants information. User accessToken must be provided.
- [Get participants information. User accessToken must be provided.](/docs/moodhood-api/v1/get-participants-list.md): Get participants information. User accessToken must be provided.
- [Create a personal token that can be used as your account identity in a server-side apps. It should be kept secure because it does not have an expiration date](/docs/moodhood-api/v1/get-personal-token.md): Create a personal token that can be used as your account identity in a server-side apps. It should be kept secure because it does not have an expiration date
- [Get a list of your personal tokens](/docs/moodhood-api/v1/get-personal-tokens.md): Get a list of your personal tokens
- [Get a single playback by its ID](/docs/moodhood-api/v1/get-playback-by-id.md): Get a single playback by its ID
- [Get a single playback event by its ID](/docs/moodhood-api/v1/get-playback-event-in-space-by-id.md): Get a single playback event by its ID
- [Get playback event sessions](/docs/moodhood-api/v1/get-playback-event-sessions.md): Get playback event sessions
- [Get timeline by playback event ID](/docs/moodhood-api/v1/get-playback-event-timeline.md): Get timeline by playback event ID
- [Get playback events](/docs/moodhood-api/v1/get-playback-events.md): Get playback events
- [Get playback timeline by playback ID](/docs/moodhood-api/v1/get-playback-timeline.md): Get playback timeline by playback ID
- [Get playbacks](/docs/moodhood-api/v1/get-playbacks.md): Get playbacks
- [Get pre join participants list](/docs/moodhood-api/v1/get-pre-join-participants.md): Get pre join participants list
- [Get a room](/docs/moodhood-api/v1/get-room.md): Get a room
- [Get room access-link by id](/docs/moodhood-api/v1/get-room-access-link.md): Get room access-link by id
- [Get permanent room access-links](/docs/moodhood-api/v1/get-room-access-links.md): Get permanent room access-links
- [Get an active room call](/docs/moodhood-api/v1/get-room-active-call.md): Get an active room call
- [Get room by it's alias with aggregated information](/docs/moodhood-api/v1/get-room-aggregated-information.md): Get room by it's alias with aggregated information
- [Get room by it's id with aggregated information](/docs/moodhood-api/v1/get-room-aggregated-information-by-id.md): Get room by it's id with aggregated information
- [Get room analytics report of a call](/docs/moodhood-api/v1/get-room-analytics-report.md): Get room analytics report of a call
- [Get signed URL for room asset](/docs/moodhood-api/v1/get-room-asset-signed-url.md): Get signed URL for room asset
- [Get room assets from base (parent) room](/docs/moodhood-api/v1/get-room-assets.md): Get room assets from base (parent) room
- [Get room by it's alias](/docs/moodhood-api/v1/get-room-by-alias.md): Get room by it's alias
- [Get active room call data](/docs/moodhood-api/v1/get-room-call-data.md): Get active room call data
- [Get room calls with pagination](/docs/moodhood-api/v1/get-room-calls.md): Get room calls with pagination
- [Get room current state](/docs/moodhood-api/v1/get-room-current-state.md): Get room current state
- [Returns an object with record audio file download URL. URL is valid for 12 hours](/docs/moodhood-api/v1/get-room-record-audio-file-download-url.md): Returns an object with record audio file download URL. URL is valid for 12 hours
- [Returns a URL to download audio tracks archive. URL is valid for 24 hours.](/docs/moodhood-api/v1/get-room-record-audio-tracks-archive-download-url.md): Returns a URL to download audio tracks archive. URL is valid for 24 hours.
- [Returns transcription of dialogue from video recording and optional summarization](/docs/moodhood-api/v1/get-room-record-transcription.md): Returns transcription of dialogue from video recording and optional summarization
- [Get room records by callId](/docs/moodhood-api/v1/get-room-records-by-call-id.md): Get room records by callId
- [Rooms list](/docs/moodhood-api/v1/get-rooms-list.md): Rooms list
- [Get space info](/docs/moodhood-api/v1/get-space.md): Get space info
- [Get space records size in bytes](/docs/moodhood-api/v1/get-space-records-size.md): Get space records size in bytes
- [Space users list](/docs/moodhood-api/v1/get-space-users-list.md): Space users list
- [Get spaces list](/docs/moodhood-api/v1/get-spaces-list.md): Get spaces list
- [Getting decoded information about the passed access token. Must be provided in one of - cookie, get-parameter, request body or in header 'Authorization'](/docs/moodhood-api/v1/get-token-decoded-info.md): Getting decoded information about the passed access token. Must be provided in one of - cookie, get-parameter, request body or in header 'Authorization'
- [Get user information of the signed in user](/docs/moodhood-api/v1/get-user-info.md): Get user information of the signed in user
- [Get a space webhook](/docs/moodhood-api/v1/get-web-hook.md): Get a space webhook
- [Grant role to user at room](/docs/moodhood-api/v1/grant-role-to-user-at-room.md): Grant role to user at room
- [Join a room](/docs/moodhood-api/v1/join-room.md): Join a room
- [Kick participant from room](/docs/moodhood-api/v1/kick-participant.md): Kick participant from room
- [livedigital API](/docs/moodhood-api/v1/livedigital-api.md)
- [Move participants to another rooms](/docs/moodhood-api/v1/move-participants.md): Move participants to another rooms
- [Pause room recording](/docs/moodhood-api/v1/pause-room-recording.md): Pause room recording
- [Create breakout rooms](/docs/moodhood-api/v1/post-breakout-rooms.md): Create breakout rooms
- [Update a room call announcement](/docs/moodhood-api/v1/post-room-call-announcement.md): Update a room call announcement
- [Preview playback](/docs/moodhood-api/v1/preview-playback.md): Preview playback
- [Download video from storage. The lifetime of the link is one day.](/docs/moodhood-api/v1/redirect-to-download-room-record.md): Download video from storage. The lifetime of the link is one day.
- [Refresh secret for space webhook](/docs/moodhood-api/v1/refresh-secret-web-hook.md): Refresh secret for space webhook
- [Removing accessToken and refreshToken from cookies. Access token must be provided in one of - cookie, get-parameter, request body or in header 'Authorization'](/docs/moodhood-api/v1/removing-access-token-and-refresh-token-from-cookies-access-token-must-be-provided-in-one-of-cookie-get-parameter-request-body-or-in-header-authorization.md): Removing accessToken and refreshToken from cookies. Access token must be provided in one of - cookie, get-parameter, request body or in header 'Authorization'
- [Request email change](/docs/moodhood-api/v1/request-email-change.md): Request user email change
- [Request password change](/docs/moodhood-api/v1/request-password-change.md): Request password change
- [Restrict permissions to some devices for users in the room](/docs/moodhood-api/v1/restrict-devices-at-room.md): Restrict permissions to some devices for users in the room
- [Resume room recording](/docs/moodhood-api/v1/resume-room-recording.md): Resume room recording
- [Revoke given personal token by it's ID](/docs/moodhood-api/v1/revoke-given-personal-token-by-its-id.md): Revoke given personal token by it's ID
- [Revoke role from user at room](/docs/moodhood-api/v1/revoke-role-from-user-at-room.md): Revoke role from user at room
- [Revoke user role](/docs/moodhood-api/v1/revoke-user-role.md): Revoke user role
- [Generate access to room](/docs/moodhood-api/v1/room-generate-access.md): Generate access to room
- [Save breakout room participant allocation](/docs/moodhood-api/v1/save-breakout-room-allocation.md): Save breakout room participant allocation
- [AccessLinkResponse](/docs/moodhood-api/v1/schemas/accesslinkresponse.md)
- [AcquisitionChannel](/docs/moodhood-api/v1/schemas/acquisitionchannel.md)
- [ActionAuthorizationRequestsExceededError](/docs/moodhood-api/v1/schemas/actionauthorizationrequestsexceedederror.md)
- [ActionAuthorizationRequestsExceededErrorSubCodeType](/docs/moodhood-api/v1/schemas/actionauthorizationrequestsexceedederrorsubcodetype.md)
- [ActionAuthorizationScopes](/docs/moodhood-api/v1/schemas/actionauthorizationscopes.md)
- [ActionAuthorizationScopesPropertyValidationError](/docs/moodhood-api/v1/schemas/actionauthorizationscopespropertyvalidationerror.md)
- [ActionAuthorizationScopeType](/docs/moodhood-api/v1/schemas/actionauthorizationscopetype.md)
- [ActionAuthorizationTicketScopeInvalidError](/docs/moodhood-api/v1/schemas/actionauthorizationticketscopeinvaliderror.md)
- [ActionAuthorizationTicketScopeInvalidErrorSubCodeType](/docs/moodhood-api/v1/schemas/actionauthorizationticketscopeinvaliderrorsubcodetype.md)
- [ActionAuthorizationTicketStaleOrInvalidError](/docs/moodhood-api/v1/schemas/actionauthorizationticketstaleorinvaliderror.md)
- [ActionAuthorizationTicketStaleOrInvalidErrorSubCodeType](/docs/moodhood-api/v1/schemas/actionauthorizationticketstaleorinvaliderrorsubcodetype.md)
- [ActionAuthorizationTicketType](/docs/moodhood-api/v1/schemas/actionauthorizationtickettype.md): Action authorization ticket used to authorize some action
- [ActivityInterval](/docs/moodhood-api/v1/schemas/activityinterval.md)
- [ActivityType](/docs/moodhood-api/v1/schemas/activitytype.md)
- [AlreadyRegisteredError](/docs/moodhood-api/v1/schemas/alreadyregisterederror.md)
- [AlreadyRegisteredErrorSubCodeType](/docs/moodhood-api/v1/schemas/alreadyregisterederrorsubcodetype.md)
- [AnalyticsChatMessage](/docs/moodhood-api/v1/schemas/analyticschatmessage.md)
- [AnalyticsReportItem](/docs/moodhood-api/v1/schemas/analyticsreportitem.md)
- [AnnouncementEvent](/docs/moodhood-api/v1/schemas/announcementevent.md)
- [AnnouncementEventData](/docs/moodhood-api/v1/schemas/announcementeventdata.md)
- [AnnouncementIdPathParam](/docs/moodhood-api/v1/schemas/announcementidpathparam.md)
- [AnnouncementResponse](/docs/moodhood-api/v1/schemas/announcementresponse.md)
- [AnnouncementType](/docs/moodhood-api/v1/schemas/announcementtype.md): Type of an announcement is used to show different UI for an announcement
- [AssetKindType](/docs/moodhood-api/v1/schemas/assetkindtype.md): Kind of an asset
- [AssetResponse](/docs/moodhood-api/v1/schemas/assetresponse.md)
- [AssetTypeType](/docs/moodhood-api/v1/schemas/assettypetype.md): Type of an asset
- [AuditoryType](/docs/moodhood-api/v1/schemas/auditorytype.md): Target auditory to which an action relates. Usually defaults to all
- [AuthenticateUserByPhoneRequestBody](/docs/moodhood-api/v1/schemas/authenticateuserbyphonerequestbody.md)
- [AuthenticateUserByPhoneResponse](/docs/moodhood-api/v1/schemas/authenticateuserbyphoneresponse.md)
- [Bizon365TimelineUpload](/docs/moodhood-api/v1/schemas/bizon-365-timelineupload.md)
- [BreakoutRoom](/docs/moodhood-api/v1/schemas/breakoutroom.md)
- [BreakoutRoomCallReportJSONPayload](/docs/moodhood-api/v1/schemas/breakoutroomcallreportjsonpayload.md)
- [BreakoutRoomReportJSONPayload](/docs/moodhood-api/v1/schemas/breakoutroomreportjsonpayload.md)
- [BreakoutRooms](/docs/moodhood-api/v1/schemas/breakoutrooms.md)
- [BreakoutRoomsLimitReachedError](/docs/moodhood-api/v1/schemas/breakoutroomslimitreachederror.md)
- [BreakoutRoomsSession](/docs/moodhood-api/v1/schemas/breakoutroomssession.md)
- [BreakoutRoomsSessionStatusType](/docs/moodhood-api/v1/schemas/breakoutroomssessionstatustype.md): Status of breakout rooms session
- [Call](/docs/moodhood-api/v1/schemas/call.md)
- [CallData](/docs/moodhood-api/v1/schemas/calldata.md)
- [ChangeUserSpaceRoleRequestBody](/docs/moodhood-api/v1/schemas/changeuserspacerolerequestbody.md)
- [ChatMessageEventData](/docs/moodhood-api/v1/schemas/chatmessageeventdata.md)
- [ChatTokenType](/docs/moodhood-api/v1/schemas/chattokentype.md): A token of chat app, also known as apiToken. Every space has a chatToken field
- [ChatUserData](/docs/moodhood-api/v1/schemas/chatuserdata.md)
- [ClientUniqueIdType](/docs/moodhood-api/v1/schemas/clientuniqueidtype.md): Unique ID of a client device (WEB/iOS/Android). Should be the same across all the requests on same device
- [CreateActionAuthorizationTicketRequestBody](/docs/moodhood-api/v1/schemas/createactionauthorizationticketrequestbody.md)
- [CreateActionAuthorizationTicketRequestValidationErrors](/docs/moodhood-api/v1/schemas/createactionauthorizationticketrequestvalidationerrors.md)
- [CreateActionAuthorizationTicketResponse](/docs/moodhood-api/v1/schemas/createactionauthorizationticketresponse.md)
- [CreateAnnouncementRequestBody](/docs/moodhood-api/v1/schemas/createannouncementrequestbody.md)
- [CreateBreakoutRoomsParams](/docs/moodhood-api/v1/schemas/createbreakoutroomsparams.md)
- [CreateChatMessageEventData](/docs/moodhood-api/v1/schemas/createchatmessageeventdata.md)
- [CreateChatRoomChannelErrorCodeType](/docs/moodhood-api/v1/schemas/createchatroomchannelerrorcodetype.md)
- [CreateChatUserData](/docs/moodhood-api/v1/schemas/createchatuserdata.md)
- [CreateParticipantParams](/docs/moodhood-api/v1/schemas/createparticipantparams.md)
- [CreatePollOption](/docs/moodhood-api/v1/schemas/createpolloption.md)
- [CreatePollParams](/docs/moodhood-api/v1/schemas/createpollparams.md)
- [CreateQuickCallRequestErrors](/docs/moodhood-api/v1/schemas/createquickcallrequesterrors.md)
- [CreateQuickCallRoomRequestsExceededErrorSubCodeType](/docs/moodhood-api/v1/schemas/createquickcallroomrequestsexceedederrorsubcodetype.md)
- [CreateQuickCallValidationErrors](/docs/moodhood-api/v1/schemas/createquickcallvalidationerrors.md)
- [CreateRoomChatChannelError](/docs/moodhood-api/v1/schemas/createroomchatchannelerror.md)
- [CreateRoomInviteResponse](/docs/moodhood-api/v1/schemas/createroominviteresponse.md)
- [CreateRoomInviteRoleType](/docs/moodhood-api/v1/schemas/createroominviteroletype.md)
- [CreateRoomParams](/docs/moodhood-api/v1/schemas/createroomparams.md)
- [CreateSpaceInviteResponse](/docs/moodhood-api/v1/schemas/createspaceinviteresponse.md)
- [CreateSpaceInviteRoleType](/docs/moodhood-api/v1/schemas/createspaceinviteroletype.md)
- [CreateSpaceParams](/docs/moodhood-api/v1/schemas/createspaceparams.md)
- [CreateUploadRoomAssetSignatureResponse](/docs/moodhood-api/v1/schemas/createuploadroomassetsignatureresponse.md)
- [CreateUserChat](/docs/moodhood-api/v1/schemas/createuserchat.md)
- [CreateUserCommonParams](/docs/moodhood-api/v1/schemas/createusercommonparams.md)
- [CreateUserRequestBody](/docs/moodhood-api/v1/schemas/createuserrequestbody.md)
- [CreateVerificationCodeRequestValidationErrors](/docs/moodhood-api/v1/schemas/createverificationcoderequestvalidationerrors.md)
- [CreateWebHookParams](/docs/moodhood-api/v1/schemas/createwebhookparams.md)
- [CurrencyCodeType](/docs/moodhood-api/v1/schemas/currencycodetype.md): Code of a used currency
- [CustomAcquisitionChannel](/docs/moodhood-api/v1/schemas/customacquisitionchannel.md)
- [CustomActivityType](/docs/moodhood-api/v1/schemas/customactivitytype.md)
- [CustomInputElement](/docs/moodhood-api/v1/schemas/custominputelement.md)
- [CustomInputElementTitleType](/docs/moodhood-api/v1/schemas/custominputelementtitletype.md): Title of the field, describing it's purpose
- [CustomInputElementTypeType](/docs/moodhood-api/v1/schemas/custominputelementtypetype.md): How the element should be rendered and validated
- [CustomSphere](/docs/moodhood-api/v1/schemas/customsphere.md)
- [DefaultTimelineUpload](/docs/moodhood-api/v1/schemas/defaulttimelineupload.md)
- [DeleteRecordResponse](/docs/moodhood-api/v1/schemas/deleterecordresponse.md)
- [DemonstrationBroadcast](/docs/moodhood-api/v1/schemas/demonstrationbroadcast.md)
- [DemonstrationEmbedded](/docs/moodhood-api/v1/schemas/demonstrationembedded.md)
- [DemonstrationInterval](/docs/moodhood-api/v1/schemas/demonstrationinterval.md)
- [DemonstrationMiro](/docs/moodhood-api/v1/schemas/demonstrationmiro.md)
- [DemonstrationType](/docs/moodhood-api/v1/schemas/demonstrationtype.md): Describes type of demonstration
- [DemonstrationTypeEnum](/docs/moodhood-api/v1/schemas/demonstrationtypeenum.md): Demonstration type
- [EmbeddedDemonstrationMeta](/docs/moodhood-api/v1/schemas/embeddeddemonstrationmeta.md)
- [ForbiddenErrorCodeType](/docs/moodhood-api/v1/schemas/forbiddenerrorcodetype.md)
- [GenerateRoomAccessParams](/docs/moodhood-api/v1/schemas/generateroomaccessparams.md)
- [GenerateRoomAccessResponse](/docs/moodhood-api/v1/schemas/generateroomaccessresponse.md)
- [HelpRequest](/docs/moodhood-api/v1/schemas/helprequest.md)
- [InputElement](/docs/moodhood-api/v1/schemas/inputelement.md)
- [InputElementDescriptionType](/docs/moodhood-api/v1/schemas/inputelementdescriptiontype.md)
- [InputElementOrderType](/docs/moodhood-api/v1/schemas/inputelementordertype.md): Order of the element in list (sorted ASC)
- [InputElementSlugType](/docs/moodhood-api/v1/schemas/inputelementslugtype.md): Unique element identifier. userName field is automatically added for all room types.
- [InputElementTitleType](/docs/moodhood-api/v1/schemas/inputelementtitletype.md): Optional title of the field, describing it's purpose (is not used in UI)
- [InputElementTypeType](/docs/moodhood-api/v1/schemas/inputelementtypetype.md): How the element should be rendered and validated. Use 'text' for userName field.
- [InvalidRequestErrorCodeType](/docs/moodhood-api/v1/schemas/invalidrequesterrorcodetype.md)
- [InvalidSignatureError](/docs/moodhood-api/v1/schemas/invalidsignatureerror.md)
- [IsoDateTime](/docs/moodhood-api/v1/schemas/isodatetime.md): Date and time in ISO 8601 format
- [JoinSettings](/docs/moodhood-api/v1/schemas/joinsettings.md)
- [MainReportAnnouncement](/docs/moodhood-api/v1/schemas/mainreportannouncement.md)
- [MainReportAnnouncementEvent](/docs/moodhood-api/v1/schemas/mainreportannouncementevent.md)
- [MediumPropertyValidationError](/docs/moodhood-api/v1/schemas/mediumpropertyvalidationerror.md)
- [MiroBoardMeta](/docs/moodhood-api/v1/schemas/miroboardmeta.md)
- [NotFoundErrorCodeType](/docs/moodhood-api/v1/schemas/notfounderrorcodetype.md)
- [NotificationSettings](/docs/moodhood-api/v1/schemas/notificationsettings.md)
- [Oauth2Client](/docs/moodhood-api/v1/schemas/oauth-2-client.md)
- [ObjectIdType](/docs/moodhood-api/v1/schemas/objectidtype.md)
- [OwnRoomParticipationItem](/docs/moodhood-api/v1/schemas/ownroomparticipationitem.md)
- [OwnRoomsParticipationResponse](/docs/moodhood-api/v1/schemas/ownroomsparticipationresponse.md)
- [Participant](/docs/moodhood-api/v1/schemas/participant.md)
- [ParticipantImageType](/docs/moodhood-api/v1/schemas/participantimagetype.md): URL for participant's avatar
- [ParticipantNameType](/docs/moodhood-api/v1/schemas/participantnametype.md): Participant name
- [ParticipantSlot](/docs/moodhood-api/v1/schemas/participantslot.md)
- [PersonalToken](/docs/moodhood-api/v1/schemas/personaltoken.md)
- [PhonePropertyValidationError](/docs/moodhood-api/v1/schemas/phonepropertyvalidationerror.md)
- [PhoneType](/docs/moodhood-api/v1/schemas/phonetype.md)
- [PinResponse](/docs/moodhood-api/v1/schemas/pinresponse.md)
- [PinType](/docs/moodhood-api/v1/schemas/pintype.md): Describes target pin object
- [Plan](/docs/moodhood-api/v1/schemas/plan.md)
- [PlanAliasType](/docs/moodhood-api/v1/schemas/planaliastype.md): Human-readable unique alternative for planId
- [PlanDataEssential](/docs/moodhood-api/v1/schemas/plandataessential.md)
- [PlanFeaturesType](/docs/moodhood-api/v1/schemas/planfeaturestype.md): A map between feature names and their on/off statuses
- [PlanRestrictionsType](/docs/moodhood-api/v1/schemas/planrestrictionstype.md): A map between restriction names, their on/off statuses and values
- [PlaybackCountersResponse](/docs/moodhood-api/v1/schemas/playbackcountersresponse.md)
- [PlaybackEventExtendedResponse](/docs/moodhood-api/v1/schemas/playbackeventextendedresponse.md)
- [PlaybackEventResponse](/docs/moodhood-api/v1/schemas/playbackeventresponse.md)
- [PlaybackEventSessionListViewItem](/docs/moodhood-api/v1/schemas/playbackeventsessionlistviewitem.md)
- [PlaybackResponse](/docs/moodhood-api/v1/schemas/playbackresponse.md)
- [PlaybackTimelineResponse](/docs/moodhood-api/v1/schemas/playbacktimelineresponse.md)
- [PlaybackType](/docs/moodhood-api/v1/schemas/playbacktype.md): Playback type
- [PollOption](/docs/moodhood-api/v1/schemas/polloption.md)
- [PollVote](/docs/moodhood-api/v1/schemas/pollvote.md)
- [PreJoinParticipantInfo](/docs/moodhood-api/v1/schemas/prejoinparticipantinfo.md): A compact version of Participant to list in the pre-join stage
- [PreviewPlaybackResponse](/docs/moodhood-api/v1/schemas/previewplaybackresponse.md)
- [ProdamusPaymentEvent](/docs/moodhood-api/v1/schemas/prodamuspaymentevent.md)
- [ProdamusPaymentsReportRecord](/docs/moodhood-api/v1/schemas/prodamuspaymentsreportrecord.md)
- [PublicUserMeta](/docs/moodhood-api/v1/schemas/publicusermeta.md)
- [QuickCallDisabledError](/docs/moodhood-api/v1/schemas/quickcalldisablederror.md)
- [QuickCallRequestsExceededError](/docs/moodhood-api/v1/schemas/quickcallrequestsexceedederror.md)
- [ReactionSettings](/docs/moodhood-api/v1/schemas/reactionsettings.md)
- [RestrictionItem](/docs/moodhood-api/v1/schemas/restrictionitem.md)
- [Role](/docs/moodhood-api/v1/schemas/role.md)
- [RoleRoomCoModeratorType](/docs/moodhood-api/v1/schemas/roleroomcomoderatortype.md)
- [RoleRoomGuestType](/docs/moodhood-api/v1/schemas/roleroomguesttype.md)
- [RoleRoomModeratorType](/docs/moodhood-api/v1/schemas/roleroommoderatortype.md)
- [RoleRoomSpeakerType](/docs/moodhood-api/v1/schemas/roleroomspeakertype.md)
- [RoleRoomUserType](/docs/moodhood-api/v1/schemas/roleroomusertype.md)
- [RoleSpaceGuestType](/docs/moodhood-api/v1/schemas/rolespaceguesttype.md)
- [RoleSpaceModeratorType](/docs/moodhood-api/v1/schemas/rolespacemoderatortype.md)
- [RoleSpaceOwnerType](/docs/moodhood-api/v1/schemas/rolespaceownertype.md)
- [RoleSpaceUserType](/docs/moodhood-api/v1/schemas/rolespaceusertype.md)
- [RoleToGrantInRoomType](/docs/moodhood-api/v1/schemas/roletograntinroomtype.md)
- [Room](/docs/moodhood-api/v1/schemas/room.md)
- [RoomActiveCallData](/docs/moodhood-api/v1/schemas/roomactivecalldata.md)
- [RoomAggregatedInformation](/docs/moodhood-api/v1/schemas/roomaggregatedinformation.md)
- [RoomAliasType](/docs/moodhood-api/v1/schemas/roomaliastype.md): Short unique autogenerated room identifier for usage in URL
- [RoomCurrentState](/docs/moodhood-api/v1/schemas/roomcurrentstate.md)
- [RoomNameType](/docs/moodhood-api/v1/schemas/roomnametype.md)
- [RoomPoll](/docs/moodhood-api/v1/schemas/roompoll.md)
- [RoomRecord](/docs/moodhood-api/v1/schemas/roomrecord.md)
- [RoomRoleType](/docs/moodhood-api/v1/schemas/roomroletype.md): Describes possible role of a client in a room
- [RoomStreaming](/docs/moodhood-api/v1/schemas/roomstreaming.md)
- [RoomTypeEnum](/docs/moodhood-api/v1/schemas/roomtypeenum.md)
- [RoomTypeType](/docs/moodhood-api/v1/schemas/roomtypetype.md)
- [SendVerificationCodeRequestBody](/docs/moodhood-api/v1/schemas/sendverificationcoderequestbody.md)
- [SendVerificationCodeResponse](/docs/moodhood-api/v1/schemas/sendverificationcoderesponse.md)
- [SlotAssignment](/docs/moodhood-api/v1/schemas/slotassignment.md)
- [SlotNumberType](/docs/moodhood-api/v1/schemas/slotnumbertype.md): ParticipantSlot ID in template
- [Space](/docs/moodhood-api/v1/schemas/space.md)
- [SpaceDescriptionType](/docs/moodhood-api/v1/schemas/spacedescriptiontype.md)
- [SpaceLogoType](/docs/moodhood-api/v1/schemas/spacelogotype.md): Space image URL
- [SpaceNameType](/docs/moodhood-api/v1/schemas/spacenametype.md)
- [SpaceNotFoundError](/docs/moodhood-api/v1/schemas/spacenotfounderror.md)
- [SpacePermissions](/docs/moodhood-api/v1/schemas/spacepermissions.md)
- [SpaceRoleType](/docs/moodhood-api/v1/schemas/spaceroletype.md): Describes any possible role of a client in a given space
- [SpaceUser](/docs/moodhood-api/v1/schemas/spaceuser.md)
- [Sphere](/docs/moodhood-api/v1/schemas/sphere.md): User sphere of activity
- [StartBreakoutRoomsSessionGroupItem](/docs/moodhood-api/v1/schemas/startbreakoutroomssessiongroupitem.md)
- [StartBreakoutRoomsSessionParams](/docs/moodhood-api/v1/schemas/startbreakoutroomssessionparams.md)
- [StateIdPropertyValidationError](/docs/moodhood-api/v1/schemas/stateidpropertyvalidationerror.md)
- [SubscriptionActivationLinkAliasType](/docs/moodhood-api/v1/schemas/subscriptionactivationlinkaliastype.md): Unique alias as string
- [SubscriptionActivationLinkRequestsExceededError](/docs/moodhood-api/v1/schemas/subscriptionactivationlinkrequestsexceedederror.md)
- [SubscriptionActivationLinkRequestsExceededSubCodeType](/docs/moodhood-api/v1/schemas/subscriptionactivationlinkrequestsexceededsubcodetype.md)
- [SurveyEntity](/docs/moodhood-api/v1/schemas/surveyentity.md)
- [TargetUseEnum](/docs/moodhood-api/v1/schemas/targetuseenum.md)
- [TemporaryRoomRoleType](/docs/moodhood-api/v1/schemas/temporaryroomroletype.md): Possible temporary role of a client in a room
- [TicketToTheRoom](/docs/moodhood-api/v1/schemas/tickettotheroom.md): Ticket to join room from Waiting Room
- [TokenGroupIdType](/docs/moodhood-api/v1/schemas/tokengroupidtype.md): Unique identifier of an authenticated client by its' sing-in credentials on a specific device (if a client re-authenticates, the value of token group ID will change)
- [TooManyRequestsErrorCodeType](/docs/moodhood-api/v1/schemas/toomanyrequestserrorcodetype.md)
- [TrackLabelType](/docs/moodhood-api/v1/schemas/tracklabeltype.md)
- [Transcription](/docs/moodhood-api/v1/schemas/transcription.md)
- [TransformParams](/docs/moodhood-api/v1/schemas/transformparams.md)
- [TurnOffLabelType](/docs/moodhood-api/v1/schemas/turnofflabeltype.md): Track label type to turn off
- [UnsupportedPhoneNumberRegionError](/docs/moodhood-api/v1/schemas/unsupportedphonenumberregionerror.md)
- [UnsupportedPhoneNumberRegionErrorSubCodeType](/docs/moodhood-api/v1/schemas/unsupportedphonenumberregionerrorsubcodetype.md)
- [UnsupportedVerificationCodeMediumError](/docs/moodhood-api/v1/schemas/unsupportedverificationcodemediumerror.md)
- [UnsupportedVerificationCodeMediumErrorSubCodeType](/docs/moodhood-api/v1/schemas/unsupportedverificationcodemediumerrorsubcodetype.md)
- [UpdateBreakoutRoomsParams](/docs/moodhood-api/v1/schemas/updatebreakoutroomsparams.md)
- [UpdateBreakoutRoomsRequestErrors](/docs/moodhood-api/v1/schemas/updatebreakoutroomsrequesterrors.md)
- [UpdateBreakoutRoomsValidationErrors](/docs/moodhood-api/v1/schemas/updatebreakoutroomsvalidationerrors.md)
- [UpdateJoinSettingsCustomFieldsArrayItem](/docs/moodhood-api/v1/schemas/updatejoinsettingscustomfieldsarrayitem.md)
- [UpdateJoinSettingsFieldsArrayItem](/docs/moodhood-api/v1/schemas/updatejoinsettingsfieldsarrayitem.md)
- [UpdateJoinSettingsFieldsParams](/docs/moodhood-api/v1/schemas/updatejoinsettingsfieldsparams.md)
- [UpdateRoomParams](/docs/moodhood-api/v1/schemas/updateroomparams.md)
- [UpdateSpaceParams](/docs/moodhood-api/v1/schemas/updatespaceparams.md)
- [UpdateUserParams](/docs/moodhood-api/v1/schemas/updateuserparams.md)
- [UpdateWebHookParams](/docs/moodhood-api/v1/schemas/updatewebhookparams.md)
- [UserChat](/docs/moodhood-api/v1/schemas/userchat.md)
- [UserInfo](/docs/moodhood-api/v1/schemas/userinfo.md)
- [UsernameProp](/docs/moodhood-api/v1/schemas/usernameprop.md)
- [UserSignupRequestValidationErrors](/docs/moodhood-api/v1/schemas/usersignuprequestvalidationerrors.md)
- [UuidType](/docs/moodhood-api/v1/schemas/uuidtype.md)
- [VerificationCodeMediumType](/docs/moodhood-api/v1/schemas/verificationcodemediumtype.md): A medium that will be used to send a verification code
- [VerificationCodePropertyValidationError](/docs/moodhood-api/v1/schemas/verificationcodepropertyvalidationerror.md)
- [VerificationCodeRequestsExceededError](/docs/moodhood-api/v1/schemas/verificationcoderequestsexceedederror.md)
- [VerificationCodeRequestsExceededErrorSubCodeType](/docs/moodhood-api/v1/schemas/verificationcoderequestsexceedederrorsubcodetype.md)
- [VerificationCodeStateIdType](/docs/moodhood-api/v1/schemas/verificationcodestateidtype.md): Unique identifier used in the verification process to exchange a code for an action authorization ticket
- [VerificationCodeType](/docs/moodhood-api/v1/schemas/verificationcodetype.md): Verification code is a 4-20 digit number send by SMS or email to verify some action
- [ViewSettingsItem](/docs/moodhood-api/v1/schemas/viewsettingsitem.md)
- [ViewSettingsMeta](/docs/moodhood-api/v1/schemas/viewsettingsmeta.md)
- [WaitingRoomAudience](/docs/moodhood-api/v1/schemas/waitingroomaudience.md)
- [WebHook](/docs/moodhood-api/v1/schemas/webhook.md)
- [WebHookView](/docs/moodhood-api/v1/schemas/webhookview.md)
- [Send a verification code](/docs/moodhood-api/v1/send-verification-code.md): Send a verification code
- [Start breakout rooms session](/docs/moodhood-api/v1/start-breakout-rooms-session.md): Start breakout rooms session
- [Start room recording](/docs/moodhood-api/v1/start-room-recording.md): Start room recording
- [Start room streaming](/docs/moodhood-api/v1/start-room-streaming.md): Start room streaming
- [Stop room recording](/docs/moodhood-api/v1/stop-room-recording.md): Stop room recording
- [Stop room streaming](/docs/moodhood-api/v1/stop-room-streaming.md): Stop room streaming
- [Store external user meta data](/docs/moodhood-api/v1/store-external-user-meta.md): Store external user meta data
- [Submit breakout room help requests](/docs/moodhood-api/v1/submit-breakout-room-help-request.md): Submit breakout room help requests
- [Switch off devices to a group of participants at room](/docs/moodhood-api/v1/switch-off-devices-at-room.md): Switch off devices to a group of participants at room
- [Create a task to transcribe dialogue from recording and optional summarization](/docs/moodhood-api/v1/transcribe-record.md): Create a task to transcribe dialogue from recording and optional summarization
- [Update breakout rooms with requested amount](/docs/moodhood-api/v1/update-breakout-rooms.md): Update breakout rooms with requested amount
- [Update join settings fields of the room](/docs/moodhood-api/v1/update-join-settings-fields.md): Update join settings fields of the room
- [Override (update) space user permissions](/docs/moodhood-api/v1/update-overridden-space-permissions.md): Override (update) space user permissions
- [Update a playback](/docs/moodhood-api/v1/update-playback.md): Update a playback
- [Update a playback event](/docs/moodhood-api/v1/update-playback-event.md): Update a playback event
- [Update a room record](/docs/moodhood-api/v1/update-record.md): Update a room record
- [Update a room](/docs/moodhood-api/v1/update-room.md): Update a room
- [Update room access-link](/docs/moodhood-api/v1/update-room-access-link.md): Update room access-link
- [Update a space](/docs/moodhood-api/v1/update-space.md): Update a space
- [Change user information](/docs/moodhood-api/v1/update-user.md): Change user information
- [Change email](/docs/moodhood-api/v1/update-user-email.md): Apply confirmationToken, generated for email changing in request-change-email. User accessToken required.
- [Change password](/docs/moodhood-api/v1/update-user-password.md): Change password
- [Update a space webhook](/docs/moodhood-api/v1/update-web-hook.md): Update a space webhook
- [Upload playback timeline by playback ID](/docs/moodhood-api/v1/upload-playback-timeline.md): Upload playback timeline by playback ID

### push-registration-api

- [Удалить ключ push-провайдера](/docs/push-registration-api/delete-apns-voip-provider-credential.md): Удаляет ключ для связки (tenant, pushPlatform, pushEnvironment). После удаления новые push-уведомления
- [Удалить ключ push-провайдера](/docs/push-registration-api/delete-fcm-provider-credential.md): Удаляет ключ для связки (tenant, pushPlatform). После удаления новые push-уведомления
- [Devices](/docs/push-registration-api/devices.md): Devices
- [Получить информацию об устройстве](/docs/push-registration-api/get-device.md): Возвращает данные о зарегистрированном устройстве по его `deviceId`. Полезен для отладки,
- [Health](/docs/push-registration-api/health.md): Health
- [Health/Readiness probe](/docs/push-registration-api/health-readiness.md): Health/Readiness probe
- [Список устройств по номеру телефона](/docs/push-registration-api/list-devices-by-phone.md): Возвращает все зарегистрированные устройства для указанного номера
- [Получить список зарегистрированных push-провайдеров](/docs/push-registration-api/list-provider-credentials.md): Возвращает полный список push-провайдеров для которых зарегистрирован ключ. Метод позволяет мониторить валидность ключей, не раскрывая их.
- [ProviderCredentials](/docs/push-registration-api/provider-credentials.md): ProviderCredentials
- [Push Registration API](/docs/push-registration-api/push-registration-api.md): Сервис регистрации push-токенов для SIP Gateway.
- [Зарегистрировать или обновить ключ push-провайдера](/docs/push-registration-api/register-apns-voip-provider-credential.md): Регистрирует или обновляет ключ для работы с APNS API. Ключ уникален для связки (tenant, pushPlatform, pushEnvironment).
- [Регистрация или обновление устройства](/docs/push-registration-api/register-device.md): Регистрирует устройство с push-токеном для указанного номера телефона.
- [Зарегистрировать или обновить ключ push-провайдера](/docs/push-registration-api/register-fcm-provider-credential.md): Регистрирует или обновляет ключ для работы с FCM API. Ключ уникален для связки (tenant, pushPlatform).
- [APNSCredentialRegistrationRequest](/docs/push-registration-api/schemas/apnscredentialregistrationrequest.md)
- [CredentialsListResponse](/docs/push-registration-api/schemas/credentialslistresponse.md)
- [Device](/docs/push-registration-api/schemas/device.md)
- [DeviceListResponse](/docs/push-registration-api/schemas/devicelistresponse.md)
- [DeviceRegistrationRequest](/docs/push-registration-api/schemas/deviceregistrationrequest.md)
- [DeviceRegistrationResponse](/docs/push-registration-api/schemas/deviceregistrationresponse.md)
- [ErrorResponse](/docs/push-registration-api/schemas/errorresponse.md)
- [FCMCredentialRegistrationRequest](/docs/push-registration-api/schemas/fcmcredentialregistrationrequest.md): Формат запроса совместим с форматом файла ключа serviceAccount.json
- [HealthResponse](/docs/push-registration-api/schemas/healthresponse.md)
- [ProviderCredential](/docs/push-registration-api/schemas/providercredential.md)
- [PushEnvironment](/docs/push-registration-api/schemas/pushenvironment.md)
- [PushPlatform](/docs/push-registration-api/schemas/pushplatform.md)
- [Удалить все устройства по номеру телефона](/docs/push-registration-api/unregister-all-devices.md): Удаляет все зарегистрированные устройства для указанного номера
- [Удалить регистрацию устройства](/docs/push-registration-api/unregister-device.md): Удаляет push-токен и регистрацию устройства. Устройство перестаёт

### sdk-api

Classes

- [@livedigital/client](/docs/sdk-api.md): Classes
- [Class: Client](/docs/sdk-api/classes/Client.md): Основная точка входа в SDK LiveDigital.
- [Class: EnhancedEventEmitter<E>](/docs/sdk-api/classes/EnhancedEventEmitter.md): Типизированный EventEmitter, который используется во внешнем API SDK для подписки на события.
- [Class: Peer](/docs/sdk-api/classes/Peer.md): Представление участника канала в публичном API SDK.
- [Class: PeerProducer](/docs/sdk-api/classes/PeerProducer.md): Constructors
- [Class: ScoresCalculator](/docs/sdk-api/classes/ScoresCalculator.md): Утилита для расчёта MOS-оценок на основе WebRTC-статистики.
- [Enumeration: DeviceErrors](/docs/sdk-api/enumerations/DeviceErrors.md): Типовые ошибки доступа к медиаустройствам.
- [Enumeration: TrackLabel](/docs/sdk-api/enumerations/TrackLabel.md): Логические метки треков, которыми SDK помечает разные источники медиа.
- [Interface: ActivityConfirmationRequiredPayload](/docs/sdk-api/interfaces/ActivityConfirmationRequiredPayload.md): Payload события, которым сервер просит подтвердить активность участника в канале.
- [Interface: AudioStreamStats](/docs/sdk-api/interfaces/AudioStreamStats.md): Нормализованные метрики аудиопотока, которые используются при расчёте качества.
- [Interface: AudioTrack](/docs/sdk-api/interfaces/AudioTrack.md): Публичный контракт локального аудиотрека.
- [Interface: AvailableMediaDevices](/docs/sdk-api/interfaces/AvailableMediaDevices.md): Список доступных на устройстве камер и микрофонов.
- [Interface: BaseTrack](/docs/sdk-api/interfaces/BaseTrack.md): Базовый контракт локального трека, которым управляет SDK.
- [Interface: BaseTrackInfo](/docs/sdk-api/interfaces/BaseTrackInfo.md): Краткая информация о локальном треке в удобном для UI и диагностики виде.
- [Interface: ChannelEvent](/docs/sdk-api/interfaces/ChannelEvent.md): Произвольное серверное событие канала, которое приложение может обработать в своей бизнес-логике.
- [Interface: ChannelStateInconsistentPayload](/docs/sdk-api/interfaces/ChannelStateInconsistentPayload.md): Payload события о рассинхронизации локального состояния клиента с состоянием канала.
- [Interface: ClientMetaPayload](/docs/sdk-api/interfaces/ClientMetaPayload.md): Служебные метаданные текущей сессии клиента.
- [Interface: ClientObserverEvents](/docs/sdk-api/interfaces/ClientObserverEvents.md): Event map emitted by client.observer.
- [Interface: ClientParams](/docs/sdk-api/interfaces/ClientParams.md): Параметры инициализации основного клиента SDK.
- [Interface: ConsumerData](/docs/sdk-api/interfaces/ConsumerData.md): Properties
- [Interface: Effects](/docs/sdk-api/interfaces/Effects.md): Набор визуальных эффектов, который можно применить к локальному видеотреку.
- [Interface: InitEffectsSDKParams](/docs/sdk-api/interfaces/InitEffectsSDKParams.md): Параметры предварительной инициализации SDK видеоэффектов.
- [Interface: JoinChannelParams](/docs/sdk-api/interfaces/JoinChannelParams.md): Параметры подключения к каналу.
- [Interface: LDTransportWebRTCStats](/docs/sdk-api/interfaces/LDTransportWebRTCStats.md): Extends
- [Interface: MediaDeviceAvailability](/docs/sdk-api/interfaces/MediaDeviceAvailability.md): Статус доступности медиаустройств.
- [Interface: MOSScores](/docs/sdk-api/interfaces/MOSScores.md): MOS-оценки качества аудио и видео в понятной для UI форме.
- [Interface: PayloadOfPublishedMedia](/docs/sdk-api/interfaces/PayloadOfPublishedMedia.md): Событие о публикации медиа участником.
- [Interface: PeerConsumer](/docs/sdk-api/interfaces/PeerConsumer.md): Публичная форма consumer-объекта, связанного с удалённым треком.
- [Interface: PeerInfo](/docs/sdk-api/interfaces/PeerInfo.md): Сводная информация об участнике канала и его активных треках.
- [Interface: PeerObserverEvents](/docs/sdk-api/interfaces/PeerObserverEvents.md): Карта событий участника канала, доступная через peer.observer.
- [Interface: PeerTrack](/docs/sdk-api/interfaces/PeerTrack.md): Публичная форма удалённого трека, который SDK возвращает через peer.tracks.
- [Interface: PeerTrackInfo](/docs/sdk-api/interfaces/PeerTrackInfo.md): Properties
- [Interface: PeerTrackObserverEvents](/docs/sdk-api/interfaces/PeerTrackObserverEvents.md): Карта событий удалённого трека, доступная через peerTrack.observer.
- [Interface: PreferredLayersParams](/docs/sdk-api/interfaces/PreferredLayersParams.md): Properties
- [Interface: ProducePermissionsChangedPayload](/docs/sdk-api/interfaces/ProducePermissionsChangedPayload.md): Payload события об изменении набора треков, которые участнику разрешено публиковать.
- [Interface: ProducerData](/docs/sdk-api/interfaces/ProducerData.md): Properties
- [Interface: SubscribeOptions](/docs/sdk-api/interfaces/SubscribeOptions.md): Параметры подписки на удалённый producer участника.
- [Interface: TrackForceClosedPayload](/docs/sdk-api/interfaces/TrackForceClosedPayload.md): Payload события о принудительном закрытии локального трека.
- [Interface: TrackInboundStats](/docs/sdk-api/interfaces/TrackInboundStats.md): Статистика входящего удалённого трека, полезная для диагностики подписки и качества приёма.
- [Interface: TrackOutboundStats](/docs/sdk-api/interfaces/TrackOutboundStats.md): Статистика исходящего локального трека, полезная для диагностики публикации.
- [Interface: TrackTransformParams](/docs/sdk-api/interfaces/TrackTransformParams.md): Properties
- [Interface: TransformParams](/docs/sdk-api/interfaces/TransformParams.md): Properties
- [Interface: TransportsStateInfo](/docs/sdk-api/interfaces/TransportsStateInfo.md): Состояние send и receive transport'ов клиента в удобной для диагностики форме.
- [Interface: TransportsWebRTCStats](/docs/sdk-api/interfaces/TransportsWebRTCStats.md): Агрегированная транспортная статистика WebRTC, которую возвращает клиент.
- [Interface: VideoStreamStats](/docs/sdk-api/interfaces/VideoStreamStats.md): Нормализованные метрики видеопотока, которые используются при расчёте качества.
- [Interface: VideoTrack](/docs/sdk-api/interfaces/VideoTrack.md): Публичный контракт локального видеотрека.
- [Interface: VideoTrackPublishParams](/docs/sdk-api/interfaces/VideoTrackPublishParams.md): Дополнительные параметры публикации видеотрека.
- [Type Alias: AudioEncoderConfig](/docs/sdk-api/type-aliases/AudioEncoderConfig.md): AudioEncoderConfig = EncoderConfig & object
- [Type Alias: CreateCameraVideoTrackOptions](/docs/sdk-api/type-aliases/CreateCameraVideoTrackOptions.md): CreateCameraVideoTrackOptions = BaseVideoTrackOptions & object
- [Type Alias: CreateCustomAudioOptions](/docs/sdk-api/type-aliases/CreateCustomAudioOptions.md): CreateCustomAudioOptions = BaseAudioTrackOptions & object
- [Type Alias: CreateCustomVideoOptions](/docs/sdk-api/type-aliases/CreateCustomVideoOptions.md): CreateCustomVideoOptions = BaseVideoTrackOptions & object
- [Type Alias: CreateMicrophoneAudioTrackOptions](/docs/sdk-api/type-aliases/CreateMicrophoneAudioTrackOptions.md): CreateMicrophoneAudioTrackOptions = BaseAudioTrackOptions & object
- [Type Alias: CreateScreenMediaOptions](/docs/sdk-api/type-aliases/CreateScreenMediaOptions.md): CreateScreenMediaOptions = BaseVideoTrackOptions & BaseAudioTrackOptions & object
- [Type Alias: EncoderConfig](/docs/sdk-api/type-aliases/EncoderConfig.md): EncoderConfig = object
- [Type Alias: IceTransportPolicy](/docs/sdk-api/type-aliases/IceTransportPolicy.md): IceTransportPolicy = "all" \| "relay"
- [Type Alias: InputKind](/docs/sdk-api/type-aliases/InputKind.md): InputKind = "audio" \| "video"
- [Type Alias: IssuesHandler](/docs/sdk-api/type-aliases/IssuesHandler.md): IssuesHandler = (issues) => void
- [Type Alias: LayoutTypes](/docs/sdk-api/type-aliases/LayoutTypes.md): LayoutTypes = "center" \| "left-bottom" \| "right-bottom"
- [Type Alias: MediaDeviceAvailabilityReason](/docs/sdk-api/type-aliases/MediaDeviceAvailabilityReason.md): MediaDeviceAvailabilityReason = "notallowed" \| "notfound" \| "deviceisbusy"
- [Type Alias: NetworkScores](/docs/sdk-api/type-aliases/NetworkScores.md): NetworkScores = object
- [Type Alias: NetworkScoresUpdatedHandler](/docs/sdk-api/type-aliases/NetworkScoresUpdatedHandler.md): NetworkScoresUpdatedHandler = (networkScores) => void
- [Type Alias: PayloadOfUnpublishedMedia](/docs/sdk-api/type-aliases/PayloadOfUnpublishedMedia.md): PayloadOfUnpublishedMedia = PayloadOfPublishedMedia
- [Type Alias: PeerGroup](/docs/sdk-api/type-aliases/PeerGroup.md): PeerGroup = "moderator" \| "user"
- [Type Alias: Role](/docs/sdk-api/type-aliases/Role.md): Role = "audience" \| "host"
- [Type Alias: SpatialLayerParams](/docs/sdk-api/type-aliases/SpatialLayerParams.md): SpatialLayerParams = RtpEncodingParameters & TransformParams
- [Type Alias: Track](/docs/sdk-api/type-aliases/Track.md): Track = AudioTrack \| VideoTrack
- [Type Alias: TrackLabelString](/docs/sdk-api/type-aliases/TrackLabelString.md): TrackLabelString = "camera" \| "microphone" \| "screen-video" \| "screen-audio" \| "custom-video" \| "custom-audio"
- [Type Alias: VideoCodec](/docs/sdk-api/type-aliases/VideoCodec.md): VideoCodec = "h264" \| "vp8" \| "vp9"
- [Type Alias: VideoEncoderConfig](/docs/sdk-api/type-aliases/VideoEncoderConfig.md): VideoEncoderConfig = EncoderConfig & object

### tutorials

- [Построение дашбордов по успеваемости прохождения курсов пользователями в различных разрезах](/docs/tutorials/addtitional/dashboars.md): При вызове метода generateAccess, которым генерируется ссылка на вход в комнату:
- [Аналитика по звонку](/docs/tutorials/analytics.md): Для выгрузки аналитики по вебинару\конференции используется метод getRoomAnalyticsReport, который возвращает данные
- [Введение](/docs/tutorials/auth/auth_intro.md): Для работы с API ВКС необходима авторизация в соответствии со стандартом Oauth2.
- [Создание Oauth2 клиента](/docs/tutorials/auth/create_oauth_client.md): Для регистрации пользователей и обращения к публичным ресурсам вам может понадобится конфиденциальный
- [Создание персонального токена](/docs/tutorials/auth/create_personal_token.md): Персональные токены не имеют срока жизни и используются для авторизованного доступа к API в своих приложениях.
- [Создание токенов доступа](/docs/tutorials/auth/get_tokens.md): Токены доступа разделяются на два вида
- [Обмен токена доступа](/docs/tutorials/auth/refresh_tokens.md): Для обмена токена доступа вам необходимо выполнить POST запрос к ендпоинту авторизации
- [Создание, добавление и настройка автовебинара](/docs/tutorials/autowebinars.md): Для формирования комнаты с типом «Автовебинар» используется метод создания сущности автовебинара в API ВКС: createPlayback. В теле запроса передается name - наименование автовебинарной комнаты и type \- тип комнаты, может принимать значение webinar или conference.
- [Баннеры (рекламные объявления)](/docs/tutorials/banners.md): Баннеры в комнате звонков помогают как донести важную информацию до участников (например, промоакции или инструкции), так и создать продающую форму.
- [Чат](/docs/tutorials/chat.md): Настройка
- [Облачная запись](/docs/tutorials/cloud_record.md): API ВКС предоставляет возможность вашему сервису автоматически выгружать видеозаписи после
- [Часто задаваемые вопросы](/docs/tutorials/faq.md): Авторизация и доступ пользователей
- [Встраивание через iFrame](/docs/tutorials/iframe.md): Для добавления на сайт комнаты с трансляцией следует вставить в код страницы элемент iFrame с нужными атрибутами.
- [Распространённые варианты интеграции](/docs/tutorials/integration_cases.md): Общая информация
- [Этапы интеграции](/docs/tutorials/integration_plan.md): Для начала работы необходимо зарегистрировать аккаунт на платформе ВКС и пройти в личный кабинет,
- [Выбор способа интеграции](/docs/tutorials/integration-approach.md): Прежде чем начать, важно выбрать подходящий способ встраивания видеозвонков — от этого зависят объём работ и архитектура решения. Livedigital предоставляет несколько независимых путей интеграции.
- [Введение](/docs/tutorials/intro.md): Документ описывает порядок действий для добавления на сайт ВКС с помощью предоставляемого API.
- [Опросы](/docs/tutorials/polls.md): Зачастую бывает полезно перед стартом звонка создать необходимые опросы в комнате,
- [Комнаты](/docs/tutorials/rooms.md): Представляют собой аналоги виртуальных переговорных. Комнаты бывают двух типов и отличаются целью использования и набором инструментов.
- [Спэйсы (группы)](/docs/tutorials/spaces.md): Группа, или же в терминологии API «спэйс» (space) - это иерархическая сущность, которая позволяет отделить ваши комнаты
- [Получение и выгрузка транскрибации и саммаризации видеозаписи](/docs/tutorials/transcribation.md): Транскрибация представляет собой процесс преобразования видеозаписи вашей встречи в текстовый формат, что позволяет сохранить важные детали обсуждений, лекций или интервью.
- [Ссылка временного доступа](/docs/tutorials/user_access/access_link.md): В случае если вам, в силу архитектуры вашего сервиса, не подходят сценарии с приглашением пользователей в спэйс или в комнату,
- [Управление устройствами пользователя в комнате](/docs/tutorials/user_access/device_restrictions.md): Для управления устройствами пользователей вы можете воспользоваться функционалом
- [Генерация временного пользователя](/docs/tutorials/user_access/generate_access.md): При помощи метода roomGenerateAccess, который позволяет создать временного пользователя
- [Самостоятельная генерация signaling-токена](/docs/tutorials/user_access/generate_signaling_token.md): Signaling token — это JWT, который медиа-сервер livedigital использует для аутентификации участника при подключении к каналу. В токене зашита информация о том, в какой канал входит участник, какую роль он занимает и какие медиа-потоки имеет право публиковать.
- [Введение](/docs/tutorials/user_access/intro.md): Доступ к ресурсам API можно предоставлять несколькими способами. Например
- [Приглашение в комнату](/docs/tutorials/user_access/room_invite.md): Дать постоянный доступ зарегистрированному пользователю к комнате, можно двумя способами.
- [Приглашение в группу (спэйс)](/docs/tutorials/user_access/space_invite.md): Приглашение можно создать обратившись к эндпоинту создания приглашений
- [Пользователи](/docs/tutorials/users.md): Пользователь является основным ресурсом API, от имени которого выполняются запросы. Пользователь идентифицируется при помощи
- [Веб хуки](/docs/tutorials/webhooks.md): API ВКС предоставляет возможность отслеживать события при помощи механизма вебхуков (webhook).

### web-sdk

- [Метаданные участника (appData)](/docs/web-sdk/appdata-guide.md): appData — это JSON-объект, который каждый участник несёт с собой в канале. Все остальные участники видят его в реальном времени и получают событие app-data-updated при каждом изменении.
- [Управление полосой пропускания](/docs/web-sdk/bandwidth-management.md): В конференции с большим числом участников не нужно подписываться на все медиапотоки сразу. Управление подписками — основной инструмент снижения нагрузки на сеть и браузер.
- [Инициализация Client](/docs/web-sdk/client-initialization.md): Client — главный класс SDK. Создаётся один раз при старте приложения и управляет всем жизненным циклом: подключением к каналу, медиа-треками, участниками и сетевым транспортом.
- [Подключение к комнате](/docs/web-sdk/connection.md): Канал (room/channel) — пространство, в котором участники обмениваются медиапотоками. SDK поддерживает роли участников, автоматическое восстановление соединения и ручное переподключение.
- [Управление устройствами](/docs/web-sdk/devices.md): SDK предоставляет API для обнаружения камер и микрофонов, отслеживания их подключения/отключения и выбора конкретного устройства при создании трека.
- [Обработка ошибок](/docs/web-sdk/error-handling.md): Ошибки join()
- [Справочник событий](/docs/web-sdk/events-reference.md): SDK использует событийную модель на основе observer. Все события подписываются через client.observer.on() или peer.observer.on().
- [Установка](/docs/web-sdk/installation.md): npm-пакет
- [Введение](/docs/web-sdk/intro.md): livedigital Web SDK — клиент сервиса livedigital для браузеров. Поставляется как npm-пакет @livedigital/client и предоставляет всё необходимое для встраивания видеоконференций в веб-приложение.
- [Медиа-треки](/docs/web-sdk/media-tracks.md): Трек — единица медиапотока: видео с камеры, аудио с микрофона, захват экрана или кастомный поток. SDK предоставляет методы для создания, публикации, паузы, замены и удаления треков.
- [Качество соединения (QoE)](/docs/web-sdk/network-quality.md): SDK предоставляет инструменты для мониторинга качества WebRTC-соединения, управления сетевым транспортом и диагностики проблем в реальном времени.
- [Шумоподавление](/docs/web-sdk/noise-suppression.md): SDK поддерживает два движка шумоподавления: встроенный rnnoise и внешний asdk. Оба работают на стороне клиента в реальном времени — шум фильтруется до публикации аудио.
- [P2P режим (звонок 1-на-1)](/docs/web-sdk/p2p-mode.md): Если ваш сценарий предполагает звонок строго между двумя участниками, передайте флаг isP2pCall: true в client.join().
- [Участники (Peers)](/docs/web-sdk/peers.md): Каждый подключённый к каналу клиент представлен объектом Peer. SDK уведомляет о входе/выходе участников, позволяет подписываться на их медиапотоки и управлять правами публикации.
- [Экран настройки перед входом (лобби)](/docs/web-sdk/pre-call-setup.md): Большинство конференц-сервисов показывают пользователю экран предварительной настройки: выбор камеры/микрофона, превью своего видео, выбор аудиовыхода — до того как он войдёт в комнату. SDK поддерживает этот паттерн через preview-треки.
- [Быстрый старт](/docs/web-sdk/quickstart.md): Минимальный рабочий пример: войти в комнату, увидеть видео других участников, опубликовать свою камеру.
- [React-интеграция](/docs/web-sdk/react-integration.md): SDK хорошо компонуется с React, но требует осторожности в трёх местах:
- [Отображение видео и аудио](/docs/web-sdk/rendering-media.md): Флоу событий медиапотока
- [Подготовка комнаты](/docs/web-sdk/room-setup.md): Прежде чем войти в видеоконференцию, приложение должно выполнить ряд шагов на бэкенде. Комната не имеет времени жизни — её можно использовать многократно или создавать по необходимости и удалять после звонка.
- [Демонстрация экрана](/docs/web-sdk/screen-sharing.md): SDK позволяет публиковать захват экрана, вкладки или окна. Поддерживается передача системного аудио (зависит от браузера и ОС).
- [Жизненный цикл SDK](/docs/web-sdk/sdk-lifecycle.md): SDK работает как конечный автомат: в каждый момент времени сессия находится в одном из шести состояний. Понимание этих состояний критично для корректной обработки ошибок, переподключений и очистки ресурсов.
- [Устранение неполадок](/docs/web-sdk/troubleshooting.md): authentication failed: token verification failed
- [Видеоэффекты и статические файлы](/docs/web-sdk/video-effects.md): SDK использует два отдельных движка обработки медиа:
- [Режим вебинара](/docs/web-sdk/webinar-mode.md): Вебинар — формат с асимметричными ролями: небольшая группа спикеров публикует медиа, тысячи слушателей только потребляют.

## Optional
- [Moodhood API — OpenAPI spec (JSON)](https://livedigital.space/specs/moodhood-api-public.json): Raw OpenAPI specification for the Moodhood API
- [Push Registration API — OpenAPI spec (YAML)](https://livedigital.space/specs/push-registration-api.yaml): Raw OpenAPI specification for the Push Registration API