Get Phonecalls

cURL

curl --request GET \
  --url https://api.aicaller.io/v1/phoneCalls \
  --header 'aicaller-api-key: <api-key>'

{
  "data": [
    {
      "teamId": "363573667364666473667332",
      "callTemplateId": "363573667364666473667332",
      "nameOfHuman": "John",
      "toPhoneNumber": "+1234567890",
      "promptVariableValues": [
        {
          "key": "customer_name",
          "value": "John"
        }
      ],
      "resultValues": [
        {
          "columnName": "city",
          "value": "Bangalore"
        }
      ],
      "_id": "12345678901234567890",
      "fileId": "363573667364666473667332",
      "fileName": "lead_list.csv",
      "callTriggeredAt": "2023-10-12T09:07:55.387Z",
      "callStartedAt": "2023-10-12T09:08:05.387Z",
      "callEndedAt": "2023-10-12T09:09:02.387Z",
      "createdAt": "2023-10-12T09:08:00.387Z",
      "updatedAt": "2023-10-12T09:08:00.387Z",
      "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"
        }
      ],
      "statusExtraInfo": {
        "statusCode": "CALL_LATER",
        "dateTime": "2024-03-11T10:00:00Z"
      },
      "fixedMeetingTime": "2024-03-11T10:00:00Z",
      "recordingUrl": "https://example.com/recording.mp3",
      "callDuration": 60,
      "callOrigin": "api",
      "customTagsHitOnCall": [
        "<string>"
      ]
    }
  ]
}

GET

phoneCalls

cURL

curl --request GET \
  --url https://api.aicaller.io/v1/phoneCalls \
  --header 'aicaller-api-key: <api-key>'

{
  "data": [
    {
      "teamId": "363573667364666473667332",
      "callTemplateId": "363573667364666473667332",
      "nameOfHuman": "John",
      "toPhoneNumber": "+1234567890",
      "promptVariableValues": [
        {
          "key": "customer_name",
          "value": "John"
        }
      ],
      "resultValues": [
        {
          "columnName": "city",
          "value": "Bangalore"
        }
      ],
      "_id": "12345678901234567890",
      "fileId": "363573667364666473667332",
      "fileName": "lead_list.csv",
      "callTriggeredAt": "2023-10-12T09:07:55.387Z",
      "callStartedAt": "2023-10-12T09:08:05.387Z",
      "callEndedAt": "2023-10-12T09:09:02.387Z",
      "createdAt": "2023-10-12T09:08:00.387Z",
      "updatedAt": "2023-10-12T09:08:00.387Z",
      "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"
        }
      ],
      "statusExtraInfo": {
        "statusCode": "CALL_LATER",
        "dateTime": "2024-03-11T10:00:00Z"
      },
      "fixedMeetingTime": "2024-03-11T10:00:00Z",
      "recordingUrl": "https://example.com/recording.mp3",
      "callDuration": 60,
      "callOrigin": "api",
      "customTagsHitOnCall": [
        "<string>"
      ]
    }
  ]
}

List of possible `status` and `statusExtraInfo` values

Please refer to this blog for list all possible values and their meaning.

Authorizations

aicaller-api-key

string

header

required

Query Parameters

callTemplateId

string

Unique ID of the CallTemplate

phoneNumberId

string

Unique ID of the PhoneNumber you own

fromDate

string<date-time>

Get phoneCalls created after this date

toDate

string<date-time>

Get phoneCalls created before this date

toPhoneNumber

string

Get phoneCalls made to a phoneNumber

status

string

Get phoneCalls with specific status, Possible values: "queued", "ringing", "inProgress", "busy", "noAnswer", "canceled", "failed", "completed".

fileId

string

Get bulk phoneCalls triggered using a file associated with fileId

Response

Phone calls found.

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.resultValues

object[]

required

Array of result values from the call.

Show child attributes

data.resultValues.columnName

string

required

Example:

"city"

data.resultValues.value

string

required

Example:

"Bangalore"

data._id

string

required

Unique identifier for the phoneCall

Example:

"12345678901234567890"

data.fileId

string

required

File Id of File from which this call was created.

Example:

"363573667364666473667332"

data.fileName

string

required

File name from which this call was created.

Example:

"lead_list.csv"

data.callTriggeredAt

string<date-time>

required

Time stamp when the call was triggered

Example:

"2023-10-12T09:07:55.387Z"

data.callStartedAt

string<date-time>

required

Time stamp when the call started (i.e connected)

Example:

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

data.callEndedAt

string<date-time>

required

Time stamp when the call ended

Example:

"2023-10-12T09:09:02.387Z"

data.createdAt

string<date-time>

required

Example:

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

data.updatedAt

string<date-time>

required

Example:

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

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"

data.statusExtraInfo

object

Extra information about how did the call end.

Example:

{
  "statusCode": "CALL_LATER",
  "dateTime": "2024-03-11T10:00:00Z"
}

data.fixedMeetingTime

string<date-time>

If the call was scheduled for a meeting, the time will be shown here.

Example:

"2024-03-11T10:00:00Z"

data.recordingUrl

string

URL to the recording of the phone call.

Example:

"https://example.com/recording.mp3"

data.callDuration

number

Duration of the phone call in seconds.

Example:

60

data.callOrigin

enum<string>

Origin of call (demo, ui, api, batch)

Available options:

demo,

ui,

api,

batch

Example:

"api"

data.customTagsHitOnCall

string[]

custom tags hit on call

About Call templates Post Phonecall

⌘I

API Documentation

Voices

Teams

Call templates

Phone Calls

Transcripts

Webhooks

List of possible `status` and `statusExtraInfo` values

Authorizations

Query Parameters

Response

API Documentation

Voices

Teams

Call templates

Phone Calls

Transcripts

Webhooks

​List of possible status and statusExtraInfo values

Authorizations

Query Parameters

Response

List of possible `status` and `statusExtraInfo` values