Retrieve a message

get https://{domain}.gorgias.com/api/tickets/{ticket_id}/messages/{id}

Response

Response body

object

integer

required

ID of the message.

uri

string

required

URI of the message.

message_id

string

required

ID of the message on the service that send the message.It can be the ID of an email, a Messenger message, a Facebook comment, etc...

ticket_id

integer

required

The ID of the ticket the message is associated with.

external_id

string

required

ID of the message in a foreign system (Aircall, Zendesk, etc...). This field is not used by Gorgias, feel free to set it as you wish.

public

boolean

Defaults to true

Whether the message was sent/receive by a customer. Internal notes are not public.

channel

required

The channel used to send the message.

via

string

required

How the message has been received, or sent from Gorgias.

aircall api chat contact_form email facebook facebook-mention facebook-messenger facebook-recommendations form gorgias_chat helpdesk help-center instagram instagram-ad-comment instagram-comment instagram-direct-message instagram-mention internal-note offline_capture phone rule self_service shopify sms twilio twitter twitter-direct-message whatsapp yotpo yotpo-review zendesk

source

object

required

Information used to route the message. It contains the names and the addresses of the sender and receivers.

type

string

required

Describes a more detailed channel information of how the message was sent/received. Either the slug of a non-legacy channel or one of aircall,api,app,chat,chat-contact-form,chat-offline-capture,contact-form,email,facebook-comment,facebook-message,facebook-messenger,facebook-post,facebook-mention-post,facebook-mention-comment,facebook,facebook-review,facebook-review-comment,form,help-center,helpdesk,instagram-ad-comment,instagram-ad-media,instagram-comment,instagram-mention-comment,instagram-media,instagram-mention-media,instagram,instagram-direct-message,internal-note,ottspott-call,phone,rule,self_service,shopify,sms,system-message,twilio,yotpo-review,yotpo-review-public-comment,yotpo-review-private-comment,twitter-tweet,twitter-quoted-tweet,twitter-mention-tweet,twitter-direct-message,help-center-contact-form,whatsapp-message.

array of objects

A list of To addresses. To and From are usually present for most channel types.

object

name

string

address

string

array of objects

A list of CC addresses. Only present in an email context.

object

name

string

address

string

bcc

array of objects

A list of BCC addresses. Only present in an email context.

bcc

object

name

string

address

string

from

object

A single From address. To and From are usually present for most channel types.

extra

string

sender

object

required

The person who sent the message. It can be a user or a customer.

integer

required

string

required

name

string

required

firstname

string

required

lastname

string

required

meta

string

required

Metadata associated with the message.
You can use this field to store structured information (key-value data) about the message.
Reserved keys:

current_page: The page from where the user is currently chatting.
relevant_content_indexes: Indexes containing relevant text of the message.
is_quick_reply: Whether the message is a "quick reply".
campaigns: ID of the chat campaign the message is replying to.
campaigns_id: ID of the chat campaign that sent this message.
self_service_flow: An object containing metadata of the self-service flow associated to the message.

created_datetime

date-time

required

When the message was created.

deleted_datetime

date-time

When the message was deleted.

sent_datetime

date-time

required

When the message was sent. If ommited, the message will be sent by Gorgias.

failed_datetime

date-time

required

When the message failed to be sent. Messages that couldn't be sent can be resend.

opened_datetime

date-time

required

When the message was opened by the primary receiver.

last_sending_error

object

required

Details of the last error encountered when Gorgias attempted to send the message.

error

string

required

is_retriable

boolean

required

It determines if the message can be retried or not.

replied_by

object

The message designated as a response to the current message. This field is temporary and only provided to the web app.

integration_id

integer

required

ID of the integration which created the message.

message_id

string

required

ID of the message in Gorgias.

created_datetime

date-time

required

When the message was created.

body_text

string

required

The full text version of the body of the message, if any.

source

object

required

Information used to route the message. It contains the names and the addresses of the sender and receivers.

customer

object

required

The customer who sent the message.

user

object

required

The agent who sent the message.

replied_to

object

The message designated as replied by the current message. This field is temporary and only provided to the web app.

integration_id

integer

required

ID of the integration which created the message.

message_id

string

required

ID of the message in Gorgias.

created_datetime

date-time

required

When the message was created.

body_text

string

required

The full text version of the body of the message, if any.

source

object

required

Information used to route the message. It contains the names and the addresses of the sender and receivers.

customer

object

required

The customer who sent the message.

user

object

required

The agent who sent the message.

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://your-domain.gorgias.com/api/tickets/ticket_id/messages/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The requested message.