Attachments
Anexos são como você compartilha coisas em Protocolo-eles permitem que você envie todos os tipos de arquivos para seus contatos e grupos. Nesta página, vamos nos aprofundar nos diferentes endpoints de anexos que você pode usar para gerenciar anexos programaticamente. Veremos como consultar, carregar, atualizar e excluir anexos.
The attachment model
O modelo de anexo contém todas as informações sobre os ficheiros que envia aos seus contactos e grupos, incluindo o nome, tipo e tamanho.
Properties
- Name
id- Type
- string
- Description
Identificador único do anexo.
- Name
message_id- Type
- string
- Description
Identificador único da mensagem associada ao anexo.
- Name
filename- Type
- string
- Description
O nome do ficheiro do anexo.
- Name
file_url- Type
- string
- Description
O URL do ficheiro anexo.
- Name
file_type- Type
- string
- Description
O tipo MIME do ficheiro anexo.
- Name
file_size- Type
- integer
- Description
O tamanho do ficheiro do anexo em bytes.
- Name
created_at- Type
- timestamp
- Description
Carimbo de data / hora de quando o anexo foi criado.
List all attachments
Este ponto de extremidade permite que você recupere uma lista paginada de todos os seus anexos (em uma conversa, se um ID de conversa for fornecido). Por predefinição, são apresentados um máximo de dez anexos por página.
Optional attributes
- Name
conversation_id- Type
- string
- Description
Limite aos anexos de uma determinada conversa.
- Name
limit- Type
- integer
- Description
Limite o número de anexos devolvidos.
Request
curl -G https://api.protocol.chat/v1/attachments \
-H "Authorization: Bearer {token}" \
-d conversation_id="xgQQXg3hrtjh7AvZ" \
-d limit=10Response
{
"has_more": false,
"data": [
{
"id": "Nc6yKKMpcxiiFxp6",
"message_id": "LoPsJaMcPBuFNjg1",
"filename": "Invoice_room_service__Plaza_Hotel.pdf",
"file_url": "https://assets.protocol.chat/attachments/Invoice_room_service__Plaza_Hotel.pdf",
"file_type": "application/pdf",
"file_size": 21352,
"created_at": 692233200
},
{
"id": "hSIhXBhNe8X1d8Et"
// ...
}
]
}Create an attachment
Este ponto de extremidade permite-lhe carregar um novo anexo para uma conversa. Veja os exemplos de código para saber como enviar o arquivo para a API do Protocolo.
Required attributes
- Name
file- Type
- string
- Description
O ficheiro que pretende adicionar como anexo.
Request
curl https://api.protocol.chat/v1/attachments \
-H "Authorization: Bearer {token}" \
-F file="../Invoice_room_service__Plaza_Hotel.pdf"Response
{
"id": "Nc6yKKMpcxiiFxp6",
"message_id": "LoPsJaMcPBuFNjg1",
"filename": "Invoice_room_service__Plaza_Hotel.pdf",
"file_url": "https://assets.protocol.chat/attachments/Invoice_room_service__Plaza_Hotel.pdf",
"file_type": "application/pdf",
"file_size": 21352,
"created_at": 692233200
}Retrieve an attachment
Este ponto de extremidade permite que você recupere um anexo fornecendo o ID do anexo. Referir-se a the list no topo desta página para ver quais propriedades estão incluídas com objetos de anexo.
Request
curl https://api.protocol.chat/v1/attachments/Nc6yKKMpcxiiFxp6 \
-H "Authorization: Bearer {token}"Response
{
"id": "Nc6yKKMpcxiiFxp6",
"message_id": "LoPsJaMcPBuFNjg1",
"filename": "Invoice_room_service__Plaza_Hotel.pdf",
"file_url": "https://assets.protocol.chat/attachments/Invoice_room_service__Plaza_Hotel.pdf",
"file_type": "application/pdf",
"file_size": 21352,
"created_at": 692233200
}Update an attachment
Este ponto de extremidade permite que você execute uma atualização em um anexo. Actualmente, o único tipo de actualização suportado é a alteração do nome do ficheiro.
Optional attributes
- Name
filename- Type
- string
- Description
O novo nome do ficheiro para o anexo.
Request
curl -X PUT https://api.protocol.chat/v1/attachments/Nc6yKKMpcxiiFxp6 \
-H "Authorization: Bearer {token}" \
-d filename="Invoice_room_service__Plaza_Hotel_updated.pdf"Response
{
"id": "Nc6yKKMpcxiiFxp6",
"message_id": "LoPsJaMcPBuFNjg1",
"filename": "Invoice_room_service__Plaza_Hotel.pdf",
"file_url": "https://assets.protocol.chat/attachments/Invoice_room_service__Plaza_Hotel_updated.pdf",
"file_type": "application/pdf",
"file_size": 21352,
"created_at": 692233200
}Delete an attachment
Este ponto de extremidade permite excluir anexos. Observação: isso excluirá permanentemente o arquivo.
Request
curl -X DELETE https://api.protocol.chat/v1/attachments/Nc6yKKMpcxiiFxp6 \
-H "Authorization: Bearer {token}"