Skip to main content
GET
cURL
Para utilizar nossas APIs e Webhooks de linhas virtuais, é necessário aderir ao nosso manual de branding
Este endpoint permite que empresas listem os números virtuais criados.

Authorizations

Authorization
string
header
required

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

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"