Bloquear/desbloquear contacto

POST

api

chat

block

:instance

Bloquear/desbloquear contacto

curl --request POST \
  --url https://api.example.com/api/chat/block/:instance \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "block": true
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({number: '<string>', block: true})
};

fetch('https://api.example.com/api/chat/block/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/chat/block/:instance"

payload = {
    "number": "<string>",
    "block": True
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí Bloquea o desbloquea un contacto. La respuesta incluye blocked_count, el total de contactos bloqueados de la cuenta tras la operación.

Ejemplos

Bloquear

Agrega el contacto a la lista de bloqueados (block: true), deteniendo el envío y la recepción de mensajes en ambas direcciones. El historial previo se preserva.

curl -X POST "https://ryzeapi.cloud/api/chat/block/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"number": "5511999999999", "block": true}'

await fetch(`https://ryzeapi.cloud/api/chat/block/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ number: "5511999999999", block: true })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/block/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={"number": "5511999999999", "block": True}
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{"number": "5511999999999", "block": true}`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/block/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Desbloquear

Quita el contacto de la lista de bloqueados (block: false), reanudando el tráfico de mensajes en ambas direcciones. La operación se sincroniza automáticamente con la app del teléfono.

curl -X POST "https://ryzeapi.cloud/api/chat/block/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"number": "5511999999999", "block": false}'

await fetch(`https://ryzeapi.cloud/api/chat/block/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ number: "5511999999999", block: false })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/block/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={"number": "5511999999999", "block": False}
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{"number": "5511999999999", "block": false}`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/block/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Respuesta exitosa

200 OK

{
  "success": true,
  "message": "Contact blocked successfully",
  "contact_jid": "5511999999999@s.whatsapp.net",
  "blocked_count": 7,
  "blocked": true
}

Campo	Tipo	Descripción
`contact_jid`	string	JID del contacto afectado.
`blocked`	boolean	Estado final (`true` bloqueado, `false` desbloqueado).
`blocked_count`	int	Total de contactos bloqueados en la cuenta tras la operación.

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

Cuerpo de la solicitud

string

requerido

Número de teléfono o JID del contacto. Solo contactos individuales, no funciona con grupos.

boolean

requerido

true bloquea, false desbloquea.

Notas

Bloquear detiene el envío/recepción de mensajes en ambas direcciones; el historial previo permanece.
Sincroniza con la app del teléfono automáticamente.
No existe un evento de webhook específico para bloquear/desbloquear en el modelo actual.

Respuestas de error

HTTP	`error.message`	Cuándo
400	`Invalid request body`	JSON malformado.
400	`Number is required`	Campo faltante.
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance is not connected to WhatsApp`	Sin sesión activa.

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Bloquear/desbloquear contacto

Ejemplos

Bloquear

Desbloquear

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Respuestas de error

​Ejemplos

​Bloquear

​Desbloquear

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Notas

​Respuestas de error

Ejemplos

Bloquear

Desbloquear

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Respuestas de error