SignalWire Calls API
Manage voice calls and call recordings.
SignalWire Calls API is one of 80 APIs that SignalWire publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Calls. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 6 operations across 3 paths, and defines 151 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://{space_name}.signalwire.com/api/laml/2010-04-01, https://{space_name}.signalwire.com.
6 operations
3 paths
151 schemas
1 DELETE2 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
SignalWire Calls API declares
2 security schemes
for authenticating requests.
It accepts HTTP basic authentication (SignalWireBasicAuth).
It accepts HTTP bearer tokens (SignalWireBearerAuth).
By default, every request must be authenticated.
SignalWireBasicAuth— SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed…SignalWireBearerAuth— SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer follow…
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Calls 6
Manage voice calls and call recordings.
GET
/Accounts/{AccountSid}/Calls
List all Calls
POST
/Accounts/{AccountSid}/Calls
Create a Call
GET
/Accounts/{AccountSid}/Calls/{Sid}
Retrieve a Call
POST
/Accounts/{AccountSid}/Calls/{Sid}
Update a Call
DELETE
/Accounts/{AccountSid}/Calls/{Sid}
Delete a Call
POST
/api/calling/calls
Send call commands
Schemas 151
The contract defines 151 schemas that model the data the API accepts and returns. The most detailed are Call (36 properties), CallResponse (36 properties), CreateCallRequest (33 properties), VoiceStatusCallbackPayload (30 properties). Each schema is shown below with its type and property counts.
CallStatus
string
Call status.
CompatibilityErrorArrayItem
object
Error item in the errors array format.
3 properties
CallSubresourceUris
object
Call subresource URIs.
2 properties
2 required
CompatibilityErrorArrayResponse
object
Error response with errors array format.
1 property
CreateCallRequest
object
Request body for creating a call.
33 properties
2 required
uuid
string
Universal Unique Identifier.
UpdateCallRequest
object
Request body for updating a call.
7 properties
CallListResponse
object
Response containing a list of calls.
7 properties
7 required
AnsweredBy
string
Who/what answered the call.
CallDirection
string
Call direction.
VoiceStatusCallbackPayload
object
30 properties
21 required
CallResponse
object
Response containing a single call.
36 properties
36 required
Call
object
Call model representing a voice call.
36 properties
36 required
CompatibilityErrorResponse
object
Error response model.
4 properties
4 required
Calling.LiveTranscribeStopAction
string
Stops the live transcription session.
Types.StatusCodes.StatusCode401
object
Access is unauthorized.
1 property
1 required
Calling.RecordParams
object
Recording configuration wrapper. Currently only audio recording is supported.
1 property
1 required
Calling.CallDenoiseRequest
object
Enable noise reduction on an active call. Denoise is per-call (no controlid); a call has at most one active denoise filter. Use calling.denoise.stop to disable…
3 properties
3 required
Calling.ReferSipParams
object
SIP REFER device parameters.
4 properties
1 required
Calling.TapRtpParams
object
RTP tap target parameters.
4 properties
2 required
Calling.CallResponseStatus
string
The status of the call throughout its lifecycle.
Types.StatusCodes.StatusCode400
object
The request is invalid.
1 property
1 required
SWML.Calling.TranscribeDirection
string
Calling.ChargeDetails
object
2 properties
2 required
Calling.TapDeviceWs
object
WebSocket tap device configuration.
2 properties
2 required
SWML.Calling.AISidecarBooleanParam
object
3 properties
1 required
Types.StatusCodes.StatusCode404
object
The server cannot find the requested resource.
1 property
1 required
Calling.TapDevice
object
Tap device configuration — specifies where to stream captured audio.
1 property
1 required
Calling.TapCodec
string
RTP/WebSocket audio codec. Case-sensitive; accepted in both upper and lower case.
SWML.Calling.AISidecarNumberParam
object
4 properties
1 required
SWML.Calling.AISidecarSWAIGDefaults
object
3 properties
Calling.CallAIMessageResetParams
object
Parameters for resetting the AI conversation state.
3 properties
SWML.Calling.AISidecarIntegerParam
object
4 properties
1 required
Calling.CallAISidecarStopRequest
object
3 properties
3 required
Calling.ReferDevice
object
Device configuration for SIP REFER.
2 properties
2 required
Calling.DetectMachineParams
object
Answering-machine detection parameters. Applies only when detect.type is machine.
7 properties
Types.StatusCodes.RestApiErrorItem
object
Details about a specific error.
5 properties
4 required
Calling.CallUpdateParamsSWML
object
5 properties
2 required
SWML.Calling.AISidecarStringParam
object
4 properties
1 required
Calling.CallSendFaxStopRequest
object
3 properties
3 required
SWML.Calling.POM
Regular section that requires either body or bullets.
SWML.Calling.AISidecarSummarizeAction
object
1 property
1 required
Calling.CallCollectRequest
object
Collect user input (DTMF digits, speech, or both) on an active call. At least one of digits or speech must be provided; requests missing both return 400. Resul…
3 properties
3 required
Calling.PlayAudioItem
object
Play an audio file from a URL.
2 properties
2 required
SWML.Calling.AISidecarPermissions
object
3 properties
Calling.CallTranscribeRequest
object
Transcribe the entire call in the background. The transcription covers the whole call and completes when the call ends. For real-time transcription, use callin…
3 properties
3 required
Calling.HangupReason
string
The reason for hanging up the call.
Calling.CallRequest
object
Call request union for JSON-RPC style method dispatch. Use the command field to specify which call method to invoke. Only the commands listed here are supporte…
Calling.CallAISidecarAskRequest
object
3 properties
3 required
Calling.DetectMachineConfig
object
Answering-machine detection configuration.
2 properties
1 required
Calling.PlayRingtoneItem
object
Play a country-coded ringtone cadence.
2 properties
2 required
Calling.DetectFaxConfig
object
Fax-tone detection configuration.
2 properties
1 required
Calling.LiveTranscribeSummarizeAction
object
1 property
1 required
Calling.PlayTtsParams
object
Text-to-speech playback parameters.
4 properties
1 required
Calling.CallAISidecarRequest
object
3 properties
3 required
Calling.CallAIStopRequest
object
3 properties
3 required
Calling.DetectConfig
object
Detection configuration. The shape of params depends on type.
1 property
1 required
Calling.DetectDigitParams
object
DTMF-digit detection parameters. Applies only when detect.type is digit.
1 property
Calling.PlayDirection
string
The direction of audio playback relative to the call participants.
Calling.CallStreamRequest
object
Stream call audio to an external WebSocket endpoint. Audio is sent to a wss:// URL; customparameters pass through to the endpoint as connection metadata. Strea…
3 properties
3 required
SWML.Calling.AISidecarPromptPom
object
1 property
1 required
Calling.DetectType
string
The type of detection to perform.
Calling.TapPtime
number
RTP packetization time in milliseconds. Must be a multiple of 10 between 10 and 120.
Calling.CallCreateParamsURL
object
17 properties
2 required
Calling.CallCollectStartInputTimersRequest
object
3 properties
3 required
Calling.LiveTranslateStartAction
object
1 property
1 required
SWML.Calling.GlobalData
object
A key-value object for data that persists throughout an AI or sidecar session.
Calling.CallCollectStopRequest
object
3 properties
3 required
Calling.CallUpdateCurrentCallRequest
object
Update a call in progress — cancel, complete, or redirect the SWML flow. State-transition rules: - status: canceled is only valid while the leg is queued or ri…
2 properties
2 required
SWML.Calling.PomSectionBodyContent
object
Content model with body text and optional bullets
6 properties
1 required
Calling.CallTranscribeStopRequest
object
3 properties
3 required
SWML.Calling.AISidecarArrayParam
object
3 properties
2 required
Calling.CallPlayRequest
object
Play media (audio files, text-to-speech, silence, or ringtones) on an active call. The HTTP response confirms the command was accepted. Playback lifecycle is d…
3 properties
3 required
SWML.Calling.AISidecarObjectParam
object
4 properties
1 required
Calling.StreamStatusUrlMethod
string
HTTP method used when invoking the statusurl webhook.
Calling.CallResponse
The response varies based on the type of call. A standard call returns a Call Leg, while a Fabric subscriber call returns a Fabric Device Leg.
Calling.PlayRingtoneParams
object
Ringtone playback parameters.
2 properties
1 required
Calling.CallCreate422Error
object
The request contains invalid parameters. See errors for details.
1 property
1 required
Calling.CallRecordStopRequest
object
3 properties
3 required
Calling.CallRecordPauseRequest
object
3 properties
3 required
Calling.CallReferRequest
object
3 properties
3 required
SWML.Calling.AISidecarPrompt
Calling.LiveTranslateStopAction
string
Stops the live translation session.
Calling.LiveTranscribeStartAction
object
1 property
1 required
Calling.CallTapStopRequest
object
3 properties
3 required
Calling.CallDirection
string
The direction of the call.
Calling.CallAISidecarStatusRequest
object
3 properties
3 required
Calling.CallCreateRequest
object
2 properties
2 required
Calling.CallPlayPauseRequest
object
3 properties
3 required
Calling.LiveTranslateSummarizeAction
object
1 property
1 required
SWML.Calling.CustomTranslationFilter
string
Custom translation filter with a prompt prefix. Use prompt: followed by your custom instructions (e.g., prompt:Use formal business language).
Calling.TapConfig
object
Tap configuration — specifies what audio to capture.
2 properties
2 required
Calling.PlayMediaType
string
The type of media to play.
Calling.CallRecordResumeRequest
object
3 properties
3 required
Calling.CallPlayStopRequest
object
3 properties
3 required
Calling.PlayTtsItem
object
Play text-to-speech. Per-item language/voice/gender override the request-level fallbacks.
2 properties
2 required
Types.StatusCodes.StatusCode500
object
An internal server error occurred.
1 property
1 required
Calling.LiveTranslateInjectAction
object
1 property
1 required
Calling.CallPlayVolumeRequest
object
3 properties
3 required
Calling.CallTransferRequest
object
3 properties
3 required
Calling.PlayAudioParams
object
Audio file playback parameters.
1 property
1 required
SWML.Calling.PomSectionBulletsContent
object
Content model with bullets and optional body
6 properties
1 required
Calling.DetectDigitConfig
object
DTMF-digit detection configuration.
2 properties
1 required
SpeechEngine
string
Speech recognition engine options.
SWML.Calling.AISidecarObject
object
12 properties
1 required
Calling.CallRecordRequest
object
Starts recording an active call. The HTTP response returns the call leg — the recording URL is not included. Recording runs asynchronously; provide statusurl t…
3 properties
3 required
Calling.CollectSpeechEngine
string
Speech recognition engine for calling.collect. Note: values are case-sensitive.
Calling.CallLiveTranslateRequest
object
3 properties
3 required
Calling.CallLeg
object
Returned when the call is a standard PSTN, SIP, or WebRTC call.
15 properties
15 required
Calling.CallDetectRequest
object
Start detection (answering machine, fax tone, or DTMF digits) on an active call. Detection runs asynchronously up to timeout seconds. Results are delivered via…
3 properties
3 required
Calling.TapWsParams
object
WebSocket tap target parameters.
2 properties
1 required
Calling.TapDeviceRtp
object
RTP tap device configuration.
2 properties
2 required
Calling.PlayMediaItem
object
A media item to play on the call. The shape of params is determined by type.
1 property
1 required
SWML.Calling.AISidecarParamProperty
Calling.CallHangupRequest
object
3 properties
3 required
SWML.Calling.AISidecarParams
object
18 properties
Calling.OutboundCallCodec
string
Codec offered on an outbound call. For PSTN, PCMU/PCMA are widely supported. OPUS@ H@ I variants pin the OPUS sample rate (Hz) and packetization time (ms).
Calling.CollectDigitsParams
object
Parameters for collecting DTMF digit input.
3 properties
1 required
SWML.Calling.MCPServer
object
4 properties
1 required
Calling.PlayRingtoneName
string
Ringtone name. Two-letter country code selects a country-specific ringtone cadence.
Calling.RecordAudioParams
object
Audio recording parameters.
9 properties
SWML.Calling.AISidecarPromptFile
object
1 property
1 required
Calling.StreamTrack
string
The audio track to stream.
Calling.CollectSpeechParams
object
Parameters for collecting speech input.
6 properties
Calling.CallDisconnectRequest
object
3 properties
3 required
Calling.CallUserEventRequest
object
3 properties
3 required
Calling.CallHoldRequest
object
3 properties
3 required
SWML.Calling.AISidecarSWAIGFunction
object
7 properties
1 required
Calling.CallStreamStopRequest
object
3 properties
3 required
Calling.CallLiveTranscribeRequest
object
3 properties
3 required
Calling.TapDeviceType
string
The type of tap device to stream audio to.
Calling.PlaySilenceParams
object
Silence playback parameters.
1 property
1 required
SWML.Calling.AISidecarFunctionParameters
object
3 properties
2 required
Calling.TtsGender
string
Text-to-speech voice gender.
Calling.CallAISidecarPokeRequest
object
3 properties
3 required
Calling.CallCreateParamsSWML
object
17 properties
2 required
Calling.CallDenoiseStopRequest
object
3 properties
3 required
Calling.CallUpdateParamsURL
object
5 properties
2 required
Calling.CallPlayResumeRequest
object
3 properties
3 required
SWML.Calling.TranslationFilterPreset
string
Preset translation filter values that adjust the tone or style of translated speech. - polite - Translates to a polite version, removing anything insulting whi…
Calling.FabricDeviceLeg
object
Returned when the call is a Fabric subscriber device leg. The status field is always null for this type.
11 properties
11 required
Calling.CallReceiveFaxStopRequest
object
3 properties
3 required
Calling.CallTapRequest
object
Capture audio from an active call and stream it to an external destination. Audio is streamed via RTP (to a public IP/port) or WebSocket (to a ws:///wss:// URI…
3 properties
3 required
Calling.CallAIMessageRequest
object
3 properties
3 required
Calling.PlaySilenceItem
object
Play silence for a fixed duration.
2 properties
2 required
Calling.CallDetectStopRequest
object
3 properties
3 required
Calling.CallUnholdRequest
object
3 properties
3 required
SWML.Calling.AISidecarPromptText
object
1 property
1 required
Calling.DetectFaxParams
object
Fax-tone detection parameters. Applies only when detect.type is fax.
1 property
SWML.Calling.AISidecarSWAIG
object
3 properties
Calling.DetectFaxTone
string
Fax tone to detect.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from SignalWire 12
Other APIs SignalWire publishes across the network.
SignalWire Calling API (JSON-RPC)
SignalWire Accounts API
SignalWire Addresses API
SignalWire AI Agents: Custom API
SignalWire AI Agents: Dialogflow API
SignalWire AI Chat API
SignalWire AI Webhooks API
SignalWire Applications API
SignalWire Available Phone Numbers API
SignalWire Call Flows API
SignalWire Calling Webhooks API
SignalWire Campaign Registry: Brands API
#Calls
Where this information came from
This is an independent, third-party profile of SignalWire Calls API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.