Get message by message id

GEThttps://services.leadconnectorhq.com/conversations/messages/{id}
Get message by message id.
Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

id
string
required
Example:
ve9EPM428h8vShlRW1KT
type
number
required
Example:
1
messageType
string
required

Type of the message as a string

Allowed values:
TYPE_CALLTYPE_SMSTYPE_EMAILTYPE_SMS_REVIEW_REQUESTTYPE_WEBCHATTYPE_SMS_NO_SHOW_REQUESTTYPE_CAMPAIGN_SMSTYPE_CAMPAIGN_CALLTYPE_CAMPAIGN_EMAILTYPE_CAMPAIGN_VOICEMAILTYPE_FACEBOOKTYPE_CAMPAIGN_FACEBOOKTYPE_CAMPAIGN_MANUAL_CALLTYPE_CAMPAIGN_MANUAL_SMSTYPE_GMBTYPE_CAMPAIGN_GMBTYPE_REVIEWTYPE_INSTAGRAMTYPE_WHATSAPPTYPE_CUSTOM_SMSTYPE_CUSTOM_EMAILTYPE_CUSTOM_PROVIDER_SMSTYPE_CUSTOM_PROVIDER_EMAILTYPE_IVR_CALLTYPE_ACTIVITY_CONTACTTYPE_ACTIVITY_INVOICETYPE_ACTIVITY_PAYMENTTYPE_ACTIVITY_OPPORTUNITYTYPE_LIVE_CHATTYPE_LIVE_CHAT_INFO_MESSAGETYPE_ACTIVITY_APPOINTMENTTYPE_FACEBOOK_COMMENTTYPE_INSTAGRAM_COMMENTTYPE_CUSTOM_CALLTYPE_INTERNAL_COMMENT
Example:
SMS
locationId
string
required
Example:
ve9EPM428h8vShlRW1KT
contactId
string
required
Example:
ve9EPM428h8vShlRW1KT
conversationId
string
required
Example:
ve9EPM428h8vShlRW1KT
dateAdded
string
required
Example:
2024-03-27T18:13:49.000Z
body
string
Example:
Hi there
direction
string
required
Allowed values:
inboundoutbound
status
string
Allowed values:
connecteddeliveredfailedopenedpendingreadscheduledsentundeliveredclickedopt_out
contentType
string
required
Example:
text/plain
attachments
array[string]

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.

meta
object
callDuration
string

Call duration in seconds

Example:
120
callStatus
string

Call status - can be pending, completed, answered, busy, no-answer, failed, canceled, or voicemail

Allowed values:
pendingcompletedansweredbusyno-answerfailedcanceledvoicemail
Example:
completed
email
object

meta will contain email, for message type 3 (email). messageIds is list of all email message ids under the message thread

Example:
{"email":{"messageIds":["ve9EPM428kjkvShlRW1KT","ve9EPs1028kjkvShlRW1KT"]}}
source
string

Message source

Allowed values:
workflowbulk_actionscampaignapiapp
userId
string

User Id

Example:
ve9EPM428kjkvShlRW1KT
conversationProviderId
string

Conversation Provider Id

Example:
ve9EPM428kjkvShlRW1KT

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request