Mensagens

Status da janela de atendimento

Informa se a janela de atendimento de 24 horas do WhatsApp está ABERTA para um contato no número vinculado à chave de API.

Números Meta Cloud API — windowType: "META_24H". open é true quando a última mensagem recebida do contato chegou nas últimas 24 horas; expiresAt é lastInboundAt + 24h. Com a janela aberta, mensagens de texto livre são permitidas; quando fecha, os envios falham com META_OUTSIDE_24H_WINDOW e é preciso usar um template aprovado.
Números web (não oficiais) — sem restrição da Meta: windowType: "NONE" e open é sempre true; lastInboundAt/expiresAt continuam sendo retornados de forma informativa.

Consulte antes de enviar conteúdo livre para decidir entre mensagem livre e template.

Requer uma chave com escopo de número.

GET

service-window

Status da janela de atendimento

curl --request GET \
  --url https://pilotstatus.com.br/v1/service-window \
  --header 'x-api-key: <api-key>'

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

fetch('https://pilotstatus.com.br/v1/service-window', 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/service-window",
  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/service-window"

	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/service-window")

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

{
  "open": true,
  "windowType": "META_24H",
  "lastInboundAt": "2026-07-18T10:00:00.000Z",
  "expiresAt": "2026-07-19T10:00:00.000Z"
}

{
  "error": "destinationNumber é obrigatório e deve ser um telefone válido (E.164, com ou sem +)",
  "code": "INVALID_DESTINATION"
}

{
  "error": "Unauthorized"
}

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

{
  "error": "WhatsApp number not found",
  "code": "NUMBER_NOT_FOUND"
}

{
  "error": "Too many requests"
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Parâmetros de consulta

destinationNumber

string

obrigatório

Telefone do contato em formato E.164, com ou sem o + inicial (somente dígitos também é aceito).

Resposta

Status da janela de atendimento

open

boolean

Se mensagens de texto livre podem ser enviadas agora. Sempre true para números web (não oficiais).

Exemplo:

true

windowType

enum<string>

META_24H para números Meta Cloud API (janela de 24h aplicada); NONE para números web (não oficiais).

Opções disponíveis:

META_24H,

NONE

Exemplo:

"META_24H"

lastInboundAt

string | null

Timestamp UTC ISO da mensagem recebida mais recente do contato, ou null quando desconhecido.

Exemplo:

"2026-07-18T10:00:00.000Z"

expiresAt

string | null

Timestamp UTC ISO de quando a janela fecha (lastInboundAt + 24h), ou null. Informativo em números web.

Exemplo:

"2026-07-19T10:00:00.000Z"

Status da janela de atendimento

curl --request GET \
  --url https://pilotstatus.com.br/v1/service-window \
  --header 'x-api-key: <api-key>'

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

fetch('https://pilotstatus.com.br/v1/service-window', 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/service-window",
  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/service-window"

	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/service-window")

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

{
  "open": true,
  "windowType": "META_24H",
  "lastInboundAt": "2026-07-18T10:00:00.000Z",
  "expiresAt": "2026-07-19T10:00:00.000Z"
}

{
  "error": "destinationNumber é obrigatório e deve ser um telefone válido (E.164, com ou sem +)",
  "code": "INVALID_DESTINATION"
}

{
  "error": "Unauthorized"
}

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

{
  "error": "WhatsApp number not found",
  "code": "NUMBER_NOT_FOUND"
}

{
  "error": "Too many requests"
}

Endpoints

Workspace

Status da janela de atendimento

Autorizações

Parâmetros de consulta

Resposta