Skip to main content
MessagesVersion: v3

Get message by message id

GET/conversations/messages/{id}

Get message by message id.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:conversations/message.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Response

Message object for the id given.

idstringrequired
Example:ve9EPM428h8vShlRW1KT
altIdstring

Alternative identifier for the message

Example:msg_123456789
typenumberrequired
Example:1
messageTypestringrequired

Type of the message as a string

Available optionsTYPE_CALLTYPE_SMSTYPE_EMAILTYPE_SMS_REVIEW_REQUESTTYPE_WEBCHATTYPE_SMS_NO_SHOW_REQUESTTYPE_CAMPAIGN_SMSTYPE_CAMPAIGN_CALLTYPE_CAMPAIGN_EMAILTYPE_CAMPAIGN_VOICEMAILTYPE_FACEBOOKTYPE_CAMPAIGN_FACEBOOK
Example:SMS
locationIdstringrequired
Example:ve9EPM428h8vShlRW1KT
contactIdstringrequired
Example:ve9EPM428h8vShlRW1KT
conversationIdstringrequired
Example:ve9EPM428h8vShlRW1KT
dateAddedstringrequired
Example:2024-03-27T18:13:49.000Z
bodystring
Example:Hi there
directionstringrequired
Available optionsinboundoutbound
statusstring
Available optionsconnecteddeliveredfailedopenedpendingreadscheduledsentundeliveredclickedopt_out
contentTypestringrequired
Example:text/plain
attachmentsstring[]

An array of attachment URLs. Attachments will be empty for Call and Voicemails, type 1 and 10. Please use get call recording API to fetch call recording and voicemails.

metaobject
sourcestring

Message source

Available optionsworkflowbulk_actionscampaignapiapp
userIdstring

User Id

Example:ve9EPM428kjkvShlRW1KT
conversationProviderIdstring

Conversation Provider Id

Example:ve9EPM428kjkvShlRW1KT
chatWidgetIdstring

Chat Widget Id

Example:67b0cc8cf14b19d85ace7s35
fromstring

Sender identifier (phone/name). Not returned for email types.

Example:+14155551234
tostring

Recipient identifier (phone/name). Not returned for email types.

Example:+14155555678
errorstring

Error message if message delivery failed