Consultar Flows

Last update: 4 days ago by Irais Aguirre

Lista los Flows de una WABA y obtén la información de un Flow específico.

Resumen para integración
URL base: https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services
Token: de administración, en el encabezado Authorization: Bearer {{admin-token}} (cómo generarlo)
Endpoints en esta página:
GET /v1/flows/{{waba_id}}: Listar todos los Flows por WABA
GET /v1/flows/{{waba_id}}/{{flow_id}}/details: Obtener información de un Flow

Listar todos los Flows por WABA

Petición

Petición de Listar todos los Flows por WABA:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}
Método	GET

Encabezados

Encabezados de Listar todos los Flows por WABA:

Nombre	Descripción	Tipo	Requerimientos
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Listar todos los Flows por WABA:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio

Ejemplo

Ejemplo completo de Listar todos los Flows por WABA:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Listar todos los Flows por WABA:

Nombre	Descripción	Tipo
data	Listado de Flows por WABA.	Lista objetos
paging	Información de paginación. Presente cuando Meta devuelve más Flows que el tamaño de página predeterminado.	Objeto

{
    "data": [
        {
            "id": "flow-1",
            "name": "flow 1",
            "status": "DRAFT",
            "categories": [ "CONTACT_US" ],
            "validation_errors": []
        },
        {
            "id": "flow-2",
            "name": "flow 2",
            "status": "PUBLISHED",
            "categories": [ "SURVEY" ],
            "validation_errors": []
        }
    ],
    "paging": {
        "cursors": {
            "before": "QVFIU…before",
            "after":  "QVFIU…after"
        },
        "next":     "https://graph.facebook.com/v22.0/{{waba_id}}/flows?after=QVFIU…after",
        "previous": "https://graph.facebook.com/v22.0/{{waba_id}}/flows?before=QVFIU…before"
    }
}

Objeto data

Nombre	Descripción	Tipo
id	ID del Flow.	String
name	Nombre del Flow.	String
status	Estatus del Flow.	String
categories	Categorías del Flow.	Array
validation_errors	Errores del Flow.	Lista objetos
errorCode	Código de error devuelto por Meta para esta fila específica. Solo está presente cuando falló la obtención de los datos de este Flow; el resto del listado se devuelve con normalidad. La clave en el wire es camelCase (`errorCode`).	Integer
errorMessage	Descripción legible del error asociada a `errorCode`. Solo está presente cuando falló la obtención de los datos de este Flow. La clave en el wire es camelCase (`errorMessage`).	String

Objeto paging

Refleja la paginación basada en cursores de la Graph API de Meta. Todos los campos son opcionales y solo se incluyen cuando están presentes en la respuesta de Meta (@JsonInclude(NON_NULL)).

Nombre	Descripción	Tipo
cursors.before	Cursor opaco que apunta al primer elemento de la página actual.	String
cursors.after	Cursor opaco que apunta al último elemento de la página actual.	String
next	URL completa que puedes llamar para obtener la siguiente página. Ausente cuando no hay más páginas.	String
previous	URL completa que puedes llamar para obtener la página anterior. Ausente cuando estás en la primera página.	String

Obtener información de un Flow

Petición

Petición de Obtener información de un Flow:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/details
Método	GET

Encabezados

Encabezados de Obtener información de un Flow:

Nombre	Descripción	Tipo	Requerimientos
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Obtener información de un Flow:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
flow_id	ID de un Flow devuelto después de llamar a Crear Flow.	String	Obligatorio

Ejemplo

Ejemplo completo de Obtener información de un Flow:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/details' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Obtener información de un Flow:

Nombre	Descripción	Tipo
id	ID del Flow.	String
name	Nombre del Flow.	String
status	Estatus del Flow (DRAFT, PUBLISHED, DEPRECATED, BLOCKED, THROTTLED).	String
categories	Categorías del Flow.	Array
validation_errors	Errores del Flow.	Lista objetos
endpoint_uri	La URL del WA Flow Endpoint.	String

{
    "id": "<Flow-ID>",
    "name": "<Flow-Name>",
    "status": "DRAFT",
    "categories": [ "LEAD_GENERATION" ],
    "validation_errors": [],
    "endpoint_uri": "https://example.com"
}

Crear y actualizar Flows

Publicar, marcar como obsoleto y eliminar Flows