Skip to main content

Приглашение пользователей в конференцию

Метод и конечная точка​

POST /conference.inviteUsers

Описание​

Приглашает пользователей в конференцию через сообщение.

Параметры​

Перечень параметров представлен в таблице.

НазваниеОбязательныйТип данныхОписание
meetingIdдаstringИдентификатор встречи
userIdsдаarrayСписок ID пользователей

Запрос​

curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/conference.inviteUsers' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>' \
-d '{ \
"meetingId": "<MEETING_ID>",
"userIds": [
"<USER_ID_1>",
"<USER_ID_2>"
]
}'

Где:

  • <ENV> — окружение, на котором выполняется запрос;
  • <DEFAULT_DOMAIN> — домен сервера Squadus;
  • <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
  • <AUTH_TOKEN> — токен аутентификации пользователя;
  • <MEETING_ID> — идентификатор встречи;
  • <USER_ID_1>, <USER_ID_2> — идентификаторы приглашаемых пользователей.

Ответ​

200 — Basic API response with success status — Приглашения отправлены. Пример вывода:

{
"success": true
}