Nuvidio

https://docs.nuvidio.com
Admin
Nuvidio is a real-time video communication platform that enables companies to conduct sales and...
Tokens:164,065
Snippets:1,093
Trust Score:7.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Node.js Example for Text to Audio API

Source: https://docs.nuvidio.com/reference/texto-para-%C3%A1udio

Demonstrates how to call the Text to Audio API using Node.js. Ensure you have the necessary libraries installed.

```Node.js
const axios = require('axios');

const textToAudio = async (text, gender = 'female') => {
  try {
    const response = await axios.post('https://apigw.nuvidio.com/conversify/api/v1/text/audio/full', {
      text: text,
      gender: gender
    }, {
      headers: {
        'Content-Type': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error converting text to audio:', error.response ? error.response.data : error.message);
    throw error;
  }
};

// Example usage:
// textToAudio('Olá, este é um teste de conversão de texto para áudio.').then(audioData => {
//   console.log('Audio data received:', audioData);
// }).catch(err => {
//   console.error('Failed to get audio data.');
// });
```

--------------------------------

### Example Response for Token Creation

Source: https://docs.nuvidio.com/reference/api-nuvidio

This is an example of a successful response when creating an authentication token. The token is valid for 10 minutes.

```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3YzlkN2NlOWNlOTZmMmYyOTMwMWFmNiIsImlhdCI6MTc0MzUyMTk3MywiZXhwIjoxNzQzNTI1NTczfQ.W-JBnM4vxnYmojIL6yTIlhSoB-zrZCxON-ux6zFnYRY",
  "tokenExpiration": "2025-04-01T16:39:33.487Z"
}
```

--------------------------------

### Example Authorization Header with Bearer Token

Source: https://docs.nuvidio.com/reference/api-nuvidio

An example of how the authorization header should be formatted with a Bearer Token. Replace the example token with your actual generated token.

```json
"headers": {
... 
"authorization": "Bearer eyJhASOIPnsn998919IsInR5cCI6IkpXVCJ9.eyJpZCI6IjVmNOJSANNojan72179dn198&8Nu7McabnioB97BDcxNjk1OCwiZXhwIjoxNjk4NzE3NTU4fQ.hequWhG5OTvqOUsb18bsC9Ca0Nu81PanA95wnYk6HtG9zU"
...
}
```

--------------------------------

### Shell Example for Text to Audio API

Source: https://docs.nuvidio.com/reference/texto-para-%C3%A1udio

A basic example using `curl` to interact with the Text to Audio API. This demonstrates a direct HTTP request.

```Shell
curl -X POST https://apigw.nuvidio.com/conversify/api/v1/text/audio/full \
-H "Content-Type: application/json" \
-d '{ "text": "conteúdo a ser convertido em áudio", "gender": "male" }'
```

--------------------------------

### Ruby Example for Text to Audio API

Source: https://docs.nuvidio.com/reference/texto-para-%C3%A1udio

Provides a Ruby example for calling the Text to Audio API. This snippet uses the 'net/http' library.

```Ruby
require 'net/http'
require 'uri'
require 'json'

def text_to_audio(text, gender = 'female')
  uri = URI.parse('https://apigw.nuvidio.com/conversify/api/v1/text/audio/full')
  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = true

  request = Net::HTTP::Post.new(uri.request_uri)
  request['Content-Type'] = 'application/json'
  request.body = { text: text, gender: gender }.to_json

  response = http.request(request)

  if response.is_a?(Net::HTTPSuccess)
    JSON.parse(response.body)
  else
    puts "Error: #{response.code} #{response.message}"
    nil
  end
end

# Example usage:
# audio_data = text_to_audio('Olá, este é um teste de conversão de texto para áudio.')
# if audio_data
#   puts "Audio data received: #{audio_data}"
# else
#   puts "Failed to get audio data."
# end
```

--------------------------------

### Python Example for Text to Audio API

Source: https://docs.nuvidio.com/reference/texto-para-%C3%A1udio

Shows how to integrate with the Text to Audio API using Python. This example uses the 'requests' library.

