Get message by message id

GET 
/conversations/messages/:id

Get message by message id.

Request

Version stringrequired

API Version

Available optionsv3

application/json

Message object for the id given.

application/json

Schema

Schema

idstringrequired
altIdstring

Alternative identifier for the message

typenumberrequired
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
locationIdstringrequired
contactIdstringrequired
conversationIdstringrequired
dateAddedstringrequired
bodystring
directionstringrequired
Available optionsinboundoutbound
statusstring
Available optionsconnecteddeliveredfailedopenedpendingreadscheduledsentundeliveredclickedopt_out
contentTypestringrequired
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

conversationProviderIdstring

Conversation Provider Id

chatWidgetIdstring

Chat Widget Id

fromstring

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

tostring

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

errorstring

Error message if message delivery failed

Example (auto)

{
  "id": "ve9EPM428h8vShlRW1KT",
  "altId": "msg_123456789",
  "type": 1,
  "messageType": "SMS",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "contactId": "ve9EPM428h8vShlRW1KT",
  "conversationId": "ve9EPM428h8vShlRW1KT",
  "dateAdded": "2024-03-27T18:13:49.000Z",
  "body": "Hi there",
  "direction": "inbound",
  "status": "connected",
  "contentType": "text/plain",
  "attachments": [
    "string"
  ],
  "meta": {
    "callDuration": 120,
    "callStatus": "completed",
    "email": {
      "email": {
        "messageIds": [
          "ve9EPM428kjkvShlRW1KT",
          "ve9EPs1028kjkvShlRW1KT"
        ]
      }
    },
    "ig": {
      "ig": {
        "page_id": "1234567890",
        "page_name": "Instagram Page"
      }
    },
    "fb": {
      "fb": {
        "page_id": "1234567890",
        "page_name": "Facebook Page"
      }
    }
  },
  "source": "workflow",
  "userId": "ve9EPM428kjkvShlRW1KT",
  "conversationProviderId": "ve9EPM428kjkvShlRW1KT",
  "chatWidgetId": "67b0cc8cf14b19d85ace7s35",
  "from": "+14155551234",
  "to": "+14155555678",
  "error": "string"
}