Docs

getOrCreateMessage

Retrieves the Message object for given discriminating tags. If the message does not exist, it will be created. If the message already exists, its tags and payload will be updated with the provided values if they are defined.

POST/v1/chat/messages/get-or-create

Authorization

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

Header parameters

x-bot-idstringrequired
Bot id
x-integration-idstring
Integration id
x-integration-aliasstring
Integration alias

Request body

Message data

payloadobject
Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
userIdstringrequired
ID of the User(min length: 28, max length: 36)
conversationIdstringrequired
ID of the Conversation(min length: 28, max length: 36)
typestringrequired
Type of the Message represents the resource type that the message is related to(max length: 200)
tagsobjectrequired
Set of Tags that you can attach to a Message. The set of Tags available on a Message is restricted by the list of Tags defined previously by the Bot. Individual keys can be unset by posting an empty value to them.
scheduleobject
Schedule the Message to be sent at a specific time. Either dateTime or delay must be provided.
originenum<string>
Available options:"synthetic"
discriminateByTagsstring[]
Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.

Response

Returns a Message object if a valid identifier was provided. Returns an Error otherwise

messageobjectrequired
The Message object represents a message in a Conversation for a specific User.
metaobjectrequired