Properties
| Name | Type | Description |
|---|---|---|
| code | string | The conversation's code |
The conversation's code | ||
| externalAddress | string | The other party's number, E.164 |
The other party's number, E.164 | ||
| contact | CodeAndNameDto | |
| client | ClientRefDto | |
| isAmbiguous | boolean | The number was on more than one record when it was last matched automatically; see candidates |
The number was on more than one record when it was last matched automatically; see candidates | ||
| matchedByUserName | string | Who matched or unmatched it by hand; null when its match is automatic |
Who matched or unmatched it by hand; null when its match is automatic | ||
| matchedDate | string | When it was matched or unmatched by hand |
When it was matched or unmatched by hand | ||
| dismissedByUserName | string | Who dismissed it from the inbox |
Who dismissed it from the inbox | ||
| dismissedDate | string | When it was dismissed from the inbox; null while it is not |
When it was dismissed from the inbox; null while it is not | ||
| lastMessageDate | string | When its newest message arrived or was sent |
When its newest message arrived or was sent | ||
| whatsAppWindowClosesAt | string | When WhatsApp free text to the number stops being allowed, as the Messaging Service stated it (24 hours after |
When WhatsApp free text to the number stops being allowed, as the Messaging Service stated it (24 hours after | ||
| hasUnread | boolean | Someone in the practice has yet to read its newest inbound message. Practice-wide, not per user: |
Someone in the practice has yet to read its newest inbound message. Practice-wide, not per user: | ||
| lastReadDate | string | When it was last marked read; null when it never has been |
When it was last marked read; null when it never has been | ||
| messageCount | integer | How many messages it holds, from the Messaging Service; 0 when the service could not be read |
How many messages it holds, from the Messaging Service; 0 when the service could not be read | ||
| lastMessage | MessagingMessageDto | |
| candidates | array of MessagingMatchCandidateDto | For an ambiguous conversation in the inbox: the contacts and clients holding its number. Empty otherwise. |
For an ambiguous conversation in the inbox: the contacts and clients holding its number. Empty otherwise. | ||
JSON Example
{
"code": "string",
"externalAddress": "string",
"contact": {
"code": "string",
"name": "string"
},
"client": {
"code": "string",
"name": "string",
"logoUrl": "string"
},
"isAmbiguous": false
}
Used By Operations
-
PUT
Match Messaging Conversation
/tenants/{tenant}/messaging/conversations/{code}/match
-
DELETE
Unmatch Messaging Conversation
/tenants/{tenant}/messaging/conversations/{code}/match
-
POST
Dismiss Messaging Conversation
/tenants/{tenant}/messaging/conversations/{code}/dismiss
-
DELETE
Undismiss Messaging Conversation
/tenants/{tenant}/messaging/conversations/{code}/dismiss