```Python
import requests

def text_to_audio(text, gender='female'):
    url = "https://apigw.nuvidio.com/conversify/api/v1/text/audio/full"
    payload = {
        "text": text,
        "gender": gender
    }
    headers = {
        "Content-Type": "application/json"
    }
    try:
        response = requests.post(url, json=payload, headers=headers)
        response.raise_for_status()  # Raise an exception for bad status codes
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f"Error converting text to audio: {e}")
        return None

# Example usage:
# audio_data = text_to_audio("Olá, este é um teste de conversão de texto para áudio.")
# if audio_data:
#     print("Audio data received:", audio_data)
# else:
#     print("Failed to get audio data.")
```

--------------------------------

### PHP Example for Text to Audio API

Source: https://docs.nuvidio.com/reference/texto-para-%C3%A1udio

Illustrates how to use PHP to send a request to the Text to Audio API. This example uses cURL.

```PHP
<?php

function textToAudio($text, $gender = 'female') {
    $url = 'https://apigw.nuvidio.com/conversify/api/v1/text/audio/full';
    $data = json_encode(['text' => $text, 'gender' => $gender]);

    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Content-Type: application/json',
        'Content-Length: ' . strlen($data)
    ]);

    $response = curl_exec($ch);

    if (curl_errno($ch)) {
        echo 'Error:' . curl_error($ch);
        return null;
    }

    curl_close($ch);
    return json_decode($response, true);
}

// Example usage:
// $audioData = textToAudio('Olá, este é um teste de conversão de texto para áudio.', 'male');
// if ($audioData) {
//     print_r($audioData);
// } else {
//     echo 'Failed to get audio data.';
// }

?>
```

--------------------------------

### Create Invite with Multi Case - cURL Example

Source: https://docs.nuvidio.com/reference/criar-invite-com-multicase

Example of how to make a POST request to create an invite using cURL. Replace placeholders with actual values.

```shell
curl -X POST \
  https://apigw.nuvidio.com/video-agreement/api/v1/account/multicase/invite \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -d '{ 
    "availableAt": "2025-03-29T17:21:00.000",
    "expiresAt": "2025-03-29T17:21:00.000",
    "timezone": "America/Sao_Paulo",
    "customer": {
        "name": "Nome do Cliente",
        "email": "email@cliente.com",
        "phone": "+5511999999999"
    },
    "script": {
        "name": "Nome do Script",
        "version": "1.0.0",
        "fields": {
            "name": "Nome do Usuário",
            "age": "Idade do Usuário"
        },
        "journey": {
            "fields": {
                "name": "Nome do Usuário",
                "age": "Idade do Usuário"
            }
        }
    }
}'
```

--------------------------------

### Create Invite with Customer Fields

Source: https://docs.nuvidio.com/reference/multi-cases

This example shows how to include customer fields when creating an invite. Conditions can be based on these fields, such as 'age', to route the customer to different scripts like 'Empréstimo Consignado' or 'Empréstimo CLT'.

```json
"customer": {
    "cpf": "string",
    "fields": [
      {
        "label": "age",
        "value": "60",
        "private": false
      }
    ],
    "name": "string",
    "identificationImage": "string"
  }

```

--------------------------------

### Create Invite cURL Request

Source: https://docs.nuvidio.com/reference/invites

A cURL request example for creating a video-agreement invite. Ensure to replace placeholders with actual values.

```curl
curl --request POST \
     --url https://apigw.nuvidio.com/video-agreement/api/v1/account/invite \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

--------------------------------

### Base64 Encode/Decode Implementation Example

Source: https://docs.nuvidio.com/reference/api-nuvidio

This code snippet provides a basic implementation for encoding and decoding strings to/from Base64. You can use alternative implementations if preferred.

```javascript
function base64Encode(str) {
  return btoa(str);
}

function base64Decode(str) {
  return atob(str);
}

```

--------------------------------

### Create Invite with Multi Case - Request Body

Source: https://docs.nuvidio.com/reference/criar-invite-com-multicase

This is an example of the JSON payload required to create an invite. Ensure all required fields like 'expiresAt', 'customer', and 'script' are included.

```json
{
    "availableAt": "2025-03-29T17:21:00.000",
    "expiresAt": "2025-03-29T17:21:00.000",
    "timezone": "America/Sao_Paulo",
    "customer": {
        "name": "Nome do Cliente",
        "email": "email@cliente.com",
        "phone": "+5511999999999"
    },
    "script": {
        "name": "Nome do Script",
        "version": "1.0.0",
        "fields": {
            "name": "Nome do Usuário",
            "age": "Idade do Usuário"
        },
        "journey": {
            "fields": {
                "name": "Nome do Usuário",
                "age": "Idade do Usuário"
            }
        }
    }
}
```

--------------------------------

### GET Request to retrieve video agreement

Source: https://docs.nuvidio.com/reference/obter-v%C3%ADdeo-do-agreement

Use this cURL command to make a GET request to the video agreement API. Ensure you replace 'invite_id' with the actual invite ID.

```Shell
curl --request GET \
     --url https://apigw.nuvidio.com/video-agreement/api/v1/account/invite/invite_id/agreement/video \
     --header 'accept: application/json'
