Envia uma notificação via SMS com o link para acesso a vídeo chamada
📌 Por que enviar notificação de convite via SMS?
Enviar notificações via SMS é uma forma rápida e concreta de garantir que o cliente irá receber todas as informações necessárias do convite.
- Não necessita de internet para o envio.
- Acesso fácil ao link via celular.
🔗 Endpoint:
Método: POST
URL: https://api.nuvidio.com/v1/api/invite/sms
📦 Corpo da Requisição:
{
"phone": "5531999999999",
"id": "64c2c8cf165f63af8fd386b1",
"validateIsInviteActive": true
}
- phone: número do telefone do cliente
- id: id do convite
- validateIsInviteActive: valida se convite está ativo
🔎 Parâmetros da Requisição:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| phone | string | ✅ | Telefone para onde será enviada a notificação |
| validateIsInviteActive | boolean | - | Ao enviar essa opção validaremos se o convite ainda é utilizável antes de enviar a notificação (desabilitado, expirado, utilizado) |
| id* | string | - | Identificar único do convite |
| token* | string | - | Token único do convite |
| url* | string | - | URL de acesso à vídeo chamada vinculada ao convite |
É obrigatório informar pelo menos uma das três opções:
id,tokenouurl.
✅ Resposta de Sucesso:
202 - Accepted
❌ Respostas de erro:
| Código | Mensagem |
|---|---|
400 | Convite inutilizável, por isso não é possível notificar o cliente. |
403 | Funcionalidade não habilitada |
404 | Convite não encontrado |
422 | Algum dado está inválido (campo obrigatório faltando ou tipo incorreto) |
500 | Erro interno |