HOGI-SMS

Gestion Des Messages

Consultation des messages

La consultation des messages permet à un utilisateur ou à un administrateur de visualiser tous les messages envoyés ou reçus dans le système HOGI-SMS. Cette fonctionnalité offre un aperçu complet de l'historique des communications, incluant le contenu des messages, l'expéditeur, le destinataire, ainsi que la date et l'heure d'envoi. Elle est essentielle pour suivre les échanges, vérifier le statut des messages, et assurer une gestion efficace et sécurisée de la communication au sein de la plateforme.

Endpoint: GET /api/messages/

Authentification:

Requise - Un jeton Bearer doit être envoyé dans l'en-tête :

Authorization: Bearer < votre-jeton >
Paramètres (Query):
Champ Type Obligatoire Description
status string Non Etat du message sent failed received
Exemple de Réponse: 

{
  "count": 1,
  "next": null,
  "previous": null,
  "results":[
    {
      "id": 73,
      "brand_name": "NTABARIZA",
      "recipient_number": "+25761160948",
      "content": "Twabatabarije. Nimero yanyu ni #50. Muyitange ku bigo vy'ubuvuzi, vy'umutekano no ku baremeshakiyago babafashe.",
      "count": 1,
      "response": "OK",
      "status": "sent",
      "created_at": "2025-10-22T09:20:50.552508Z",
      "sent_at": "2025-10-22T09:21:36.725068Z",
      "sent_by": 2
    }
  ]
}

Envoi de message unique

L'envoi d'un message unique permet à un utilisateur autorisé d'envoyer un SMS à un destinataire spécifique via le système HOGI-SMS. Cette fonctionnalité nécessite de fournir les informations essentielles telles que le numéro du destinataire et le contenu du message. Elle garantit que le message est transmis de manière sécurisée et suivie, et permet de vérifier l'état de l'envoi (envoyé, reçu ou échoué). Ce mécanisme est utilisé pour la communication directe avec un contact précis et peut être intégré dans des workflows nécessitant l'envoi ciblé de notifications ou d'informations importantes.

Endpoint: POST /api/messages/

Authentification:

Requise - Un jeton Bearer doit être envoyé dans l'en-tête :

Authorization: Bearer < votre-jeton >
Paramètres (Query):
Nom Type Obligatoire Description
recipient_numbers list Oui Numéros des destinataires du message (format local recommandé).
message string Oui Contenu du message à envoyer.
brand_name string Oui Nom ou identifiant de l'expéditeur. Si non fourni, la valeur par défaut du système est utilisée.
scheduled_time datetime Non Date et heure programmées pour l'envoi du message (optionnel).
Exemple de requête: 

{
    "recipient_numbers": [61069606],
    "brand_name": "efeza",
    "content": "Ibintu biriko bigenda neza"
}
Exemple de Réponse: 

{
    "success_messages": [
        "61069606"
    ],
    "failed_numbers": 0,
    "remaining_sms": 98
}

Envoi de messages multiples

L'envoi de messages multiples permet à un utilisateur autorisé de transmettre simultanément un SMS à plusieurs destinataires via le système HOGI-SMS. Chaque message contient le contenu textuel à envoyer et la liste des destinataires. Cette fonctionnalité garantit que les messages sont envoyés de manière sécurisée et suivie, et permet de vérifier le statut de chaque envoi (envoyé, reçu ou échoué). Elle est particulièrement utile pour les campagnes de communication, les notifications groupées ou les messages d'information destinés à un ensemble de contacts.

Endpoint: POST /api/messages/

Authentification:

Requise - Un jeton Bearer doit être envoyé dans l'en-tête :

Authorization: Bearer < votre-jeton >
Paramètres (Query):
Nom Type Obligatoire Description
recipient_numbers list of strings Non Liste des numéros de téléphone des destinataires. Chaque numéro est une chaîne de caractères (max 128 caractères).
brand_name string Oui Nom de l'expéditeur affiché aux destinataires (max 16 caractères).
content string Oui Contenu du message à envoyer.
response string Non Réponse générée automatiquement par l'API après l'envoi du message (lecture seule).
Exemple de requête: 

{
  "recipient_numbers": ["+25761234567", "+25767890123", "+25769988777"],
  "brand_name": "HOGI-SMS",
  "content": "N'oubliez pas notre offre du week-end !"
}
Exemple de Réponse: 

{
    "success_messages": [
        "61069606"
    ],
    "failed_numbers": 0,
    "remaining_sms": 98
}

Suppression de message non encore envoyé

La suppression d'un message non encore envoyé permet à un utilisateur ou à un administrateur de retirer un message programmé avant son envoi effectif. Cette fonctionnalité est utile pour corriger des erreurs, annuler un envoi prévu ou gérer de manière sécurisée les messages planifiés. Seuls les messages dont l'envoi n'a pas encore été effectué peuvent être supprimés. L'accès à cet endpoint nécessite une authentification valide afin de garantir que seuls les utilisateurs autorisés peuvent effectuer cette action.

Endpoint: DELETE /api/messages/{id}

Authentification:

Requise - Un jeton Bearer doit être envoyé dans l'en-tête :

Authorization: Bearer < votre-jeton >
Paramètres (Query):
Nom Type Obligatoire Description
id integer Oui Identifiant unique du message à supprimer.
Exemple de Réponse: 

{
  "success": true,
  "message": "Le message avec l'ID 25 a été supprimé avec succès."
}

Sur cette page