Skip to main content
POST
/
api
/
v2
/
virtual-phone-accounts
cURL
curl --request POST \
  --url https://api.salvy.com.br/api/v2/virtual-phone-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "areaCode": 11,
  "employeeId": "0140a8c6-3815-45b7-9e60-8e137cad845c",
  "name": "Meu Número Virtual",
  "costCenter": "marketing",
  "customFields": [
    {
      "label": "Departamento",
      "value": "Vendas"
    }
  ]
}
'
{
  "id": "0140a8c6-3815-45b7-9e60-8e137cad845c",
  "name": "Meu Número Virtual",
  "phoneNumber": "+551151231234",
  "status": "pending",
  "createdAt": "2023-11-07T05:31:56Z",
  "canceledAt": "2023-11-07T05:31:56Z",
  "cancelReason": "<string>",
  "costCenter": "marketing",
  "employeeId": "0140a8c6-3815-45b7-9e60-8e137cad845c",
  "customFields": [
    {
      "label": "<string>",
      "type": "text",
      "value": "<string>"
    }
  ]
}
Para utilizar nossas APIs e Webhooks de linhas virtuais, é necessário aderir ao nosso manual de branding
Este endpoint permite que empresas criem números de telefone virtuais para uso em situações como o cadastro no WhatsApp Business.
Recomendação: Antes de criar um número virtual, consulte o endpoint de listagem de DDDs disponíveis para verificar quais códigos de área estão em estoque. A disponibilidade pode variar ao longo do tempo.

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.

Example:

11

​
employeeId
string

ID do colaborador associado ao número virtual.

Example:

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

​
name
string | null

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

Example:

"Meu Número Virtual"

​
costCenter
string | null

Centro de custo associado ao número virtual.

Example:

"marketing"

​
customFields
object[]

Campos customizados associados ao número virtual. Labels inexistentes serão ignorados.

Example:
[
  {
    "label": "Departamento",
    "value": "Vendas"
  }
]

Response

​
id
string
required

A valid UUID string, in any version.

Examples:

"123e4567-e89b-12d3-a456-426614174000"

"123e4567-e89b-12d3-a456-426614174001"

​
name
string | null
required

Nome 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.

Examples:

"+5511999999999"

"+551139999999"

​
status
enum<string>
required
Available options:
pending,
active,
blocked,
canceled
​
createdAt
string<date-time>
required
​
canceledAt
string<date-time> | null
required
​
cancelReason
string | null
required
​
costCenter
string | null
required

Centro de custo associado ao número virtual.

Example:

"marketing"

​
employeeId
string | null
required

ID do colaborador associado ao número virtual.

Example:

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

​
customFields
object[]
required

Campos customizados associados ao número virtual.