kickPeer

Description: remove a participant from a conference.

Used only in conferences where the moderated role-based conference TrueConf Room API is the owner, moderator, or operator.

Request example:

{
    "method" : "kickPeer",
    "requestId" : "1",
    "peerId" : "user1@some.server/InstanceId"
}

Response example:

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

Parameter description:

• peerId - a unique user identifier (TrueConf ID). It is recommended to use those obtained from the methods: newParticipantInConference, getConferenceParticipants. Applicability:

  • PeerId - not supported

  • CallId - not supported

  • InstanceId - supported

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

See also:

• inviteToConference
• participantLeftConference
• getConferenceParticipants
• newParticipantInConference