BadRequestDTO
{
"statusCode": 400,
"message": "Bad Request"
}
UnauthorizedDTO
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}
StartAfterNumberSchema
Search to begin after the specified date - should contain the sort value of the last document
{
"startAfterDate": 1600854
}
StartAfterArrayNumberSchema
Search to begin after the specified date - should contain the sort value of the last document
{
"startAfterDate": [
1600854,
1600851
]
}
ConversationSchema
Conversation Id
Contact Id
Location Id
Content of the most recent message in the conversation
Channel/type of the most recent message (SMS, Email, Call, etc)
Primary channel/type of the conversation (Phone, Email, etc)
Number of unread messages in this conversation
Complete name of the contact (first and last name)
Alternative display name for the contact - used when full name is not available
Primary email address of the contact
Primary phone number of the contact
{
"id": "ABCHkzuJQ8ZMd4Te84GK",
"contactId": "ABCHkzuJQ8ZMd4Te84GK",
"locationId": "ABCHkzuJQ8ZMd4Te84GK",
"lastMessageBody": "This is a sample message body",
"lastMessageType": "TYPE_CALL",
"type": "TYPE_PHONE",
"unreadCount": 1,
"fullName": "John Doe",
"contactName": "John Doe Company",
"email": "johndoe@mailingdomain.com",
"phone": "+15550001234"
}
SendConversationResponseDto
The list of all conversations found for the given query
Conversation Id
Contact Id
Location Id
Content of the most recent message in the conversation
Channel/type of the most recent message (SMS, Email, Call, etc)
Primary channel/type of the conversation (Phone, Email, etc)
Number of unread messages in this conversation
Complete name of the contact (first and last name)
Alternative display name for the contact - used when full name is not available
Primary email address of the contact
Primary phone number of the contact
Total Number of results found for the given query
{
"conversations": [
{
"id": "ABCHkzuJQ8ZMd4Te84GK",
"contactId": "ABCHkzuJQ8ZMd4Te84GK",
"locationId": "ABCHkzuJQ8ZMd4Te84GK",
"lastMessageBody": "This is a sample message body",
"lastMessageType": "TYPE_SMS",
"type": "TYPE_PHONE",
"unreadCount": 1,
"fullName": "John Doe",
"contactName": "John Doe Company",
"email": "johndoe@mailingdomain.com",
"phone": "+15550001234"
}
],
"total": 100
}
CreateConversationDto
Location ID as string
Contact ID as string
{
"locationId": "tDtDnQdgm2LXpyiqYvZ6",
"contactId": "tDtDnQdgm2LXpyiqYvZ6"
}
ConversationCreateResponseDto
Unique identifier for the conversation
Date when the conversation was last updated
Date when the conversation was created
Flag indicating if this conversation has been deleted
Unique identifier of the contact associated with this conversation
Unique identifier of the business location where this conversation takes place
Date of the last message in the conversation
Unique identifier of the team member assigned to this conversation
{
"id": "tDtDnQdgm2LXpyiqYvZ6",
"dateUpdated": "2023-10-01T12:00:00Z",
"dateAdded": "2023-10-01T12:00:00Z",
"deleted": false,
"contactId": "ve9EPM428kjkvShlRW1KT",
"locationId": "ve9EPM428kjkvShlRW1KT",
"lastMessageDate": "2023-10-01T12:00:00Z",
"assignedTo": "ve9EPM428kjkvShlRW1KT"
}
CreateConversationSuccessResponse
Indicates whether the API request was successful.
Conversation data of the provided conversation ID.
Unique identifier for the conversation
Date when the conversation was last updated
Date when the conversation was created
Flag indicating if this conversation has been deleted
Unique identifier of the contact associated with this conversation
Unique identifier of the business location where this conversation takes place
Date of the last message in the conversation
Unique identifier of the team member assigned to this conversation
{
"success": true,
"conversation": {
"id": "tDtDnQdgm2LXpyiqYvZ6",
"dateUpdated": "2023-10-01T12:00:00Z",
"dateAdded": "2023-10-01T12:00:00Z",
"deleted": false,
"contactId": "ve9EPM428kjkvShlRW1KT",
"locationId": "ve9EPM428kjkvShlRW1KT",
"lastMessageDate": "2023-10-01T12:00:00Z",
"assignedTo": "ve9EPM428kjkvShlRW1KT"
}
}
GetConversationByIdResponse
Unique identifier of the contact associated with this conversation
Unique identifier of the business location where this conversation takes place
Flag indicating if this conversation has been moved to trash/deleted
Flag indicating if this conversation is currently in the main inbox view
Communication channel type for this conversation: 1 (Phone), 2 (Email), 3 (Facebook Messenger), 4 (Review), 5 (Group SMS), 6 (Internal Chat - coming soon)
Number of messages in this conversation that have not been read by the user
Unique identifier of the team member currently responsible for handling this conversation
Unique identifier for this specific conversation thread
Flag indicating if this conversation has been marked as important/starred by the user
{
"contactId": "ve9EPM428kjkvShlRW1KT",
"locationId": "ve9EPM428kjkvShlRW1KT",
"deleted": false,
"inbox": true,
"type": 0,
"unreadCount": 1,
"assignedTo": "ve9EPM428kjkvShlRW1KT",
"id": "ve9EPM428kjkvShlRW1KT",
"starred": true
}
UpdateConversationDto
Location ID as string
Count of unread messages in the conversation
Starred status of the conversation.
{
"locationId": "tDtDnQdgm2LXpyiqYvZ6",
"unreadCount": 1,
"starred": true,
"feedback": {}
}
ConversationDto
Contact ID as string
Location ID as string
Contact ID as string
Assigned User ID as string
User ID as string
Last message body as string
Last message date as UTC
Type of the last message sent/received in the conversation.
Count of unread messages in the conversation
Inbox status of the conversation.
Starred status of the conversation.
Deleted status of the conversation.
{
"id": "tDtDnQdgm2LXpyiqYvZ6",
"locationId": "tDtDnQdgm2LXpyiqYvZ6",
"contactId": "tDtDnQdgm2LXpyiqYvZ6",
"assignedTo": "tDtDnQdgm2LXpyiqYvZ6",
"userId": "tDtDnQdgm2LXpyiqYvZ6",
"lastMessageBody": "Hello, this is the message body",
"lastMessageDate": "1628008053263",
"lastMessageType": "TYPE_CALL",
"unreadCount": 1,
"inbox": true,
"starred": true,
"deleted": false
}
GetConversationSuccessfulResponse
Boolean value as the API response.
Conversation data of the provided conversation ID.
Contact ID as string
Location ID as string
Contact ID as string
Assigned User ID as string
User ID as string
Last message body as string
Last message date as UTC
Type of the last message sent/received in the conversation.
Count of unread messages in the conversation
Inbox status of the conversation.
Starred status of the conversation.
Deleted status of the conversation.
{
"success": true,
"conversation": {
"id": "tDtDnQdgm2LXpyiqYvZ6",
"locationId": "tDtDnQdgm2LXpyiqYvZ6",
"contactId": "tDtDnQdgm2LXpyiqYvZ6",
"assignedTo": "tDtDnQdgm2LXpyiqYvZ6",
"userId": "tDtDnQdgm2LXpyiqYvZ6",
"lastMessageBody": "Hello, this is the message body",
"lastMessageDate": "1628008053263",
"lastMessageType": "TYPE_CALL",
"unreadCount": 1,
"inbox": true,
"starred": true,
"deleted": false
}
}
DeleteConversationSuccessfulResponse
Boolean value as the API response.
{
"success": true
}
GetEmailMessageResponseDto
External Id
Message Id or thread Id
An array of attachment URLs.
Name and Email Id of the sender
List of email Ids of the receivers
List of email Ids of the people in the cc field
List of email Ids of the people in the bcc field
In case of reply, email message Id of the reply to email
Email source
Conversation provider ID
{
"id": "ve9EPM428h8vShlRW1KT",
"altId": "ve9EPM428h8vShlRW1KT",
"threadId": "ve9EPM428h8vShlRW1KT",
"locationId": "ve9EPM428h8vShlRW1KT",
"contactId": "ve9EPM428h8vShlRW1KT",
"conversationId": "ve9EPM428h8vShlRW1KT",
"dateAdded": "2024-03-27T18:13:49.000Z",
"subject": "Order confirm",
"body": "Hi there",
"direction": "inbound",
"status": "pending",
"contentType": "text/plain",
"attachments": [
"string"
],
"provider": "Leadconnector Gmail",
"from": "string",
"to": [
"string"
],
"cc": [
"string"
],
"bcc": [
"string"
],
"replyToMessageId": "string",
"source": "workflow",
"conversationProviderId": "cI08i1Bls3iTB9bKgF01"
}