Pular para o conteúdo principal
POST
/
api
/
chat
/
block
/
:instance
Bloquear/desbloquear contato
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
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim Bloqueia ou desbloqueia um contato. A resposta inclui blocked_count, total de contatos bloqueados na conta após a operação.

​
Exemplos

​
Bloquear

Adiciona o contato à lista de bloqueados (block: true), interrompendo o envio e recebimento de mensagens nas duas direções. O histórico anterior é preservado. 
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}'

​
Desbloquear

Remove o contato da lista de bloqueados (block: false), liberando o tráfego de mensagens nas duas direções. A operação sincroniza automaticamente com o app do celular. 
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}'

​
Resposta de sucesso

200 OK
{
  "success": true,
  "message": "Contact blocked successfully",
  "contact_jid": "5511999999999@s.whatsapp.net",
  "blocked_count": 7,
  "blocked": true
}
CampoTipoDescrição
contact_jidstringJID do contato afetado.
blockedbooleanEstado final (true bloqueado, false liberado).
blocked_countintTotal de contatos bloqueados na conta após a operação.

​
Path parameters

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Request body

​
number
string
obrigatório
Número ou JID do contato. Apenas contatos individuais, não funciona com grupos.
​
block
boolean
obrigatório
true bloqueia, false desbloqueia.

​
Notas

  • Bloquear interrompe o envio/recebimento de mensagens nas duas direções; o histórico anterior permanece.
  • Sincroniza com o app do celular automaticamente.
  • Não há evento de webhook específico para block/unblock no modelo atual.

​
Respostas de erro

HTTPerror.messageQuando
400Invalid request bodyJSON malformado.
400Number is requiredCampo ausente.
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsAppSem sessão ativa.