Favoritar mensagem

PUT/v1/instances/{id}/messages/{msg_id}/stardesde M9token da instância ou admin

Quando usar

Favorita (ou desfavorita) uma mensagem do log em todos os aparelhos da conta; a mensagem passa a ter starred: true.

Autenticação

Aceita o token da instância (só a própria instância) ou o token admin. Um token de outra instância recebe 403 forbidden (ou 404 not_found em webhooks de outra instância).

Parâmetros

Caminho

Nome	Tipo	Descrição
idobrigatório	string	Id da instância (inst_...).
msg_idobrigatório	string	Id da mensagem no LiteZap.

Corpo (JSON)

Nome	Tipo	Descrição
starredobrigatório	boolean

Exemplo

cURL

curl -s -X PUT "$LITEZAP_URL/v1/instances/$ID/messages/$MSG_ID/star" \
  -H "Authorization: Bearer $LITEZAP_TOKEN" \
  -d '{"starred":true}'

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/messages/msg_a41c9e07d2b35f68/star", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "starred": true
  }),
});
console.log(res.status, res.status === 204 ? "" : await res.json());

Python

import os
import requests

r = requests.put(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/messages/msg_a41c9e07d2b35f68/star",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    json={
        "starred": True,
    },
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

Go

package main

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

func main() {
  req, _ := http.NewRequest("PUT", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/messages/msg_a41c9e07d2b35f68/star", strings.NewReader(`{"starred":true}`))
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_TOKEN"))
  req.Header.Set("Content-Type", "application/json")
  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  out, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.Status, string(out))
}

PHP

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);
$res = $client->request('PUT', '/v1/instances/inst_7f3a9c2e5b1d4086/messages/msg_a41c9e07d2b35f68/star', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    'json' => [
        'starred' => true,
    ],
    'http_errors' => false,
]);
echo $res->getStatusCode(), ' ', $res->getBody(), PHP_EOL;

Nos exemplos, LITEZAP_URL é a URL base (ex.: http://localhost:8787) e o token vem deLITEZAP_TOKEN (instância) ou LITEZAP_ADMIN_TOKEN.

Resposta

200 A mensagem.

Campos de Message

id	string
client_message_id	string
wa_message_id	string
chat	string
sender	string
from_me	boolean
source	"contact" | "api" | "device" | "history"
type	string
text	string
media	MediaInfo
media.id	string	Id da mídia recebida.
media.kind	string
media.mime	string
media.size	integer
media.file_name	string
media.seconds	integer
media.ptt	boolean
media.url	string	Caminho da API para baixar (mídia recebida).
reaction_to	string
status	"queued" | "in_flight" | "sent" | "delivered" | "read" | "played" | "failed" | "received" | "pending"
attempts	integer
error	string	Último erro (codigo: detalhe) de item não enviado.
timestamp	string

Erros

Código	HTTP	Retentável	O que fazer
validation_failed	400	não	Corrija o corpo ou os parâmetros; a message diz o campo.
unauthorized	401	não	Envie Authorization: Bearer <token> válido.
forbidden	403	não	Use o token certo (admin, ou o da própria instância).
not_found	404	não	Confira o id do recurso (mensagem, chat, contato, mídia ou webhook).
instance_not_found	404	não	Confira o id da instância.
app_state_not_synced	409	não
worker_error	502	sim	Tente de novo com backoff; se persistir, veja o log do servidor.
worker_timeout	504	sim	Tente de novo; a instância pode estar sobrecarregada ou reconectando.

Todo erro usa o envelope {"error":{"code","message","retryable"}}. Tabela completa em Erros.

Eventos gerados

• chat.updated

Outras operações de Mensagens: Enviar mensagem · Consultar mensagem · Listar a fila · Esvaziar a fila · Cancelar item da fila