5.0.0 • Published 5 years ago

@datafire/isendpro v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/isendpro

Client library for API iSendPro

Installation and Usage

npm install --save @datafire/isendpro
let isendpro = require('@datafire/isendpro').create();

.then(data => {
  console.log(data);
});

Description

1 Liste des fonctionnalités :

  • envoi de SMS à un ou plusieurs destinataires,
  • lookup HLR,
  • récupération des récapitulatifs de campagne,
  • gestion des répertoires,
  • ajout en liste noire.
  • comptage du nombre de caractères des SMS

2 Pour utiliser cette API vous devez:

  • Créer un compte iSendPro sur https://isendpro.com/
  • Créditer votre compte
    • Remarque: obtention d'un crédit de test possible sous conditions
  • Noter votre clé de compte (keyid)
    • Elle vous sera indispensable à l'utilisation de l'API
    • Vous pouvez la trouver dans le rubrique mon "compte", sous-rubrique "mon API"
  • Configurer le contrôle IP
    • Le contrôle IP est configurable dans le rubrique mon "compte", sous-rubrique "mon API"
    • Il s'agit d'un système de liste blanche, vous devez entrer les IP utilisées pour appeler l'API
    • Vous pouvez également désactiver totalement le contrôle IP

Actions

getCampagne

Retourne les SMS envoyés sur une période donnée en fonction d'une date de début et d'une date de fin.

Les dates sont au format YYYY-MM-DD hh:mm.

Le fichier rapport de campagne est sous la forme d'un fichier zip + contenant un fichier csv contenant le détail des envois.

isendpro.getCampagne({
  "keyid": "",
  "rapportCampagne": "",
  "date_deb": "",
  "date_fin": ""
}, context)

Input

  • input object
    • keyid required string: Clé API
    • rapportCampagne required string (values: 1): Doit valoir "1"
    • date_deb required string: date de debut au format YYYY-MM-DD hh:mm
    • date_fin required string: date de fin au format YYYY-MM-DD hh:mm

Output

  • output string

comptage

Compte le nombre de SMS necessaire à un envoi

isendpro.comptage({
  "body": {
    "comptage": "",
    "keyid": "",
    "num": "",
    "sms": ""
  }
}, context)

Input

Output

getCredit

Retourne le credit existant associe au compte.

isendpro.getCredit({
  "keyid": "",
  "credit": ""
}, context)

Input

  • input object
    • keyid required string: Clé API
    • credit required string (values: 1, 2): Type de reponse demandée, 1 pour euro, 2 pour euro + estimation quantité

Output

delListeNoire

Supprime un numero en liste noire

isendpro.delListeNoire({
  "keyid": "",
  "delListeNoire": "",
  "num": ""
}, context)

Input

  • input object
    • keyid required string: Clé API
    • delListeNoire required string (values: 1): Doit valoir "1"
    • num required string: numéro de mobile à supprimer

Output

getListeNoire

Retourne un fichier csv zippé contenant la liste noire

isendpro.getListeNoire({
  "keyid": "",
  "getListeNoire": ""
}, context)

Input

  • input object
    • keyid required string: Clé API
    • getListeNoire required string (values: 1): Doit valoir "1"

Output

  • output string

getHlr

Réalise un lookup HLR sur les numéros 

isendpro.getHlr({
  "body": {
    "getHLR": "",
    "keyid": "",
    "num": []
  }
}, context)

Input

Output

repertoireCrea

Cree un nouveau répertoire et retourne son identifiant. Cet identifiant pourra être utilisé pour ajouter ou supprimer des numéros via l'API.

isendpro.repertoireCrea({
  "body": {
    "keyid": "",
    "repertoireEdit": "",
    "repertoireNom": ""
  }
}, context)

Input

Output

repertoire

Ajoute ou supprime une liste de numéros à un répertoire existant.

isendpro.repertoire({
  "body": {
    "keyid": "",
    "num": [],
    "repertoireEdit": "",
    "repertoireId": ""
  }
}, context)

Input

Output

setListeNoire

Ajoute un numero en liste noire. Une fois ajouté, les requêtes d'envoi de SMS marketing vers ce numéro seront refusées.

