Messages
As mensagens são o que as conversas são feitas no protocolo — eles são os blocos de construção básicos de suas conversas com seus contatos de Protocolo. Nesta página, vamos nos aprofundar nos diferentes endpoints de mensagens que você pode usar para gerenciar mensagens programaticamente. Veremos como consultar, enviar, atualizar e excluir mensagens.
The message model
O modelo de mensagem contém todas as informações sobre as mensagens e anexos que envia aos seus contactos e grupos, incluindo a forma como os seus contactos reagiram a eles.
Properties
- Name
id- Type
- string
- Description
Identificador único da mensagem.
- Name
conversation_id- Type
- string
- Description
Identificador único para a conversa à qual a mensagem Pertence.
- Name
contacto- Type
- objecto
- Description
O objecto de contacto do contacto que enviou a mensagem.
- Name
message- Type
- string
- Description
O conteúdo da mensagem.
- Name
reactions- Type
- array
- Description
Uma matriz de objetos de reação associados à mensagem.
- Name
attachments- Type
- array
- Description
Uma matriz de objetos anexos associados à mensagem.
- Name
read_at- Type
- timestamp
- Description
Timestamp de quando a mensagem foi lida.
- Name
created_at- Type
- timestamp
- Description
Data e hora de quando a mensagem foi criada.
- Name
updated_at- Type
- timestamp
- Description
Data e hora de quando a mensagem foi atualizada pela última vez.
List all messages
Este ponto de extremidade permite que você recupere uma lista paginada de todas as suas mensagens (em uma conversa, se um ID de conversa for fornecido). Por predefinição, são apresentadas no máximo dez mensagens por página.
Optional attributes
- Name
conversation_id- Type
- string
- Description
Limit to messages from a given conversation.
- Name
limit- Type
- integer
- Description
Limit the number of messages returned.
Request
curl -G https://api.protocol.chat/v1/messages \
-H "Authorization: Bearer {token}" \
-d conversation_id=xgQQXg3hrtjh7AvZ \
-d limit=10Response
{
"has_more": false,
"data": [
{
"id": "SIuAFUNKdSYHZF2w",
"conversation_id": "xgQQXg3hrtjh7AvZ",
"contact": {
"id": "WAz8eIbvDR60rouK",
"username": "KevinMcCallister",
"phone_number": "1-800-759-3000",
"avatar_url": "https://assets.protocol.chat/avatars/buzzboy.jpg",
"last_active_at": 705103200,
"created_at": 692233200
},
"message": "It’s a nice night for a neck injury.",
"reactions": [],
"attachments": [],
"read_at": 705103200,
"created_at": 692233200,
"updated_at": 692233200
},
{
"id": "hSIhXBhNe8X1d8Et",
// ..
}
]
}Send a message
Este ponto de extremidade permite-lhe enviar uma nova mensagem para uma das suas conversas.
Required attributes
- Name
conversation_id- Type
- string
- Description
Identificador único para a conversa à qual a mensagem Pertence.
- Name
message- Type
- string
- Description
O conteúdo da mensagem.
Optional attributes
- Name
attachments- Type
- array
- Description
Uma matriz de objetos anexos associados à mensagem.
Request
curl https://api.protocol.chat/v1/messages \
-H "Authorization: Bearer {token}" \
-d conversation_id="xgQQXg3hrtjh7AvZ" \
-d message="You’re what the French call ‘les incompetents.’"Response
{
"id": "gWqY86BMFRiH5o11",
"conversation_id": "xgQQXg3hrtjh7AvZ",
"contact": {
"id": "inEIRvzjC6YLMX3o",
"username": "LinnieMcCallister",
"phone_number": "1-800-759-3000",
"avatar_url": "https://assets.protocol.chat/avatars/linnie.jpg",
"last_active_at": 705103200,
"created_at": 692233200
},
"message": "You’re what the French call ‘les incompetents.’",
"reactions": [],
"attachments": [],
"read_at": null,
"created_at": 692233200,
"updated_at": null
}Retrieve a message
Este ponto de extremidade permite que você recupere uma mensagem fornecendo o ID da mensagem. Referir-se a the list no topo desta página para ver quais propriedades estão incluídas com objetos de mensagem.
Request
curl https://api.protocol.chat/v1/messages/SIuAFUNKdSYHZF2w \
-H "Authorization: Bearer {token}"Response
{
"id": "SIuAFUNKdSYHZF2w",
"conversation_id": "xgQQXg3hrtjh7AvZ",
"contact": {
"id": "WAz8eIbvDR60rouK",
"username": "KevinMcCallister",
"phone_number": "1-800-759-3000",
"avatar_url": "https://assets.protocol.chat/avatars/kevin.jpg",
"last_active_at": 705103200,
"created_at": 692233200
},
"message": "I’m traveling with my dad. He’s at a meeting. I hate meetings.",
"reactions": [],
"attachments": [],
"read_at": 705103200,
"created_at": 692233200,
"updated_at": 692233200
}Update a message
Este ponto de extremidade permite que você execute uma atualização em uma mensagem. Exemplos de atualizações são adicionar uma reação, editar a mensagem ou adicionar um anexo.
Optional attributes
- Name
message- Type
- string
- Description
O conteúdo da mensagem.
- Name
reactions- Type
- array
- Description
Uma matriz de objetos de reação associados à mensagem.
- Name
attachments- Type
- array
- Description
Uma matriz de objetos anexos associados à mensagem.
Request
curl -X PUT https://api.protocol.chat/v1/messages/SIuAFUNKdSYHZF2w \
-H "Authorization: Bearer {token}" \
-d reactions[red_angry_face][]="KateMcCallister"Response
{
"id": "SIuAFUNKdSYHZF2w",
"conversation_id": "xgQQXg3hrtjh7AvZ",
"contact": {
"id": "WAz8eIbvDR60rouK",
"username": "KevinMcCallister",
"phone_number": "1-800-759-3000",
"avatar_url": "https://assets.protocol.chat/avatars/buzzboy.jpg",
"last_active_at": 705103200,
"created_at": 692233200
},
"message": "I'm not apologizing. I'd rather kiss a toilet seat.",
"reactions": [
{
"red_angry_face": [
"KateMcCallister"
]
}
],
"attachments": [],
"read_at": 705103200,
"created_at": 692233200,
"updated_at": 692233200
}Delete a message
Este ponto de extremidade permite que você exclua mensagens de suas conversas. Observação: isso excluirá permanentemente a mensagem.
Request
curl -X DELETE https://api.protocol.chat/v1/messages/SIuAFUNKdSYHZF2w \
-H "Authorization: Bearer {token}"