List Messages
/unified/instant-messaging/messages
Query Parameters
Refer Specifying query parameters in Truto APIs
2 supported2 required
Channel to which the message belongs.
3 supported3 required
Unique identifier for the channel.
Type of the channel.
channeldmgroup_dm
Name of the channel.
The user whose messages are to be retrieved.
1 supported
The unique identifier of the user.
Date and time when the message was last updated.
3 supported
Parent entity of the message.
3 supported
Unique identifier for the parent entity.
Type of the parent entity.
message
Date and time when the message was created.
3 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
Defaults to unified.
unifiedunifiedrawnormalizedstream
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Messages
Unique identifier for the message.
3 supported
Attachments of the message.
3 supported
4 properties
Unique identifier for the attachment.
Name of the attachment.
Type of the attachment.
URL of the attachment.
Author of the message. Is a member object.
3 supported
2 properties
Unique identifier for the author.
Name of the author.
Body of the message.
3 supported
2 properties
Content of the message body.
Format of the message body.
Channel to which the message belongs.
3 supported
3 properties
Unique identifier for the channel.
Name of the channel.
Type of the channel.
Date and time when the message was created.
3 supported
Whether the message has children.
1 supported
Parent entity of the message.
3 supported
2 properties
Unique identifier for the parent entity.
Type of the parent entity.
message
Raw data returned from the remote API call.
Date and time when the message was last updated.
3 supported
curl -X GET 'https://api.truto.one/unified/instant-messaging/messages?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/instant-messaging/messages?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/instant-messaging/messages"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())import Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'instant-messaging',
'messages',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"instant-messaging",
"messages",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())