# Attachments

> Nesta página, vamos nos aprofundar nos diferentes endpoints de anexos que você pode usar para gerenciar anexos programaticamente.
>
> - **Canonical URL:** https://www.builderbot.app/pt/attachments
> - **Documentation Index:** https://www.builderbot.app/llms.txt
> - **Full Corpus:** https://www.builderbot.app/llms-full.txt

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

  
Identificador único do anexo.
  
  
Identificador único da mensagem associada ao anexo.
  
  
O nome do ficheiro do anexo.
  
  
O URL do ficheiro anexo.
  
  
O tipo MIME do ficheiro anexo.
  
  
O tamanho do ficheiro do anexo em bytes.
  
  
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

    
      
Limite aos anexos de uma determinada conversa.
      
      
Limite o número de anexos devolvidos.
      
    

  
  

    

    ```bash (cURL)
    curl -G https://api.protocol.chat/v1/attachments \
      -H "Authorization: Bearer {token}" \
      -d conversation_id="xgQQXg3hrtjh7AvZ" \
      -d limit=10
    ```

    ```js
    import ApiClient from '@example/protocol-api'

    const client = new ApiClient(token)

    await client.attachments.list()
    ```

    ```python
    from protocol_api import ApiClient

    client = ApiClient(token)

    client.attachments.list()
    ```

    ```php
    $client = new \Protocol\ApiClient($token);

    $client->attachments->list();
    ```

    

    ```json (Response)
    {
      "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

    
      
O ficheiro que pretende adicionar como anexo.
      
    

  
  

    

    ```bash (cURL)
    curl https://api.protocol.chat/v1/attachments \
      -H "Authorization: Bearer {token}" \
      -F file="../Invoice_room_service__Plaza_Hotel.pdf"
    ```

    ```js
    import ApiClient from '@example/protocol-api'

    const client = new ApiClient(token)

    await client.attachments.create({ file })
    ```

    ```python
    from protocol_api import ApiClient

    client = ApiClient(token)

    client.attachments.create(file=file)
    ```

    ```php
    $client = new \Protocol\ApiClient($token);

    $client->attachments->create([
      'file' => $file,
    ]);
    ```

    

    ```json (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](#the-attachment-model) no topo desta página para ver quais propriedades estão incluídas com objetos de anexo.

  
  

    

    ```bash (cURL)
    curl https://api.protocol.chat/v1/attachments/Nc6yKKMpcxiiFxp6 \
      -H "Authorization: Bearer {token}"
    ```

    ```js
    import ApiClient from '@example/protocol-api'

    const client = new ApiClient(token)

    await client.attachments.get('Nc6yKKMpcxiiFxp6')
    ```

    ```python
    from protocol_api import ApiClient

    client = ApiClient(token)

    client.attachments.get("Nc6yKKMpcxiiFxp6")
    ```

    ```php
    $client = new \Protocol\ApiClient($token);

    $client->attachments->get('Nc6yKKMpcxiiFxp6');
    ```

    

    ```json (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

    
      
O novo nome do ficheiro para o anexo.
      
    

  
  

    

    ```bash (cURL)
    curl -X PUT https://api.protocol.chat/v1/attachments/Nc6yKKMpcxiiFxp6 \
      -H "Authorization: Bearer {token}" \
      -d filename="Invoice_room_service__Plaza_Hotel_updated.pdf"
    ```

    ```js
    import ApiClient from '@example/protocol-api'

    const client = new ApiClient(token)

    await client.attachments.update('Nc6yKKMpcxiiFxp6', {
      filename: 'Invoice_room_service__Plaza_Hotel_updated.pdf',
    })
    ```

    ```python
    from protocol_api import ApiClient

    client = ApiClient(token)

    client.attachments.update("Nc6yKKMpcxiiFxp6", filename="Invoice_room_service__Plaza_Hotel_updated.pdf")
    ```

    ```php
    $client = new \Protocol\ApiClient($token);

    $client->attachments->update('Nc6yKKMpcxiiFxp6', [
      'filename' => 'Invoice_room_service__Plaza_Hotel_updated.pdf',
    ]);
    ```

    

    ```json (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.

  
  

    

    ```bash (cURL)
    curl -X DELETE https://api.protocol.chat/v1/attachments/Nc6yKKMpcxiiFxp6 \
      -H "Authorization: Bearer {token}"
    ```

    ```js
    import ApiClient from '@example/protocol-api'

    const client = new ApiClient(token)

    await client.attachments.delete('Nc6yKKMpcxiiFxp6')
    ```

    ```python
    from protocol_api import ApiClient

    client = ApiClient(token)

    client.attachments.delete("Nc6yKKMpcxiiFxp6")
    ```

    ```php
    $client = new \Protocol\ApiClient($token);

    $client->attachments->delete('Nc6yKKMpcxiiFxp6');
    ```
