Skip to content

Message

Work with individual messages. Supports bulk fetch by universal message ID or message ID, performing an action on a message, marking a message as read (WhatsApp only), adding associated application data, and updating message workflow with optional content or attachments.

Operations

Fetch Messages by UM ID or Message Id. Supports bulk fetch.

Request

Security
bearerAuth and apiKeyAuth
Query
messageIdstring

Comma-separated list of messageId

umIdstring

Comma-separated list of umId

sourceTypestring(SourceType)

source

Enum:"ACCOUNT""PERSISTENT_SEARCH""LISTENING""BENCHMARKING""AUDIENCE""AUDIENCE_STUDY""FEED_DATA""ADVOCACY""EXTERNAL""SPRINKLR_COMMERCE"
translationstring

language code to translate message to

curl -i -X GET \
  'https://dev-staging.sprinklr.com/_mock/apis/sprinklr-v3/message?messageId=string&umId=string&sourceType=ACCOUNT&translation=string' \
  -H 'Authorization: Bearer <YOUR_Token_HERE>' \
  -H 'Key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
Array [
idstring
draftIdinteger, (int64)

Outbound Draft Id.

sourceTypestringrequired

Source of the message.

sourceIdinteger, (int64)required

Source of the message, Sprinklr AccountId in case its a message associated to an account.

contentobject(Content)required

Describes the content to be used in the message.

channelMessageIdstring

Id of the message on the social channel

channelTypestring

Social channel for the message

accountTypestring

Type of account

channelCreatedTimeinteger, (int64)

Created time of the message on social channel

senderProfileobject(Profile)

Profile details of the message sender

receiverProfileobject(Profile)

Profile details of the message receiver

mentionedProfilesArray of objects(Profile)

Details of the mentioned profiles

languagestring

language code of the message.

messageIdstring

Describes the unique message id for the message in sprinklr.

postIdinteger, (int64)

Id of the post corresponds to this message, if any.

assetIdstring

Id of the Post Asset from which this message was created

authorIdinteger, (int64)

Id of the sprinklr user who created the post, if any.

brandPostboolean

Flag to determine if this is brand post

createdTimeinteger, (int64)

Message created time in sprinklr

modifiedTimeinteger, (int64)

Last modified time of the message in sprinklr

textEntitiesobject

Hastags, indices, emoticons and other information.

locationobject(MessageLocation_message)

Location details

insightsobject

Insights of the message on social channel. e.g. likes, comments, shares

workflowobject(Workflow)

Workflow details of the message. It includes customproperties, queues, assignment details of the message.

enrichmentsobject(MessageEnrichment)

Extra information added to the message as part of enrichment in Sprinklr.

deletedstring

True if message is deleted

conversationIdstring

Conversation Identifier for the message.

parentMessageIdstring

Message Id of the Parent for the message.

autoImportedboolean

Flag to indicate if the message was published outside Sprinklr.

autoResponseboolean

True if the message was published by the system or a bot.

apiStatusstring

Api Status in case fields are removed due to resyndication policy.

quotedMessageIdstring

Quoted Message ID of the Message

botApplicationInfoobject(MessageBotApplicationInfoWrapper)

Bot Application Information

associatedCaseNumberinteger, (int64)

Case number of the associated case

contextualInformationArray of any(EnhancedDetail)

contextual Information of the Message

channelSpecificInfoany(ChannelSpecificInfo)
customPropertiesMetadataArray of objects(CustomPropertyWithMetadata)

Custom Property details

]
Response
[
  {
    "id": "string",
    "draftId": 0,
    "sourceType": "string",
    "sourceId": 0,
    "content": { … },
    "channelMessageId": "string",
    "channelType": "string",
    "accountType": "string",
    "channelCreatedTime": 0,
    "senderProfile": { … },
    "receiverProfile": { … },
    "mentionedProfiles": [ … ],
    "permalink": "string",
    "language": "string",
    "messageId": "string",
    "postId": 0,
    "assetId": "string",
    "authorId": 0,
    "brandPost": true,
    "createdTime": 0,
    "modifiedTime": 0,
    "textEntities": { … },
    "location": { … },
    "insights": { … },
    "workflow": { … },
    "enrichments": { … },
    "deleted": "string",
    "conversationId": "string",
    "parentMessageId": "string",
    "autoImported": true,
    "autoResponse": true,
    "apiStatus": "string",
    "quotedMessageId": "string",
    "botApplicationInfo": { … },
    "associatedCaseNumber": 0,
    "contextualInformation": [ … ],
    "channelSpecificInfo": { … },
    "customPropertiesMetadata": [ … ]
  }
]