SMS API

Hello World
Rest
HTTP Status Codes

Voice

Overview
Security & Authentication
Data Format
Different Voice Parameters that are Available
Call Management and Status
Call Queue Management
- Retrieves a specific call queueget
- Dequeue the first caller in queuepost
Number Masking
Webhooks
- Creates a Webhookpost

Authenticate

Verifications
- Check Verificationpost
- Create Verificationpost

Unifonic Push

Create Push Notificationpost
Get Notificationget

Ulink

Create Single Urlpost
Url Detailsget
List Custom Domainsget

SMS API

Hello World
Rest
HTTP Status Codes

Voice

Overview
Security & Authentication
Data Format
Different Voice Parameters that are Available
Call Management and Status
Call Queue Management
- Retrieves a specific call queueget
- Dequeue the first caller in queuepost
Number Masking
Webhooks
- Creates a Webhookpost

Authenticate

Verifications
- Check Verificationpost
- Create Verificationpost

Unifonic Push

Create Push Notificationpost
Get Notificationget

Ulink

Create Single Urlpost
Url Detailsget
List Custom Domainsget

Creates an Outbound Call

post https://voice.unifonic.com/v1/calls

This operation creates a request to generate outbound calls to a list of recipients specified within the API payload.

Body Params

Recipient, callerId, call instructions

recipient

array of strings

required

Description of usage

recipient*

callerId

string

required

callerId which is used to send the outbound calls

type

string

required

Possible values for the status of the Usage

callRecording

boolean

optional field. Setting to true would result in a recorded call, call recording will be made available on the Unifonic Console

expiry

string

Date and Time of Expiry

ivr

object

ivr call instruction. Only required when type is chosen as ivr.

referenceId

string

any content that is of relevance, as this will be appended as a query in all responses and webhook notification

Headers

appsId

string

required

applicationId found on Unifonic Console

Responses

Response body

object

callId

string

unique identifier

status

string

status of the call request

referenceId

string

referenceId as specified in payload

Response body

object

message

string

required

Application relevant detail, defined in the API or a common list.

errors

string

required

Explanation of the reason for the error which can be shown to a client user.

Response body

object

message

string

required

Application relevant detail, defined in the API or a common list.

Response body

object

message

string

required

Application relevant detail, defined in the API or a common list.

Updated over 2 years ago

Different Voice Parameters that are Available

Retrieves call status

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://voice.unifonic.com/v1/calls \
3
     --header 'accept: application/json;charset=utf-8' \
4
     --header 'content-type: application/json;charset=utf-8' \
5
     --data '{"type":"ivr"}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json;charset=utf-8

Updated over 2 years ago

Different Voice Parameters that are Available

Retrieves call status

Did this page help you?

SMS API
Hello World
Rest
Stop Scheduled Messagesdelete
Scheduled Message Detailsget
Send Scheduled Messagespost
Get Message Detailspost
Send messagepost
HTTP Status Codes

Voice
Overview
Security & Authentication
Data Format
Different Voice Parameters that are Available
Call Management and Status
Sending Multiple IVR Objects in a single request
How to create a Conference Bridge
Managing your Incoming Calls
How to use Random Caller ID feature
Making an Outgoing Voice Call to Send a Simple Text-to-Speech message
Making an Outgoing Voice Call to Send an OTP
Making an Outgoing Call to Collect Response
Making an Outgoing Call that Plays an Audio
Understanding the use of Secondary Caller ID
Checking my call status via APIs
Retrieves call statusget
Creates an Outbound Callpost
Call Queue Management
Dequeue the first caller in queuepost
Retrieves a specific call queueget
Number Masking
Deactivates a specific masking sessiondelete
Retrieves details of a specific masking sessionget
Creates a One Way Number Masking Sessionpost
Creates a Two Way Number Masking Sessionpost
Retrieves all masking sessionsget
Webhooks
Creates a Webhookpost

Authenticate
Verifications
Create Verificationpost
Check Verificationpost

Unifonic Push
Create Push Notificationpost
Get Notificationget

Ulink
Create Single Urlpost
Url Detailsget
List Custom Domainsget

SMS API
Hello World
Rest
Stop Scheduled Messagesdelete
Scheduled Message Detailsget
Send Scheduled Messagespost
Get Message Detailspost
Send messagepost
HTTP Status Codes

Voice
Overview
Security & Authentication
Data Format
Different Voice Parameters that are Available
Call Management and Status
Sending Multiple IVR Objects in a single request
How to create a Conference Bridge
Managing your Incoming Calls
How to use Random Caller ID feature
Making an Outgoing Voice Call to Send a Simple Text-to-Speech message
Making an Outgoing Voice Call to Send an OTP
Making an Outgoing Call to Collect Response
Making an Outgoing Call that Plays an Audio
Understanding the use of Secondary Caller ID
Checking my call status via APIs
Retrieves call statusget
Creates an Outbound Callpost
Call Queue Management
Dequeue the first caller in queuepost
Retrieves a specific call queueget
Number Masking
Deactivates a specific masking sessiondelete
Retrieves details of a specific masking sessionget
Creates a One Way Number Masking Sessionpost
Creates a Two Way Number Masking Sessionpost
Retrieves all masking sessionsget
Webhooks
Creates a Webhookpost

Authenticate
Verifications
Create Verificationpost
Check Verificationpost

Unifonic Push
Create Push Notificationpost
Get Notificationget

Ulink
Create Single Urlpost
Url Detailsget
List Custom Domainsget

201Created

400Bad Request

403Forbidden

500Internal Server Error