Post
/api/v1/video-conference.ring
Rings a conference member who is not in the call. The response field rang is false when no ring was sent, for example because the member is already in the call, is already being rung, or the call has ended.
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.
Permission required: videoconf-ring-users
Changelog
| Version | Description |
|---|---|
| 8.9.0 | Added |
Header parameters
X-User-Id
stringRequired
The user ID.
ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired
The authentication token.
Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Body parameters
Example
{
"callId": "697887e3c8b0533020781a4a",
"userId": "kP3wQz8LmNvT5rXyB"
}object
callId
string Required
The video conference call ID.
Example697887e3c8b0533020781a4a
userId
string Required
The user ID (not the username) of the conference member to ring.
ExamplekP3wQz8LmNvT5rXyB
Responses
200
OK
Success Example
{
"rang": true,
"success": true
}object
rang
boolean
Whether the member was rung.
success
boolean
400
Bad Request
Missing Parameter
{
"success": false,
"error": "must have required property 'callId' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}object
success
boolean
error
string
404
Not Found. The call does not exist, or you are neither a member of the conference nor able to access its room.
Not Found
{
"success": false,
"error": "Resource not found"
}object
success
boolean
error
string