Skip to navigation
Conversive Voice API v1.0

Initiate Call

Start a new outbound call. Two calling modes are available — choose the one that fits your integration.

  • Browser calling — the response includes a LiveKit token and livekit_url. Pass these to your WebRTC client immediately so the agent can join the call from a browser tab.

  • Phone-bridge calling — the platform dials the agent’s configured phone number first, then bridges to the customer. token and livekit_url are returned as null.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
phone_numberstringRequired

Customer number to dial in E.164 format, e.g. +919580440262.

from_numberstringRequired
Business number used as the caller ID. Must belong to the authenticated account.
contact_namestringOptional
Optional display name for the contact.
use_agent_phonebooleanOptionalDefaults to false

false — agent joins via browser (default). true — platform calls the agent's phone and bridges to the customer.

Response

Call successfully initiated.
call_idstringOptionalformat: "uuid"

Unique ID of the created call. Save this — it is required for all follow-up operations.

room_namestringOptional
LiveKit room name created for this call. Required for call action requests.
tokenstring or nullOptional

LiveKit browser-join token. Present only when agent_join_via_phone is false.

livekit_urlstring or nullOptional

LiveKit server WebSocket URL. Present only when agent_join_via_phone is false.

agent_join_via_phonebooleanOptional
Reflects the calling mode that was used.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error