Adds users as members of the conference. Membership allows a user to join the call, but does not add them to the conference's room, so they might not be able to read the call chat. Use video-conference.info to check chatAccess, and video-conference.share-chat to give members access to the chat.
The response lists the user IDs of the members that were added. Users who are already members, usernames that do not exist, and calls that have ended result in no additions.
You must be a member of the conference or have access to the conference's room or discussion. Requests are limited to 5 per minute per client IP address.
Changelog
| Version | Description |
|---|---|
| 8.9.0 | Added |
The user ID.
The authentication token.
{
"callId": "697887e3c8b0533020781a4a",
"users": [
"sam.okafor",
"lee.chen"
],
"ring": true
}The video conference call ID.
The usernames (not user IDs) of the people to add. Enter between 1 and 10 usernames.
Whether to ring the people being added. Defaults to false. Ringing also requires the videoconf-ring-users permission; without it, the users are added without being rung.
OK
{
"added": [
"kP3wQz8LmNvT5rXyB",
"Hn4tYw9QeVb2LsJxR"
],
"success": true
}The user IDs of the members that were added.
Bad Request
{
"success": false,
"error": "must have required property 'callId' [invalid-params]",
"errorType": "invalid-params"
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}Not Found. The call does not exist, or you are neither a member of the conference nor able to access its room.
{
"success": false,
"error": "Resource not found"
}