Create a VoiceCall

Overview

Create a VoiceCall Available for Staff, App, and Directory tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The unique identifier of the staff member associated with the call (e.g., "d290f1ee-6c54-4b01-90e6-d701748f0851").

string
required

The unique identifier of the client involved in the call (e.g., "d290f1ee-6c54-4b01-90e6-d701748f0851").

string
required

The phone number the call originated from, in E.164 format (e.g., "+14155550148").

string
required

The phone number the call was directed to, in E.164 format (e.g., "+14155550901").

string
enum
required

The direction of the call. Must be one of the allowed enum values: INBOUND (incoming call to the business) or OUTBOUND (outgoing call from the business). Values are case-sensitive and must be uppercase (e.g., "INBOUND").

Allowed:
string
enum
required

The status of the call. Must be one of the allowed enum values: INCOMING_CALL (call is ringing), ANSWERED_BY_STAFF (staff picked up), MISSED (no one answered), ANSWERED_BY_CALLS_PROVIDER (handled by provider IVR), MISSED_CALL_HANDLED (missed call was followed up), VOICEMAIL_RECEIVED (caller left a voicemail). Values are case-sensitive and must be uppercase (e.g., "MISSED").

Allowed:
string
required

The price rate of the call as a string value (e.g., "0.05"). Pass "0" for free calls. Must be a string, not a number.

string
enum
required

The voice call provider. Currently only VONAGE is supported. Values are case-sensitive and must be uppercase (e.g., "VONAGE").

Allowed:
string
required

A unique source identifier for the call from the provider system (e.g., "call-src-001").

string
required

An external unique identifier for the call from the provider system (e.g., "ext-call-001").

string
required

The unique identifier of the business to which the call belongs (e.g., "d290f1ee-6c54-4b01-90e6-d701748f0851").

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json