Messages

Service window status

Reports whether the WhatsApp 24-hour customer-service window is currently OPEN for a contact on the number bound to the API key.

Meta Cloud API numbers — windowType: "META_24H". open is true when the contact’s last inbound message arrived within the last 24 hours; expiresAt is lastInboundAt + 24h. While the window is open, free-form messages are allowed; once it closes, sends fail with META_OUTSIDE_24H_WINDOW and you must use an approved template.
Web (unofficial) numbers — no Meta restriction: windowType: "NONE" and open is always true; lastInboundAt/expiresAt are still returned informatively.

Check it before sending free-form content to decide between free-form and template messages.

Requires a number-scoped key.

GET

service-window

Service window status

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 is required and must be a valid phone (E.164, with or without +)",
  "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"
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Query Parameters

destinationNumber

string

required

Contact phone number in E.164 format, with or without the leading + (digits also accepted).

Response

Service window status

open

boolean

Whether free-form messages can be sent right now. Always true for web (unofficial) numbers.

Example:

true

windowType

enum<string>

META_24H for Meta Cloud API numbers (24-hour window enforced); NONE for web (unofficial) numbers.

Available options:

META_24H,

NONE

Example:

"META_24H"

lastInboundAt

string | null

UTC ISO timestamp of the contact's most recent inbound message, or null when none is known.

Example:

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

expiresAt

string | null

UTC ISO timestamp when the window closes (lastInboundAt + 24h), or null. Informative on web numbers.

Example:

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

Service window status

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 is required and must be a valid phone (E.164, with or without +)",
  "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

Service window status

Authorizations

Query Parameters

Response