Obter mensagem

GET

messages

{id}

Obter mensagem

curl --request GET \
  --url https://pilotstatus.com.br/v1/messages/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/messages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/messages/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://pilotstatus.com.br/v1/messages/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/messages/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "msg_01HZX...",
  "externalMessageId": "wamid.HBg...",
  "status": "DELIVERED",
  "correlationId": "corr_01HZX...",
  "destinationNumber": "5511988887777",
  "createdAt": "2026-06-20T10:00:00.000Z",
  "sentAt": "2026-06-20T10:00:01.000Z",
  "deliveredAt": "2026-06-20T10:00:03.000Z",
  "readAt": null,
  "errorCode": null,
  "errorMessage": null,
  "template": "boas_vindas",
  "origin": "API",
  "metaPricing": null
}

{
  "error": "Validation error"
}

{
  "error": "Unauthorized"
}

{
  "error": "Tenant-scoped keys cannot call number endpoints",
  "code": "TENANT_SCOPE_NOT_ALLOWED"
}

{
  "error": "Too many requests"
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Parâmetros de caminho

string

obrigatório

Id interno, correlationId ou externalMessageId (wamid da Meta).

Resposta

Obter mensagem

string

Id interno da mensagem — o id devolvido por POST /v1/messages/send.

Exemplo:

"msg_01HZX..."

externalMessageId

string | null

Id da mensagem no provedor (num número oficial, o wamid da Meta). null até o provedor aceitar a mensagem.

Exemplo:

"wamid.HBg..."

status

enum<string>

Status de entrega atual.

Opções disponíveis:

QUEUED,

SENT,

DELIVERED,

READ,

PLAYED,

FAILED,

CANCELED

Exemplo:

"FAILED"

correlationId

string

Identificador de correlação do envio.

Exemplo:

"corr_01HZX..."

destinationNumber

string

Número de telefone de destino.

Exemplo:

"5511988887777"

createdAt

string<date-time>

Quando a mensagem foi criada (UTC, ISO 8601).

Exemplo:

"2026-06-20T10:00:00.000Z"

sentAt

string<date-time> | null

Quando a mensagem foi enviada, ou null.

Exemplo:

"2026-06-20T10:00:01.000Z"

deliveredAt

string<date-time> | null

Quando a mensagem foi entregue, ou null.

Exemplo:

null

readAt

string<date-time> | null

Quando a mensagem foi lida, ou null.

Exemplo:

null

errorCode

string | null

Motivo da falha legível por máquina — o mesmo valor que GET /v1/messages devolve para esta mensagem. null quando não há erro, e sempre null em DELIVERED, READ, PLAYED e CANCELED. Ramifique por ele, nunca pelo errorMessage. O conjunto cresce (veja Códigos de Erro do Log): trate um código desconhecido como "precisa de revisão".

Exemplo:

"META_OUTSIDE_24H_WINDOW"

errorMessage

string | null

Motivo da falha legível por pessoas, ou null. A redação não é contrato — não faça parsing; use o errorCode.

Exemplo:

"Re-engagement message: Message failed to send because more than 24 hours have passed since the customer last replied to this number."

template

string

Nome do template com que a mensagem foi enviada. A chave é omitida (não null) quando o envio não usou template.

Exemplo:

"boas_vindas"

origin

enum<string> | null

Por onde a mensagem saiu. null quer dizer que não há requisição de envio reconhecida — não quer dizer recebida. Mensagens enviadas que não passaram pela Pilot Status — APP, LAYER e respostas CHATWOOT de uma inbox nativa WhatsApp Cloud — só aparecem em GET /v1/messages e GET /v1/messages/history; este endpoint responde 404 para elas.

Opções disponíveis:

API,

MCP,

CHATWOOT,

CHAT,

DASHBOARD,

SYSTEM,

null

Exemplo:

"API"

metaPricing

object | null

O veredito de cobrança da própria Meta para esta mensagem. null enquanto a Meta não reportar, e sempre null em números que não são Meta.

Show child attributes

Obter mensagem

curl --request GET \
  --url https://pilotstatus.com.br/v1/messages/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/messages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/messages/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://pilotstatus.com.br/v1/messages/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/messages/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "msg_01HZX...",
  "externalMessageId": "wamid.HBg...",
  "status": "DELIVERED",
  "correlationId": "corr_01HZX...",
  "destinationNumber": "5511988887777",
  "createdAt": "2026-06-20T10:00:00.000Z",
  "sentAt": "2026-06-20T10:00:01.000Z",
  "deliveredAt": "2026-06-20T10:00:03.000Z",
  "readAt": null,
  "errorCode": null,
  "errorMessage": null,
  "template": "boas_vindas",
  "origin": "API",
  "metaPricing": null
}

{
  "error": "Validation error"
}

{
  "error": "Unauthorized"
}

{
  "error": "Tenant-scoped keys cannot call number endpoints",
  "code": "TENANT_SCOPE_NOT_ALLOWED"
}

{
  "error": "Too many requests"
}

Endpoints

Workspace

Autorizações

Parâmetros de caminho

Resposta