POST
/
v1
/
phoneCalls
curl --request POST \
  --url https://api.aicaller.io/v1/phoneCalls \
  --header 'Content-Type: application/json' \
  --header 'aicaller-api-key: <api-key>' \
  --data '{
  "teamId": "363573667364666473667332",
  "phoneNumberId": "363573667364666473667332",
  "callTemplateId": "363573667364666473667332",
  "nameOfHuman": "John",
  "fromPhoneNumber": "+1234567890",
  "toPhoneNumber": "+1234567890",
  "toEmailAddress": "someone@email.com",
  "status": "queued",
  "telephonyProvider": "twilio",
  "promptVariableValues": [
    {
      "key": "customer_name",
      "value": "John"
    }
  ],
  "record": false,
  "callDelayedUntil": "2023-10-12T09:08:00.387Z",
  "phoneCallWebhooks": [
    {
      "url": "https://hooks.abc.com/",
      "subscribedEvent": "phoneCall.completed",
      "secret": "NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"
    }
  ]
}'
{
  "data": {
    "teamId": "363573667364666473667332",
    "phoneNumberId": "363573667364666473667332",
    "callTemplateId": "363573667364666473667332",
    "nameOfHuman": "John",
    "fromPhoneNumber": "+1234567890",
    "toPhoneNumber": "+1234567890",
    "toEmailAddress": "someone@email.com",
    "status": "queued",
    "telephonyProvider": "twilio",
    "promptVariableValues": [
      {
        "key": "customer_name",
        "value": "John"
      }
    ],
    "record": false,
    "callDelayedUntil": "2023-10-12T09:08:00.387Z",
    "phoneCallWebhooks": [
      {
        "url": "https://hooks.abc.com/",
        "subscribedEvent": "phoneCall.completed",
        "secret": "NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"
      }
    ],
    "_id": "12345678901234567890",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

​
aicaller-api-key
string
header
required

Body

application/json
​
teamId
object
required

The unique ID of the Team, phoneCall associated with.

Example:

"363573667364666473667332"

​
callTemplateId
string
required

The ID of the call template used for the call.

Example:

"363573667364666473667332"

​
nameOfHuman
string
required

The name of the human making the call to.

Example:

"John"

​
toPhoneNumber
string
required

The phone number the call is made to.

Example:

"+1234567890"

​
promptVariableValues
object[]
required

Array of prompt variables used in the call.

​
phoneNumberId
string

The ID of the phone number associated with the call.

Example:

"363573667364666473667332"

​
fromPhoneNumber
string

The optional phone number the call should be made from. If not provided AI will use a number from twilio settings.

Example:

"+1234567890"

​
toEmailAddress
string

The email of the person, the call is made to.

Example:

"someone@email.com"

​
status
enum<string>

The status of the phone call. Possible values: "queued", "ringing", "inProgress", "busy", "noAnswer", "canceled", "failed", "completed".

Available options:
queued,
ringing,
inProgress,
busy,
failed,
noAnswer,
cancelled,
completed
Example:

"queued"

​
telephonyProvider
enum<string>

The telephony provider to be used for the phone call. Possible values: "twilio", "plivo", "telnyx".

Available options:
twilio,
plivo,
telnyx
Example:

"twilio"

​
record
boolean
default:false

Flag indicating whether recording is enabled for the specific phone call.

Example:

false

​
callDelayedUntil
string

Can be used to schedule a call for the future. Must be ISO Date as a string with UTC timezone.

Example:

"2023-10-12T09:08:00.387Z"

​
phoneCallWebhooks
object[]

Array of webhooks to be notified for this call.

Response

200
application/json
Phone call successfully created.
​
data
object
required