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. readonlyAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Response
Message object for the id given.
idstringrequired
Example:
ve9EPM428h8vShlRW1KTaltIdstring
Alternative identifier for the message
Example:
msg_123456789typenumberrequired
Example:
1messageTypestringrequired
Type of the message as a string
Available options
TYPE_CALLTYPE_SMSTYPE_EMAILTYPE_SMS_REVIEW_REQUESTTYPE_WEBCHATTYPE_SMS_NO_SHOW_REQUESTTYPE_CAMPAIGN_SMSTYPE_CAMPAIGN_CALLTYPE_CAMPAIGN_EMAILTYPE_CAMPAIGN_VOICEMAILTYPE_FACEBOOKTYPE_CAMPAIGN_FACEBOOKExample:
SMSlocationIdstringrequired
Example:
ve9EPM428h8vShlRW1KTcontactIdstringrequired
Example:
ve9EPM428h8vShlRW1KTconversationIdstringrequired
Example:
ve9EPM428h8vShlRW1KTdateAddedstringrequired
Example:
2024-03-27T18:13:49.000Zbodystring
Example:
Hi theredirectionstringrequired
Available options
inboundoutboundstatusstring
Available options
connecteddeliveredfailedopenedpendingreadscheduledsentundeliveredclickedopt_outcontentTypestringrequired
Example:
text/plainattachmentsstring[]
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 options
workflowbulk_actionscampaignapiappuserIdstring
User Id
Example:
ve9EPM428kjkvShlRW1KTconversationProviderIdstring
Conversation Provider Id
Example:
ve9EPM428kjkvShlRW1KTchatWidgetIdstring
Chat Widget Id
Example:
67b0cc8cf14b19d85ace7s35fromstring
Sender identifier (phone/name). Not returned for email types.
Example:
+14155551234tostring
Recipient identifier (phone/name). Not returned for email types.
Example:
+14155555678errorstring
Error message if message delivery failed