```

--------------------------------

### Get Company Data

Source: https://docs.nuvidio.com/reference/dados-da-empresa-1

Fetches all essential administrative and configuration data for the company.

```APIDOC
## GET /v1/api/company

### Description
Retrieves all company information, including contact details, configuration settings, and business hours.

### Method
GET

### Endpoint
https://api.nuvidio.com/v1/api/company

### Response
#### Success Response (200)
- **name** (string) - The company's name.
- **email** (string) - The company's contact email.
- **companyName** (string) - The official company name.
- **tel** (string) - The company's phone number.
- **cnpj** (string) - The company's CNPJ number.
- **style** (object) - Styling configurations for the company's appearance.
  - **logo** (string) - URL of the company logo.
  - **borderRadius** (integer) - Border radius for UI elements.
  - **font** (string) - Default font family.
  - **fontSize** (integer) - Default font size.
  - **textColor** (string) - Default text color.
  - **colors** (object) - Color palette.
    - **primary** (string) - Primary color.
    - **secondary** (string) - Secondary color.
    - **background** (string) - Background color.
- **configs** (object) - Various configuration settings.
  - **videoRoom** (object) - Video room settings.
    - **screenSharing** (boolean) - Whether screen sharing is enabled.
    - **textChat** (boolean) - Whether text chat is enabled.
    - **chatFiles** (boolean) - Whether file sharing in chat is enabled.
    - **notes** (boolean) - Whether notes feature is enabled.
  - **allowMissedCalls** (boolean) - Whether missed calls are allowed.
  - **blockAttendantAccessOutOfWorkingTime** (boolean) - Whether to block attendant access outside working hours.
  - **attendantAcessIPWhitelist** (array) - List of allowed IP addresses for attendant access.
  - **hideQueuePosition** (boolean) - Whether to hide the queue position.
  - **whitelabel** (object) - Whitelabel specific configurations.
    - **icon** (string) - URL of the whitelabel icon.
    - **favicon** (string) - URL of the whitelabel favicon.
  - **fabButton** (object) - Floating action button configuration.
    - **buttonImage** (string) - Image for the button.
    - **backgroundColor** (string) - Background color of the button.
    - **imageBorderColor** (string) - Border color of the button image.
    - **font** (string) - Font family for button text.
    - **textColor** (string) - Text color of the button.
    - **buttonSize** (integer) - Size of the button.
    - **borderRadius** (integer) - Border radius of the button.
    - **shadow** (integer) - Shadow intensity of the button.
    - **buttonText** (string) - Text displayed on the button.
    - **horizontalDistance** (integer) - Horizontal distance from the edge.
    - **verticalDistance** (integer) - Vertical distance from the edge.
    - **position** (string) - Position of the button (e.g., 'right-bottom').
    - **expandedMode** (boolean) - Whether the button is in expanded mode.
  - **privacyPolicy** (object) - Privacy policy settings.
    - **required** (boolean) - Whether the privacy policy is required.
    - **url** (string) - URL of the privacy policy.
  - **storeBySector** (boolean) - Whether to store data by sector.
  - **attendantPasswordResetSchedule** (object) - Attendant password reset schedule.
    - **forceSecretReset** (boolean) - Whether to force secret reset.
    - **daysToForceReset** (integer) - Number of days to force reset.
- **hooks** (array) - List of configured hooks.
- **apiKeys** (array) - List of API keys.
  - **apiKey** (string) - The API key.
  - **createdAt** (string) - Timestamp when the API key was created.
  - **usedAt** (string) - Timestamp when the API key was last used.
