--- updatedAt: 2026-05-28T08:54:44.000Z agentTools: projectIndex: https://developers.edesk.com/llms.txt --- # Read Message Return details of a message # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "eDesk Open API", "version": "2.0", "description": "The eDesk OpenAPI allows you to interact with eDesk programmatically.\n\nThe below table defines the validation error codes that this API may return.\n\n| Error Code | Description |\n| --------------- | -------------------------------------------------- |\n| 4001 | Missing required field |\n| 4002 | Not able to find an object |\n| 4003 | Must be unique value |\n| 4004 | User can not access an object |\n| 4005 | Must be a numeric value |\n| 4006 | Must be an array |\n| 4007 | Must be one of the allowed values |\n| 4008 | Must be a string |\n| 4009 | Must be a boolean |\n| 4010 | Must be a valid date |\n| 4011 | Must be a valid file url |\n| 4012 | Must be a valid image url |\n| 4013 | Related channel type is not supported |\n| 4014 | Mismatch between sales order and channel |\n| 4015 | Mismatch between client and channels |\n| 4016 | Templates limit exceeded |\n| 4017 | Mismatch between sales order and sales order item |\n| 4018 | Custom field value must match the type |\n| 4019 | Each attachment must match format AttachmentRequest|\n| 4020 | Must be less or equal characters |\n| 4021 | Must be an email |\n| 4022 | Shouldn't reach the message items limit |\n| 4023 | Required for the channel type of this ticket |\n| 4024 | Channel is not set up to send messages |\n| 4025 | Must contain an allowed number of items |\n" }, "servers": [ { "url": "https://api.edesk.com/v1", "description": "Main (production) endpoint" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/messages/{messageId}": { "get": { "tags": [ "Messages" ], "summary": "Read Message", "description": "Return details of a message", "operationId": "getMessage", "parameters": [ { "in": "path", "name": "messageId", "description": "Message ID to fetch", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "$ref": "#/components/responses/TicketItem_Get" }, "default": { "$ref": "#/components/responses/DefaultErrorResponse" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } }, "responses": { "DefaultErrorResponse": { "description": "Default error response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseErrorResponse" }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "details": { "type": "string", "description": "Error details." } } } } } ] } } } }, "TicketItem_Get": { "description": "Return details of a TicketItem", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Ticket_Item" } } } ] } } } } }, "schemas": { "User": { "type": "object", "properties": { "id": { "type": "integer", "example": 123 }, "name": { "type": "string", "example": "John Smith" }, "email": { "type": "string", "example": "agent@company.com" }, "active": { "type": "boolean", "example": false }, "username": { "type": "string", "example": "john_smith" }, "role": { "type": "string", "example": "agent" } } }, "Ticket_Item": { "type": "object", "properties": { "id": { "type": "number", "description": "Depending on the message type the id will be corresponding to that model table. Not necessarily unique!" }, "external_id": { "type": "string", "description": "Depending on the channel this can be Facebook, Twitter etc." }, "subject": { "type": "string" }, "created_at": { "type": "string" }, "from_consumer_id": { "type": "integer" }, "from_user": { "$ref": "#/components/schemas/User" }, "type": { "type": "string", "enum": [ "Message", "Note", "Status", "AutoReply", "NegativeFeedback", "NegativeFeedbackResponse", "NegativeFeedbackFixed", "ExternalMessage", "Rating", "ChatNavigate", "Scheduled", "SalesOrderEvent", "SalesOrderFeedbackSolicitation", "ChannelFeedback", "ChannelMessageThreadRule", "ChannelMessageAssignment", "EbayCancellationReply", "EbayCancellationCaseResponseHistory", "EbayPostOrderCase", "EbayInquiryCase", "EbayInquiryCaseResponseHistory", "EbayReturnCaseResponseHistory", "EbayReturnCaseFile", "EbayReturnCaseMoneyMovement", "EbayOrderExternalTransaction", "EbayInquiryReply", "PreSalesConversion", "RequestReview", "VoiceCall", "VoiceCallRecording", "VoiceCallVoicemail", "AmazonBuyerCancellation", "TikTokShopBuyerCancellation", "ChannelAdvisorAdjustment", "AiQuickReply", "AiAutoReplyHandsFree" ] }, "attachments": { "type": "array", "description": "Array of Ticket Item Attachment", "items": { "$ref": "#/components/schemas/TicketItem_Attachment" } }, "direction": { "type": "string", "enum": [ "Incoming", "Outgoing", "Other" ] }, "body": { "type": "string" }, "errors": { "type": "array", "description": "Array of Error Items", "items": { "type": "string" } }, "ticket_id": { "type": "number" } } }, "TicketItem_Attachment": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "example": "cat.jpg", "type": "string" }, "link": { "example": "https://s3bucket/channel_message_item_attachment/000/182/905/291?X-Amz-Signature=...", "type": "string", "nullable": true, "description": "Pre-signed download URL, valid for 1 hour from the moment this response was generated, and requires no eDesk authentication. Download the file or refresh the link by requesting the message again before it expires. Media hosted by the channel provider (Instagram) returns the provider link instead, which carries its own expiry.\n" }, "mime": { "example": "image/jpeg", "type": "string" } } }, "BaseResponse": { "type": "object", "properties": { "data": { "type": "object" } } }, "BaseErrorResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "httpCode": { "type": "integer", "description": "Error code", "example": 500 }, "message": { "type": "string", "description": "Error short message" } } } } } } } } ```