Consultar usuarios bloqueados

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:
GET /v1/block_users/{{waba_id}}: Listar usuarios bloqueados por WABA
GET /v1/block_users/{{waba_id}}/{{phone_number_id}}: Listar usuarios bloqueados por número de teléfono

Consulta los usuarios bloqueados de toda tu WABA o de un número de teléfono. Si la petición es correcta, el servicio responde con el código HTTP 200 y una lista de usuarios.

Listar usuarios bloqueados por WABA

Petición

Petición de Listar usuarios bloqueados por WABA:


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

Encabezados

Encabezados de Listar usuarios bloqueados 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 usuarios bloqueados por WABA:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
blocked	Filtra por estatus. Con `true` devuelve solo los usuarios bloqueados y con `false` solo los desbloqueados. Se envía como parámetro de consulta (query).	Boolean	Opcional. Si no se envía, se devuelven los usuarios bloqueados y desbloqueados.

Ejemplo

Ejemplo completo de Listar usuarios bloqueados por WABA:

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

Respuesta

Respuesta de Listar usuarios bloqueados por WABA:

Aplica para la consulta por WABA y por número de teléfono. El servicio responde con el código HTTP 200 y una lista de usuarios.

Nombre	Descripción	Tipo
phone_number_id	ID del número de teléfono que bloqueó al usuario. Solo se incluye en la consulta por WABA.	String
input	Identificador usado en la petición de bloqueo.	String
status	Estatus actual del usuario. Los valores pueden ser: BLOCKED UNLOCKED FAILED (solo aparece cuando el parámetro `blocked` no se envía)	String

[
    {
        "phone_number_id": "1234567890",
        "input": "521550123456",
        "status": "BLOCKED"
    },
    {
        "phone_number_id": "1234567890",
        "input": "US.13491208655302741918",
        "status": "BLOCKED"
    }
]

Listar usuarios bloqueados por número de teléfono

Petición

Petición de Listar usuarios bloqueados por número de teléfono:


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

Encabezados

Encabezados de Listar usuarios bloqueados por número de teléfono:

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

Parámetros

Parámetros de Listar usuarios bloqueados por número de teléfono:

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 a consultar.	String	Obligatorio
blocked	Filtra por estatus. Con `true` devuelve solo los usuarios bloqueados y con `false` solo los desbloqueados. Se envía como parámetro de consulta (query).	Boolean	Opcional. Si no se envía, se devuelven los usuarios bloqueados y desbloqueados.

Ejemplo

Ejemplo completo de Listar usuarios bloqueados por número de teléfono:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/block_users/{{waba_id}}/{{phone_number_id}}?blocked=true' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Listar usuarios bloqueados por número de teléfono:

Aplica para la consulta por WABA y por número de teléfono. El servicio responde con el código HTTP 200 y una lista de usuarios.

Nombre	Descripción	Tipo
phone_number_id	ID del número de teléfono que bloqueó al usuario. Solo se incluye en la consulta por WABA.	String
input	Identificador usado en la petición de bloqueo.	String
status	Estatus actual del usuario. Los valores pueden ser: BLOCKED UNLOCKED FAILED (solo aparece cuando el parámetro `blocked` no se envía)	String

[
    {
        "input": "521550123456",
        "status": "BLOCKED"
    },
    {
        "input": "US.13491208655302741918",
        "status": "BLOCKED"
    }
]

Bloquear y desbloquear usuarios

Códigos de error