Respuestas

Last update: 3 days ago by Jimena Acevedo - JC

Crear Flow

Nombre	Descripción	Tipo
id	ID del Flow.	String

{
    "id": "flow-1"
}

Subir Flow JSON

Nombre	Descripción	Tipo
success	Si el Flow JSON no se pudo subir correctamente retorna `false`, en caso contrario retorna `true`.	Boolean
validation_errors	Objeto que describe los errores del Flow JSON en caso de encontrar alguno, si no encuentra errores se retorna un array vacío.	Lista objetos

{
    "success": true,
    "validation_errors": [
        {
            "error": "INVALID_PROPERTY",
            "error_type": "JSON_SCHEMA_ERROR",
            "message": "The property \"initial-text\" cannot be specified at \"$root/screens/0/layout/children/2/children/0\".",
            "line_start": 46,
            "line_end": 46,
            "column_start": 17,
            "column_end": 30
        }
    ]
}

Objeto validation errors

Nombre	Descripción	Tipo
error	Nombre del error.	String
error_type	Tipo de error.	String
message	Descripción del error.	String
line_start	Línea en la que empieza el error.	Integer
line_end	Línea en la que termina el error.	Integer
column_start	Columna en la que empieza el error.	Integer
column_end	Columna en la que termina el error.	Integer

Para más información acerca de los posibles errores que aparezcan al momento de subir un archivo con el Flow JSON y cómo solucionarlos, consulta la documentación de Meta: Static validation errors.

Actualizar Metadata

Nombre	Descripción	Tipo
success	En caso de actualizar correctamente alguna propiedad, retorna `true`, en caso contrario retorna `false`.	Boolean

{
    "success": true
}

Listar todos los Flows por WABA

Nombre	Descripción	Tipo
data	Listado de Flows por WABA.	Lista objetos

{
    "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": []
        }
    ]
}

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

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, PUBLISH).	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"
}

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
}

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

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
}

Cifrado de Flows

Nombre	Descripción	Tipo
success	En caso de subirse la llave pública correctamente se retorna `true`, en caso contrario se retorna `false`.	Boolean

{
    "success": true
}