Archivar chat

POST

api

chat

Descripción

Archiva (archive: true) o desarchiva (archive: false) un chat. La operación se propaga a WhatsApp vía app state, puede tardar segundos en reflejarse en los demás dispositivos vinculados.

Ejemplos

Archivar

Mueve el chat a la carpeta de archivados (archive: true), quitándolo de la lista principal sin borrar el historial. Sincroniza con los demás dispositivos vinculados vía 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)
}

Desarchivar

Saca el chat de la carpeta de archivados (archive: false) y lo regresa a la lista principal. La operación se propaga a todos los 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)
}

Respuesta exitosa

La respuesta confirma la operación con chat_jid (JID resuelto desde number) y archived reflejando el estado final. El message cambia según el valor de archive: "Chat archived successfully" o "Chat unarchived successfully".

200 OK

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

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

Nombre	Requerido	Ejemplo	Descripción
`Content-Type`	sí	`application/json`	,
`token`	sí (o `Authorization`)	`a1b2c3d4-...`	TokenAccount o TokenInstance.

Cuerpo de la solicitud

string

requerido

Número de teléfono, JID privado (...@s.whatsapp.net o ...@lid), JID de grupo (...@g.us) o newsletter.

boolean

requerido

true archiva, false desarchiva.

Respuestas de error

HTTP	`error.message`	Cuándo ocurre
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`	,

Error 400

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

Relacionados

Fijar chat

POST /api/chat/pinChat/:instance

Silenciar chat

POST /api/chat/mute/:instance

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Descripción

Ejemplos

Archivar

Desarchivar

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Respuestas de error

Relacionados

Fijar chat

Silenciar chat

​Descripción

​Ejemplos

​Archivar

​Desarchivar

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Respuestas de error

​Relacionados

Fijar chat

Silenciar chat

Descripción

Ejemplos

Archivar

Desarchivar

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Respuestas de error

Relacionados