Numbers

Number connection status

Syncs and returns the number’s current connection state (OPEN/CONNECTING/CLOSE). Meta numbers return OPEN. A Meta number created by POST /v1/numbers/remote-pairing answers PENDING while the end user is still inside the Embedded Signup dialog and EXPIRED once that window closed without completion — both carry expiresAt. A 200 does NOT mean connected: poll until state is OPEN and stop on EXPIRED. Useful to poll after creating/connecting.

GET

numbers

{id}

status

Number connection status

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

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

fetch('https://pilotstatus.com.br/v1/numbers/{id}/status', 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/numbers/{id}/status",
  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/numbers/{id}/status"

	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/numbers/{id}/status")

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": "num_01HZX...",
  "state": "OPEN"
}

{
  "error": "Validation error"
}

{
  "error": "Unauthorized"
}

{
  "error": "Too many requests"
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Path Parameters

string

required

Number/instance id.

Response

Status

string

The number's public id.

Example:

"num_01HZX..."

state

enum<string>

OPEN = connected. PENDING/EXPIRED = Meta number awaiting (or past) the Embedded Signup window.

Available options:

OPEN,

CONNECTING,

CLOSE,

PENDING,

EXPIRED

Example:

"OPEN"

stale

boolean

false = live reading (with checkedAt); true = last remembered state (with lastKnownAt).

Example:

false

checkedAt

string

ISO 8601. Only when stale is false.

Example:

"2026-07-22T12:34:56.000Z"

lastKnownAt

string

ISO 8601. Only when stale is true.

Example:

"2026-07-22T12:34:56.000Z"

expiresAt

string

ISO 8601 end of the pairing window. Only on PENDING/EXPIRED.

Example:

"2026-08-04T18:27:31.000Z"

Number connection status

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

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

fetch('https://pilotstatus.com.br/v1/numbers/{id}/status', 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/numbers/{id}/status",
  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/numbers/{id}/status"

	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/numbers/{id}/status")

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": "num_01HZX...",
  "state": "OPEN"
}

{
  "error": "Validation error"
}

{
  "error": "Unauthorized"
}

{
  "error": "Too many requests"
}

Endpoints

Workspace

Number connection status

Authorizations

Path Parameters

Response