GetAttachment

This operation is part of the Email API section of the Web Services API.

Overview

This operation retrieves the specified attached document for the specified email interaction.

Request URL	/api/v2/emails/{emailId}/attachments/{attachmentId}
HTTP Method	GET
Required Features	api-multimedia

Meta Data

You can find meta data for attachments on the email interaction resource:

{
  "id": "FEWOIFWJ3243224",
  "state": "Processing",
  "uri": "/api/v2/me/emails/FEWOIFWJ3243224",
  "contactId": "HIFEW879",
  "from": "customerservice@genesys.com",
  "to": [
      "bruce.wayne@wayneenterprises.com",
      "damian.wayne@wayneenterprises.com"
  ]
  "subject": "Customer Service",
  "bodyAsPlainText" : ""
  "attachments": [
      {
          "id": "JIFOJWEF342423",
          "name": "Random Document",
          "size": "12",
          "uri": "/emails/FEWOIFWJ3243224/attachments/JIFOJWEF342423",
          "mime": "text/plain"
      },
      {
          "id": "FUEO234EF342JQ",
          "name": "aPicture.jpg",
          "size": "235",
          "uri": "/emails/FEWOIFWJ3243224/attachments/JIFOJWEF342423",
          "mime": "image/jpeg"
      }
  ],
  "capabilities": [
      "Reply", "ReplyAll", "Save", "Complete", "Transfer", "Send"
  ]
}

For information about how to retrieve email interactions, refer to operations such as Accept.

Important

The maximum size of attachments depends on the hardware running your Genesys environment.

Sample

Request

GET /api/v2/emails/0000Na9B26EF003M/attachments/3333Na9B26EF003F

Response

The raw data for the attachment on the specified email interaction.