Pular para o conteúdo principal
POST
Criar número (PILOT_STATUS)

Autorizações

x-api-key
string
header
obrigatório

Sua chave de API ps_

Corpo

application/json
name
string
obrigatório

Nome de exibição do número.

Exemplo:

"Suporte"

number
string
obrigatório

Número de telefone (mínimo 10 dígitos, opcional +).

Exemplo:

"5511999999999"

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

Exemplo:

"true"

settings
object

Configurações com que o número NASCE — o mesmo bloco do PATCH /v1/numbers/{id}. É aqui que se decide o historyImportEnabled: o padrão é true (era false para números criados entre 2026-08-26 e 2026-09-16), o provedor entrega o histórico do aparelho numa rajada única logo após a conexão, e não há como pedi-lo depois. Todos os campos do bloco do PATCH são aceitos aqui; o 201 devolve as configurações com que o número foi criado.

Resposta

Criar número

numberId
string

O id do número — o mesmo id do GET /v1/numbers, o que o DELETE /v1/numbers/{id} recebe e o data.numberId dos webhooks. Não é o mesmo que instance.id (o id da instância, sem mudança).

instance
object

A instância criada. Sem mudança; instance.id é o id da instância.

qrcodeBase64
string | null
pairingCode
string | null
linkedApiKeyId
null

Sempre null (o vínculo de chave foi aposentado).