Skip to main content
POST
cURL
Para utilizar nossas APIs e Webhooks de linhas virtuais, é necessário aderir ao nosso manual de branding
Permite criar números de telefone virtuais para uso em serviços como a API Oficial META.
Recomendação: Antes de criar um número virtual, consulte a lista de DDDs disponíveis. A disponibilidade pode variar ao longo do tempo.
No sandbox, este endpoint sempre retorna o mesmo número de demonstração, independentemente do DDD informado.

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. Os campos devem ser criados previamente no dashboard da Salvy; labels inexistentes serão ignorados.

Example:

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.