Editar Configurações

Modifica as configurações das funcionalidades da plataforma.

📌 Por que editar as configurações?

Permite que sua empresa personalize e adapte o funcionamento da sua empresa na plataforma, adequando as configurações da forma que desejar.

Melhora o controle de horários.
Ajuste de configurações de comportamentos de notificações, etc.

🔗 Endpoint:

Método: PUT

URL: https://api.nuvidio.com/v1/api/company/configs

📦 Corpo da Requisição:

{
  "videoRoom": {
    "screenSharing": false,
    "textChat": true,
    "chatFiles": true,
    "notes": true
  },
  "allowMissedCalls": true,
  "blockAttendantAccessOutOfWorkingTime": true,
  "attendantAcessIPWhitelist": [],
  "hideQueuePosition": false,
  "whitelabel": {
    "icon": "/static/media/logo.9e5f6c6e.png",
    "favicon": "/static/media/favicon.ico"
  },
  "fabButton": {
    "buttonImage": "/static/media/logo.9e5f6c6e.png",
    "backgroundColor": "#201747",
    "imageBorderColor": "#2f1655",
    "font": "Segoe UI",
    "textColor": "#ffffff",
    "buttonSize": 1,
    "borderRadius": 40,
    "shadow": 3,
    "buttonText": "Botão",
    "horizontalDistance": 15,
    "verticalDistance": 15,
    "position": "right-bottom",
    "expandedMode": false
  },
  "privacyPolicy": {
    "required": true,
    "url": "https://www.exemplo.com/"
  },
  "storeBySector": true,
  "attendantPasswordResetSchedule": {
    "forceSecretReset": true,
    "daysToForceReset": 0
  }
}

🔎 Parâmetros da Requisição:

Property	Type	Required	Description
videoRoom.screenSharing	boolean	✅	Permite que seja executado o compartilhamento de tela durante a chamada
videoRoom.textChat	boolean	✅	Permite a utilização do chat de texto
videoRoom.notes	boolean	✅	Disponibiliza o campo de anotação para o atendente
videoRoom.chatFiles	boolean	✅	Permite o envio de arquivo através chat de texto
allowMissedCalls	boolean	✅	Exibe para os atendentes as chamadas perdidas dos departamentos que ele faz parte
blockAttendantAccessOutOfWorkingTime	boolean	✅	Restringe o acesso do atendente à plataforma apenas aos horários permitidos
attendantAcessIPWhitelist	[]	✅	Restringe o acesso do atendente à plataforma apenas através dos IPs informados
hideQueuePosition	boolean	✅	Exibe ou não a posição do cliente na fila
whitelabel	object	✅	Adiciona uma imagem e a favicon à tela de acesso do cliente
fabButton	object	❌	Permite a configuração de estilização do botão flutuante do widget. A propriedade `position` pode ser as seguintes entradas `left-top, right-top, left-bottom, right-bottom`
privacyPolicy	object	❌	Permite a configuração dos termos de privacidade, onde `required` torna obrigatório o aceite dos termos e `url` abre uma nova guia permitindo a leitura dos termos
attendantPasswordResetSchedule	object	❌	Obriga o atendente a trocar a senha ao primeiro acesso, quando a empresa gera uma nova senha ou em um determinado espaço de tempo. Ex.: A cada 90 dias

✅ Resposta de Sucesso:

 {
  "videoRoom": {
    "screenSharing": false,
    "textChat": true,
    "chatFiles": true,
    "notes": true
  },
  "allowMissedCalls": true,
  "blockAttendantAccessOutOfWorkingTime": true,
  "attendantAcessIPWhitelist": [],
  "hideQueuePosition": false,
  "whitelabel": {
    "icon": "/static/media/logo.9e5f6c6e.png",
    "favicon": "/static/media/favicon.ico"
  },
  "fabButton": {
    "buttonImage": "/static/media/logo.9e5f6c6e.png",
    "backgroundColor": "#201747",
    "imageBorderColor": "#2f1655",
    "font": "Segoe UI",
    "textColor": "#ffffff",
    "buttonSize": 1,
    "borderRadius": 40,
    "shadow": 3,
    "buttonText": "Botão",
    "horizontalDistance": 15,
    "verticalDistance": 15,
    "position": "right-bottom",
    "expandedMode": false
  },
  "privacyPolicy": {
    "required": true,
    "url": "https://www.exemplo.com/"
  },
  "storeBySector": true,
  "attendantPasswordResetSchedule": {
    "forceSecretReset": true,
    "daysToForceReset": 0
  }
}

❌ Respostas de erro:

Código	Mensagem
`404`	Empresa não encontrada
`500`	Erro interno