Referência da API de Carregamento de Anexos

A API de Carregamento de Anexos permite carregar ativos que podem ser enviados em mensagens em outro momento. Ela ajuda a evitar o carregamento desnecessário e frequente de arquivos muito utilizados. Essa API oferece suporte para salvar ativos a partir de uma URL ou um sistema de arquivos local.

Também é possível usar a Send API para enviar uma mensagem com um anexo e simultaneamente salvá-lo para uso posterior. Para ver mais informações, consulte a seção Carregar e enviar abaixo.

Carregar um anexo

Para carregar um anexo, envie uma solicitação POST ao ponto de extremidade /Your-page-id/message_attachment com message.attachment incluindo type e payload. Se quiser usar o ativo em várias mensagens, defina payload.is_reusable como true.

Exemplo de solicitação para carregar de uma URL

Texto formatado para facilitar a leitura. Substitua os valores em negrito e itálico (como page_access_token) pelos seus valores.

curl -X POST "https://graph.facebook.com/v21.0/Your-page-id/message_attachments" \
     -H "Content-Type: application/json" \
     -d '{
           "access_token":"Your_page_access_token",
           "message":{
             "attachment":{
               "type":"image", 
               "payload":{
                 "url":"https://your-url.com/image.jpg",
                 "is_reusable": true
               }
             }
           }
         }'

Exemplo de solicitação para carregar de um arquivo

Texto formatado para facilitar a leitura. Substitua os valores em negrito e itálico (como page_access_token) pelos seus valores.

curl -X POST -H "Content-Type: application/json" -d '{
   "message": {
     "attachment": {
       "type": "image"
     }
   },
   "filedata": "@/path-to-your-file/image.jpg",
   "type": "image/png"
  }' "https://graph.facebook.com/v21.0/{PAGE_ID}/message_attachments?access_token={PAGE_ACCESS_TOKEN}"

Caso a solicitação seja bem-sucedida, o app receberá um objeto JSON com attachment_id definido como o ID do anexo a ser usado nas suas mensagens.

{"attachment_id": "Your-attachment-ID"}

Enviar uma mensagem com um ativo carregado

Para enviar uma mensagem com um ativo que já foi carregado, carregue-o com message.attachment.payload.is_reusable definido como true, envie uma solicitação POST ao ponto de extremidade /Your-page-id/messages com recipient.id, além do objeto message.attachment com type e payload.attachment_id.

Exemplo de solicitação para carregar de um arquivo

Texto formatado para facilitar a leitura. Substitua os valores em negrito e itálico (como page_access_token) pelos seus valores.

curl -X POST -H "Content-Type: application/json" -d '{
    "recipient": {
      "id": "{PSID}"
    },
    "message": {
      "attachment": {
        "type": "image",
        "payload": {
          "attachment_id": "Your-attachment-ID"
        }
      }
    }
  }' "https://graph.facebook.com/v21.0/{PAGE_ID}/messages?access_token={PAGE_ACCESS_TOKEN}"

Caso seja bem-sucedida, o app receberá um objeto JSON com success definido como true.

{"success": "true"}

Carregar e enviar

Também é possível carregar e enviar a mídia em uma solicitação única de API.

Exemplo de solicitação para carregar de uma URL

Texto formatado para facilitar a leitura. Substitua os valores em negrito e itálico (como page_access_token) pelos seus valores.

curl -X POST -H "Content-Type: application/json" -d '{
   "recipient": {
     "id": "{PSID}"
   },
   "message": {
     "attachment": {
       "type": "image",
       "payload": {
         "url": "https://your-url.com/image.jpg"
       }
     }
   }
  }' "https://graph.facebook.com/v21.0/{PAGE_ID}/messages?access_token={PAGE_ACCESS_TOKEN}"

Caso seja bem-sucedida, o app receberá um objeto JSON com success definido como true.

{"success": "true"}

Propriedades

Para anexos com origem em URLs, forneça as propriedades a seguir no corpo da solicitação como um objeto JSON. Para anexos com origem em arquivos, envie as propriedades como dados de formulário.

message

message.attachment

message.attachment.payload

Códigos de erro