POST
/
api
/
virtual-phone-accounts
curl --request POST \
  --url https://api.salvy.com.br/api/virtual-phone-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "identifier": "meu-número-virtual",
  "areaCode": 11,
  "redirectPhoneNumber": "11912341234",
  "redirectExpiresAt": "2024-01-03T00:00:00Z"
}'
{
  "id": "0140a8c6-3815-45b7-9e60-8e137cad845c",
  "identifier": "meu-número-virtual",
  "phoneNumber": "+551151231234",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "canceledAt": "2023-11-07T05:31:56Z",
  "cancelReason": "<string>",
  "redirectPhoneNumber": "+5511912341234",
  "redirectExpiresAt": "2024-01-03T00:00:00Z"
}

Este endpoint permite que empresas criem números de telefone virtuais para uso em situações como o cadastro no WhatsApp Business.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
areaCode
number
required

Código de área (DDD) associado ao número virtual.

Required range: 11 <= x <= 99
Example:

11

​
redirectPhoneNumber
string
required

Número (incluindo DDD) para o qual serão encaminhadas as chamadas recebidas.

Example:

"11912341234"

​
identifier
string | null

Identificador do número virtual. Utilize para facilitar a gestão dos números virtuais.

Example:

"meu-número-virtual"

​
redirectExpiresAt
string

Data de expiração do redirecionamento de chamadas. Caso não seja informada, o redirecionamento terá validade de 72 horas.

Example:

"2024-01-03T00:00:00Z"

Response

200
application/json
​
id
string
required
Example:

"0140a8c6-3815-45b7-9e60-8e137cad845c"

​
identifier
string | null
required

Identificador do número virtual. Utilize para facilitar a gestão dos números virtuais.

Example:

"meu-número-virtual"

​
phoneNumber
string
required

Número virtual recém-criado, formatado conforme o padrão internacional E.164.

Example:

"+551151231234"

​
status
enum<string>
required
Available options:
active,
canceled
​
createdAt
string
required
​
canceledAt
string | null
required
​
cancelReason
string | null
required
​
redirectPhoneNumber
string
required

Número designado para receber chamadas direcionadas ao número virtual recém-criado, formatado conforme o padrão internacional E.164.

Example:

"+5511912341234"

​
redirectExpiresAt
string | null
required

Data de expiração do redirecionamento de chamadas.

Example:

"2024-01-03T00:00:00Z"