isendpro.setListeNoire({
  "keyid": "",
  "setlisteNoire": "",
  "num": ""
}, context)

Input

  • input object
    • keyid required string: Clé API
    • setlisteNoire required string (values: 1): Doit valoir "1"
    • num required string: numéro de mobile à insérer en liste noire

Output

addShortlink

add a shortlink

isendpro.addShortlink({
  "body": {
    "keyid": "",
    "shortlink": ""
  }
}, context)

Input

Output

sendSms

Envoi un sms vers un unique destinataire

isendpro.sendSms({
  "body": {
    "keyid": "",
    "num": "",
    "sms": ""
  }
}, context)

Input

Output

sendSmsMulti

Envoi de SMS vers 1 ou plusieurs destinataires

isendpro.sendSmsMulti({
  "body": {
    "keyid": "",
    "num": [],
    "sms": []
  }
}, context)

Input

Output

subaccountAdd

Ajoute un sous compte

isendpro.subaccountAdd({
  "body": {
    "keyid": "",
    "subAccountEdit": "",
    "subAccountLogin": "",
    "subAccountPassword": ""
  }
}, context)

Input

Output

subaccountEdit

Edit a subaccount

isendpro.subaccountEdit({
  "body": {
    "keyid": "",
    "subAccountEdit": ""
  }
}, context)

Input

Output

Definitions

ComptageReponse

ComptageReponse_etat

ComptageReponse_etat_etat

  • ComptageReponse_etat_etat object
    • nb_caractere string: nombre de caractères
    • nb_sms string: nombre de sms nécessaires
    • tel string: numéro de téléphone

