Connector API
Search…
Message threads

Get all message threads

Get all message threads that you have created, filtered by time interval and/or specific message thread IDs. Note this operation uses the Limitation property to implement a form of data pagination and thus limit the quantity of items returned.

Request

[PlatformAddress]/api/connector/v1/messageThreads/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"CreatedUtc":{
6
"StartUtc": "2022-03-03T00:00:00Z",
7
"EndUtc": "2022-03-14T00:00:00Z"
8
},
9
"Limitation":{
10
"Cursor": "e7f26210-10e7-462e-9da8-ae8300be8ab7",
11
"Count": 10
12
}
13
}
Copied!
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
MessageThreadIds
array of string
optional, max 1000 items
Unique identifiers of Message threads. Required if no other filter is provided.
CreatedUtc
optional, max length 3 months
Interval in which the Message thread was created. Required if no other filter is provided.
UpdatedUtc
optional, max length 3 months
Interval in which the Message thread was updated. Required if no other filter is provided.
Limitation
required
Limitation on the quantity of message thread data returned (using cursor pagination).

Time interval

Property
Type
Contract
Description
StartUtc
string
required
Start of the interval in UTC timezone in ISO 8601 format.
EndUtc
string
required
End of the interval in UTC timezone in ISO 8601 format.

Limitation

Property
Type
Contract
Description
Cursor
string
optional
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned. Note that the response message will include the identifier of the oldest item in the response, which can then be used in subsequent calls - see Limitation example below.
Count
number
required
Count of items to be returned, minimum 1, maximum 1000.
Limitation example: A request with Cursor set to null and Count set to 10 will return the latest or most recent 10 items, and the value of Cursor in the response will reference the oldest of those 10 items returned. Let's say the value of Cursor returned is "12345", then if a subsequent request is made with Cursor set to "12345" and Count set to 10, then the next oldest 10 items will be returned. This process can be repeated as required to fetch historical data.

Response

1
{
2
"MessageThreads": [
3
{
4
"Id": "7f9325f6-ef44-4911-89a8-ae51010a5aa4",
5
"OriginalSender": "John Doe",
6
"Subject": "Example subject",
7
"CreatedUtc": "2022-03-07T16:09:45Z",
8
"UpdatedUtc": "2022-03-07T16:09:45Z"
9
}
10
],
11
"Cursor": "7f9325f6-ef44-4911-89a8-ae51010a5aa4"
12
}
Copied!
Property
Type
Contract
Description
MessageThreads
array of Message threads
required
The filtered message threads.
Cursor
string
optional
Unique identifier of the last and hence oldest message thread returned. This can be used in Limitation in a subsequent request to fetch the next batch of older message threads.

Message thread

Property
Type
Contract
Description
Id
string
required
Unique identifier of the message thread.
OriginalSender
string
required
The sender of the original message in the thread.
Subject
string
required
Subject of the message thread.
CreatedUtc
string
required
Creation date and time of the message thread in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the message thread in UTC timezone in ISO 8601 format.

Add message thread

Creates a new Message thread on behalf of the specified customer, i.e. the sender of the original message in the message thread.

Request

[PlatformAddress]/api/connector/v1/messageThreads/add
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"OriginalSender": "John Doe",
6
"Subject": "Example subject"
7
}
Copied!
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
OriginalSender
string
required
The sender of the original message in the thread.
Subject
string
required
Subject of the message thread.

Response

1
{
2
"MessageThreads": [
3
{
4
"Id": "8d02142f-31cf-4115-90bf-ae5200c7a1ba",
5
"OriginalSender": "John Doe",
6
"Subject": "Example subject",
7
"CreatedUtc": "2022-03-08T12:06:50Z",
8
"UpdatedUtc": "2022-03-08T12:06:50Z",
9
"IsResolved": false
10
}
11
]
12
}
Copied!
Property
Type
Contract
Description
MessageThreads
array of Message threads
required
The created message threads.
Last modified 1mo ago