Chat

O Chat e ChatMessages representam, respectivamente, uma conversa entre dois usuários e suas mensagens. Atualmente é possível, apenas, visualizar estes recursos através da API. A possibilidade de criação e remoção de mensagens de chat, bem como streaming das mesmas está disponível em breve.
Chat
GET /api/users/:id/chats
Retorna todos os chats do usuário em questão.
Autorização
É necessário ter poder de gerenciamento do usuário.
Parâmetros
Parâmetro | Descrição | Restrições |
---|---|---|
id | ID ou login do usuário | N/A |
Exemplo
Requisição:
GET /api/users/guiocavalcanti/chats12
Resposta:
[ {
"links": [
{
"rel": "self",
"href": "http://redu.com.br/api/chats/1475"
},
{
"rel": "user",
"href": "http://redu.com.br/api/users/guiocavalcanti"
},
{
"rel": "contact",
"href": "http://redu.com.br/api/users/tiago"
},
{
"rel": "chat_messages",
"href": "http://redu.com.br/api/chats/1475/chat_messages"
}
],
"id": 1475,
"created_at": "2012-09-19T15:29:13-03:00",
"updated_at": "2012-09-19T15:29:13-03:00"
},
{
"links": [
{
"rel": "self",
"href": "http://redu.com.br/api/chats/1477"
},
{
"rel": "user",
"href": "http://redu.com.br/api/users/guiocavalcanti"
},
{
"rel": "contact",
"href": "http://redu.com.br/api/users/test_user"
},
{
"rel": "chat_messages",
"href": "http://redu.com.br/api/chats/1477/chat_messages"
}
],
"id": 1477,
"created_at": "2012-09-19T15:29:13-03:00",
"updated_at": "2012-09-19T15:29:13-03:00"
} ]
GET /api/chats/:id
Retorna o chat em questão. O recurso Chat contém todas as mensagens trocadas entre dois usuários utilizando o sistema de chat do Redu.
Autorização
É necessário ser participante do chat para visualizar este recurso.
Parâmetros
Parâmetro | Descrição | Restrições |
---|---|---|
id | ID do chat | N/A |
Exemplo
Requisição:
GET /api/chats/1475
Resposta:
{
"links": [
{
"rel": "self",
"href": "http://redu.com.br/api/chats/1475"
},
{
"rel": "user",
"href": "http://redu.com.br/api/users/guiocavalcanti"
},
{
"rel": "contact",
"href": "http://127.0.0.1:3000/api/users/tiago"
},
{
"rel": "chat_messages",
"href": "http://127.0.0.1:3000/api/chats/1475/chat_messages"
}
],
"id": 1475,
"created_at": "2012-09-19T15:29:13-03:00",
"updated_at": "2012-09-19T15:29:13-03:00"
}
Chat message
GET /api/chats/:id/chat_messages
Retorna todas as mensagens contidas num chat.
Autorização
É necessário ser participante do chat para visualizar este recurso.
Parâmetros
Parâmetro | Descrição | Restrições |
---|---|---|
id | ID do chat | N/A |
Exemplo
Requisição:
GET /api/chats/1475/chat_messages
Resposta:
[
{
"links": [
{
"rel": "self",
"href": "http://127.0.0.1:3000/api/chat_messages/16"
},
{
"rel": "user",
"href": "http://127.0.0.1:3000/api/users/guiocavalcanti"
},
{
"rel": "contact",
"href": "http://127.0.0.1:3000/api/users/tiago"
},
{
"rel": "sender_chat",
"href": "http://127.0.0.1:3000/api/chats/1475"
},
{
"rel": "receiver_chat",
"href": "http://127.0.0.1:3000/api/chats/1476"
}
],
"id": 16,
"created_at": "2011-06-29T13:15:18-03:00",
"message": "Opa!",
"updated_at": "2011-06-29T13:15:18-03:00"
},
{
"links": [
{
"rel": "self",
"href": "http://127.0.0.1:3000/api/chat_messages/34"
},
{
"rel": "user",
"href": "http://127.0.0.1:3000/api/users/guiocavalcanti"
},
{
"rel": "contact",
"href": "http://127.0.0.1:3000/api/users/tiago"
},
{
"rel": "sender_chat",
"href": "http://127.0.0.1:3000/api/chats/1475"
},
{
"rel": "receiver_chat",
"href": "http://127.0.0.1:3000/api/chats/1476"
}
],
"id": 34,
"created_at": "2011-06-29T13:55:35-03:00",
"message": "Todo mundo com foto",
"updated_at": "2011-06-29T13:55:35-03:00"
}
]
GET /api/chat_messages/:id
Retorna uma mensagem do chat.
Autorização
É necessário ser participante do chat para visualizar este recurso.
Parâmetros
Parâmetro | Descrição | Restrições |
---|---|---|
id | ID da mensagem | N/A |
Exemplo
Requisição:
GET /api/chat_messages/169
Resposta:
{
"links": [
{
"rel": "self",
"href": "http://127.0.0.1:3000/api/chat_messages/16"
},
{
"rel": "user",
"href": "http://127.0.0.1:3000/api/users/guiocavalcanti"
},
{
"rel": "contact",
"href": "http://127.0.0.1:3000/api/users/tiago"
},
{
"rel": "sender_chat",
"href": "http://127.0.0.1:3000/api/chats/1475"
},
{
"rel": "receiver_chat",
"href": "http://127.0.0.1:3000/api/chats/1476"
}
],
"id": 16,
"created_at": "2011-06-29T13:15:18-03:00",
"message": "Opa!",
"updated_at": "2011-06-29T13:15:18-03:00"
}