- **businessTimePatterns** (array) - Patterns for business hours.
  - **name** (string) - Name of the business time pattern.
  - **behindScheduleText** (string) - Text to display when outside business hours.
  - **businessTime** (object) - Defines the opening and closing times for each day.
    - **sunday** (array) - Sunday's business hours.
      - **opening** (integer) - Opening time in minutes from midnight.
      - **closing** (integer) - Closing time in minutes from midnight.
    - **monday** (array) - Monday's business hours.
      - **opening** (integer) - Opening time in minutes from midnight.
      - **closing** (integer) - Closing time in minutes from midnight.
    - **tuesday** (array) - Tuesday's business hours.
      - **opening** (integer) - Opening time in minutes from midnight.
      - **closing** (integer) - Closing time in minutes from midnight.
    - **wednesday** (array) - Wednesday's business hours.
      - **opening** (integer) - Opening time in minutes from midnight.
      - **closing** (integer) - Closing time in minutes from midnight.
    - **thursday** (array) - Thursday's business hours.
      - **opening** (integer) - Opening time in minutes from midnight.
      - **closing** (integer) - Closing time in minutes from midnight.
    - **friday** (array) - Friday's business hours.
      - **opening** (integer) - Opening time in minutes from midnight.
      - **closing** (integer) - Closing time in minutes from midnight.
    - **saturday** (array) - Saturday's business hours.
      - **opening** (integer) - Opening time in minutes from midnight.
      - **closing** (integer) - Closing time in minutes from midnight.
    - **timezone** (array) - Timezone information.
      - **opening** (integer) - Opening time in minutes from midnight.
      - **closing** (integer) - Closing time in minutes from midnight.

### Response Example
```json
{
    "name": "NuVidio",
    "email": "empresa@nuvidio.com.br",
    "companyName": "NuVidio",
    "tel": "31999999999",
    "cnpj": "-",
    "style": {
      "logo": "https://site.com/logo.png",
      "borderRadius": 10,
      "font": "Segoe UI",
      "fontSize": 12,
      "textColor": "#ffffff",
      "colors": {
        "primary": "#ffffff",
        "secondary": "#ffffff",
        "background": "#ffffff"
      }
    },
    "configs": {
      "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
      }
    },
    "hooks": [],
    "apiKeys": [
        {
            "apiKey": "----",
            "createdAt": "2030-07-26T03:40:56.237Z",
            "usedAt": "2030-08-10T20:40:34.023Z"
        }
    ],
    "businessTimePatterns": [{
      "name": "",
      "behindScheduleText": "",
      "businessTime": {
        "sunday": [{
          "opening": 660,
          "closing": 690
        }],
        "monday": [{
          "opening": 660,
          "closing": 690
        }],
        "tuesday": [{
          "opening": 660,
          "closing": 690
        }],
        "wednesday": [{
          "opening": 660,
          "closing": 690
        }],
        "thursday": [{
          "opening": 660,
          "closing": 690
        }],
        "friday": [{
          "opening": 660,
          "closing": 690
        }],
        "saturday": [{
          "opening": 660,
          "closing": 690
        }],
        "timezone": [{
          "opening": 660,
          "closing": 690
        }]
      }
    }]
}
```

### Error Handling
- **404**: Company not found
- **500**: Internal server error
```

--------------------------------

### Listar Clientes - Resposta de Sucesso

Source: https://docs.nuvidio.com/reference/clientes-3

Exibe a estrutura JSON de uma resposta de sucesso ao listar clientes. Inclui a contagem total de clientes e uma lista de objetos de cliente, cada um com detalhes como id, nome, email, telefone e data de atualização.

```json
{
    "count": 2,
    "customers": [
        {
            "id": "60fffd1baad3a3469b9db719",
            "name": "João Luiz",
            "email": "joao@mail.com",
            "tel": "3199999999",
            "updatedAt": "2021-07-27T12:33:31.227Z"
        },
        {
            "id": "60fffd1baad3a3469b9db719",
            "name": "Pedro Lucas",
            "email": "pedro@mail.com",
            "tel": "3199999999",
            "updatedAt": "2021-07-27T12:33:31.227Z"
        }
    ]
}
```

--------------------------------

### Configuração de Fluxo Multicase com Alternativas

Source: https://docs.nuvidio.com/reference/como-funciona-o-multicase

Detalha como configurar fluxos alternativos em convites multicase, tanto quando há condições definidas quanto quando não há. Explica o papel de `alternativePaths` e `scriptReference`.

```APIDOC
## Fluxo Multicase com `alternativePaths`

