Fetch a customer's conversation history (or specific messages) already mapped to the V2 conversation UI model

Fetch a customer's conversation history (or specific messages) already mapped to the V2 conversation UI model

Path Parameters

departmentUUID string required
userUUID string required
customerUUID string required

application/json

Request Body

pageSize int32
cursor string
includeDrafts boolean
protocolFilter string
messageUuids string[]

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

statusCode int32
items object[]
Array [
messageUuid string
conversationUuid string
tenantUuid string
workspaceUuid string
parentMessageUuid string
parentPreview string
sender object
tenantUuid string
type string
uuid string
displayName string
tenantName string
senderAddress string
recipient object
tenantUuid string
type string
uuid string
displayName string
tenantName string
recipientAddress string
recipientAddressLabel string
email object
cc string[]
bcc string[]
protocol string
direction string
messageType string
status string
isManual boolean
subject string
bodyPreview string
parts object[]
Array [
sortOrder int32
partType string
payload string
]
attachments object[]
Array [
attachmentUuid string
fileName string
contentType string
category string
sizeBytes int64
isVoiceNote boolean
url string
previewUrl string
thumbnailUrl string
]
mentions object[]
Array [
mentionId string
mentionedUuid string
mentionedType string
workspaceUuid string
displayName string
]
tags object[]
Array [
tagType string
tagTypeCode string
tagTypeDisplayName string
tagUuid string
tagValue string
secondaryValues string[]
parentTags object[]
Array [
tagTypeUuid string
referenceIdentifier string
]
]
predictions object[]
Array [
featureCode string
predictedValue string
confidence double
details object
property name* object
feedback object[]
Array [
verdict string
reason string
userUuid string
workspaceUuid string
]
]
systemEvent object
code string
params object
property name* string
subject string
buttons object[]
Array [
label string
translationKey string
theme string
actionEventData object
property name* string
]
failure object
code string
reason string
draft object
addSignature boolean
snooze object
snoozedAt string
snoozedUntil string
note string
call object
providerCallId string
status string
durationSeconds double
recording object
url string
transcript object
text string
utterances object[]
Array [
speaker string
startSeconds double
endSeconds double
text string
confidence double
]
whatsApp object
kind string
template object
name string
language string
contentSid string
variables object
property name* string
isVoiceNote boolean
forwarded boolean
frequentlyForwarded boolean
profileName string
interactive object
type string
header string
body string
footer string
selectedButtonId string
selectedButtonTitle string
selectedItemId string
selectedItemTitle string
selectedItemDescription string
actions object[]
Array [
id string
title string
description string
type string
url string
phoneNumber string
]
reaction object
emoji string
removed boolean
reactedMessageSid string
reactedMessageUuid string
internalNote object
notified object[]
Array [
tenantUuid string
type string
uuid string
displayName string
tenantName string
]
following object[]
Array [
tenantUuid string
type string
uuid string
displayName string
tenantName string
]
groups object[]
Array [
uuid string
displayName string
members object[]
Array [
tenantUuid string
type string
uuid string
displayName string
tenantName string
]
]
followersAdded object[]
Array [
tenantUuid string
type string
uuid string
displayName string
tenantName string
]
followersRemoved object[]
Array [
tenantUuid string
type string
uuid string
displayName string
tenantName string
]
origin object
service string
automationRuleUuid string
campaignId string
businessConnect object
originTenantName string
insertTs string
sentAt string
scheduledAt string
legacyRef object
protocol string
messageType string
purpose string
deliveryStatus string
optOutStatus string
metaData string
]
drafts object[]
Array [
messageUuid string
conversationUuid string
tenantUuid string
workspaceUuid string
parentMessageUuid string
parentPreview string
sender object
tenantUuid string
type string
uuid string
displayName string
tenantName string
senderAddress string
recipient object
tenantUuid string
type string
uuid string
displayName string
tenantName string
recipientAddress string
recipientAddressLabel string
email object
cc string[]
bcc string[]
protocol string
direction string
messageType string
status string
isManual boolean
subject string
bodyPreview string
parts object[]
Array [
sortOrder int32
partType string
payload string
]
attachments object[]
Array [
attachmentUuid string
fileName string
contentType string
category string
sizeBytes int64
isVoiceNote boolean
url string
previewUrl string
thumbnailUrl string
]
mentions object[]
Array [
mentionId string
mentionedUuid string
mentionedType string
workspaceUuid string
displayName string
]
tags object[]
Array [
tagType string
tagTypeCode string
tagTypeDisplayName string
tagUuid string
tagValue string
secondaryValues string[]
parentTags object[]
Array [
tagTypeUuid string
referenceIdentifier string
]
]
predictions object[]
Array [
featureCode string
predictedValue string
confidence double
details object
property name* object
feedback object[]
Array [
verdict string
reason string
userUuid string
workspaceUuid string
]
]
systemEvent object
code string
params object
property name* string
subject string
buttons object[]
Array [
label string
translationKey string
theme string
actionEventData object
property name* string
]
failure object
code string
reason string
draft object
addSignature boolean
snooze object
snoozedAt string
snoozedUntil string
note string
call object
providerCallId string
status string
durationSeconds double
recording object
url string
transcript object
text string
utterances object[]
Array [
speaker string
startSeconds double
endSeconds double
text string
confidence double
]
whatsApp object
kind string
template object
name string
language string
contentSid string
variables object
property name* string
isVoiceNote boolean
forwarded boolean
frequentlyForwarded boolean
profileName string
interactive object
type string
header string
body string
footer string
selectedButtonId string
selectedButtonTitle string
selectedItemId string
selectedItemTitle string
selectedItemDescription string
actions object[]
Array [
id string
title string
description string
type string
url string
phoneNumber string
]
reaction object
emoji string
removed boolean
reactedMessageSid string
reactedMessageUuid string
internalNote object
notified object[]
Array [
tenantUuid string
type string
uuid string
displayName string
tenantName string
]
following object[]
Array [
tenantUuid string
type string
uuid string
displayName string
tenantName string
]
groups object[]
Array [
uuid string
displayName string
members object[]
Array [
tenantUuid string
type string
uuid string
displayName string
tenantName string
]
]
followersAdded object[]
Array [
tenantUuid string
type string
uuid string
displayName string
tenantName string
]
followersRemoved object[]
Array [
tenantUuid string
type string
uuid string
displayName string
tenantName string
]
origin object
service string
automationRuleUuid string
campaignId string
businessConnect object
originTenantName string
insertTs string
sentAt string
scheduledAt string
legacyRef object
protocol string
messageType string
purpose string
deliveryStatus string
optOutStatus string
metaData string
]
nextCursor string
requestUuid string
errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "statusCode": 0,
  "items": [
    {
      "messageUuid": "string",
      "conversationUuid": "string",
      "tenantUuid": "string",
      "workspaceUuid": "string",
      "parentMessageUuid": "string",
      "parentPreview": "string",
      "sender": {
        "tenantUuid": "string",
        "type": "string",
        "uuid": "string",
        "displayName": "string",
        "tenantName": "string"
      },
      "senderAddress": "string",
      "recipient": {
        "tenantUuid": "string",
        "type": "string",
        "uuid": "string",
        "displayName": "string",
        "tenantName": "string"
      },
      "recipientAddress": "string",
      "recipientAddressLabel": "string",
      "email": {
        "cc": [
          "string"
        ],
        "bcc": [
          "string"
        ]
      },
      "protocol": "string",
      "direction": "string",
      "messageType": "string",
      "status": "string",
      "isManual": true,
      "subject": "string",
      "bodyPreview": "string",
      "parts": [
        {
          "sortOrder": 0,
          "partType": "string",
          "payload": "string"
        }
      ],
      "attachments": [
        {
          "attachmentUuid": "string",
          "fileName": "string",
          "contentType": "string",
          "category": "string",
          "sizeBytes": 0,
          "isVoiceNote": true,
          "url": "string",
          "previewUrl": "string",
          "thumbnailUrl": "string"
        }
      ],
      "mentions": [
        {
          "mentionId": "string",
          "mentionedUuid": "string",
          "mentionedType": "string",
          "workspaceUuid": "string",
          "displayName": "string"
        }
      ],
      "tags": [
        {
          "tagType": "string",
          "tagTypeCode": "string",
          "tagTypeDisplayName": "string",
          "tagUuid": "string",
          "tagValue": "string",
          "secondaryValues": [
            "string"
          ],
          "parentTags": [
            {
              "tagTypeUuid": "string",
              "referenceIdentifier": "string"
            }
          ]
        }
      ],
      "predictions": [
        {
          "featureCode": "string",
          "predictedValue": "string",
          "confidence": 0,
          "details": {},
          "feedback": [
            {
              "verdict": "string",
              "reason": "string",
              "userUuid": "string",
              "workspaceUuid": "string"
            }
          ]
        }
      ],
      "systemEvent": {
        "code": "string",
        "params": {},
        "subject": "string",
        "buttons": [
          {
            "label": "string",
            "translationKey": "string",
            "theme": "string",
            "actionEventData": {}
          }
        ]
      },
      "failure": {
        "code": "string",
        "reason": "string"
      },
      "draft": {
        "addSignature": true
      },
      "snooze": {
        "snoozedAt": "string",
        "snoozedUntil": "string",
        "note": "string"
      },
      "call": {
        "providerCallId": "string",
        "status": "string",
        "durationSeconds": 0,
        "recording": {
          "url": "string"
        },
        "transcript": {
          "text": "string",
          "utterances": [
            {
              "speaker": "string",
              "startSeconds": 0,
              "endSeconds": 0,
              "text": "string",
              "confidence": 0
            }
          ]
        }
      },
      "whatsApp": {
        "kind": "string",
        "template": {
          "name": "string",
          "language": "string",
          "contentSid": "string",
          "variables": {}
        },
        "isVoiceNote": true,
        "forwarded": true,
        "frequentlyForwarded": true,
        "profileName": "string",
        "interactive": {
          "type": "string",
          "header": "string",
          "body": "string",
          "footer": "string",
          "selectedButtonId": "string",
          "selectedButtonTitle": "string",
          "selectedItemId": "string",
          "selectedItemTitle": "string",
          "selectedItemDescription": "string",
          "actions": [
            {
              "id": "string",
              "title": "string",
              "description": "string",
              "type": "string",
              "url": "string",
              "phoneNumber": "string"
            }
          ]
        },
        "reaction": {
          "emoji": "string",
          "removed": true,
          "reactedMessageSid": "string",
          "reactedMessageUuid": "string"
        }
      },
      "internalNote": {
        "notified": [
          {
            "tenantUuid": "string",
            "type": "string",
            "uuid": "string",
            "displayName": "string",
            "tenantName": "string"
          }
        ],
        "following": [
          {
            "tenantUuid": "string",
            "type": "string",
            "uuid": "string",
            "displayName": "string",
            "tenantName": "string"
          }
        ],
        "groups": [
          {
            "uuid": "string",
            "displayName": "string",
            "members": [
              {
                "tenantUuid": "string",
                "type": "string",
                "uuid": "string",
                "displayName": "string",
                "tenantName": "string"
              }
            ]
          }
        ],
        "followersAdded": [
          {
            "tenantUuid": "string",
            "type": "string",
            "uuid": "string",
            "displayName": "string",
            "tenantName": "string"
          }
        ],
        "followersRemoved": [
          {
            "tenantUuid": "string",
            "type": "string",
            "uuid": "string",
            "displayName": "string",
            "tenantName": "string"
          }
        ]
      },
      "origin": {
        "service": "string",
        "automationRuleUuid": "string",
        "campaignId": "string"
      },
      "businessConnect": {
        "originTenantName": "string"
      },
      "insertTs": "string",
      "sentAt": "string",
      "scheduledAt": "string",
      "legacyRef": {
        "protocol": "string",
        "messageType": "string",
        "purpose": "string",
        "deliveryStatus": "string",
        "optOutStatus": "string",
        "metaData": "string"
      }
    }
  ],
  "drafts": [
    {
      "messageUuid": "string",
      "conversationUuid": "string",
      "tenantUuid": "string",
      "workspaceUuid": "string",
      "parentMessageUuid": "string",
      "parentPreview": "string",
      "sender": {
        "tenantUuid": "string",
        "type": "string",
        "uuid": "string",
        "displayName": "string",
        "tenantName": "string"
      },
      "senderAddress": "string",
      "recipient": {
        "tenantUuid": "string",
        "type": "string",
        "uuid": "string",
        "displayName": "string",
        "tenantName": "string"
      },
      "recipientAddress": "string",
      "recipientAddressLabel": "string",
      "email": {
        "cc": [
          "string"
        ],
        "bcc": [
          "string"
        ]
      },
      "protocol": "string",
      "direction": "string",
      "messageType": "string",
      "status": "string",
      "isManual": true,
      "subject": "string",
      "bodyPreview": "string",
      "parts": [
        {
          "sortOrder": 0,
          "partType": "string",
          "payload": "string"
        }
      ],
      "attachments": [
        {
          "attachmentUuid": "string",
          "fileName": "string",
          "contentType": "string",
          "category": "string",
          "sizeBytes": 0,
          "isVoiceNote": true,
          "url": "string",
          "previewUrl": "string",
          "thumbnailUrl": "string"
        }
      ],
      "mentions": [
        {
          "mentionId": "string",
          "mentionedUuid": "string",
          "mentionedType": "string",
          "workspaceUuid": "string",
          "displayName": "string"
        }
      ],
      "tags": [
        {
          "tagType": "string",
          "tagTypeCode": "string",
          "tagTypeDisplayName": "string",
          "tagUuid": "string",
          "tagValue": "string",
          "secondaryValues": [
            "string"
          ],
          "parentTags": [
            {
              "tagTypeUuid": "string",
              "referenceIdentifier": "string"
            }
          ]
        }
      ],
      "predictions": [
        {
          "featureCode": "string",
          "predictedValue": "string",
          "confidence": 0,
          "details": {},
          "feedback": [
            {
              "verdict": "string",
              "reason": "string",
              "userUuid": "string",
              "workspaceUuid": "string"
            }
          ]
        }
      ],
      "systemEvent": {
        "code": "string",
        "params": {},
        "subject": "string",
        "buttons": [
          {
            "label": "string",
            "translationKey": "string",
            "theme": "string",
            "actionEventData": {}
          }
        ]
      },
      "failure": {
        "code": "string",
        "reason": "string"
      },
      "draft": {
        "addSignature": true
      },
      "snooze": {
        "snoozedAt": "string",
        "snoozedUntil": "string",
        "note": "string"
      },
      "call": {
        "providerCallId": "string",
        "status": "string",
        "durationSeconds": 0,
        "recording": {
          "url": "string"
        },
        "transcript": {
          "text": "string",
          "utterances": [
            {
              "speaker": "string",
              "startSeconds": 0,
              "endSeconds": 0,
              "text": "string",
              "confidence": 0
            }
          ]
        }
      },
      "whatsApp": {
        "kind": "string",
        "template": {
          "name": "string",
          "language": "string",
          "contentSid": "string",
          "variables": {}
        },
        "isVoiceNote": true,
        "forwarded": true,
        "frequentlyForwarded": true,
        "profileName": "string",
        "interactive": {
          "type": "string",
          "header": "string",
          "body": "string",
          "footer": "string",
          "selectedButtonId": "string",
          "selectedButtonTitle": "string",
          "selectedItemId": "string",
          "selectedItemTitle": "string",
          "selectedItemDescription": "string",
          "actions": [
            {
              "id": "string",
              "title": "string",
              "description": "string",
              "type": "string",
              "url": "string",
              "phoneNumber": "string"
            }
          ]
        },
        "reaction": {
          "emoji": "string",
          "removed": true,
          "reactedMessageSid": "string",
          "reactedMessageUuid": "string"
        }
      },
      "internalNote": {
        "notified": [
          {
            "tenantUuid": "string",
            "type": "string",
            "uuid": "string",
            "displayName": "string",
            "tenantName": "string"
          }
        ],
        "following": [
          {
            "tenantUuid": "string",
            "type": "string",
            "uuid": "string",
            "displayName": "string",
            "tenantName": "string"
          }
        ],
        "groups": [
          {
            "uuid": "string",
            "displayName": "string",
            "members": [
              {
                "tenantUuid": "string",
                "type": "string",
                "uuid": "string",
                "displayName": "string",
                "tenantName": "string"
              }
            ]
          }
        ],
        "followersAdded": [
          {
            "tenantUuid": "string",
            "type": "string",
            "uuid": "string",
            "displayName": "string",
            "tenantName": "string"
          }
        ],
        "followersRemoved": [
          {
            "tenantUuid": "string",
            "type": "string",
            "uuid": "string",
            "displayName": "string",
            "tenantName": "string"
          }
        ]
      },
      "origin": {
        "service": "string",
        "automationRuleUuid": "string",
        "campaignId": "string"
      },
      "businessConnect": {
        "originTenantName": "string"
      },
      "insertTs": "string",
      "sentAt": "string",
      "scheduledAt": "string",
      "legacyRef": {
        "protocol": "string",
        "messageType": "string",
        "purpose": "string",
        "deliveryStatus": "string",
        "optOutStatus": "string",
        "metaData": "string"
      }
    }
  ],
  "nextCursor": "string",
  "requestUuid": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Loading...