Chat Messages
chat/messages@1.0.22 providers
Get chat messages
Retrieve paginated list of messages
Input
Destination
After Timestamp
Before Timestamp
Limit
Page
Result
Messages
Next Page
Rate Limit
1.Choose a provider
2.Use GetMessages with mock in your code
Below instructions are for our Node.js SDK. Use OneService for other languages.
npm i @superfaceai/one-sdk
Copied!
const { SuperfaceClient } = require('@superfaceai/one-sdk');
// You can manage tokens here: https://superface.ai/insights
const sdk = new SuperfaceClient({ sdkAuthToken: '<< Login to get your token >>' });
async function run() {
// Load the profile
const profile = await sdk.getProfile('chat/messages@1.0.2');
// Use the profile
const result = await profile
.getUseCase('GetMessages')
.perform({
destination: 'general',
limit: 2
}, {
provider: 'mock'
});
// Handle the result
try {
const data = result.unwrap();
console.log(data);
} catch (error) {
console.error(error);
}
}
run();Copied!
Structure details
Input (object)
destination
required
Representation of a messaging destination. Can be ID or channel name, depending on the provider capability.
string
afterTimestamp
optional
Retrieve only messages after the given UNIX timestamp (in milliseconds, e.g. 1095379198750)
number
beforeTimestamp
optional
Retrieve only messages before the given UNIX timestamp (in milliseconds, e.g. 1095379198750)
number
limit
optional
Maximum number of messages to retrieve in one page
number
page
optional
Identification of page with paginated results (cursor)
string
Example
{
"destination": "general",
"limit": 2
}Copied!
Result (object)
messages
required
List of retrieved messages
list
id
required
Unique identifier of the message
string
author
required
Author of retrieved message. Contains ID and username, depending on the provider capability.
object
id
required
string
username
optional
string
createdAt
required
UNIX timestamp (in milliseconds, e.g. 1095379198750) when the message was created
number
url
optional
URL address pointing to retrieved message.
string
hasThread
optional
Boolean that represents whether message is parent to some thread
boolean
threadId
optional
If the message was sent to a thread, identifies the parent thread by its Id.
string
text
optional
Contents of the retrieved message
string
updatedAt
optional
UNIX timestamp (in milliseconds, e.g. 1095379198750) when the message was last updated
number
reactions
optional
List of reactions on retrieved message. Each reaction contains emoji string containing encoded emoji,
number of reactions and list of users (IDs or usernames, depending on the provider capability)
list
emoji
optional
string
count
optional
number
users
optional
list
attachments
optional
List of attachments in retrieved message. Contains
list
id
required
Unique identifier of the attachment
string
createdAt
required
UNIX timestamp (in milliseconds, e.g. 1095379198750) when the attachment was created
number
fileName
optional
Name of attached file
string
mediaType
optional
MIME type of the attached file
string
url
optional
Source url of the attachment
string
nextPage
optional
Cursor to the next page for pagination forwards
string
rateLimit
optional
Rate limit details.
object
bucket
optional
Different parts of API may have different rate limits.
Bucket identifies to which part of API the rate limits apply.
string
totalRequests
optional
Total requests available in the time window.
number
remainingRequests
optional
Remaining requests available in the time window.
number
remainingRequestsPercentage
optional
Remaining requests available in the time window in percents.
number
resetTimestamp
optional
Unix timestamp when the rate limits will reset (in milliseconds).
number
resetAfter
optional
Number of seconds until reset of rate limit
number
retryAfter
optional
Number of seconds until user can retry the request
number
Example
{
"messages": [
{
"id": "1",
"author": {
"id": "U01",
"username": "user1"
},
"createdAt": 1643835553658.259,
"text": "test 1"
}
]
}Copied!