Retorna a lista de convites já gerados.
📌 Por que listar convites?
Essa funcionalidade permite que a empresa rastreie todos os convites criados para chamadas de vídeo, possibilitando uma maior facilidade de gerenciamento, rastreamento e auditoria dos atendimentos realizados.
🔗 Endpoint:
Método: GET
URL: https://api.nuvidio.com/v1/api/invites
🔎 Parâmetros da Requisição:
Parâmetro | Padrão | Tipo | Obrigatório |
---|---|---|---|
take | 10 | number | ❌ |
page | 1 | number | ❌ |
search | - | string | ❌ |
✅ Resposta de Sucesso:
{
"invites": [
{
"id": "6473f9f96582b85611b26128",
"title": "Exemplo - Departamento",
"start": "2023-05-26T18:10:54.790Z",
"expiration": "2023-05-27T18:10:54.790Z",
"used": true,
"usedAt": [
"2023-05-26T18:12:03.669Z"
],
"customerData": [
{
"_id": "6473f9f96582b89bfcb26129",
"value": "Exemplo",
"label": "name"
},
{
"_id": "6473f9f96582b8be23b2612a",
"value": "[email protected]",
"label": "email"
}
],
"token": "e515cdb9-1775-4578-8879-23279c759214",
"type": "access-link",
"canceled": false,
"accessed": true,
"calls": [
"6470f68402334be45fb9c502"
],
"createdAt": "2023-05-26T18:10:54.793Z",
"isEnabled": true
}
],
"count": 314
}
id
: ID do convitetitle
: nome do convitestart
: inicio do conviteexpiration
: data de expiração do conviteused
: true = convite utilizado, false = convite não utilizadousedAt
: data em que o convite foi utilizado
❌ Respostas de erro:
Código | Mensagem |
---|---|
500 | Erro interno |