Chat Channels
chat/channels@1.0.22 providers
Get Channels
Retrieve paginated list of channels, e.g. text channels in slack or discord
Input
Workspace
Channel Visibility Filter
Limit
Page
Result
Channels
Next Page
Rate Limit
1.Choose a provider
2.Use GetChannels 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/channels@1.0.2');
// Use the profile
const result = await profile
.getUseCase('GetChannels')
.perform({
visibility: 'public',
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)
workspace
optional
Representation of a workspace. Can be guild or workspace, depending on the provider capability.
string
visibility
optional
Limit the listing to either public or private channels; all channels are listed by default.
enum
privatepublic
limit
optional
Maximum number of channels to retrieve
number
page
optional
Identification of page with paginated results (cursor)
string
Example
{
"visibility": "public",
"limit": 2
}Copied!
Result (object)
channels
required
List of retrieved channels
list
id
required
Unique identifier of the channel
string
createdAt
required
UNIX timestamp (in milliseconds, e.g. 1095379198750) when the channel was created
number
name
optional
Name of the retrieved channel
string
description
optional
Description of the channel. Can describe purpose or use of the channel.
string
membersCount
optional
Number of members of the retrieved channel
number
nextPage
optional
Cursor to the next page of listing
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
{
"channels": [
{
"id": "1",
"createdAt": 1546167104000,
"name": "random",
"membersCount": 100
}
]
}Copied!