Bloquear y desbloquear usuarios

Last update: 4 days ago by Irais Aguirre

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/block_users/{{waba_id}}/{{phone_number_id}}: Bloquear usuarios
PUT /v1/block_users/{{waba_id}}/{{phone_number_id}}: Desbloquear usuarios

Bloquea y desbloquea usuarios de WhatsApp para un número de teléfono de tu WABA. Puedes identificar a cada usuario por su número de teléfono o su BSUID.

Bloquear usuarios

Petición

Petición de Bloquear usuarios:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/block_users/{{waba_id}}/{{phone_number_id}}
Método	POST
Tipo	application/json

Encabezados

Encabezados de Bloquear usuarios:

Nombre	Descripción	Tipo	Requerimientos
Content-Type	application/json	String	Obligatorio
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Bloquear usuarios:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
phone_number_id	ID del número de teléfono desde el que se bloquea al usuario.	String	Obligatorio

Cuerpo

Campos del cuerpo de Bloquear usuarios:

Nombre	Descripción	Tipo	Requerimientos
block_users	Lista de usuarios a bloquear.	Lista de objetos user	Obligatorio

Objeto user

Nombre	Descripción	Tipo	Requerimientos
user	Número de teléfono del usuario o su Business-scoped user ID (BSUID).	String	Obligatorio. No puede estar vacío.

Ejemplo

Ejemplo completo de Bloquear usuarios:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/block_users/{{waba_id}}/{{phone_number_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin-token}}' \
--data '{
    "block_users": [
        {
            "user": "521550123456"
        },
        {
            "user": "US.13491208655302741918"
        }
    ]
}'

Respuesta

Respuesta de Bloquear usuarios:

Si la petición es correcta, el servicio responde con el código HTTP 201.

Nombre	Descripción	Tipo
messaging_product	Siempre `"whatsapp"`. Se incluye para coincidir con las respuestas de la API de Meta Cloud.	String
block_users	Objeto con los usuarios bloqueados y los que no se pudieron bloquear.	Objeto
errors	Error de nivel superior devuelto por Meta cuando la petición falla en su totalidad (a diferencia de los fallos por usuario, que aparecen en `block_users.failed_users`). Se omite en una respuesta totalmente exitosa.	Objeto

Objeto block users

Nombre	Descripción	Tipo
added_users	Lista de usuarios bloqueados.	Lista de objetos added users
failed_users	Lista de usuarios que no se pudieron bloquear.	Lista de objetos failed users

Objeto added users

Nombre	Descripción	Tipo
input	Identificador enviado en la petición.	String
wa_id	Identificador de WhatsApp resuelto por Meta.	String

{
    "messaging_product": "whatsapp",
    "block_users": {
        "added_users": [
            {
                "input": "2721520198",
                "wa_id": "5212721520198"
            }
        ],
        "failed_users": [
            {
                "input": "2721520160",
                "errors": [
                    {
                        "code": 131047,
                        "message": "Re-engagement check failed",
                        "error_data": {
                            "details": "Failed to block due to re-engagement check failed"
                        }
                    }
                ]
            }
        ]
    }
}

Desbloquear usuarios

Petición

Petición de Desbloquear usuarios:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/block_users/{{waba_id}}/{{phone_number_id}}
Método	PUT
Tipo	application/json

Encabezados

Encabezados de Desbloquear usuarios:

Nombre	Descripción	Tipo	Requerimientos
Content-Type	application/json	String	Obligatorio
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Desbloquear usuarios:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
phone_number_id	ID del número de teléfono desde el que se desbloquea al usuario.	String	Obligatorio

Cuerpo

Campos del cuerpo de Desbloquear usuarios:

Nombre	Descripción	Tipo	Requerimientos
block_users	Lista de usuarios a desbloquear.	Lista de objetos user	Obligatorio

Ejemplo

Ejemplo completo de Desbloquear usuarios:

curl --location --request PUT 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/block_users/{{waba_id}}/{{phone_number_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin-token}}' \
--data '{
    "block_users": [
        {
            "user": "2721520198"
        }
    ]
}'

Respuesta

Respuesta de Desbloquear usuarios:

Si la petición es correcta, el servicio responde con el código HTTP 200.

Nombre	Descripción	Tipo
block_users	Objeto con los usuarios desbloqueados y los que no se pudieron desbloquear.	Objeto

Objeto block users desbloqueo

Nombre	Descripción	Tipo
removed_users	Lista de usuarios desbloqueados.	Lista de objetos removed users
failed_users	Lista de usuarios que no se pudieron desbloquear.	Lista de objetos failed users

Objeto removed users

Nombre	Descripción	Tipo
input	Identificador enviado en la petición.	String
wa_id	Identificador de WhatsApp resuelto por Meta.	String

{
    "block_users": {
        "removed_users": [
            {
                "input": "2721520198",
                "wa_id": "5212721520198"
            }
        ],
        "failed_users": [
            {
                "input": "US.13491208655302741918",
                "errors": [
                    {
                        "code": 131047,
                        "message": "Re-engagement check failed",
                        "error_data": {
                            "details": "Failed to block due to re-engagement check failed"
                        }
                    }
                ]
            }
        ]
    }
}

Objeto failed users

Se usa tanto al bloquear como al desbloquear.

Nombre	Descripción	Tipo
input	Identificador enviado en la petición.	String
errors	Lista de errores que impidieron la operación.	Lista de objetos errors

Objeto errors

Nombre	Descripción	Tipo
code	Código de error.	Number
message	Mensaje de error.	String
error_data	Detalles del error.	Objeto

Objeto error data

Nombre	Descripción	Tipo
details	Razón detallada por la que no se pudo bloquear o desbloquear al usuario.	String

Whatsapp — Anterior

Bloqueo de usuarios

Consultar usuarios bloqueados