Sign in

v1

latestOpenAPI 3.1.02026-07-26160119.8 KB
Public API

Lista os números virtuais.

get/api/v2/virtual-phone-accounts

Response

idstring required

A valid UUID string, in any version.

namestring nullable required

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

phoneNumberstring required

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

status'pending' | 'active' | 'blocked' | 'canceled' required
createdAtstring date-time required
canceledAtstring date-time nullable required
cancelReasonstring nullable required
redirectPhoneNumberstring nullable required

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

redirectExpiresAtstring date-time nullable required

Data de expiração do redirecionamento de chamadas.

costCenterstring nullable required

Centro de custo associado ao número virtual.

employeeIdstring nullable required

A valid UUID string, in any version.

Example response

[
  {
    "id": "0140a8c6-3815-45b7-9e60-8e137cad845c",
    "name": "meu-número-virtual",
    "phoneNumber": "+551151231234",
    "redirectPhoneNumber": "+5511912341234",
    "redirectExpiresAt": "2024-01-03T00:00:00Z",
    "costCenter": "marketing",
    "employeeId": "0140a8c6-3815-45b7-9e60-8e137cad845c"
  }
]