API HSMS - Documentation

Consulter son solde SMS avec HSMS

Vous pouvez consulter le nombre total de SMS disponible au sein de chacune de vos applications en formulant une requête de type POST comme celle-ci :

Method : POST

URL : https://hsms.ci/api/check-sms

Authorization : "bearer Token ( Disponible au sein de votre Tableau de bord HSMS )"

clientid : Identifiant de l'application concernée ( Disponible au sein de votre Tableau de bord HSMS )

clientsecret : Mot de passe de l'application concernée ( Disponible au sein de votre Tableau de bord HSMS )

Formulation de la requête


                            curl --location --request POST 'https://hsms.ci/api/check-sms' \
                            -H 'authorization : Bearer TjJ4ZTd4emsyNUZaRW5TMFlnbWxEMTBhOnhwUERza0JJOUdLcGJQamtISnJBTjZRYQ==' \
                            -H 'content-type : application/form-data' \
                            -d 'clientid=BOULANGERIE_fbjrgfjbjnjvfvj & clientsecret=bf5b6873bc2e6e020d5bec0ad818ceb4bab605' \

Reponse attendue : 


                            {
                                "SMS disponibles": 0,
                                "Application": "JK LIVRAISON"
                            }

Comment envoyer des SMS avec notre Api en Python ,Php, Java , Javascript ?

Rien de plus simple que l'envoi de sms avec l'APi de HSMS , afin d'y arriver , vous devez formuler une requete de type POST comme celle-ci :

Vous pouvez consulter le nombre total de SMS disponible au sein de chacune de vos applications en formulant une requête de type POST comme celle-ci :

Method : POST

URL : https://hsms.ci/api/envoi-sms

Authorization : "bearer Token ( Disponible au sein de votre Tableau de bord HSMS )"

clientid : Identifiant de l'application concernée ( Disponible au sein de votre Tableau de bord HSMS )

clientsecret : Mot de passe de l'application concernée ( Disponible au sein de votre Tableau de bord HSMS )

telephone : liste des numeros séparés d'une virgule, vous ne devez pas ajouter d'espaces , ni d'autres symboles entre les numéros ( Exemple: 002250789889494, 002250789426868)

message : le message à envoyer au(x) destinataire(s)

NB : Le nombre de message s'incrémente à chaque 160 caractères, par exemple si vous envoyez un message de 161 caractères total, le sytème vous facturera 2 SMS.

Formulation de la requête

                            curl --location --request POST 'https://hsms.ci/api/envoi-sms/' \
                            -H 'authorization : Bearer TjJ4ZTd4emsyNUZaRW5TMFlnbWxEMTBhOnhwUERza0JJOUdLcGJQamtISnJBTjZRYQ==' \
                            -H 'content-type : application/form-data' \
                            -d 'clientid=BOULANGERIE_fbjrgfjbjnjvfvj & clientsecret=bf5b6873bc2e6e020d5bec0ad818ceb4bab605 & telephone=2250789889555,2250505500220,2250160709894 & message=bonjour ' \

Reponse en cas d'envoi reussi : 
                            {
                              "success": true,
                              "message": "Message(s) envoyé(s)",
                              "resultats": [
                                    {
                                        "destinataire": "002250709797390",
                                        "ticket": "a5555990-08bd-11ef-9401-00000a148c01"
                                    }
                              ]
                            }
                            
                            status code = 200

Comment envoyer des SMS Unicode avec notre Api en Python ,Php, Java , Javascript ?

Rien de plus simple que l'envoi de sms avec l'APi de HSMS , afin d'y arriver , vous devez formuler une requete de type POST comme celle-ci :

Vous pouvez consulter le nombre total de SMS disponible au sein de chacune de vos applications en formulant une requête de type POST comme celle-ci :

Method : POST

URL : https://hsms.ci/api/envoi-sms

Authorization : "bearer Token ( Disponible au sein de votre Tableau de bord HSMS )"

clientid : Identifiant de l'application concernée ( Disponible au sein de votre Tableau de bord HSMS )

clientsecret : Mot de passe de l'application concernée ( Disponible au sein de votre Tableau de bord HSMS )

telephone : liste des numeros séparés d'une virgule, vous ne devez pas ajouter d'espaces , ni d'autres symboles entre les numéros ( Exemple: 002250789889494, 002250789426868)

message : le message à envoyer au(x) destinataire(s)

unicode : true.

Permet l'utilisation de l'Unicode. Si le contenu du SMS nécessite l'utilisation de l'Unicode en raison de la présence de caractères qui ne font pas partie de l'alphabet GSM 03.38, le SMS sera envoyé en Unicode. En l'absence de ce paramètre, votre message sera converti pour être transmis en utilisant l'alphabet GSM (GSM 03.38), ce qui implique la substitution de certains caractères par leurs équivalents proches.

NB : Le nombre de message s'incrémente à chaque 160 caractères, par exemple si vous envoyez un message de 161 caractères total, le sytème vous facturera 2 SMS.

