Aller au contenu principal

POST /messenger/create-message

version 2.0.0

Créer un nouveau message.

Authentification

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

👥 Autorisation

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

  • Corail
  • Zelta

🧾 Paramètres

Les champs suivants sont attendus dans le corps de la requête :

NomTypeDansRequisDescriptionValeur par default
bodystringBodyLe message
headersstringBodyL'entête du message
queueNamestringBodyLe nom du message?
createdAtstringBodyLe moment où le message a été créecurrentTimeStamp
availableAtstringBodyLe moment où le message sera accessiblecurrentTimeStamp
deliveredAtstringBodyLe moment où le message est reçu

🧾 Réponse

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

NomTypeNullableDescription
idnumberL’identifiant du message
bodystringLe message
headersstringL'entête du message
queueNamestringLe nom du message?
createdAtstringLe moment où le message a été crée
availableAtstringLe moment où le message sera accessible
deliveredAtstringLe moment où le message est reçu

📤 Exemple de requête

http://0.0.0.0/api/messenger/create-message

Et dans le body mettre par exemple :

{
"id": 7,
"body": "Je ne suis pas sûr pour le 'queue_name'",
"headers": "Advienne que pourra",
"queueName": "Le nom du message?",
"availableAt": "2025-11-12T11:00:00Z"
}

📥 Exemple de réponse

Si le message est bien créé (code 201) :

{
"id": 7,
"body": "Je ne suis pas sûr pour le 'queue_name'",
"headers": "Advienne que pourra",
"queueName": "Le nom du message?",
"createdAt": "2025-10-12T10:00:00Z",
"availableAt": "2025-11-12T11:00:00Z",
"deliveredAt": null
}

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTPDescriptionCause possible
400Bad RequestParamètres manquants ou invalides
401UnauthorizedClé API manquante ou invalide
403ForbiddenDroits insuffisants pour utiliser la requête
500Internal Server ErrorErreur 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

NomTypeDescription
codenumberLe code d'erreur que retourne la requête
messagestringLe message de l'API expliquant l'erreur

Exemple avec l'erreur 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas accès à cette requête.

{
"message": "Access Denied",
"code": 403
}