Chat Threads
chat/threads@1.0.21 provider
Get Threads
Retrieve list of threads from the whole workspace.
Input
Workspace
Result
Threads
Rate Limit
1.Choose a provider
2.Use GetThreads 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/threads@1.0.2');
// Use the profile
const result = await profile
.getUseCase('GetThreads')
.perform({
workspace: 'workspace_id'
}, {
provider: 'mock'
});
// Handle the result
try {
const data = result.unwrap();
console.log(data);
} catch (error) {
console.error(error);
}
}
run();Copied!
Structure details
Input (object)
workspace
required
Identifier of a workspace, for example a Discord guild or a Slack workspace.
string
Example
{
"workspace": "workspace_id"
}Copied!
Result (object)
threads
required
List of retrieved threads
list
id
required
Unique identifier of the thread
string
createdAt
required
UNIX timestamp (in milliseconds, e.g. 1095379198750) when the thread was created
number
channel
required
Unique identifier of the channel where the thread is located
string
archiveAt
optional
UNIX timestamp (in milliseconds, e.g. 1095379198750) when the thread will be archived
Some providers limit the lifetime of threads and automatically archive them after some time period of inactivity.
number
name
optional
Name of retrieved thread
string
membersCount
optional
Number of users participating in the thread
number
messagesCount
optional
Number of messages in the retrieved thread
number
lastMessageAt
optional
UNIX timestamp (in milliseconds, e.g. 1095379198750) when was the last message sent to thread.
number
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
Timestamp when the rate limits will reset (in Unix Timestamp ms format).
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
{
"threads": [
{
"id": "1",
"createdAt": 1546167104000,
"channel": "random"
}
]
}Copied!