L'API REST SMS v.2 - la communication avec la passerelle SMS
Ce document fournit une référence pour toutes les fonctions auxquelles vous pouvez accéder via l'interface HTTP pour l'envoi d'SMS.
L'API HTTP vous permet d'intégrer votre application (client) à la (Passerelle) de SMSCenter.gr en utilisant le protocole HTTP pour envoyer des SMS.
Informations générales
Le client envoie une requête HTTP GET à l'interface HTTP de SMSCenter.gr , cette requête contient une liste de paramètres requis. SMSCenter.gr renvoie une réponse HTTP indiquant le succès de l'opération.
A Noter que le délimiteur utilisé pour l'API status dans les données renvoyées, '|', est le caractère pipe (ASCII 124).
Tous les paramètres transférés doivent être encodés au format URL et aussi en UTF-8, tel que décrit dans les exemples de code suivants.
Formats des réponses de l'API
L'API répond à toutes les requêtes selon les paramètrestype. Les valeurs acceptées pour le paramètre type sont : v2 qui est la valeur par défaut, json et xml.
Exemples de réponses pour une requête API key/get:
URL: https://static.smscenter.gr/api/key/get?username=[username]&password=[password]&type=...
...&type=v2
Répond:
6fe2dd9c06df83
...&type=json
Répond:
{
"status" : "1",
"key" : "6fe2dd9c06df83",
"remarks" : "Success"
}
...&type=xml
Répond:
<response>
<status>1</status>
<key>6fe2dd9c06ff83</key>
<remarks>Success</remarks>
</response>
Faire un essai (key/get)
https://static.smscenter.gr/api/key/get?username=&password=&type=
Les commandes disponibles dans cette version de SMSCenter.gr API suivent.
API Key
L'API Key doit être utilisé à la place du nom d'utilisateur et du mot de passe pour toutes les requêtes API. Vous pouvez toujours utiliser les paramètres: nom d'utilisateur et mot de passe, mais, pour des raisons de sécurité, nous vous recommandons vivement d'utiliser l'API Key.
Vous acquérez votre API Key en utilisant la requête key/get et vous l'utilisez pour toutes les requêtes API au lieu des paramètres : nom d'utilisateur et mot de passe. Si vous souhaitez changer l'API Key, vous pouvez le faire en utilisant la requête key/reset.
les requêtes key/get et key/reset sont les seules requêtes qui requièrent l'utilisation du nom d'utilisateur et du mot de passe.
Une fois que vous obtenez l'API Key, vous pouvez l'utiliser pour toutes les requêtes API.
Faire un essai (key/get)
https://static.smscenter.gr/api/key/get?username=&password=&type=
Faire un essai (key/reset)
https://static.smscenter.gr/api/key/reset?username=&password=&type=
Revenir
...&type=v2
Répond:
6fe2dd9c06df83
...&type=json
Répond:
{
"status" : "1",
"key" : "6fe2dd9c06df83",
"remarks" : "Success"
}
...&type=xml
Répond:
<response>
<status>1</status>
<key>6fe2dd9c06ff83</key>
<remarks>Success</remarks>
</response>
Envoi d'SMS
URL: https://static.smscenter.gr/api/sms/send?key=[API Key]
Paramètres acceptés
| Paramètre | Description | Présence |
|---|---|---|
text |
Message à envoyer. Doit être encodé au format URL. | Obligatoire |
to |
Le numéro MSISDN du destinataire indiquant que le message est à envoyer à. Ex: 49175123456 | Obligatoire |
from |
ID d'expéditeur (s'il est au format alphanumérique, 11 caractères maximum. S'il est au format numérique, 16 chiffres maximum) | Facultatif |
flash |
Définir en tant que 'Vrai' pour envoyer un SMS Flash | Facultatif |
ucs |
Définir en tant que 'Vrai' pour envoyer le SMS en utilisant l'encodage UCS | Facultatif |
timestamp |
Définir l'estampille temporelle pour envoyer le sms dans timestamp Unix Epoch | Facultatif |
type |
Le type de réponses de l'API peut être soit v2, ou json ou xml |
Facultatif |
Renvoie
...&type=v2
Répond:
1234567890
...&type=json
Répond:
{
"status" : "1",
"id" : "1234567890",
"balance" : "1234",
"remarks" : "Success"
}
...&type=xml
Répond:
<response>
<status>1</status>
<id>1234567890</id>
<balance>1234</balance>
<remarks>Success</remarks>
</response>
| Description | |
|---|---|
statut |
1 pour le message envoyé, sinon : échec d'envoi du message |
id |
l'ID du message, les accusés de réception sont livrés selon les ID des messages |
Solde |
le solde du compte |
Remarques |
Remarques concernant la requête |
Faire un essai (sms/send)
https://static.smscenter.gr/api/sms/send?key=&to=&from=&text=Hello&type=