Listar campañas

Este contenido describe cómo listar campañas utilizando una API.

La API de Beepcall permite gestionar campañas de contacto, incluyendo la creación de leads y el listado de campañas asociadas a tu cuenta. Esta guía explica cómo crear un lead, listar campañas, y cómo probar estas funcionalidades.

URL base del servidor

https://app.beepcall.ai/api (Servidor principal de la API de Beepcall)

Autenticación Todas las solicitudes a la API de Beepcall requieren autenticación mediante una clave API. Sigue estos pasos para obtener y usar tu clave API:

Obtener tu clave API:
- Inicia sesión en tu cuenta de Beepcall en https://app.beepcall.ai.
- Ve a la sección "Claves API" en tu panel de usuario.
- Haz clic en "Crear nueva clave API".
- Copia la clave generada y guárdala en un lugar seguro. Nota de seguridad: Mantén tu clave API confidencial. No la compartas públicamente ni la subas a sistemas de control de versiones como GitHub.
Usar tu clave API:
- Incluye tu clave API en el encabezado de cada solicitud:

Authorization: Bearer TU_CLAVE_API

Reemplaza TU_CLAVE_API con la clave que generaste.

1. Crear un nuevo lead Este endpoint te permite registrar un nuevo lead en una campaña específica de Beepcall.

Método: POST
URL: https://app.beepcall.ai/api/user/lead
Descripción: Crea un lead proporcionando un número de teléfono y el ID de la campaña. Puedes incluir datos adicionales y configurar si se permiten duplicados.
Cuerpo de la solicitud (JSON):
- phone_number (requerido, texto): Número de teléfono en formato E.164 (por ejemplo, "+1234567890").
- campaign_id (requerido, número): ID de la campaña donde se registrará el lead (por ejemplo, 1).
- variables (opcional, lista de objetos): Información adicional del lead.
  - customer_name (texto): Nombre del cliente (por ejemplo, "John Doe").
  - email (texto): Correo electrónico del cliente (por ejemplo, "john.doe@example.com").
- allow_duplicate (opcional, booleano): Indica si se permiten leads duplicados en la campaña (por ejemplo, false).
- Ejemplo del cuerpo:

{
  "phone_number": "+1234567890",
  "campaign_id": 1,
  "variables": [
    { "customer_name": "John Doe", "email": "john.doe@example.com" }
  ],
  "allow_duplicate": false
}

Encabezados requeridos:

{
  "message": "Lead created successfully",
  "data": { "id": "1234569" }
}

Respuestas posibles:

200 (Éxito): Lead creado correctamente. Respuesta:

{
  "message": "Lead created successfully",
  "data": { "id": "1234569" }
}

400 (Solicitud inválida): Faltan campos requeridos o el formato es incorrecto.
401 (No autorizado): Clave API inválida o no proporcionada.
404 (No encontrado): La campaña especificada no existe.
500 (Error del servidor): Problema interno en el servidor de Beepcall.

2. Listar campañas Este endpoint te permite obtener una lista de todas las campañas asociadas a tu cuenta.

Método: GET
URL: https://app.beepcall.ai/api/user/campaigns
Descripción: Devuelve una lista de campañas con detalles como su ID, nombre, estado y fecha de creación.
Encabezados requeridos:

Authorization: Bearer TU_CLAVE_API

Respuestas posibles:

200 (Éxito): Lista de campañas devuelta correctamente. Respuesta:

[
  {
    "id": 1,
    "name": "Campaña de prueba",
    "status": "active",
    "created_at": "2023-01-01T12:00:00Z"
  }
]

401 (No autorizado): Clave API inválida o no proporcionada.
500 (Error del servidor): Problema interno en el servidor de Beepcall.

Probar los endpoints con ReqBin Puedes usar la herramienta online ReqBin (https://reqbin.com) para probar los endpoints de la API de Beepcall. Sigue estos pasos para cada endpoint:

Probar la creación de un lead:

Abre https://reqbin.com en tu navegador.
En el campo de URL, escribe:

https://app.beepcall.ai/api/user/lead

Selecciona el método POST.
En la pestaña "Headers", agrega
Reemplaza TU_CLAVE_API con tu clave API real.
En la pestaña "Body", selecciona "JSON" y escribe:

{
  "phone_number": "+1234567890",
  "campaign_id": 1,
  "variables": [
    { "customer_name": "John Doe", "email": "john.doe@example.com" }
  ],
  "allow_duplicate": false
}

Si ves un error (como 401), revisa tu clave API.

Notas adicionales

Asegúrate de que el número de teléfono esté en formato E.164 (por ejemplo, "+1234567890").
Verifica que la campaña (campaign_id) exista en tu cuenta antes de crear un lead. Puedes usar el endpoint de listar campañas para obtener los IDs válidos.
Si encuentras errores como 401, revisa que tu clave API sea válida y esté correctamente incluida en el encabezado.

PreviousCrear Lead

Last updated 4 months ago