Publicar, marcar como obsoleto y eliminar Flows
Last update: 4 days ago by Irais Aguirre
Publica, descontinúa y elimina WhatsApp Flows.
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:
POST /v1/flows/{{waba_id}}/{{flow_id}}/publish: Publicar un FlowPOST /v1/flows/{{waba_id}}/{{flow_id}}/deprecate: Flow obsoletoDELETE /v1/flows/{{waba_id}}/{{flow_id}}: Eliminar un Flow
Publicar un Flow
Petición
Petición de Publicar un Flow:
| URL | https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/publish |
| Método | POST |
Encabezados
Encabezados de Publicar 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 Publicar 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 Publicar un Flow:
curl --location --request POST 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/publish' \--header 'Authorization: Bearer {{admin-token}}'
Respuesta
Respuesta de Publicar un Flow:
| Nombre | Descripción | Tipo |
|---|---|---|
| success | En caso de publicarse el Flow correctamente se retorna true, en caso contrario se retorna false. | Boolean |
{"success": true}
Flow obsoleto
Petición
Petición de Flow obsoleto:
| URL | https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/deprecate |
| Método | POST |
Encabezados
Encabezados de Flow obsoleto:
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| Authorization | Token de administración. Consulta Generar Token de Autenticación. | String | Obligatorio |
Parámetros
Parámetros de Flow obsoleto:
| 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 Flow obsoleto:
curl --location --request POST 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}/deprecate' \--header 'Authorization: Bearer {{admin-token}}'
Respuesta
Respuesta de Flow obsoleto:
| Nombre | Descripción | Tipo |
|---|---|---|
| success | En caso de marcarse el Flow como obsoleto correctamente se retorna true, en caso contrario se retorna false. | Boolean |
{"success": true}
Eliminar un Flow
Petición
Petición de Eliminar un Flow:
| URL | https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}} |
| Método | DELETE |
Encabezados
Encabezados de Eliminar 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 Eliminar 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 Eliminar un Flow:
curl --location --request DELETE 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/flows/{{waba_id}}/{{flow_id}}' \--header 'Authorization: Bearer {{admin-token}}'
Respuesta
Respuesta de Eliminar un Flow:
| Nombre | Descripción | Tipo |
|---|---|---|
| success | En caso de eliminar el Flow correctamente retorna true, en caso contrario retorna false. | Boolean |
{"success": true}