Post Batch Phonecall

cURL

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

{
  "data": [
    {
      "teamId": "363573667364666473667332",
      "callTemplateId": "363573667364666473667332",
      "nameOfHuman": "John",
      "toPhoneNumber": "+1234567890",
      "promptVariableValues": [
        {
          "key": "customer_name",
          "value": "John"
        }
      ],
      "_id": "12345678901234567890",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "phoneNumberId": "363573667364666473667332",
      "fromPhoneNumber": "+1234567890",
      "toEmailAddress": "[email protected]",
      "status": "queued",
      "telephonyProvider": "twilio",
      "record": false,
      "callDelayedUntil": "2023-10-12T09:08:00.387Z",
      "phoneCallWebhooks": [
        {
          "url": "https://hooks.abc.com/",
          "subscribedEvent": "phoneCall.completed",
          "secret": "NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"
        }
      ]
    }
  ]
}

POST

phoneCalls

batch

cURL

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

{
  "data": [
    {
      "teamId": "363573667364666473667332",
      "callTemplateId": "363573667364666473667332",
      "nameOfHuman": "John",
      "toPhoneNumber": "+1234567890",
      "promptVariableValues": [
        {
          "key": "customer_name",
          "value": "John"
        }
      ],
      "_id": "12345678901234567890",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "phoneNumberId": "363573667364666473667332",
      "fromPhoneNumber": "+1234567890",
      "toEmailAddress": "[email protected]",
      "status": "queued",
      "telephonyProvider": "twilio",
      "record": false,
      "callDelayedUntil": "2023-10-12T09:08:00.387Z",
      "phoneCallWebhooks": [
        {
          "url": "https://hooks.abc.com/",
          "subscribedEvent": "phoneCall.completed",
          "secret": "NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"
        }
      ]
    }
  ]
}

Authorizations

aicaller-api-key

string

header

required

Body

application/json

phoneCalls

object[]

required

Array of phone calls used in the call (maximum 20 items).

Maximum array length: 20

Show child attributes

phoneCalls.teamId

object

required

The unique ID of the Team, phoneCall associated with.

Example:

"363573667364666473667332"

phoneCalls.callTemplateId

string

required

The ID of the call template used for the call.

Example:

"363573667364666473667332"

phoneCalls.nameOfHuman

string

required

The name of the human making the call to.

Example:

"John"

phoneCalls.toPhoneNumber

string

required

The phone number the call is made to.

Example:

"+1234567890"

phoneCalls.promptVariableValues

object[]

required

Array of prompt variables used in the call.

Show child attributes

phoneCalls.promptVariableValues.key

string

required

Example:

"customer_name"

phoneCalls.promptVariableValues.value

string

required

Example:

"John"

phoneCalls.phoneNumberId

string

The ID of the phone number associated with the call.

Example:

"363573667364666473667332"

phoneCalls.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"

phoneCalls.toEmailAddress

string

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

Example:

"[email protected]"

phoneCalls.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"

phoneCalls.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"

phoneCalls.record

boolean

default:false

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

Example:

false

phoneCalls.callDelayedUntil

string<date-time>

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"

phoneCalls.phoneCallWebhooks

object[]

Array of webhooks to be notified for this call.

Show child attributes

phoneCalls.phoneCallWebhooks.url

string

required

Example:

"https://hooks.abc.com/"

phoneCalls.phoneCallWebhooks.subscribedEvent

string

required

Example:

"phoneCall.completed"

phoneCalls.phoneCallWebhooks.secret

string

Example:

"NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"

Response

Phone calls successfully created.

data

object[]

required

Show child attributes

data.teamId

object

required

The unique ID of the Team, phoneCall associated with.

Example:

"363573667364666473667332"

data.callTemplateId

string

required

The ID of the call template used for the call.

Example:

"363573667364666473667332"

data.nameOfHuman

string

required

The name of the human making the call to.

Example:

"John"

data.toPhoneNumber

string

required

The phone number the call is made to.

Example:

"+1234567890"

data.promptVariableValues

object[]

required

Array of prompt variables used in the call.

Show child attributes

data.promptVariableValues.key

string

required

Example:

"customer_name"

data.promptVariableValues.value

string

required

Example:

"John"

data._id

string

required

Unique identifier for the phoneCall

Example:

"12345678901234567890"

data.createdAt

string

required

data.updatedAt

string

required

data.phoneNumberId

string

The ID of the phone number associated with the call.

Example:

"363573667364666473667332"

data.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"

data.toEmailAddress

string

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

Example:

"[email protected]"

data.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"

data.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"

data.record

boolean

default:false

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

Example:

false

data.callDelayedUntil

string<date-time>

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"

data.phoneCallWebhooks

object[]

Array of webhooks to be notified for this call.

Show child attributes

data.phoneCallWebhooks.url

string

required

Example:

"https://hooks.abc.com/"

data.phoneCallWebhooks.subscribedEvent

string

required

Example:

"phoneCall.completed"

data.phoneCallWebhooks.secret

string

Example:

"NjUyOTgwMjkpJU0NmY25yzWkJFWDBE12"

Post Phonecall Get Single Phonecall

⌘I

API Documentation

Voices

Teams

Call templates

Phone Calls

Transcripts

Webhooks

Post Batch Phonecall

Authorizations

Body

Response