Saltar al contenido principal
GET
/
campaigns
/
{id}
/
calls
cURL
curl --request GET \
  --url https://api.altur.io/api/v1.0/campaigns/{id}/calls \
  --header 'Authorization: <api-key>'
{
  "total_count": 123,
  "calls": [
    {
      "id": "<string>",
      "type": "inbound",
      "status": "ended",
      "answered_by": "human",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration": 123,
      "billed_duration": 123,
      "contact": {
        "id": 123,
        "f_id": "<string>",
        "name": "<string>",
        "phone_number": "<string>",
        "status": "<string>"
      },
      "extracted_data": {
        "interested": "yes",
        "appointment_date": "2024-01-20"
      },
      "tags": [
        "interested",
        "callback"
      ],
      "recording_url": "/api/v1.0/call/call_abc123def456/recording"
    }
  ],
  "pagination": {
    "page_index": 123,
    "page_size": 123,
    "has_next": true,
    "has_previous": true,
    "next_page": 123,
    "previous_page": 123
  }
}
Límite de Tasa: 12 solicitudes por segundo

Authorizations

​
Authorization
string
header
required

Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.

Path Parameters

​
id
integer
required

The identifier of the Campaign to return the Calls

Query Parameters

​
status
enum<string>

Filters the Campaign Calls by the status of the Call

Opciones disponibles:
ended,
failed,
busy,
no-answer,
in-progress
​
answeredBy
enum<string>

Filters the Campaign Calls by who answered the call

Opciones disponibles:
human,
machine,
unknown
​
startDate
string<ISO 8601>

Filter calls created after this date in ISO 8601 format

​
endDate
string<ISO 8601>

Filter calls created before this date in ISO 8601 format

​
pageSize
integer
default:50

Number of items per page to return.

Rango requerido: 1 <= x <= 100
​
pageIndex
integer
default:0

Page number to return (0-based).

Rango requerido: 0 <= x <= 25000

Response

Campaign Calls response

​
total_count
integer

Total number of Campaign Calls for the given query.

​
calls
object[]
​
pagination
object

Pagination information for campaign calls