### Description
Quando `alternativePaths` é informado em uma transição, o script entra em modo multicase. Isso permite que o fluxo siga para mensagens de outros scripts associados ao convite.

### Comportamento sem `conditions`
Se `alternativePaths` existe mas a lista de `conditions` está vazia, o fluxo prossegue para **todas** as mensagens dos scripts listados em `script.cases`, na ordem em que aparecem.

### Comportamento com `conditions`
Cada condição na lista pode conter:
- **`path`**: Onde buscar o valor para comparação.
- **`operator`**: O operador de comparação a ser usado.
- **`value`**: O valor esperado para a comparação (se aplicável).
- **`scriptReference`**: Referência ao script a ser seguido se a condição for atendida. Se omitido, o sistema pode seguir para todos os caminhos possíveis que satisfaçam a condição.
```

--------------------------------

### Success Response Example

Source: https://docs.nuvidio.com/reference/listar-todos-os-atendentes-que-n%C3%A3o-est%C3%A3o-em-um-departamento-1

This JSON structure represents a successful response, detailing the count of attendants not in a department and their information.

```json
{
  "count": 1,
  "attendants": [
    {
      "id": "5cbf4af789f1821f8c12e350",
      "name": "João",
      "email": "joao@1003apps.com",
      "lastName": "Luiz",
      "timezone": 180,
      "identifier": "nuvidio-atendimento",
      "profilePhoto": "https://site.com.br/profile-default.jpg",
      "departmentsCount": 4
    }
  ]
}
```

--------------------------------

### Exemplo de Resposta de Sucesso

Source: https://docs.nuvidio.com/reference/buscar-um-atendente-1

Este é um exemplo da estrutura de dados retornada quando um atendente é encontrado com sucesso. Contém informações detalhadas sobre o atendente.

```json
{
    "id": "5cbf4af789f1821f8c12e350",
    "name": "João",
    "email": "joao@nuvidio.com.br",
    "lastName": "Luiz",
    "timezone": 180,
    "identifier": "joao.company.comercial",
    "profilePhoto": "https://site.com.br/profile-default.jpg",
    "businessTime": {
      "timezone":  -3,
      "sunday": [{"opening":  0, "closing":  1439}],
      "monday": [{"opening":  0, "closing":  1439}],
      "tuesday": [{"opening":  0, "closing":  1439}],
      "wednesday": [{"opening":  0, "closing":  1439}],
      "thursday": [{"opening":  0, "closing":  1439}],
      "friday": [{"opening":  0, "closing":  1439}],
      "saturday": [{"opening":  0, "closing":  1439}]
    },
    "createdAt": "2021-07-00T09:12:00.000Z",
    "updatedAt": "2021-07-27T13:39:33.035Z",
    "callsCount": 424,
    "departmentsCount": 4
}
```

--------------------------------

### iOS Webview WKWebView Implementation

Source: https://docs.nuvidio.com/docs/integra%C3%A7%C3%A3o-webview

Basic setup for WKWebView in a ViewController to load a URL. JavaScript is enabled by default.

```swift
import UIKit
import WebKit
class ViewController: UIViewController, WKUIDelegate {

var webView: WKWebView!

override func viewDidLoad() {
    super.viewDidLoad()
    
    let myURL = URL(string:"https://www.apple.com")
    let myRequest = URLRequest(url: myURL!)
    let preferences = WKPreferences()
    let configuration = WKWebViewConfiguration()

    preferences.javaScriptEnabled = true
    preferences.allowsInlineMediaPlayback = true
    preferences.mediaTypesRequiringUserActionForPlayback = .all
    preferences.contentInsetAdjustmentBehavior = .never

    configuration.preferences = preferences
    webView = WKWebView(frame: view.bounds, configuration: configuration)
    webView.scrollView.alwaysBounceVertical = false;
    webView.scrollView.bounces = false;
    view.addSubview(webView)

    webView.load(myRequest)
}}
```

--------------------------------

### Date Format Example

Source: https://docs.nuvidio.com/reference/criar-invite-com-multicase

The expected date format is ISO 8601 extended with milliseconds. Use YYYY-MM-DDTHH:mm:ss.SSS.

```text
YYYY-MM-DDTHH:mm:ss.SSS
```

--------------------------------

### Exemplo de Resposta de Sucesso - Listar Setores

Source: https://docs.nuvidio.com/reference/listar-setores-1

Este JSON demonstra a estrutura de uma resposta de sucesso ao listar setores. Inclui a contagem total de setores e uma lista dos setores encontrados com seus detalhes.

```json
{
  "count": 1,
  "sectors": [
    {
      "id": "6111bc701b782146a4e9b16f",
      "name": "Telemarket",
      "description": "Setor de telemarket",
      "configs":null,
      "company": "6111bc701b782146a4e9b16f"
    }
  ]
}
```

--------------------------------

### Configure Iframe for Integration

Source: https://docs.nuvidio.com/reference/integra%C3%A7%C3%A3o-via-iframe-frontend-copy

Set up the Iframe with necessary permissions and sandbox attributes for secure and functional integration. Ensure the `src` attribute points to the correct service URL.

```html
<iframe 
	allow="camera; microphone; geolocation; display-capture"
	sandbox="allow-scripts allow-same-origin allow-forms allow-popups"
	src="https://nuvidio.ai/:companySlug/invite/:inviteId" // ou o short link gerado na criação do invite
	allowfullscreen
