API entrante

El activador API entrante es una potente acción de SmartFlows. Este activador puede:

  • Desencadenar un flujo desde cualquier evento que pueda enviar una solicitud POST a través de una API REST.
  • Usar parámetros en la solicitud como variables para personalizar el contenido o la lógica. Un flujo con una API entrante le permite desencadenar un flujo enviando una solicitud POST.

Un flujo con una API de entrada le permite desencadenar un flujo enviando una solicitud POST.

  1. Para activar un SmartFlow a través de la API REST, realice una solicitud HTTP POST a: https://smart-flows.intelepeer.com/v2/api/apitriggers
Parámetros
Parámetro Tipo de datos ¿Requerido? Descripción
flowId string required

Un identificador único para un SmartFlow que se encuentra en la sección de metadatos de flujo de SmartFlows.

Seleccione el título del flujo para el Id. de flujo.

ANI string required Un número de formato e164 utilizado como número de destino en las comunicaciones salientes en su flujo.
DNIS string required Un número de formato e164 que se usa como número de origen (por ejemplo, identificador de llamadas) en las comunicaciones salientes en su flujo.
other string   Un número de formato e164 que se usa como número de origen (por ejemplo, identificador de llamadas) en las comunicaciones salientes en su flujo.

Se pueden transferir otros parámetros a la solicitud utilizando un formato «$<>». Cuando se hace referencia al parámetro en el flujo (es decir, $accountBalance), se sustituirá por el valor que se envió en la solicitud.

Ejemplo de parámetros utilizados en un flujo
Códigos de respuesta

Las API en SmartFlows siguen el formato de código de respuesta estándar.

Códigos de respuesta Descripción
202 Accepted
400 Bad request
401 Unauthorized
403 Forbidden (or unauthorized)
404 Not Found