GET
/
v1
/
phoneCalls
curl --request GET \
  --url https://api.aicaller.io/v1/phoneCalls \
  --header 'aicaller-api-key: <api-key>'
{
  "data": [
    {
      "teamId": "363573667364666473667332",
      "phoneNumberId": "363573667364666473667332",
      "callTemplateId": "363573667364666473667332",
      "nameOfHuman": "John",
      "fromPhoneNumber": "+1234567890",
      "toPhoneNumber": "+1234567890",
      "toEmailAddress": "[email protected]",
      "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"
        }
      ],
      "statusExtraInfo": {
        "statusCode": "CALL_LATER",
        "dateTime": "2024-03-11T10:00:00Z"
      },
      "fixedMeetingTime": "2024-03-11T10:00:00Z",
      "recordingUrl": "https://example.com/recording.mp3",
      "callDuration": 60,
      "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",
      "callOrigin": "api",
      "customTagsHitOnCall": [
        "<string>"
      ],
      "createdAt": "2023-10-12T09:08:00.387Z",
      "updatedAt": "2023-10-12T09:08:00.387Z"
    }
  ]
}

​
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

​
teamId
any
required

Unique ID of the Team

​
callTemplateId
string

Unique ID of the CallTemplate

​
phoneNumberId
string

Unique ID of the PhoneNumber you own

​
fromDate
string

Get phoneCalls created after this date

​
toDate
string

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

​
offset
any

Skipping webhooks till the provided offset value

​
limit
any

Limiting number of values per page

​
orderBy
any

Sorting order of the phone calls. use "-" for descending order. eg. for ascending order use orderBy=createdAt, for descending order use orderBy=-createdAt

​
statusExtraInfo
any

Extra infor tag about the status of

​
customTagsHitOnCall
any

Custom tags that hit on call

Response

200
application/json

Phone calls found.

The response is of type object.

GET
/
v1
/
phoneCalls
curl --request GET \
  --url https://api.aicaller.io/v1/phoneCalls \
  --header 'aicaller-api-key: <api-key>'
{
  "data": [
    {
      "teamId": "363573667364666473667332",
      "phoneNumberId": "363573667364666473667332",
      "callTemplateId": "363573667364666473667332",
      "nameOfHuman": "John",
      "fromPhoneNumber": "+1234567890",
      "toPhoneNumber": "+1234567890",
      "toEmailAddress": "[email protected]",
      "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"
        }
      ],
      "statusExtraInfo": {
        "statusCode": "CALL_LATER",
        "dateTime": "2024-03-11T10:00:00Z"
      },
      "fixedMeetingTime": "2024-03-11T10:00:00Z",
      "recordingUrl": "https://example.com/recording.mp3",
      "callDuration": 60,
      "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",
      "callOrigin": "api",
      "customTagsHitOnCall": [
        "<string>"
      ],
      "createdAt": "2023-10-12T09:08:00.387Z",
      "updatedAt": "2023-10-12T09:08:00.387Z"
    }
  ]
}

​
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

​
teamId
any
required

Unique ID of the Team

​
callTemplateId
string

Unique ID of the CallTemplate

​
phoneNumberId
string

Unique ID of the PhoneNumber you own

​
fromDate
string

Get phoneCalls created after this date

​
toDate
string

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

​
offset
any

Skipping webhooks till the provided offset value

​
limit
any

Limiting number of values per page

​
orderBy
any

Sorting order of the phone calls. use "-" for descending order. eg. for ascending order use orderBy=createdAt, for descending order use orderBy=-createdAt

​
statusExtraInfo
any

Extra infor tag about the status of

​
customTagsHitOnCall
any

Custom tags that hit on call

Response

200
application/json

Phone calls found.

The response is of type object.