Arquivar chat

POST

api

chat

Descrição

Arquiva (archive: true) ou desarquiva (archive: false) um chat. A operação é propagada para o WhatsApp via app state, pode levar segundos até refletir nos demais dispositivos vinculados.

Exemplos

Arquivar

Move o chat para a pasta de arquivados (archive: true), removendo-o da lista principal sem apagar o histórico. Sincroniza com os demais dispositivos vinculados via app state.

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

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

import os, requests

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

package main

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

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

Desarquivar

Tira o chat da pasta de arquivados (archive: false) e o traz de volta para a lista principal. A operação é propagada para todos os dispositivos vinculados.

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

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

import os, requests

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

package main

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

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

Resposta de sucesso

A resposta confirma a operação com chat_jid (JID resolvido a partir do number) e archived refletindo o estado final. A message muda conforme o valor de archive: "Chat archived successfully" ou "Chat unarchived successfully".

200 OK

{
  "success": true,
  "message": "Chat archived successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "archived": true
}

Parâmetros de rota

string

obrigatório

Nome da instância.

Headers

Nome	Obrigatório	Exemplo	Descrição
`Content-Type`	sim	`application/json`	,
`token`	sim (ou `Authorization`)	`a1b2c3d4-...`	TokenAccount ou TokenInstance.

Request body

string

obrigatório

Telefone, JID privado (...@s.whatsapp.net ou ...@lid), JID de grupo (...@g.us) ou newsletter.

boolean

obrigatório

true arquiva, false desarquiva.

Respostas de erro

HTTP	`error.message`	Quando ocorre
400	`Instance name is required`	,
400	`Invalid request body: <...>`	JSON malformado.
400	`Number is required`	,
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance is not connected to WhatsApp`	,

Erro 400

{
  "success": false,
  "error": { "message": "Number is required" }
}

Relacionados

Fixar chat

POST /api/chat/pinChat/:instance

Silenciar chat

POST /api/chat/mute/:instance

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplos

Arquivar

Desarquivar

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Respostas de erro

Relacionados

Fixar chat

Silenciar chat

​Descrição

​Exemplos

​Arquivar

​Desarquivar

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Respostas de erro

​Relacionados

Fixar chat

Silenciar chat

Descrição

Exemplos

Arquivar

Desarquivar

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Respostas de erro

Relacionados