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

A payload for call creation. Most of the fields would be found to be optional. A combination of different fields typically result in different call experiences.

recipient

array of objects

required

Description of usage

recipient*

callerId

string

required

callerId which is used to send the outbound calls

type

string

enum

required

Possible values for the status of the Usage

Allowed:

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

201Created

400Bad Request

403Forbidden

500Internal Server Error