Claim the ringtone

POST

/rooms/calls/{room}/ringtone/check

const url = 'https://collab.work.optidata.cloud/api/rooms/calls/a3050cd3-5921-4153-b90a-owt42-e94de63c7b15/ringtone/check';
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/ringtone/check \
  --header 'Authorization: Bearer <token>'

Asks whether this device should play the ringtone for an incoming call. When a user has several Optiwork windows or devices open, each one asks; the first to ask gets 204 and plays the ringtone, and the others get 403 for the next 30 seconds, so the ringtone plays once.

Release the claim with endCall when the call is answered or stops ringing. You must be a party of the call.

Authorizations

bearerAuth

Parameters

Path Parameters

room

required

string

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

Responses

204

Play the ringtone on this device.

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

Another of your windows or devices is already playing the ringtone, or you are not a party of the call.

application/json

One of:

object
object

An error raised by the application’s own rules.

object

error

required

What went wrong.

string

status

The HTTP status, repeated.

integer

help

What to do about it, when there is a hint.

string

Examples

Already ringing elsewhere

{
  "error": "You are not allowed to play the ringtone at this moment",
  "status": 403,
  "help": ""
}

Not a party of the call

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

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"
}