Pular para o conteúdo principal
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 '
{
  "name": "Cliente Acme",
  "number": "5511988887777"
}
'
{
  "provider": "PILOT_STATUS",
  "remotePairingToken": "rp_01HZX...",
  "remotePairingUrl": "https://pilotstatus.com.br/connect/rp_01HZX...",
  "numberId": "num_01HZX..."
}

Autorizações

​
x-api-key
string
header
obrigatório

Sua chave de API ps_

Corpo

application/json
​
provider
string

Tipo de link (padrão PILOT_STATUS).

Exemplo:

"PILOT_STATUS"

​
name
string

Obrigatório para PILOT_STATUS; ignorado para META.

Exemplo:

"Cliente Acme"

​
number
string

Obrigatório para PILOT_STATUS; ignorado para META.

Exemplo:

"5511988887777"

​
sendViaWhatsApp
boolean

Enviar o link por WhatsApp (PILOT_STATUS). Padrão false.

Exemplo:

"false"

​
redirectUrl
string

URL de redirecionamento após concluir (META).

Exemplo:

"https://app.acme.com/done"

​
externalRef
string

Referência externa opcional para correlação (META).

Exemplo:

"customer-42"

​
linkToApiKey
boolean

Vincular o número resultante à API key chamadora (padrão true).

Exemplo:

"true"

Resposta

Link PILOT_STATUS