Send Call

Send a new voice call from a FoneNumber to a recipient phone number.

This will place a call to the given to phone number, with a caller ID corresponding to the given fonenumber. When the call connects, the API returns with the call ID, and the destination identified by service_id will be connected.

{
  "call": {
    "id": "ce20fe86-b5ce-11e7-9eec-cf0ab03fdb06"
  }
}

📘

US and International Dialing

• All non-numeric characters in a phone number are ignored; a value like "(321) 499-1008" will be interpreted as 3214991008.

• When calling a number within the United States, use 1+10 digits: 13214991000

• For international dialing: 011+(country code)+digits: 01149894567898
In this example, '49' is the country code for Germany)

Notes

to

A valid phone number (7 to 15 digits long) or a configured Speed Dial (1 to 6 digits long).

service_type

The to parameter contains the corresponding setting for the destination.

TypeValueExampleNote
DeviceThe ID for the destination device987123543678Use the Get Devices endpoint to get the desired device ID.
VoiceMailThe ID for the destination VoiceMailVM7878452661Use the Get Voicemails endpoint to get the desired voicemail ID.
SoundFileA valid URLhttps://www.example.com/file.wavURL for sound file to play. See below for more information.
TTSText StringHello, this is a test callText-to-speech. See below for more information.
PhonenumberTelephone number3215551111Valid 7 to 15 digit telephone number

TTS: Text-to-speech supports the Speech Synthesis Markup Language (SSML) for improved control over how the text is read. Official documentation is provided at the W3C SSML page.

SoundFile: Currently, only WAV files accessible by the given URL are supported. Support for uploaded files and other formats is coming soon.

service_id

Calls can be connected to one of several destination types: a configured and registered Device (e.g. SIP handset, Fractelfone mobile app, or WebRTC endpoint), a configured VoiceMail box, a SoundFile URL, or to another PhoneNumber. There is also an option to set the destination type to TTS (text-to-speech), in which the message specified by the to field is read out via speech synthesis. Use the type parameter to specify the type of call that needs to be made.

Response Properties

PropertyTypeDescription
callobjectCall object.

🚧

Making calls may result in additional charges and fees to your account.

Language
Authentication
Header
Response
Click Try It! to start a request and see the response here!