Skip to main content
POST
Generate a WebRTC login token

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Body

The telephony login request containing connection details.

Identifies the Leadping user and calling context for which a short-lived telephony client token should be issued.

includeIncoming
boolean

Includes credentials for receiving calls to the authenticated organization.

device
object | null

Provides a compact API reference to another resource using its stable identifier and human-readable display name.

Response

Login token was successfully generated.

Provides the short-lived access token and client configuration required to initialize an authenticated Leadping calling session.

incomingUsername
null | string

Username for the organization's incoming SIP connection, when requested and configured.

incomingPassword
null | string

Password for the organization's incoming SIP connection, when requested and configured.

username
string

Username for this telephony login.

password
string

Password for this telephony login.

expiresAt
null | string<date-time>

UTC timestamp for expires at on this telephony login.

callbackToken
string

Callback token for this telephony login.