Conversación del grupo
Mensajes entre los participantes de un grupo.
Lista las conversaciones de grupo de la persona
GET /me/conversas
Acceso: Cualquier persona autenticada. Estado de éxito: 200.
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
items | lista de MinhaConversa | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/me/conversas" -H "Authorization: Bearer $TOKEN"Lista los mensajes de la conversación del grupo
GET /turmas/{turmaId}/conversa
Acceso: Cualquier persona autenticada. Estado de éxito: 200.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
turmaId | string (uuid) | sí | Id del grupo. |
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
antes | string | no | a 200 caracteres; ^[A-Za-z0-9_-]+$ | Cursor: devuelve mensajes anteriores a él. |
depois | string | no | a 200 caracteres; ^[A-Za-z0-9_-]+$ | Cursor: devuelve mensajes posteriores a él. |
alteradasDesde | string (date-time) | no | Instante (agora de la lectura anterior): devuelve solo lo que cambió desde entonces. | |
limite | integer | no | 1…100; por defecto: 50 | Cuántos elementos por página (1 a 200; el valor predeterminado varía por ruta, en general 50). |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
turma | object | sí | ||
turma.id | string (uuid) | sí | ||
turma.nome | string | sí | ||
turma.disciplinaNome | string | sí | ||
turma.ativa | boolean | sí | ||
itens | lista de MensagemDto | sí | Del más antiguo al más nuevo. | |
anteriores | string o nulo | sí | Cursor para buscar las anteriores; nulo = se llegó al principio. | |
podeEscrever | boolean | sí | ||
podeModerar | boolean | sí | ||
alteradas | lista de MensagemDto | sí | Mensajes editados o eliminados desde alteradasDesde (para consulta periódica): el cliente reemplaza las que ya tiene. | |
agora | string | sí | Reloj del servidor en el momento de la lectura (úselo en el próximo alteradasDesde). |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/turmas/{turmaId}/conversa" -H "Authorization: Bearer $TOKEN"Envía un mensaje a la conversación del grupo
POST /turmas/{turmaId}/conversa/mensagens
Acceso: Cualquier persona autenticada. Límite: hasta 60 llamadas cada 60 s por origen. Estado de éxito: 201.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
turmaId | string (uuid) | sí | Id del grupo. |
Cuerpo de la solicitud (MensagemTexto)
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
texto | string | sí | 1–2000 caracteres |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
id | string (uuid) | sí | ||
turmaId | string (uuid) | sí | ||
autor | object o nulo | sí | Nulo cuando el autor eliminó la cuenta. | |
autor.id | string (uuid) | sí | ||
autor.nome | string | sí | ||
texto | string o nulo | sí | Nulo cuando el mensaje fue eliminado (el texto se borra al eliminarlo). | |
criadaEm | string | sí | ||
editadaEm | string o nulo | sí | ||
removida | boolean | sí | ||
removidaPorModeracao | boolean | sí | Eliminado por quien modera (y no por el autor). | |
cursor | string | sí | Cursor de este mensaje (úselo en depois o antes). |
En caso de error: modelo ErroApi.
Ejemplo
curl -X POST "$API/turmas/{turmaId}/conversa/mensagens" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"texto":"texto"}'Elimina un mensaje
DELETE /turmas/{turmaId}/conversa/mensagens/{mensagemId}
Acceso: Cualquier persona autenticada. Estado de éxito: 200.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
mensagemId | string (uuid) | sí | Id del mensaje. | |
turmaId | string (uuid) | sí | Id del grupo. |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
id | string (uuid) | sí | ||
turmaId | string (uuid) | sí | ||
autor | object o nulo | sí | Nulo cuando el autor eliminó la cuenta. | |
autor.id | string (uuid) | sí | ||
autor.nome | string | sí | ||
texto | string o nulo | sí | Nulo cuando el mensaje fue eliminado (el texto se borra al eliminarlo). | |
criadaEm | string | sí | ||
editadaEm | string o nulo | sí | ||
removida | boolean | sí | ||
removidaPorModeracao | boolean | sí | Eliminado por quien modera (y no por el autor). | |
cursor | string | sí | Cursor de este mensaje (úselo en depois o antes). |
En caso de error: modelo ErroApi.
Ejemplo
curl -X DELETE "$API/turmas/{turmaId}/conversa/mensagens/{mensagemId}" -H "Authorization: Bearer $TOKEN"Edita un mensaje
PATCH /turmas/{turmaId}/conversa/mensagens/{mensagemId}
Acceso: Cualquier persona autenticada. Límite: hasta 60 llamadas cada 60 s por origen. Estado de éxito: 200.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
mensagemId | string (uuid) | sí | Id del mensaje. | |
turmaId | string (uuid) | sí | Id del grupo. |
Cuerpo de la solicitud (MensagemTexto)
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
texto | string | sí | 1–2000 caracteres |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
id | string (uuid) | sí | ||
turmaId | string (uuid) | sí | ||
autor | object o nulo | sí | Nulo cuando el autor eliminó la cuenta. | |
autor.id | string (uuid) | sí | ||
autor.nome | string | sí | ||
texto | string o nulo | sí | Nulo cuando el mensaje fue eliminado (el texto se borra al eliminarlo). | |
criadaEm | string | sí | ||
editadaEm | string o nulo | sí | ||
removida | boolean | sí | ||
removidaPorModeracao | boolean | sí | Eliminado por quien modera (y no por el autor). | |
cursor | string | sí | Cursor de este mensaje (úselo en depois o antes). |
En caso de error: modelo ErroApi.
Ejemplo
curl -X PATCH "$API/turmas/{turmaId}/conversa/mensagens/{mensagemId}" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"texto":"texto"}'