API Pulling DLR MO
L'API Pulling DLR MO est à utiliser si le fonctionnent par défaut pour la récupération des DLR et MO ne s’adapte à votre application. Le mode par défaut est décrit ici. Le mode pulling est activable en option par notre support.
Si vous ne pouvez, dans votre architecture, fournir une API ouverte sur l'extérieur, notre API Pulling peut répondre à votre problématique.
Ce fonctionnement en pulling vous permet alors de récupérer vos notifications et vos MO stockés sur nos serveurs dans des files d'attente. Vous devez requêter notre API de façon régulière afin de récupérer vos informations et ainsi vider vos files d'attente. L'API vous fournira alors les mêmes retours décrits ici pour les DLR et ici pour les MO dans un tableau JSON.
Attention vous devez récupérer vos DLR et MO avant 1 mois. Au delà ceux-ci ne seront pas récupérables.
API Pulling Notification
Cette requête vous permettra de récupérer vos notifications. Selon la configuration de votre compte (restriction de l'usage des API par IP ou non), vous devez utiliser l'url avec -public ou non (comme pour l'envoi de SMS).
A chaque appel de notre API, vous pouvez définir le nombre d’éléments que vous souhaitez récupérer.
Attention si vous mettez une valeur trop grande et que votre process met du temps à traiter les éléments, vous risquez de perdre des acquittements ou des MO. Vous devez adapter cette valeur suivant les performances de vos services.
Vous pouvez aussi passer en paramètre le serviceid pour récupérer uniquement les SMS correspondant à ce serviceid.
Tant que notre API vous retourne des éléments vous pouvez la solliciter, et au contraire temporiser vos requêtes de plusieurs minutes quand les files d’attente sont vides.
Lorsqu'il n'y a pas de MO ni d'acquittements :
{"results":[]}
En cas d'erreur sur un compte :
{
"results": [
{
"msisdn" :"null",
"smscount" :"0",
"code" :"-12",
"reason" :"invalid credential",
"ticket" :"null"
}
]
}
On peut différencier les MO des acquittements avec le champ Status. Pour les MOs la valeur du champ Status est à 5. Toutes les autres valeurs correspondent à des acquittements. Vous retrouvez plus d'informations sur ces valeurs ici.
usernameUSERNAME
Votre username, transmis à l'inscription
Votre password, transmis à l'inscription
optionnel : Le nombre d'éléments que vous souhaitez récupérer (par défaut à 50)
serviceid12345optionnel : Le serviceid qui va vous permettre de ne récupérer que les DLR et MO correspondant. L'usage de cette option nécessite une configuration particulière de votre compte et une fois celle-ci faite rend obligatoire l'usage de ce champ.