API de llamadas de devolución de llamada

Las llamadas de devolución de llamada son llamadas que solicita un usuario final. Con la API de llamadas de devolución de llamada, puedes programar llamadas de devolución de llamada y cancelar llamadas programadas de manera programática. Con estas capacidades, puedes crear aplicaciones que permitan a los usuarios finales solicitar llamadas de devolución de llamada desde una cola que especifiques. Los usuarios finales también pueden cancelar las llamadas que programaron anteriormente. Para obtener información sobre la autenticación con la API de llamadas de devolución de llamada, consulta Autenticación básica.

Usa la API de llamadas de devolución de llamada

Puedes usar la API de llamadas de devolución de llamada para programar llamadas de devolución de llamada y cancelar llamadas programadas.

Programar una llamada

Para programar una llamada, llama a POST https://<subdomain>.<domain>/apps/api/v1/calls e incluye un cuerpo de solicitud similar al siguiente:

{
    "call_type": "ScheduledCall",
    "menu_id": 12345,
    "end_user_number": "+18005550100",
    "scheduled_at": "2025-09-02T14:30:00Z"
}

Una solicitud correcta muestra un objeto de llamada, incluido el ID de llamada.

Cancelar una llamada programada

Para cancelar una llamada programada, llama a PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/{id}/cancel. Especifica el ID de la llamada que deseas cancelar.

Una solicitud correcta muestra información sobre la llamada cancelada.

Cancelar varias llamadas programadas

Para cancelar varias llamadas programadas, llama a PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel. Incluye un cuerpo de solicitud que contenga un array call_ids de los IDs de llamada de las llamadas que se cancelarán.

Consulta la siguiente muestra de código:

{
    "call_ids": [123, 456, 789]
}

Una solicitud correcta muestra una respuesta con un encabezado de respuesta que contiene una URL Location para verificar el estado de la cancelación.

Usa llamadas de devolución de llamada con CRMs

Puedes usar la API de llamadas de devolución de llamada con las integraciones de CRM de Salesforce, Zendesk y ServiceNow.

Comportamiento general de la devolución de llamada

Si usas algún CRM compatible (Salesforce, Zendesk o ServiceNow), las siguientes condiciones afectan el comportamiento de la devolución de llamada programada:

  • Un registro está abierto y ya tiene una llamada programada activa: Si una búsqueda de ID de ticket indica que el registro está abierto y ya tiene una llamada programada activa, la llamada no se programa. El siguiente comentario se adjunta al registro de CRM: A scheduled call was not created because the record already has an active scheduled call.

  • No se puede acceder al CRM: Si una búsqueda de ID de ticket indica que el CRM no se puede acceder, se cancela la llamada. El siguiente comentario se adjunta al registro de CRM: A scheduled call was canceled because the CRM was unreachable.

Comportamiento de la devolución de llamada con registros cerrados

La forma en que se controlan las llamadas de devolución de llamada para los registros cerrados varía según el CRM que uses:

  • Usuarios de Zendesk y ServiceNow: Si una búsqueda de ID de ticket indica que el registro está cerrado, la llamada no se programa. El siguiente comentario se adjunta al registro de CRM: A scheduled call was not created because the record is closed.

  • Usuarios de Salesforce: Consulta Llamadas de devolución de llamada con Salesforce para configurar la forma en que tu instancia controla las llamadas programadas para registros cerrados.

Llamadas de devolución de llamada con Salesforce

Si integraste la plataforma de CCAI con Salesforce, puedes configurar la forma en que tu instancia controla las llamadas programadas para registros cerrados. Estas son las opciones de configuración para las integraciones de Salesforce:

No verifiques el estado del registro

Puedes configurar la plataforma de CCAI para que no verifique el estado del registro antes de realizar una llamada programada. Con esta configuración, la llamada se realiza según lo programado, independientemente de si el registro está abierto o cerrado.

Para configurar la plataforma de CCAI para que no verifique el estado del registro, sigue estos pasos:

  1. En el portal de la plataforma de CCAI, haz clic en Configuración > Administración de operaciones. Si no ves el menú Configuración, haz clic en Menú.

  2. Ve a Detalles de creación de registros de CRM > Opciones de registros cerrados cuando se inicia una llamada programada por la API.

  3. Selecciona No verifiques el estado del registro. Siempre inicia la llamada programada por la API.

  4. Haz clic en Guardar general.

Verifica el estado del registro y vuelve a abrir los registros cerrados

Puedes configurar la plataforma de CCAI para que verifique el estado del registro antes de realizar una llamada programada y vuelva a abrir los registros cerrados. Con esta configuración, si el estado del registro es cerrado, se realizan las siguientes acciones:

  • La llamada se realiza según lo programado.

  • Se vuelve a abrir el registro.

  • El siguiente comentario se adjunta al registro de CRM: The record was reopened at the time of a scheduled call.

Para configurar la plataforma de CCAI para que verifique el estado del registro y vuelva a abrir los registros cerrados, sigue estos pasos:

  1. En el portal de la plataforma de CCAI, haz clic en Configuración > Administración de operaciones. Si no ves el menú Configuración, haz clic en Menú.

  2. Ve a Detalles de creación de registros de CRM > Opciones de registros cerrados cuando se inicia una llamada programada por la API.

  3. Selecciona Verifica el estado del registro. Si el registro está cerrado > Vuelve a abrir el registro.

  4. Haz clic en Guardar general.

Verifica el estado del registro y cancela las llamadas programadas para registros cerrados

Puedes configurar la plataforma de CCAI para que verifique el estado del registro antes de realizar una llamada programada y cancele las llamadas programadas para registros cerrados. Con esta configuración, si el estado del registro es cerrado, se realizan las siguientes acciones:

  • Se cancela la llamada programada.

  • El siguiente comentario se adjunta al registro de CRM: A scheduled call was canceled because the record is closed.

Para configurar la plataforma de CCAI para que verifique el estado del registro y cancele las llamadas programadas para registros cerrados, sigue estos pasos:

  1. En el portal de la plataforma de CCAI, haz clic en Configuración > Administración de operaciones. Si no ves el menú Configuración, haz clic en Menú.

  2. Ve a Detalles de creación de registros de CRM > Opciones de registros cerrados cuando se inicia una llamada programada por la API.

  3. Selecciona Verifica el estado del registro. Si el registro está cerrado > Cancela la llamada programada.

  4. Haz clic en Guardar general.