/>
```

--------------------------------

### Valid RFC3339 Date Formats

Source: https://docs.nuvidio.com/reference/invites

Examples of valid date formats adhering to RFC3339, including UTC and timezone offsets, with and without milliseconds.

```text
2025-03-29T17:21:00Z                    (UTC)
2025-03-29T17:21:00-03:00              (horário de Brasília)
2025-03-29T17:21:00.000Z               (com milissegundos)
2025-03-29T17:21:00.000-03:00          (com milissegundos e timezone)
```

--------------------------------

### Exemplo de Resposta JSON para Buscar Departamento

Source: https://docs.nuvidio.com/reference/buscar-um-departamento-1

Este é um exemplo da estrutura de dados retornada ao buscar um departamento específico. Contém informações detalhadas sobre o departamento, configurações de estilo, horários de funcionamento e dados da empresa associada.

```json
{
  "identifier": "nuvidio-department",
  "id": "5f71281d112758f7d019c7c4",
  "name": "Departamento",
  "type": 1,
  "businessTime": {
    "timezone": -3,
    "sunday": [
      {
        "opening": 0,
        "closing": 1439
      }
    ]
  },
  "priority": 1,
  "disabled": false,
  "disabledContent": {
    "title": "Estamos fora do ar",
    "message": "Nesse momento não estamos atendendo por vídeo. Se quiser falar com a g...",
    "action": {
      "link": "https://www.nuvidio.com.br",
      "text": "Clique para acessar"
    }
  },
  "style": {
    "logo": "https://www.nuvidio.com.br/wp-content/uploads/2020/06/nuvidio_horizontal_positivo-768x324.png",
    "colors": {
      "primary": "#bcb3b3",
      "secondary": "#ff9500",
      "background": "#ff9500"
    },
    "videos": {
      "intro": "https://youtube.com/watch?v=ase231S12df",
      "queue": "https://youtube.com/watch?v=ase231S12df"
    },
    "font": "Segoe UI",
    "fontSize": 10,
    "borderRadius": 10,
    "textColor": "#ff9500"
  },
  "callsCount": 147,
  "attendantsCount": 1,
  "createdAt": "2020-09-27T01:05:02.172Z",
  "updatedAt": "2021-07-26T03:52:12.852Z",
  "companyStyle": {
    "logo": "https://site.com.br/logo.png",
    "colors": {
      "primary": "#e71e77",
      "secondary": "#201747",
      "background": "#e71e77"
    },
    "font": "Segoe UI",
    "fontSize": 10,
    "borderRadius": 10,
    "textColor": "#ff9500"
  },
  "companySettings": {
    "fabButton": {
      "enabled": true,
      "styleEnabled": true,
      "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
    }
  },
  "form": [],
  "settings": {
    "scheduleConfigs": {
      "behindScheduleText": "Não estamos atendimento no momento1"
    },
    "formHeader": "Olá tudo bem, digite abaixo seus dados (lembrando que todos seus dados...",
    "formButton": "Vídeo Atendimento",
    "privacyPolicy": {
      "required": true,
      "url": "https://termos.com/termosdeprivacidade1"
    },
    "attendantBackground": {
      "blurEnabled": true
    },
    "fabButton": {
      "font": "Helvetica Neue, Helvetica, Arial, sans-serif",
      "backgroundColor": "#ffffff",
      "borderRadius": 40,
      "buttonImage": "/static/media/logo.9e5f6c6e.png",
      "buttonSize": 2,
      "buttonText": "VIDEO ATENDIMENTO",
      "horizontalDistance": 18,
      "verticalDistance": 18,
      "imageBorderColor": "#ffffff",
      "position": "right-bottom",
      "shadow": 3,
      "textColor": "#000000",
      "expandedMode": true
    },
    "queueConfigs": {
      "title": "Logo logo vamos atender",
      "permanentText": "aaaa"
    },
    "hideQueuePosition": true,
    "ratingsConfigs": {
      "ratingMode": "nps-emoji",
      "title": "aaaaaa",
      "showProtocol": true,
      "thanksText": {
        "title": "aaaaa",
        "subTitle": "aaaaa"
      },
      "destinationUrl": "https://"
    },
    "showAccessLink": false,
    "blockDirectLink": false,
    "allowMissedCalls": true,
    "blockWorkOvertime": true,
    "formConfigs": {
      "formHeader": "Olá tudo bem, digite abaixo seus dados (lembrando que todos seus dados...",
      "formButton": "Vídeo atendimento",
    },
    "record": "full"
  },
  "recordAllowed": true,
  "address": {
    "location": {
      "types": "Point",
      "coordinates": [
        -19.814294,
        -44.0129921
      ]
    },
    "line1": "Av. Amazonas - 200, Centro",
    "line2": "Apt. 500",
    "district": "Centro",
    "city": "Belo Horizonte",
    "state": "MG",
    "countryCode": "BR",
    "postalCode": "30120050"
  },
  "sector": "5f71281d112758f7d019c7c4"
}
```

--------------------------------

### Flutter WebView Implementation

Source: https://docs.nuvidio.com/docs/integra%C3%A7%C3%A3o-webview

Set up a WebView in a Flutter application. This example initializes the Android WebView platform and configures basic settings for the WebView.

```dart
 import 'dart:io';

 import 'package:webview_flutter/webview_flutter.dart';

 class WebViewExample extends StatefulWidget {
   @override
   WebViewExampleState createState() => WebViewExampleState();
 }

 class WebViewExampleState extends State<WebViewExample> {
   @override
   void initState() {
     super.initState();     
     if (Platform.isAndroid) WebView.platform = AndroidWebView();
   }

   @override
   Widget build(BuildContext context) {
     return WebView(
       initialUrl: 'https://flutter.dev',
       javascriptMode: JavascriptMode.enabled,
       initialMediaPlaybackPolicy: AutoMediaPlaybackPolicy.always_allow,
      allowsInlineMediaPlayback: true,
     );
   }
 }