ComptageRequest

  • ComptageRequest object
    • comptage required string (values: 1)
    • date_envoi string: Date d'envoi au format YYYY-MM-DD hh:mm . Ce paramètre est optionnel, si il est omis l'envoi est réalisé immédiatement.
    • emetteur string: - L'emetteur doit être une chaîne alphanumérique comprise entre 4 et 11 caractères.
    • gmt_zone string (values: Pacific/Midway, America/Adak, Etc/GMT+10, Pacific/Marquesas, Pacific/Gambier, America/Anchorage, America/Ensenada, Etc/GMT+8, America/Los_Angeles, America/Denver, America/Chihuahua, America/Dawson_Creek, America/Belize, America/Cancun, Chile/EasterIsland, America/Chicago, America/New_York, America/Havana, America/Bogota, America/Caracas, America/Santiago, America/La_Paz, Atlantic/Stanley, America/Campo_Grande, America/Goose_Bay, America/Glace_Bay, America/St_Johns, America/Araguaina, America/Montevideo, America/Miquelon, America/Godthab, America/Argentina/Buenos_Aires, America/Sao_Paulo, America/Noronha, Atlantic/Cape_Verde, Atlantic/Azores, Europe/Belfast, Europe/Dublin, Europe/Lisbon, Europe/London, Africa/Abidjan, Europe/Amsterdam, Europe/Belgrade, Europe/Brussels, Africa/Algiers, Africa/Windhoek, Asia/Beirut, Africa/Cairo, Asia/Gaza, Africa/Blantyre, Asia/Jerusalem, Europe/Minsk, Asia/Damascus, Europe/Moscow, Africa/Addis_Ababa, Asia/Tehran, Asia/Dubai, Asia/Yerevan, Asia/Kabul, Asia/Yekaterinburg, Asia/Tashkent, Asia/Kolkata, Asia/Katmandu, Asia/Dhaka, Asia/Novosibirsk, Asia/Rangoon, Asia/Bangkok, Asia/Krasnoyarsk, Asia/Hong_Kong, Asia/Irkutsk, Australia/Perth, Australia/Eucla, Asia/Tokyo, Asia/Seoul, Asia/Yakutsk, Australia/Adelaide, Australia/Darwin, Australia/Brisbane, Australia/Hobart, Asia/Vladivostok, Australia/Lord_Howe, Etc/GMT-11, Asia/Magadan, Pacific/Norfolk, Asia/Anadyr, Pacific/Auckland, Etc/GMT-12, Pacific/Chatham, Pacific/Tongatapu, Pacific/Kiritimati): Fuseau horaire de la date d'envoi
    • keyid required string: Clé API
    • nostop string: Si le message n’est pas à but commercial, vous pouvez faire une demande pour retirer l’obligation du STOP. Une fois votre demande validée par nos services, vous pourrez supprimer la mention STOP SMS en ajoutant nostop = "1"
    • num required string: Numero de téléphone au format national (exemple 0680010203) ou international (example 33680010203)
    • numAzur string (values: 1)
    • sms required string: Message à envoyer aux destinataires. Le message doit être encodé au format utf-8 et ne contenir que des caractères existant dans l'alphabet GSM. Il est également possible d'envoyer (à l'étranger uniquement) des SMS en UCS-2, cf paramètre ucs2 pour plus de détails.
    • smslong string (values: 999): Le SMS long permet de dépasser la limite de 160 caractères en envoyant un message constitué
    • tracker string: Le tracker doit être une chaine alphanumérique de moins de 50 caractères. Ce tracker sera ensuite renvoyé en paramètre des urls pour les retours des accusés de réception.
    • ucs2 string: Il est également possible d’envoyer des SMS en alphabet non latin (russe, chinois, arabe, etc) sur

CreditResponse

CreditResponse_etat

  • CreditResponse_etat object
    • credit number: Montant du crédit restant
    • quantite string: Equivalence du crédit en nombre de SMS vers la France Métropolitaine.

Erreur

Erreur_etat

Erreur_etat_etat

  • Erreur_etat_etat object
    • code string: Code retour. Voir "tableau des code retour" dans l'annexe de la documentation
    • message string: Libellé associé au code de retour

HLRReponse

HLRReponse_etat

HLRReponse_etat_etat

  • HLRReponse_etat_etat object
    • operateur required string: Opérateur associé (si numéro valide)
    • tel required string: Numero de téléphone concerné

HLRrequest

  • HLRrequest object
    • getHLR required string (values: 1): Doit valoir "1"
    • keyid required string: Clé API
    • num required array: liste de numéros de téléphone
      • items string: numéro au format national français ou international

LISTENOIREReponse

LISTENOIREReponse_etat

LISTENOIREReponse_etat_etat

  • LISTENOIREReponse_etat_etat object
    • listeNoire required string: Doit valoir "OK"
    • tel required string: Numéro de téléphone à placer en liste noire. Format national Français ou international.

REPERTOIREcreatereponse

REPERTOIREcreatereponse_etat

REPERTOIREcreatereponse_etat_etat

  • REPERTOIREcreatereponse_etat_etat object
    • code required string: Code retour. Voir "tableau des code retour" dans l'annexe de la documentation
    • message string: Libellé associé au code retour.
    • repertoireId string: repertoireId du repertoire crée.

REPERTOIREcreaterequest

  • REPERTOIREcreaterequest object
    • keyid required string: Clé API
    • repertoireEdit required string (values: create): Action à réaliser doit valoir "create" ici.
    • repertoireNom required string: Nom du répertoire (libellé) à créer

REPERTOIREmodifreponse

REPERTOIREmodifreponse_etat

REPERTOIREmodifreponse_etat_etat

  • REPERTOIREmodifreponse_etat_etat object: Tableau de code retour. Si succès, un code retour distinct par numéro soumis.
    • code required string: Code retour. Voir "tableau des code retour" dans l'annexe de la documentation
    • message string: Libellé associé au code retour.
    • repertoireId string: repertoireId passé en argument lors de l'appel
    • tel string: Numéro de téléphone

REPERTOIREmodifrequest

  • REPERTOIREmodifrequest object
    • champ1 array: Noms des contact
      • items string: Nom des contacts
    • champ10 array: Champs I des contacts
      • items string: Champ I
    • champ11 array: Champs J des contacts
      • items string: Champ J
    • champ12 array: Champs K des contacts
      • items string: Champ K
    • champ13 array: Champs L des contacts
      • items string: Champ L
    • champ14 array: Champs M des contacts
      • items string: Champ M
    • champ15 array: Champs N des contacts
      • items string: Champ N
    • champ16 array: Champs O des contacts
      • items string: Champ O
    • champ17 array: Champs P des contacts
      • items string: Champ P
    • champ18 array: Champs Q des contacts
      • items string: Champ Q
    • champ19 array: Champs R des contacts
      • items string: Champ R
    • champ2 array: Champs A des contacts
      • items string: Champ A
    • champ20 array: Champs S des contacts
      • items string: Champ S
    • champ21 array: Champs T des contacts
      • items string: Champ T
    • champ22 array: Champs U des contacts
      • items string: Champ U
    • champ23 array: Champs V des contacts
      • items string: Champ V
    • champ24 array: Champs W des contacts
      • items string: Champ W
    • champ25 array: Champs X des contacts
      • items string: Champ X
    • champ26 array: Champs Y des contacts
      • items string: Champ Y
    • champ27 array: Champs Z des contacts
      • items string: Champ Z
    • champ3 array: Champs B des contacts
      • items string: Champ B
    • champ4 array: Champs C des contacts
      • items string: Champ C
    • champ5 array: Champs D des contacts
      • items string: Champ D
    • champ6 array: Champs E des contacts
      • items string: Champ E
    • champ7 array: Champs F des contacts
      • items string: Champ F
    • champ8 array: Champs G des contacts
      • items string: Champ G
    • champ9 array: Champs H des contacts
      • items string: Champ H
    • keyid required string: Clé API
    • num required array: liste des numéros des téléphone à ajouter ou supprimer
      • items string: Numéro de téléphone au format national ou international
    • repertoireEdit required string (values: add, del): action à réaliser, "add" pour l'ajout de numéros, "del" pour la suppression de numéros
    • repertoireId required string: repertoireId du répertoire cible

SMSReponse

SMSReponse_etat

SMSReponse_etat_etat

  • SMSReponse_etat_etat object
    • code integer: Code retour. Voir "tableau des code retour" dans l'annexe de la documentation
    • message string: Libellé associé au code de retour
    • smslong string: Nombre de SMS longs facturés
    • tel string: Numero de téléphone concerné

SMSRequest

  • SMSRequest object
    • date_envoi string: Paramètre optionnel, date d'envoi au format YYYY-MM-DD hh:mm
    • emetteur string: L'emetteur doit être une chaîne alphanumérique comprise entre 4 et 11 caractères. Les caractères acceptés sont les chiffres entre 0 et 9, les lettres entre A et Z et l’espace. Il ne peut pas comporter uniquement des chiffres. Pour la modification de l’émetteur et dans le cadre de campagnes commerciales, les opérateurs imposent contractuellement d’ajouter en fin de message le texte suivant : STOP XXXXX De ce fait, le message envoyé ne pourra excéder une longueur de 148 caractères au lieu des 160 caractères, le « STOP » étant rajouté automatiquement.
    • gmt_zone string (values: Pacific/Midway, America/Adak, Etc/GMT+10, Pacific/Marquesas, Pacific/Gambier, America/Anchorage, America/Ensenada, Etc/GMT+8, America/Los_Angeles, America/Denver, America/Chihuahua, America/Dawson_Creek, America/Belize, America/Cancun, Chile/EasterIsland, America/Chicago, America/New_York, America/Havana, America/Bogota, America/Caracas, America/Santiago, America/La_Paz, Atlantic/Stanley, America/Campo_Grande, America/Goose_Bay, America/Glace_Bay, America/St_Johns, America/Araguaina, America/Montevideo, America/Miquelon, America/Godthab, America/Argentina/Buenos_Aires, America/Sao_Paulo, America/Noronha, Atlantic/Cape_Verde, Atlantic/Azores, Europe/Belfast, Europe/Dublin, Europe/Lisbon, Europe/London, Africa/Abidjan, Europe/Amsterdam, Europe/Belgrade, Europe/Brussels, Africa/Algiers, Africa/Windhoek, Asia/Beirut, Africa/Cairo, Asia/Gaza, Africa/Blantyre, Asia/Jerusalem, Europe/Minsk, Asia/Damascus, Europe/Moscow, Africa/Addis_Ababa, Asia/Tehran, Asia/Dubai, Asia/Yerevan, Asia/Kabul, Asia/Yekaterinburg, Asia/Tashkent, Asia/Kolkata, Asia/Katmandu, Asia/Dhaka, Asia/Novosibirsk, Asia/Rangoon, Asia/Bangkok, Asia/Krasnoyarsk, Asia/Hong_Kong, Asia/Irkutsk, Australia/Perth, Australia/Eucla, Asia/Tokyo, Asia/Seoul, Asia/Yakutsk, Australia/Adelaide, Australia/Darwin, Australia/Brisbane, Australia/Hobart, Asia/Vladivostok, Australia/Lord_Howe, Etc/GMT-11, Asia/Magadan, Pacific/Norfolk, Asia/Anadyr, Pacific/Auckland, Etc/GMT-12, Pacific/Chatham, Pacific/Tongatapu, Pacific/Kiritimati): Fuseau horaire de la date d'envoi
    • keyid required string: Clé API
    • nostop string: Si le message n’est pas à but commercial, vous pouvez faire une demande pour retirer l’obligation du STOP. Une fois votre demande validée par nos services, vous pourrez supprimer la mention STOP SMS en ajoutant nostop = "1"
    • num required array
      • items string: Numeros de téléphone au format national (exemple 0680010203) ou international (example 33680010203)
    • numAzur string (values: 1)
    • repertoireId string: Id du repertoire
    • sms required array
      • items string: Message à envoyer aux destinataires. Il peut y avoir un seul message ou 1 message par destintaire différent.
    • smslong string: Le SMS long permet de dépasser la limite de 160 caractères en envoyant un message constitué de plusieurs SMS. Il est possible d’envoyer jusqu’à 6 SMS concaténés pour une longueur totale maximale de 918 caractères par message. Pour des raisons technique, la limite par SMS concaténé étant de 153 caractères. En cas de modification de l’émetteur, il faut considérer l’ajout automatique de 12 caractères du « STOP SMS ». Pour envoyer un smslong, il faut ajouter le paramètre smslong aux appels. La valeur de SMS doit être le nombre maximum de sms concaténé autorisé. Pour ne pas avoir ce message d’erreur et obtenir un calcul dynamique du nombre de SMS alors il faut renseigner smslong = "999"
    • tracker array
      • items string: Le tracker doit être une chaine alphanumérique de moins de 50 caractères. Ce tracker sera ensuite renvoyé en paramètre des urls pour les retours des accusés de réception.
    • ucs2 string: Il est également possible d’envoyer des SMS en alphabet non latin (russe, chinois, arabe, etc) sur les numéros hors France métropolitaine. Pour ce faire, la requête devrait être encodée au format UTF-8 et contenir l’argument ucs2 = "1" Du fait de contraintes techniques, 1 SMS unique ne pourra pas dépasser 70 caractères (au lieu des 160 usuels) et dans le cas de SMS long, chaque sms ne pourra dépasser 67 caractères.

ShortlinkRequest

  • ShortlinkRequest object
    • keyid required string
    • shortlink required string

ShortlinkResponse

  • ShortlinkResponse object
    • etat object
      • etat array
        • items object
          • code number
          • message string
          • shortlink string

SmsUniqueRequest

  • SmsUniqueRequest object
    • date_envoi string: Date d'envoi au format YYYY-MM-DD hh:mm . Ce paramètre est optionnel, si il est omis l'envoi est réalisé immédiatement.
    • emetteur string: - L'emetteur doit être une chaîne alphanumérique comprise entre 4 et 11 caractères.
    • gmt_zone string (values: Pacific/Midway, America/Adak, Etc/GMT+10, Pacific/Marquesas, Pacific/Gambier, America/Anchorage, America/Ensenada, Etc/GMT+8, America/Los_Angeles, America/Denver, America/Chihuahua, America/Dawson_Creek, America/Belize, America/Cancun, Chile/EasterIsland, America/Chicago, America/New_York, America/Havana, America/Bogota, America/Caracas, America/Santiago, America/La_Paz, Atlantic/Stanley, America/Campo_Grande, America/Goose_Bay, America/Glace_Bay, America/St_Johns, America/Araguaina, America/Montevideo, America/Miquelon, America/Godthab, America/Argentina/Buenos_Aires, America/Sao_Paulo, America/Noronha, Atlantic/Cape_Verde, Atlantic/Azores, Europe/Belfast, Europe/Dublin, Europe/Lisbon, Europe/London, Africa/Abidjan, Europe/Amsterdam, Europe/Belgrade, Europe/Brussels, Africa/Algiers, Africa/Windhoek, Asia/Beirut, Africa/Cairo, Asia/Gaza, Africa/Blantyre, Asia/Jerusalem, Europe/Minsk, Asia/Damascus, Europe/Moscow, Africa/Addis_Ababa, Asia/Tehran, Asia/Dubai, Asia/Yerevan, Asia/Kabul, Asia/Yekaterinburg, Asia/Tashkent, Asia/Kolkata, Asia/Katmandu, Asia/Dhaka, Asia/Novosibirsk, Asia/Rangoon, Asia/Bangkok, Asia/Krasnoyarsk, Asia/Hong_Kong, Asia/Irkutsk, Australia/Perth, Australia/Eucla, Asia/Tokyo, Asia/Seoul, Asia/Yakutsk, Australia/Adelaide, Australia/Darwin, Australia/Brisbane, Australia/Hobart, Asia/Vladivostok, Australia/Lord_Howe, Etc/GMT-11, Asia/Magadan, Pacific/Norfolk, Asia/Anadyr, Pacific/Auckland, Etc/GMT-12, Pacific/Chatham, Pacific/Tongatapu, Pacific/Kiritimati): Fuseau horaire de la date d'envoi
    • keyid required string: Clé API
    • nostop string: Si le message n’est pas à but commercial, vous pouvez faire une demande pour retirer l’obligation du STOP. Une fois votre demande validée par nos services, vous pourrez supprimer la mention STOP SMS en ajoutant nostop = "1"
    • num required string: Numero de téléphone au format national (exemple 0680010203) ou international (example 33680010203)
    • numAzur string (values: 1)
    • sms required string: Message à envoyer aux destinataires. Le message doit être encodé au format utf-8 et ne contenir que des caractères existant dans l'alphabet GSM. Il est également possible d'envoyer (à l'étranger uniquement) des SMS en UCS-2, cf paramètre ucs2 pour plus de détails.
    • smslong string: Le SMS long permet de dépasser la limite de 160 caractères en envoyant un message constitué
    • tracker string: Le tracker doit être une chaine alphanumérique de moins de 50 caractères. Ce tracker sera ensuite renvoyé en paramètre des urls pour les retours des accusés de réception.
    • ucs2 string: Il est également possible d’envoyer des SMS en alphabet non latin (russe, chinois, arabe, etc) sur

SubaccountAddRequest

  • SubaccountAddRequest object
    • keyid required string
    • subAccountEdit required string (values: addAccount)
    • subAccountLogin required string
    • subAccountPassword required string

SubaccountAddResponse

  • SubaccountAddResponse object
    • etat object
      • etat array
        • items object
          • code number
          • message string
          • subAccountId string
          • subAccountKeyId string
          • subAccountLogin string

SubaccountRequest

  • SubaccountRequest object
    • keyid required string: Clé API
    • subAccountAddCredit string: montant du crédit à ajouter
    • subAccountCountryCode string
    • subAccountEdit required string (values: setPrice, addCredit, setRestriction): action à réaliser soit setPrice pour définir un prix ou addCredit pour ajouter du credit ou setRestriction modifier la restriction stop /
    • subAccountKeyId string: keyid du sous-compte
    • subAccountPrice string
    • subAccountRestrictionStop string (values: 0, 1)
    • subAccountRestrictionTime string (values: 0, 1)

SubaccountResponse

  • SubaccountResponse object
    • etat object
      • etat array
        • items object
          • code string
          • message string
          • subAccountId string
          • subAccountKeyid string
datafire
@infinitebrahmanuniverse/nolb-_datafire_i@everything-registry/sub-chunk-222
5.0.0

5 years ago

4.0.0

7 years ago

3.0.0

7 years ago

2.0.0

8 years ago