Skip to main content

Commands and resources

The following endpoints can be used with the Voice API applications.

Call

EndpointDescription
/v2/callsInitiate a new call
/v2/calls/:call_control_id/actions/answerAnswer an incoming call
/v2/calls/:call_control_id/actions/fork_startStart a media fork for a call
/v2/calls/:call_control_id/actions/fork_stopStop a media fork for a call
/v2/calls/:call_control_id/actions/hangupTerminate a call
/v2/calls/:call_control_id/actions/rejectReject an incoming call
/v2/calls/:call_control_id/actions/transferTransfer a call to another destination
/v2/calls/:call_control_id/actions/suppression_startStart noise suppression for a call
/v2/calls/:call_control_id/actions/suppression_stopStop noise suppression for a call
/v2/calls/:call_control_id/actions/client_state_updateUpdate client state information for a call
/v2/calls/:call_control_id/actions/bridgeBridge a call with another destination
/v2/calls/:call_control_id/actions/conversation_startStart a conversation for a call
/v2/calls/:call_control_id/actions/conversation_stopStop a conversation for a call
/v2/calls/:call_control_id/actions/conversation_assign/:conversation_idAssign a conversation to a call
/v2/calls/:call_control_id/actions/enqueueAdd a call to a queue
/v2/calls/:call_control_id/actions/leave_queueRemove a call from a queue
/v2/calls/:call_control_id/actions/gatherCollect DTMF input from a call
/v2/calls/:call_control_id/actions/gather_using_audioCollect DTMF input while playing audio
/v2/calls/:call_control_id/actions/gather_using_speakCollect DTMF input while speaking text
/v2/calls/:call_control_id/actions/gather_using_aiCollect DTMF input using AI
/v2/calls/:call_control_id/actions/gather_stopStop an ongoing gather operation
/v2/calls/:call_control_id/actions/playback_startStart playing audio to a call
/v2/calls/:call_control_id/actions/playback_stopStop playing audio to a call
/v2/calls/:call_control_id/actions/record_startStart recording a call
/v2/calls/:call_control_id/actions/record_stopStop recording a call
/v2/calls/:call_control_id/actions/record_pausePause recording a call
/v2/calls/:call_control_id/actions/record_resumeResume recording a call
/v2/calls/:call_control_id/actions/referSend a SIP REFER request for a call
/v2/calls/:call_control_id/actions/send_dtmfSend DTMF tones to a call
/v2/calls/:call_control_id/actions/send_sip_infoSend a SIP INFO message for a call
/v2/calls/:call_control_id/actions/speakSpeak text to a call
/v2/calls/:call_control_id/actions/streaming_startStart media streaming for a call
/v2/calls/:call_control_id/actions/streaming_stopStop media streaming for a call
/v2/calls/:call_control_id/actions/transcription_startStart transcription for a call
/v2/calls/:call_control_id/actions/transcription_stopStop transcription for a call
/v2/calls/:call_control_id/actions/ai_assistant_startStart AI assistant for a call
/v2/calls/:call_control_id/actions/ai_assistant_stopStop AI assistant for a call
/v2/calls/:call_control_id/actions/siprec_startStart SIPREC recording for a call
/v2/calls/:call_control_id/actions/siprec_stopStop SIPREC recording for a call
/v2/connections/:connection_id/active_callsList all active calls for given connection
/v2/calls/:call_control_idRetrieve a call status

Call events

EndpointDescription
/v2/call_eventsProvide a list of call events based on a filter

Conference

EndpointDescription
/v2/conferencesList all conferences
/v2/conferences/:idGet details of a specific conference
/v2/conferences/:id/participantsList participants in a conference
/v2/conferences/:id/participants/:participant_idUpdate a participant in a conference
/v2/conferencesCreate a new conference
/v2/conferences/:id/actions/joinJoin a call to a conference
/v2/conferences/:id/actions/leaveRemove a call from a conference
/v2/conferences/:id/actions/gather_using_audioCollect DTMF input from conference while playing audio
/v2/conferences/:id/actions/endTerminate a conference
/v2/conferences/:id/actions/record_startStart recording a conference
/v2/conferences/:id/actions/record_stopStop recording a conference
/v2/conferences/:id/actions/record_pausePause recording a conference
/v2/conferences/:id/actions/record_resumeResume recording a conference
/v2/conferences/:id/actions/muteMute all participants in a conference
/v2/conferences/:id/actions/unmuteUnmute all participants in a conference
/v2/conferences/:id/actions/holdPut all participants on hold in a conference
/v2/conferences/:id/actions/unholdRemove hold for all participants in a conference
/v2/conferences/:id/actions/playPlay audio to a conference
/v2/conferences/:id/actions/speakSpeak text to a conference
/v2/conferences/:id/actions/stopStop all ongoing activities in a conference
/v2/conferences/:id/actions/updateUpdate conference settings

Connection

EndpointDescription
/v2/connections/:connection_id/active_callsList active calls for a connection

Queue

EndpointDescription
/v2/queuesList all queues
/v2/queues/:queue_nameGet details of a specific queue
/v2/queues/:queue_name/callsList calls in a queue
/v2/queues/:queue_name/calls/:call_control_idGet details of a call in a queue
/v2/queuesCreate a new queue
/v2/queues/:queue_nameUpdate a queue
/v2/queues/:queue_nameDelete a queue

Siprec

EndpointDescription
/v2/siprec_connectorsList all SIPREC connectors
/v2/siprec_connectors/:nameGet details of a specific SIPREC connector
/v2/siprec_connectorsCreate a new SIPREC connector
/v2/siprec_connectors/:nameUpdate a SIPREC connector
/v2/siprec_connectors/:nameDelete a SIPREC connector

Recording

EndpointDescription
/v2/recordingsList all recordings
/v2/recordings/:idGet details of a specific recording
/v2/recordings/:idDelete a recording

Custom storage

EndpointDescription
/v2/custom_storage_credentialsCreate custom storage credentials
/v2/custom_storage_credentialsList all custom storage credentials
/v2/custom_storage_credentials/:idGet details of a specific custom storage credential
/v2/custom_storage_credentials/:idDelete a custom storage credential

Recording transcription

EndpointDescription
/v2/recordings/:recording_id/transcriptionsList all transcriptions for a recording
/v2/recordings/:recording_id/transcriptions/:idGet details of a specific recording transcription
/v2/recordings/:recording_id/transcriptionsCreate a new transcription for a recording
/v2/recordings/:recording_id/transcriptions/:idDelete a recording transcription

Dialogflow connection

EndpointDescription
/v2/dialogflow_connectionsList all Dialogflow connections
/v2/dialogflow_connections/:idGet details of a specific Dialogflow connection
/v2/dialogflow_connectionsCreate a new Dialogflow connection
/v2/dialogflow_connections/:idUpdate a Dialogflow connection
/v2/dialogflow_connections/:idDelete a Dialogflow connection