Release the ringtone

POST

/rooms/calls/{room}/end

const url = 'https://collab.work.optidata.cloud/api/rooms/calls/a3050cd3-5921-4153-b90a-owt42-e94de63c7b15/end';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://collab.work.optidata.cloud/api/rooms/calls/a3050cd3-5921-4153-b90a-owt42-e94de63c7b15/end \
  --header 'Authorization: Bearer <token>'

Releases the caller’s ringtone claim for this room (see claimRingtone), so the next incoming call in the room can ring again. It does not disconnect anyone from the meeting. You must be a party of the call.

Answers 200 with an empty body.

Authorizations

bearerAuth

Parameters

Path Parameters

room

required

string

The room’s hash (from its link) or its permanent-link identifier custom_hash.

Responses

200

Claim released. Empty body.

401

No authentication key was sent, or it is malformed.

application/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

missing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

You are not a party of the call (the room’s owner, someone admitted to the room or holding a moderator or admin role in it, or someone rung into it within the last hour), or a field naming the actor is not your own uuid.

application/json

A refused or not-found request.

object

message

required

string

Examples

Not a party of the call

{
  "message": "You are not a participant of this call."
}

Actor uuid is someone else's

{
  "message": "You can only act on a call on your own behalf."
}

404

No room has this hash or permanent link.

application/json

A refused or not-found request.

object

message

required

string

Examples

notFound

{
  "message": ""
}

419

The authentication key is expired or not recognised. Get a fresh one and retry.

application/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

expired

{
  "error": "JWT passport expired: Passport expired"
}