Criar convite para chamadas de vídeo

Cria um link de convite para realização de uma chamada.

📌 Por que criar um convite?

Na Nuvidio, o convite é o ponto de partida mais importante para iniciarmos o atendimento com o cliente.

O convite funciona como um link único, exclusivo e temporário, permitindo que o cliente acesse a tela de atendimento, mesmo sem precisar se cadastrar ou preencher as suas informações de login.

Os convites possuem um identificador único e um tempo de expiração (o tempo de expiração é configurado pelo criador do convite), garantindo segurança e organização.
O cliente recebe um link direto para a videochamada, tornando a experiência ainda mais fácil e prática.
O convite é essencial para o funcionamento da videochamada.

🔗 Endpoint:

Método: POST

URL: https://api.nuvidio.com/v1/api/invite/department/:id

🔎 Parâmetros da URL:

Parâmetro	Tipo	Obrigatório	Descrição
:id	string	✅	Id do departamento

📦 Corpo da Requisição:

{
  "expirationDate": "2022-11-01T03:00:38.273Z",
  "initialDate": "2022-11-02T03:00:38.273Z",
  "push": true,
  "schedule": false,
  "callScriptId": "5f76e3d4b03f5d0012c279c7",
  "auditOverride": "audit",
  "customerData": [
    {
      "value": "Gustavo Alves Moreira",
      "label": "name"
    },
    {
      "value": "31975425803",
      "label": "tel"
    },
    {
      "value": "[email protected]",
      "label": "email"
    },
    {
      "value": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
      "label": "Imagem",
      "type": "image",
      "private": true
    },
    {
      "value": "data:application/pdf;base64,iVBORw0KGgoAAAANSUhEUgasAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAasSADWXZC12AO12",
      "label": "PDF",
      "type": "pdf",
      "private": true
    }
  ]
}

🔎 Parâmetros da Requisição:

Parâmetro	Tipo	Obrigatório	Descrição
expirationDate	date	❌	Data final de validade do link, se não for enviado será utilizado o tempo máximo de validade configurado no portal da empresa
initialDate	date	❌	Data inicial para que o link seja acessível, se não for enviado é utilizado a data atual
push	boolean	❌	Define se o cliente será redirecionado automaticamente para a fila de atendimento ao abrir o link
schedule	boolean	❌	Define se o link criado será para agendamento, caso true o link terá o formato "nuvidio.com/agendamento/:departamento" (default false)
customerData	Array	❌	Dados do cliente para que ele não precise preencher novamente ao entrar na chamada
customerData.label	number	❌	O label do campo cadastrado no formulário do departamento
customerData.value	string	❌	O valor do campo enviado, pode ser enviada uma string em formato Base64 ou um URL para anexar um arquivo de imagem
customerData.type	string	❌	Caso seja enviado um arquivo deve ser identificado o tipo desse arquivo para o tratamento correto do dado (valores válidos: 'image' e 'pdf')
customerData.private	boolean	❌	Identifica se o campo é uma informação sensível que deve ser exibida somente para o atendente e não para o cliente
callScriptId	string		Identificador do script da chamada que deve ser usado para fazer a análise da transcrição pelo agente de IA
auditOverride	string		Define se o convite será auditado ou não pelo agente de IA. Valores válidos: 'audit'(para habilitar auditoria) e 'not_audit'(para desabilitar auditoria)

✅ Resposta de Sucesso:

{
  "token": "e24fa83d-850f-4bbd-9baf-30b149d627dc",
  "shortLink": "https://nuvidio.me/XMOy8Y",
  "guestLink": "https://nuvidio.me/SK8sk8",
  "link": "https://nuvidio.com/nuvidio-gustavo?token=e24fa83d-850f-4bbd-9baf-30b149d627dc&push=true",
  "id": "63b74d6f41658a6c604219a1"
}

token: token único do convite
shortlink: link encurtado do convite
guestlink: link encurtado do convite para convidados
link: link completo da chamada
id: ID do convite

❌ Respostas de erro:

Código	Mensagem
`404`	Departamento não encontrado
`500`	Erro interno