TrueConf VideoSDK Guide

# inviteToConference

Description: invite the specified user to the conference. The command can only be executed by a user with moderator rights, including the owner (creator of the conference) and operator.

Read more about the roles of conference participants in the corresponding article of our knowledge base.

Request example:

{
    "method": "inviteToConference",
    "requestId" : "1",
    "peerId": "user1@some.server"
}

Response example:

{
    "method": "inviteToConference",
    "requestId" : "1",
    "result": true
}

Parameter description:

  • peerId - unique user identifier (TrueConf ID). Applicability of identifiers:

    • PeerId - supported. It is automatically converted to CallId inside the application and the command is executed with it. In this case, the invitation will be received by the user on all devices.

    • CallId - supported. The invite will be received by the user on all devices.

    • InstanceId - supported. The user will receive the invitation on a specific application instance.

  • requestId - unique request identifier. More details can be found here

See also: