Números
Pareamento remoto (link de conexão)
Gera um link para que outra pessoa conecte o próprio número. provider=PILOT_STATUS (padrão) exige name + number e devolve um link de pareamento por QR; provider=META devolve um link de Embedded Signup hospedado (a pessoa escolhe o número dentro do diálogo do Facebook, sem name/number).
POST
/
v1
/
numbers
/
remote-pairing
Pareamento remoto (link de conexão)
curl --request POST \
--url https://pilotstatus.com.br/v1/numbers/remote-pairing \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"provider": "PILOT_STATUS",
"name": "Cliente Acme",
"number": "5511988887777",
"sendViaWhatsApp": "false",
"redirectUrl": "https://app.acme.com/done",
"externalRef": "customer-42",
"linkToApiKey": "true",
"metaFlow": "embedded",
"settings": {
"historyImportEnabled": false,
"webhookHistoricalMessages": false,
"ignoreNewsletters": false
}
}
'import requests
url = "https://pilotstatus.com.br/v1/numbers/remote-pairing"
payload = {
"provider": "PILOT_STATUS",
"name": "Cliente Acme",
"number": "5511988887777",
"sendViaWhatsApp": "false",
"redirectUrl": "https://app.acme.com/done",
"externalRef": "customer-42",
"linkToApiKey": "true",
"metaFlow": "embedded",
"settings": {
"historyImportEnabled": False,
"webhookHistoricalMessages": False,
"ignoreNewsletters": False
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
provider: 'PILOT_STATUS',
name: 'Cliente Acme',
number: '5511988887777',
sendViaWhatsApp: 'false',
redirectUrl: 'https://app.acme.com/done',
externalRef: 'customer-42',
linkToApiKey: 'true',
metaFlow: 'embedded',
settings: {
historyImportEnabled: false,
webhookHistoricalMessages: false,
ignoreNewsletters: false
}
})
};
fetch('https://pilotstatus.com.br/v1/numbers/remote-pairing', 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/remote-pairing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'provider' => 'PILOT_STATUS',
'name' => 'Cliente Acme',
'number' => '5511988887777',
'sendViaWhatsApp' => 'false',
'redirectUrl' => 'https://app.acme.com/done',
'externalRef' => 'customer-42',
'linkToApiKey' => 'true',
'metaFlow' => 'embedded',
'settings' => [
'historyImportEnabled' => false,
'webhookHistoricalMessages' => false,
'ignoreNewsletters' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/numbers/remote-pairing"
payload := strings.NewReader("{\n \"provider\": \"PILOT_STATUS\",\n \"name\": \"Cliente Acme\",\n \"number\": \"5511988887777\",\n \"sendViaWhatsApp\": \"false\",\n \"redirectUrl\": \"https://app.acme.com/done\",\n \"externalRef\": \"customer-42\",\n \"linkToApiKey\": \"true\",\n \"metaFlow\": \"embedded\",\n \"settings\": {\n \"historyImportEnabled\": false,\n \"webhookHistoricalMessages\": false,\n \"ignoreNewsletters\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/numbers/remote-pairing")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"PILOT_STATUS\",\n \"name\": \"Cliente Acme\",\n \"number\": \"5511988887777\",\n \"sendViaWhatsApp\": \"false\",\n \"redirectUrl\": \"https://app.acme.com/done\",\n \"externalRef\": \"customer-42\",\n \"linkToApiKey\": \"true\",\n \"metaFlow\": \"embedded\",\n \"settings\": {\n \"historyImportEnabled\": false,\n \"webhookHistoricalMessages\": false,\n \"ignoreNewsletters\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/numbers/remote-pairing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider\": \"PILOT_STATUS\",\n \"name\": \"Cliente Acme\",\n \"number\": \"5511988887777\",\n \"sendViaWhatsApp\": \"false\",\n \"redirectUrl\": \"https://app.acme.com/done\",\n \"externalRef\": \"customer-42\",\n \"linkToApiKey\": \"true\",\n \"metaFlow\": \"embedded\",\n \"settings\": {\n \"historyImportEnabled\": false,\n \"webhookHistoricalMessages\": false,\n \"ignoreNewsletters\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"provider": "PILOT_STATUS",
"remotePairingToken": "rp_01HZX...",
"remotePairingUrl": "https://pilotstatus.com.br/connect/rp_01HZX...",
"numberId": "num_01HZX..."
}Autorizações
apiKeyapiKeyId
Sua chave de API ps_
Corpo
application/json
Tipo de link (padrão PILOT_STATUS).
Exemplo:
"PILOT_STATUS"
Obrigatório para PILOT_STATUS; ignorado para META.
Exemplo:
"Cliente Acme"
Obrigatório para PILOT_STATUS; ignorado para META.
Exemplo:
"5511988887777"
Enviar o link por WhatsApp (PILOT_STATUS). Padrão false.
Exemplo:
"false"
URL de redirecionamento após concluir (META).
Exemplo:
"https://app.acme.com/done"
Referência externa opcional para correlação (META).
Exemplo:
"customer-42"
Obsoleto: aceito e ignorado. Nenhuma API key é alterada e linkedApiKeyId é sempre null.
Exemplo:
"true"
Só META: embedded (padrão) roda o Embedded Signup da Meta na página hospedada; credentials coleta as credenciais de uma WABA existente.
Opções disponíveis:
embedded, credentials Exemplo:
"embedded"
Configurações com que o número NASCE — o mesmo bloco do PATCH /v1/numbers/{id}. Vale para os dois providers: no META é gravado na linha provisória em que a conexão vai cair. É aqui que se decide o histórico: settings.historyImportEnabled tem padrão true, o provider entrega o histórico do aparelho uma única vez, logo depois de a pessoa conectar, e mudar a flag depois não o traz de volta nem o desfaz. Valores inválidos respondem 400 INVALID_SETTINGS e nada é criado.
Show child attributes
Show child attributes
Resposta
Link de pareamento criado. META responde com o numberId da linha provisória, o link, o expiresAt (30 min) e os settings com que a linha provisória foi criada.
Esta página foi útil?
⌘I
Pareamento remoto (link de conexão)
curl --request POST \
--url https://pilotstatus.com.br/v1/numbers/remote-pairing \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"provider": "PILOT_STATUS",
"name": "Cliente Acme",
"number": "5511988887777",
"sendViaWhatsApp": "false",
"redirectUrl": "https://app.acme.com/done",
"externalRef": "customer-42",
"linkToApiKey": "true",
"metaFlow": "embedded",
"settings": {
"historyImportEnabled": false,
"webhookHistoricalMessages": false,
"ignoreNewsletters": false
}
}
'import requests
url = "https://pilotstatus.com.br/v1/numbers/remote-pairing"
payload = {
"provider": "PILOT_STATUS",
"name": "Cliente Acme",
"number": "5511988887777",
"sendViaWhatsApp": "false",
"redirectUrl": "https://app.acme.com/done",
"externalRef": "customer-42",
"linkToApiKey": "true",
"metaFlow": "embedded",
"settings": {
"historyImportEnabled": False,
"webhookHistoricalMessages": False,
"ignoreNewsletters": False
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
provider: 'PILOT_STATUS',
name: 'Cliente Acme',
number: '5511988887777',
sendViaWhatsApp: 'false',
redirectUrl: 'https://app.acme.com/done',
externalRef: 'customer-42',
linkToApiKey: 'true',
metaFlow: 'embedded',
settings: {
historyImportEnabled: false,
webhookHistoricalMessages: false,
ignoreNewsletters: false
}
})
};
fetch('https://pilotstatus.com.br/v1/numbers/remote-pairing', 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/remote-pairing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'provider' => 'PILOT_STATUS',
'name' => 'Cliente Acme',
'number' => '5511988887777',
'sendViaWhatsApp' => 'false',
'redirectUrl' => 'https://app.acme.com/done',
'externalRef' => 'customer-42',
'linkToApiKey' => 'true',
'metaFlow' => 'embedded',
'settings' => [
'historyImportEnabled' => false,
'webhookHistoricalMessages' => false,
'ignoreNewsletters' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/numbers/remote-pairing"
payload := strings.NewReader("{\n \"provider\": \"PILOT_STATUS\",\n \"name\": \"Cliente Acme\",\n \"number\": \"5511988887777\",\n \"sendViaWhatsApp\": \"false\",\n \"redirectUrl\": \"https://app.acme.com/done\",\n \"externalRef\": \"customer-42\",\n \"linkToApiKey\": \"true\",\n \"metaFlow\": \"embedded\",\n \"settings\": {\n \"historyImportEnabled\": false,\n \"webhookHistoricalMessages\": false,\n \"ignoreNewsletters\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/numbers/remote-pairing")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"PILOT_STATUS\",\n \"name\": \"Cliente Acme\",\n \"number\": \"5511988887777\",\n \"sendViaWhatsApp\": \"false\",\n \"redirectUrl\": \"https://app.acme.com/done\",\n \"externalRef\": \"customer-42\",\n \"linkToApiKey\": \"true\",\n \"metaFlow\": \"embedded\",\n \"settings\": {\n \"historyImportEnabled\": false,\n \"webhookHistoricalMessages\": false,\n \"ignoreNewsletters\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/numbers/remote-pairing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider\": \"PILOT_STATUS\",\n \"name\": \"Cliente Acme\",\n \"number\": \"5511988887777\",\n \"sendViaWhatsApp\": \"false\",\n \"redirectUrl\": \"https://app.acme.com/done\",\n \"externalRef\": \"customer-42\",\n \"linkToApiKey\": \"true\",\n \"metaFlow\": \"embedded\",\n \"settings\": {\n \"historyImportEnabled\": false,\n \"webhookHistoricalMessages\": false,\n \"ignoreNewsletters\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"provider": "PILOT_STATUS",
"remotePairingToken": "rp_01HZX...",
"remotePairingUrl": "https://pilotstatus.com.br/connect/rp_01HZX...",
"numberId": "num_01HZX..."
}