```

--------------------------------

### Exemplo de Resposta de Sucesso

Source: https://docs.nuvidio.com/reference/listar-atendentes-de-um-departamento

Esta é uma resposta de exemplo para a listagem de atendentes de um departamento. Inclui a contagem total de atendentes e uma lista dos atendentes encontrados.

```json
{
    "count": 1,
    "attendants": [
        {
            "id": "5cb6490584f3022388480647",
            "name": "João",
            "email": "joao@nuvidio.com.br",
            "lastName": "Luiz",
            "identifier": "nuvidio-teste",
            "profilePhoto": "https://site.com.br/joao-perfil.jpg"
        }
    ]
}
```

--------------------------------

### Exemplo de Requisição Python

Source: https://docs.nuvidio.com/reference/atendentes-1

Exemplo de como realizar a requisição para o endpoint de login transparente do atendente usando Python com a biblioteca 'requests'.

```python
import requests

url = "https://api.nuvidio.com/v1/api/attendant/single-sign-on"
headers = {
    "Content-Type": "application/json"
}
data = {
    "email": "email@example.com"
}

response = requests.post(url, headers=headers, json=data)

print(response.json())
```

--------------------------------

### Text to Audio API Request Body (Multipart Form Data)

Source: https://docs.nuvidio.com/reference/texto-para-%C3%A1udio

Example of sending data using multipart/form-data for the Text to Audio API. This is an alternative to JSON.

```HTTP
POST /conversify/api/v1/text/audio/full HTTP/1.1
Host: apigw.nuvidio.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data;

text=conteúdo a ser convertido em áudio
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data;

gender=female
------WebKitFormBoundary7MA4YWxkTrZu0gW--
```
Tokens:
Raw