Saltar al contenido principal
GET
/
campaigns
/
{id}
/
contacts
cURL
curl --request GET \
  --url https://api.altur.io/api/v1.0/campaigns/{id}/contacts \
  --header 'Authorization: <api-key>'
{
  "total_count": 123,
  "contacts": [
    {
      "f_id": "<string>",
      "id": 123,
      "name": "<string>",
      "contact": "<string>",
      "status": "<string>",
      "context": "<string>",
      "retries": 123,
      "has_follow_up": true,
      "call_count": 123,
      "billed_duration": 270,
      "last_call_at": "2025-10-03 19:11:39",
      "extracted_data": {
        "monto_prometido": "1000",
        "fecha_limite": "01-01-2025"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ],
  "pagination": {
    "has_next": true,
    "has_previous": true,
    "next_page": 123,
    "previous_page": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.altur.io/llms.txt

Use this file to discover all available pages before exploring further.

Límite de Tasa: 12 solicitudes por segundo

​
Valores de Estado por Tipo de Campaña

  • queue — Contacto esperando en cola
  • sending — Llamada siendo iniciada
  • failed — Llamada falló al conectar
  • retrying — Programado para reintento
  • converted — Contacto fue convertido
  • voicemail — Llegó a buzón de voz
  • answered — Llamada fue contestada

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de ruta

​
id
integer
requerido

The identifier of the Campaign to return the Contacts

Parámetros de consulta

​
status
enum<string>

Filters the Campaign Contacts by the Status of the Campaign Contact

Opciones disponibles:
queue,
sending,
sent,
delivered,
voicemail,
read,
failed,
retrying,
converted,
answered,
accepted,
rejected
​
pageSize
integer
predeterminado:50

Number of items per page to return.

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

Page number to the next page to return.

Rango requerido: 0 <= x <= 25000

Respuesta

Campaign Contacts response

​
total_count
integer

Total number of Campaign Contacts for the given query. NOTE: Only calculated in the first page.

​
contacts
object[]
​
pagination
object

Filters are applied to each request independently. Changing filters while paginating may result in gaps or overlaps in the result set. For consistent results, maintain the same filters throughout pagination.