logo

Conexión HTTP

Last update: 3 days ago by Jimena Acevedo - JC

Los endpoints de Flows permiten crear, actualizar, publicar, marcar como obsoletos, eliminar y consultar los Flows de una cuenta de WhatsApp Business (WABA), así como configurar el cifrado de los Flows.

Crear Flow

Petición crear Flow

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}
MétodoPOST
Tipoapplication/json

Encabezados crear Flow

NombreDescripciónTipoRequerimientos
Content-Typeapplication/jsonStringObligatorio
AuthorizationToken de autenticación devuelto por el servicio token.StringObligatorio

Parámetros crear Flow

NombreDescripciónTipoRequerimientos
waba_idID de la cuenta de WhatsApp Business.StringObligatorio

Cuerpo crear Flow

NombreDescripciónTipoRequerimientos
nameNombre del Flow.StringObligatorio
categoriesLista de categorías para un Flow, es posible asignar varios valores, pero se requiere al menos uno:
  • SIGN_UP
  • SIGN_IN
  • APPOINTMENT_BOOKING
  • LEAD_GENERATION
  • CONTACT_US
  • CUSTOMER_SUPPORT
  • SURVEY
  • OTHER
ArrayObligatorio
clone_flow_idID del Flow de origen a clonar. Debe tener permiso para acceder al Flow especificado.StringOpcional
endpoint_uriURL del WA Flow Endpoint.StringOpcional

Subir Flow JSON

Petición subir Flow JSON

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/assets
MétodoPOST
Tipomultipart/form-data

Encabezados subir Flow JSON

NombreDescripciónTipoRequerimientos
AuthorizationToken de autenticación devuelto por el servicio token.StringObligatorio

Parámetros subir Flow JSON

NombreDescripciónTipoRequerimientos
waba_idID de la cuenta de WhatsApp Business.StringObligatorio
flow_idID de un Flow devuelto después de llamar a Crear Flow.StringObligatorio

Cuerpo subir Flow JSON

NombreDescripciónTipoRequerimientos
fileArchivo con el contenido del Flow JSON.
Documentación de los componentes permitidos por Meta para la construcción del JSON: Flow JSON.
Se recomienda usar la versión 7.0 en adelante.		StringObligatorio.
El tamaño está limitado a 10 MB.

Actualizar Metadata

Petición actualizar Metadata

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}
MétodoPUT
Tipoapplication/json

Encabezados actualizar Metadata

NombreDescripciónTipoRequerimientos
Content-Typeapplication/jsonStringObligatorio
AuthorizationToken de autenticación devuelto por el servicio token.StringObligatorio

Parámetros actualizar Metadata

NombreDescripciónTipoRequerimientos
waba_idID de la cuenta de WhatsApp Business.StringObligatorio
flow_idID de un Flow devuelto después de llamar a Crear Flow.StringObligatorio

Cuerpo actualizar Metadata

NombreDescripciónTipoRequerimientos
nameNombre del Flow.StringOpcional
categoriesLista de categorías para un Flow, es posible asignar varios valores, pero se requiere al menos uno:
  • SIGN_UP
  • SIGN_IN
  • APPOINTMENT_BOOKING
  • LEAD_GENERATION
  • CONTACT_US
  • CUSTOMER_SUPPORT
  • SURVEY
  • OTHER
ArrayOpcional
endpoint_uriURL del WA Flow Endpoint.StringOpcional

Listar todos los Flows por WABA

Petición listar Flows

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}
MétodoGET

Encabezados listar Flows

NombreDescripciónTipoRequerimientos
AuthorizationToken de autenticación devuelto por el servicio token.StringObligatorio

Parámetros listar Flows

NombreDescripciónTipoRequerimientos
waba_idID de la cuenta de WhatsApp Business.StringObligatorio

Obtener información de un Flow

Petición obtener información

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/details
MétodoGET

Encabezados obtener información

NombreDescripciónTipoRequerimientos
AuthorizationToken de autenticación devuelto por el servicio token.StringObligatorio

Parámetros obtener información

NombreDescripciónTipoRequerimientos
waba_idID de la cuenta de WhatsApp Business.StringObligatorio
flow_idID de un Flow devuelto después de llamar a Crear Flow.StringObligatorio

Eliminar un Flow

Petición eliminar Flow

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}
MétodoDELETE

Encabezados eliminar Flow

NombreDescripciónTipoRequerimientos
AuthorizationToken de autenticación devuelto por el servicio token.StringObligatorio

Parámetros eliminar Flow

NombreDescripciónTipoRequerimientos
waba_idID de la cuenta de WhatsApp Business.StringObligatorio
flow_idID de un Flow devuelto después de llamar a Crear Flow.StringObligatorio

Publicar un Flow

Petición publicar Flow

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/publish
MétodoPOST

Encabezados publicar Flow

NombreDescripciónTipoRequerimientos
AuthorizationToken de autenticación devuelto por el servicio token.StringObligatorio

Parámetros publicar Flow

NombreDescripciónTipoRequerimientos
waba_idID de la cuenta de WhatsApp Business.StringObligatorio
flow_idID de un Flow devuelto después de llamar a Crear Flow.StringObligatorio

Flow obsoleto

Petición Flow obsoleto

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/deprecate
MétodoPOST

Encabezados Flow obsoleto

NombreDescripciónTipoRequerimientos
AuthorizationToken de autenticación devuelto por el servicio token.StringObligatorio

Parámetros Flow obsoleto

NombreDescripciónTipoRequerimientos
waba_idID de la cuenta de WhatsApp Business.StringObligatorio
flow_idID de un Flow devuelto después de llamar a Crear Flow.StringObligatorio

Cifrado de Flows

Petición cifrado de Flows

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{phone_number}}/encryption
MétodoPOST
Tipoapplication/x-www-form-urlencoded

Encabezados cifrado de Flows

NombreDescripciónTipoRequerimientos
Content-Typeapplication/x-www-form-urlencodedStringObligatorio
AuthorizationToken de autenticación devuelto por el servicio token.StringObligatorio

Parámetros cifrado de Flows

NombreDescripciónTipoRequerimientos
waba_idID de la cuenta de WhatsApp Business.StringObligatorio
phone_numberNúmero de teléfono vinculado a una WABA.StringObligatorio

Cuerpo cifrado de Flows

NombreDescripciónTipoRequerimientos
business_public_keyLlave pública RSA de 2048 bits generada.StringObligatorio
Whatsapp — Anterior
Flows
Siguiente — Whatsapp
Ejemplos