Sign in

v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
calls

Send calls

Use the /calls API to send individual calls quickly. A verified Caller ID and sufficient credits are required to make a call. CallRecipient represents a single recipient identified by phone number or contact id in CallFire system. You can attach user-defined attributes to a Call action via CallRecipient.attributes property, attributes are available in Call action response

post/calls

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

campaignIdinteger

Specifies a campaignId to send calls quickly on a previously created campaign

defaultLiveMessagestring

Text to be turned into a sound, this text will be played when the phone is answered. Parameter can be overridden for any particular CallRecipient

defaultMachineMessagestring

Text to be turned into a sound, this text will be played when answering machine is detected. Parameter can be overridden for any particular CallRecipient

defaultLiveMessageSoundIdinteger

Id of sound file to play if phone is answered. Parameter can be overridden for any particular CallRecipient

defaultMachineMessageSoundIdinteger

An id of a sound file to play if answering machine is detected. Parameter can be overridden for any particular CallRecipient

defaultVoice'MALE1' | 'FEMALE1' | 'FEMALE2' | 'SPANISH1' | 'FRENCHCANADIAN1'

The voice set by default for all text-to-speech messages defined in CallRecipient objects or as default *Message properties

strictValidationboolean

Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

Request body

phoneNumberstring

Recipient's phone number in E.164 format (11-digit) or short code. Example: 12132000384

fromNumberstring

~

contactIdinteger

An id of existing contact used as recipient

attributesobject

Map of user-defined string attributes associated with recipient

dialplanXmlstring

An IVR xml document describing dialplan to setup an IVR broadcast. If dialplan is set there is no need to set live, machine and transfer sounds (or vice versa)

liveMessagestring

Text to be turned into a sound, this text will be played when the phone is answered

liveMessageSoundIdinteger

An id of a sound file to play if phone is answered

machineMessagestring

Text to be used to turn into sound, this text will be played when answering machine is detected

machineMessageSoundIdinteger

An id of a sound file to play if answering machine is detected

transferMessagestring

Text to be turned into sound, this text will be played when the transfer digit is played

transferMessageSoundIdinteger

An id of a sound file to play if call is transferred

transferDigitstring

A digit pressed to initiate the transfer

transferNumberstring

Phone number in E.164 format (11-digit) to transfer the call to. Example: 12132000384

voice'MALE1' | 'FEMALE1' | 'FEMALE2' | 'SPANISH1' | 'FRENCHCANADIAN1'

The voice to be used (MALE1, FEMALE1, FEMALE2, SPANISH1, FRENCHCANADIAN1)

Response

successful operation