Números

Purgar número

Destrói o número de forma PERMANENTE e imediata — IRREVERSÍVEL, não há restauração depois. Apaga o número e tudo o que depende dele (histórico de mensagens, chats, templates, webhooks do número, as API keys dele) e desregistra na Meta um número oficial. Aceita um número já excluído com DELETE /v1/numbers/{id} (o fluxo comum: excluir e depois purgar) ou um ativo. Use quando o MESMO telefone precisa ser criado de novo em seguida. Não economiza nada na cobrança em relação ao DELETE. Use uma key de TENANT: a key presa ao número excluído deixa de autenticar assim que ele é excluído. Com token OAuth/MCP, só o OWNER do workspace pode purgar (403 PERMISSION_DENIED caso contrário).

DELETE

numbers

{id}

purge

Purgar número (exclusão permanente)

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

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

fetch('https://pilotstatus.com.br/v1/numbers/{id}/purge', 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}/purge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  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}/purge"

	req, _ := http.NewRequest("DELETE", 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}/purge")

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

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

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

{
  "ok": true
}

{
  "error": "Unauthorized"
}

{
  "error": "Your workspace role does not allow this action (numbers:purge).",
  "code": "PERMISSION_DENIED"
}

{
  "error": "Not found"
}

{
  "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 do número a destruir (ativo ou já excluído).

Resposta

Número purgado

Purgar número (exclusão permanente)

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

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

fetch('https://pilotstatus.com.br/v1/numbers/{id}/purge', 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}/purge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  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}/purge"

	req, _ := http.NewRequest("DELETE", 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}/purge")

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

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

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

{
  "ok": true
}

{
  "error": "Unauthorized"
}

{
  "error": "Your workspace role does not allow this action (numbers:purge).",
  "code": "PERMISSION_DENIED"
}

{
  "error": "Not found"
}

{
  "error": "Too many requests"
}

Endpoints

Workspace

Purgar número

Autorizações

Parâmetros de caminho

Resposta