TrueConf

# 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.

Learn more about conference participant roles in the relevant article in our knowledge base.

Request example:

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

Response example:

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

Parameter description:

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

    • PeerId - supported. Inside the application, it is automatically converted to CallId and the command is executed with it. In this case, the user will receive the invitation on all devices.

    • CallId - supported. The user will receive the invitation on all devices.

    • InstanceId - supported. The invitation will be received by the user on a specific application instance.

  • requestId - a unique request identifier. You can learn more about it here.

See also: