Phone Playback

Make an automated call to any valid phone number and playback an audio message.

Use this API to make important broadcasts or notifications by playing back pre-recorded or generated audio files.

The telephony APIs can operate in two modes, you can place your calls using our VOIP service or your can provide your own SIP trunk. Using your own SIP trunk allows you to use your own DIDs so recipients can place calls back to you. You can also setup voice mail and any other features your VOIP service provider might have.

Our Calling Rates

This API is only available to paid and verified accounts.

End Point

https://neutrinoapi.net/phone-playback

Test API

API Request

Parameter	Required	Type	Default	Description
number	yes	string		The phone number to call. Must be in valid international format
audio-url	yes	string		A URL to a valid audio file. Accepted audio formats are: MP3 WAV OGG You can use the following MP3 URL for testing: https://www.neutrinoapi.com/test-files/test1.mp3
limit	no	integer	3	Limit the total number of calls allowed to the supplied phone number, if the limit is reached within the TTL then error code 14 will be returned
limit-ttl	no	integer	1	Set the TTL in number of days that the 'limit' option will remember a phone number (the default is 1 day and the maximum is 365 days)

API Response

Parameter	Type	Description
calling	boolean	True if the call is being made now
number-valid	boolean	True if this a valid phone number

API Performance

Characteristic	Value	Description
Avg Latency	20ms	Average RTT for requests within the same data center/region
Max Rate	2/second	Maximum inbound request rate. Exceeding this will result in request throttling
Max Concurrency	10	Maximum concurrent/simultaneous requests. Exceeding this will result in error code 06 [TOO MANY CONNECTIONS]

API Example

curl https://neutrinoapi.net/phone-playback \ --header "User-ID: <your-user-id>" \ --header "API-Key: <your-api-key>" \ --data-urlencode "number=+12106100045" \ --data-urlencode "limit=3" \ --data-urlencode "audio-url=https://www.neutrinoapi.com/test-files/test1.mp3" \ --data-urlencode "limit-ttl=1"

{ numberValid: true, calling: true }