Skip to navigation

A softphone token for the rep’s browser

Mint it on your server and hand it to the rep’s browser (@rydhm/web): joining the presence room puts the rep online, and callbacks ring there. Lasts 12 hours. It also works as Bearer for decline and hangup on this rep’s own calls, and for nothing else. Send { name, mobileNumber? } (who is signed in to your app) and the rep is created the first time, or updated when it changed: no separate step. Without a body, an unknown rep is 404 rep_not_found.

Sessions: admins.

Needs the calls:write scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

externalIdstringRequired

Your id for the rep (letters, digits and . _ - : @ | +, up to 200).

Request

This endpoint expects an object.
namestringOptional<=120 characters
Their name. Required the first time.
mobileNumberstring or nullOptional

Response

OK
urlstring

The LiveKit server (wss://…).

tokenstring
presenceRoomstring

rep_presence_<rep id>.

expiresAtdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error