GET /bot/get-guild

version 2.0.0

Récupère les informations d'un serveur discord.

Authentification

Cette route nécessite de mettre votre clé API dans le Header.

👥 Autorisation

Les personnes autorisées pour utiliser cette requête sont :

Un seul paramètre est requis dans l'URL :

Nom	Type	Dans	Requis	Description	Valeur par default
`guildId`	string	URL	✅	L’identifiant du serveur discord	❌

Les données que l'API retournera avec le succès de la requête :

Nom	Type	Nullable	Description
`id`	number	❌	L'identifiant du serveur en BDD
`guildId`	string	❌	L'identifiant du serveur discord
`voiceChannelId`	string	❌	L'identifiant du channel audio de relié

Voici un exemple pour récupérer le serveur via son identifiant :

http://0.0.0.0/api/bot/get-guild?guildId=15965641156

Si le serveur est trouvé, la réponse (code 200) sera :

{
    "id": 2,
    "guildId": "15965641156",
    "voiceChannelId": "195159915159"
}

Les différents types d'erreurs :

Code HTTP	Description	Cause possible
400	Bad Request	Paramètres manquants ou invalides
401	Unauthorized	Clé API manquante ou invalide
403	Forbidden	Droits insuffisants pour utiliser la requête
404	Not found	Entité introuvable
500	Internal Server Error	Erreur interne du serveur

Attention !

En cas d'erreur 500, contactez directement Zeltaria avec votre requête, sa réponse ainsi que toutes informations que vous jugez pertinentes !

En cas d'erreur voici les informations que retourne l'API

Nom	Type	Description
`code`	number	Le code d'erreur que retourne la requête
`message`	string	Le message de l'API expliquant l'erreur

Exemple avec l'erreur 404 Not found :

Ici par exemple, l'erreur 404 signifie que le serveur n'a pas été trouvé dans la base de données.

{
    "code": 404,
    "message": "Guild not found"
}