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.

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"

employeeId
string

ID do colaborador associado ao número virtual.

Example:

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

identifier
string | null

Identificador 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"

redirectExpiresAt
string<datetime>

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

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

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

Response

id
string
required

A valid UUID string, in any version.

Examples:

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

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

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.

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
redirectPhoneNumber
string | null
required

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

Example:

"+5511999999999"

redirectExpiresAt
string<date-time> | null
required

Data de expiração do redirecionamento de chamadas.

Example:

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

costCenter
string | null
required

Centro de custo associado ao número virtual.

Example:

"marketing"