Formulation de la requête

                                curl --location --request POST 'https://hsms.ci/api/envoi-sms/' \
                                -H 'authorization : Bearer TjJ4ZTd4emsyNUZaRW5TMFlnbWxEMTBhOnhwUERza0JJOUdLcGJQamtISnJBTjZRYQ==' \
                                -H 'content-type : application/form-data' \
                                -d 'clientid=BOULANGERIE_fbjrgfjbjnjvfvj&clientsecret=bf5b6873bc2e6e020d5bec0ad818ceb4bab605&telephone=2250789889555,2250505500220,2250160709894&message=bonjour&unicode=true' \

Reponse en cas d'envoi reussi : 
                            {
                              "success": true,
                              "message": "Message(s) envoyé(s)",
                              "resultats": [
                                    {
                                        "destinataire": "002250709797390",
                                        "ticket": "a5555990-08bd-11ef-9401-00000a148c01"
                                    }
                              ]
                            }

                            status code = 200

Comment envoyer des SMS programmé en avance, expéditeur personnalisé avec notre Api en Python ,Php, Java , Javascript ?

Rien de plus simple que l'envoi de sms avec l'APi de HSMS , afin d'y arriver , vous devez formuler une requete de type POST comme celle-ci :

Vous pouvez consulter le nombre total de SMS disponible au sein de chacune de vos applications en formulant une requête de type POST comme celle-ci :

Method : POST

URL : https://hsms.ci/api/envoi-sms/sms-programme

Authorization : "bearer Token ( Disponible au sein de votre Tableau de bord HSMS )"

clientid : Identifiant de l'application concernée ( Disponible au sein de votre Tableau de bord HSMS )

clientsecret : Mot de passe de l'application concernée ( Disponible au sein de votre Tableau de bord HSMS )

telephone : liste des numeros séparés d'une virgule, vous ne devez pas ajouter d'espaces , ni d'autres symboles entre les numéros ( Exemple: 002250789889494, 002250789426868)

message : le message à envoyer au(x) destinataire(s)

dateenvoi : 2038-01-19 04:14:08

Date et heure d'envoi du message (format : yyyy-MM-dd HH:mm:ss, ex : 2038-01-19 04:14:08). La valeur de dateenvoi ne peut être utilisée pour programmer un envoi différé de plus de 24 heures. Des délais supérieurs doivent être gérés dans votre application. Une fois programmé, un message ne peut pas être annulé. Le fuseau horaire utilisé est celui de la France. Si un destinataire a exprimé son souhait de ne plus recevoir de SMS (STOP), vous ne pourrez pas arrêter un envoi déjà planifié. Les SMS programmés pour une date passée sont envoyés immédiatement.

NB : Le nombre de message s'incrémente à chaque 160 caractères, par exemple si vous envoyez un message de 161 caractères total, le sytème vous facturera 2 SMS.

Formulation de la requête

                                curl --location --request POST 'https://hsms.ci/api/envoi-sms/' \
                                -H 'authorization : Bearer TjJ4ZTd4emsyNUZaRW5TMFlnbWxEMTBhOnhwUERza0JJOUdLcGJQamtISnJBTjZRYQ==' \
                                -H 'content-type : application/form-data' \
                                -d 'clientid=BOULANGERIE_fbjrgfjbjnjvfvj&clientsecret=bf5b6873bc2e6e020d5bec0ad818ceb4bab605&telephone=2250789889555,2250505500220,2250160709894&message=bonjour&dateenvoi=2024-05-02 21:55:08' \

Reponse en cas d'envoi reussi : 
                            {
                              "success": true,
                              "message": "Message(s) envoyé(s)",
                              "resultats": [
                                    {
                                        "destinataire": "002250709797390",
                                        "ticket": "a5555990-08bd-11ef-9401-00000a148c01"
                                    }
                              ]
                            }

                            status code = 200

Génération de Token

l'API de HSMS vous permet d'envoyer des SMS depuis votre site internet ou votre application mobile, simple et facile à integrer à vos projets.

Pour des raisons de sécurité, chacune de vos requêtes doit être accompagnée d'un Token , il est par defaut disponible sur tous les comptes HSMS , vous pouvez aussi le renouveler :

Method : POST

URL : "https://hsms.ci/api/token/"

email : Adresse Email de votre compte HSMS

password : Mot de passe de votre compte HSMS


                          curl --location --request POST 'https://hsms.ci/api/token/' \
                          -H 'content-type : application/form-data' \
                          -d 'email=VOTRE_EMAIL_HSMS & password=VOTRE_MOT_DE_PASSE_HSMS' \

Reponse attendue : 

                                {
                                    "success": true,
                                    "message": "OK",
                                    "token": "bf5b6873bc2e6eb90e0d5bec0ad718ceb4bab605"
                                }

Cas Pratiques avec CURL 


                               curl --location --request POST 'https://hsms.ci/api/envoi-sms/' \
--header 'Authorization: Bearer ef4a6f41ba7a260d5ac68f0wwww91e6a' \
--form 'clientid="BOULANGERIE_dT2ju0y"' \
--form 'clientsecret="BOULANGERIEeerr2022121220927.438324Sgk9YCseKXPL2x2hhu5e"' \
--form 'telephone="2250789923424"' \
--form 'message="hello"'

Foire aux Questions

Si vous avez besoin d'aide pour l'intégration de l'API , cliquez pour ecrire à notre support technique