Pular para o conteúdo principal

WorkspaceGroup

accounts object[]

A conta da agência (principal) vem primeiro; depois, um workspace por cliente.

  • Array [
  • idstring
    namestring
    statusstring
    principalboolean
    clientInvitesboolean
    createdAtstring<date-time>
    deletion objectnullable
    requestedAtstring<date-time>nullable
    scheduledAtstring<date-time>
    alerts object

    Números com qualidade amarela ou vermelha, e números inativos.

    lowQualityNumbersinteger
    inactiveNumbersinteger
    access object[]

    Quem da equipe recebeu acesso a este cliente.

  • Array [
  • userIdstring
    tenantRolestring
    allowedPhoneNumberIdsstring[]
  • ]
  • usage object

    O que a conta consumiu no período de cobrança corrente.

    periodstring

    Período de cobrança, AAAA-MM.

    connectedNumbersinteger
    contactsinteger
    messagesinteger
  • ]
  • team object[]

    As pessoas da equipe da agência que não são donas — as donas alcançam todos os clientes.

  • Array [
  • idstring
    namestringnullable
    emailstring
    tenantRolestring
  • ]
  • limitintegernullable

    Quantas contas a assinatura cobre, a da agência incluída: um workspace por número de WhatsApp que o plano permite (mais, se o plano disser). null = sem limite, num plano sem limite de números.

    usedinteger

    Quantas contas existem, a da agência incluída.

    enabledboolean

    Se criar workspaces está liberado na plataforma.

    WorkspaceGroup
    {
    "accounts": [
    {
    "id": "string",
    "name": "string",
    "status": "string",
    "principal": true,
    "clientInvites": true,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "deletion": {
    "requestedAt": "2024-07-29T15:51:28.071Z",
    "scheduledAt": "2024-07-29T15:51:28.071Z"
    },
    "alerts": {
    "lowQualityNumbers": 0,
    "inactiveNumbers": 0
    },
    "access": [
    {
    "userId": "string",
    "tenantRole": "string",
    "allowedPhoneNumberIds": [
    "string"
    ]
    }
    ],
    "usage": {
    "period": "string",
    "connectedNumbers": 0,
    "contacts": 0,
    "messages": 0
    }
    }
    ],
    "team": [
    {
    "id": "string",
    "name": "string",
    "email": "string",
    "tenantRole": "string"
    }
    ],
    "limit": 0,
    "used": 0,
    "enabled": true
    }