Crear Lead

El endpoint "Crear cliente potencial" permite registrar un nuevo cliente en una campaña específica dentro de tu sistema.

Introducción La API de Beepcall permite crear leads en el sistema para gestionar campañas de contacto. Esta guía explica cómo crear un lead y cómo probar la funcionalidad de realizar llamadas, incluyendo los pasos para autenticar solicitudes.

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:

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

2. Usar tu clave API:

   • Incluye tu clave API en el encabezado de cada solicitud:

   • Reemplaza TU_CLAVE_API con la clave que generaste.

Text

Authorization: Bearer TU_CLAVE_API

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, "[phone]").

  • 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, "[e-mail]").

  • allow_duplicate (opcional, booleano): Indica si se permiten leads duplicados en la campaña (por ejemplo, false).

  • Ejemplo del cuerpo:

JSON

{
"phone_number": "[phone]",
"campaign_id": 1,
"variables": [
{ "customer_name": "John Doe", "email": "[e-mail]" }
],
"allow_duplicate": false
}

Encabezados requeridos:

Text

Authorization: Bearer TU_CLAVE_API
Content-Type: application/json

Respuestas posibles:

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

JSON

{
  "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.

Ejemplo de solicitud para crear un lead Puedes usar una herramienta como Postman o ReqBin para enviar la solicitud. Configura lo siguiente:

• Método: POST

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

• Encabezados:

Text

Authorization: Bearer TU_CLAVE_API
Content-Type: application/json

• Cuerpo (JSON):

JSON

{
  "phone_number": "[phone]",
  "campaign_id": 1,
  "variables": [
    { "customer_name": "John Doe", "email": "[e-mail]" }
  ],
  "allow_duplicate": false
}

Envía la solicitud y revisa la respuesta para confirmar que el lead se creó.

Probar la realización de llamadas Para probar si puedes realizar llamadas usando la API, utiliza el siguiente endpoint:

• Método: GET

• URL: https://app.beepcall.ai/api/user/campaigns

• Descripción: Este endpoint devuelve información sobre las campañas asociadas a tu cuenta. Si responde correctamente, confirma que la API está activa y puedes usarla para funciones relacionadas con campañas, como iniciar llamadas.

• Encabezados requeridos:

Text

Authorization: Bearer TU_CLAVE_API

• Respuesta esperada (200 OK): Un JSON con datos de las campañas, por ejemplo:

JSON

{
  "allowed_hours_endtime": "13:45:00",
  "other_campaign_data": "..."
}

• Si recibes un código 200 y una respuesta en JSON, la API está operativa para realizar operaciones como iniciar llamadas (según las campañas configuradas).

Notas adicionales

• Asegúrate de que el número de teléfono esté en formato E.164 (por ejemplo, "[phone]").

• Verifica que la campaña (campaign_id) exista en tu cuenta antes de crear un lead.

• Si encuentras errores como 401, revisa que tu clave API sea válida y esté correctamente incluida en el encabezado.