/channels

Retrieves information of a given channel or channel list

Endpoint Headers:

  • bot-token - Token of the Bot [String] (Required)

  • apikey - Your Api Auth Key [String] (Required)

  • guild-id - ID of the guild to be fetched [Snowflake] (Required)

  • channel - ID of the channel to be fetched [Snowflake] (Optional)

Endpoint URL Parameters

  • simple - Retrieves a simpler set of data [Boolean] (Optional)

If no channel was specified, it will grab all data and retrieve an Array, otherwise it will grab the one specified and retrieve an Object.

This will affect how to grab your data!

Examples:

Data API version required. Must replace <version> with either release or beta.

Bot Designer for Discord

Example usage of /guild/channels endpoint using BDFD

$httpAddHeader[apikey;<YOUR-API-KEY>]
$httpAddHeader[bot-token;<YOUR-BOT-TOKEN>]
$httpAddHeader[guild-id;1064098700307218463] 
$httpAddHeader[channel;1076739010849947748] $c[Optional header]
$httpGet[https://bdfddata.rickyjs.xyz/<version>/guild/channels]


$httpResult OR $httpResult[details]

OR

$httpAddHeader[apikey;<YOUR-API-KEY>]
$httpAddHeader[bot-token;<YOUR-BOT-TOKEN>]
$httpAddHeader[guild-id;1064098700307218463] 
$c[Header 'channel' cannot be used when simple = true!]
$httpGet[https://bdfddata.rickyjs.xyz/<version>/guild/channels?simple=true]


$httpResult OR $httpResult[details]
Discord.js

Example usage of /guild/channels endpoint using Discord.js

const axios = require('axios');
(async () => {
return await axios.get('https://bdfddata.rickyjs.xyz/<version>/guild/channels', {
headers: {
"apikey": "<YOUR-API-KEY>",
"bot-token": "<YOUR-BOT-TOKEN>",
"guild-id": "1064098700307218463",
"channel": "1076739010849947748" // Optional header
}
}).then(res=>res.data)
})()

OR

const axios = require('axios');
(async () => {
return await axios.get('https://bdfddata.rickyjs.xyz/<version>/guild/channels?simple=true', {
headers: {
"apikey": "<YOUR-API-KEY>",
"bot-token": "<YOUR-BOT-TOKEN>",
"guild-id": "1064098700307218463"
}
}).then(res=>res.data)
})()

Possible Responses (Codes)

Code 200 (Simple Not Used)

API succeeded and details were fetched.

{
  status: 200,
  details: [
  {
      "id": "1064102244523458680",
      "last_message_id": "1072162544359329842",
      "type": "GuildText",
      "name": "πŸŽ©γƒ»tips",
      "position": 5,
   
    
  >  'Read on `Channel Objects` : https://discord.com/developers/docs/resources/channel#channels-resource'
  ]
}
Code 200 (Simple Used)

API succeeded and details were fetched.

{
status: 200,
details: {
  channels: { // returns channel IDs!
    GuildText: [],
    GuildVoice: [],
    GuildCategory: [],
    GuildAnnouncement: [],
    AnnouncementThread: [],
    PublicThread: [],
    PrivateThread: [],
    GuildStageVoice: [],
    GuildDirectory: [],
    GuildForum: [],
    GuildNews: [],
    GuildNewsThread: [],
    GuildPublicThread: [],
    GuildPrivateThread: []
    },
    count: { // Returns channel count!
      GuildText: '26',
      GuildVoice: '2',
      GuildCategory: '5',
      GuildAnnouncement: '0',
      AnnouncementThread: '0',
      PublicThread: '0',
      PrivateThread: '0',
      GuildStageVoice: '0',
      GuildDirectory: '0',
      GuildForum: '1',
      GuildNews: '2',
      GuildNewsThread: '0',
      GuildPublicThread: '0',
      GuildPrivateThread: '0'
    }
  },
Code 400

An error occurred that stopped execution.

{
    status: 400
    error: 'Cannot read ...  (This can vary)'
}
Code 401

Invalid bot token was provided.

{
  status: 401,
  details: { message: '401: Unauthorized', code: 0 }
}
Code 404

Guild was not found via DAPI

{
  status: 404,
  details: { message: 'Unknown Guild', code: 10004 } (this can vary)
}

Last updated