Methode : get_mail
Cette méthode sert à récupérer les informations de vos messages (Email, SMS, Courrier, VMS) suivant vos paramètres, ou un message en particulier suivant son identifiant.
| Champ | Type | Description |
|---|---|---|
| mailid | integer | Identifiant de votre message Si ce paramètre est définit, vos autres paramètres ne seront pas pris en compte(Optionnel) |
| titre | string | Titre de votre message(Optionnel) |
| sujet | string | Sujet de votre message(Optionnel) |
| type | string | Type de votre message 'auto', 'manu'(Optionnel) |
| format | string | Format de votre message 'email', 'sms', 'lettre_nb_j4', 'lettre_c_j4', 'lettre_nb_j1', 'vms'(Optionnel) |
| listeid | integer | Liste de votre message(Optionnel) |
| limite | array | Limite de récupération de données. Format [0,50](Optionnel) |
// Recherche des 5 premiers messages de la liste 12345 $sgApi ->set('listeid', 12345) ->set('limite', [0,5]) ->set('detail', true); $call = $sgApi->call('get_mail');
Methode : set_mail
Cette méthode sert à créer un message suivant vos paramètres.
| Champ | Type | Description |
|---|---|---|
| titre | string | Titre de votre message Paramètre requis |
| sujet | string | Sujet de votre message Paramètre requis |
| msghtml | string | Contenu de votre message Paramètre requis |
| type | string | Type de votre message 'auto', 'manu' Paramètre requis |
| format | string | Format de votre message 'email', 'sms', 'lettre_nb_j4', 'lettre_c_j4', 'lettre_nb_j1', 'vms' Paramètre requis |
| listeid | integer | Liste de votre message Paramètre requis |
// Ajout d'un message manuel dans la liste 12345 $sgApi ->set('titre', "Message Test API") ->set('sujet', "Bonjour ++prenom++") ->set('msghtml', "Blablabla") ->set('type', "manu") ->set('format', "email") ->set('listeid', 12345); $call = $sgApi->call('set_mail');
Methode : del_mail
Cette méthode sert à supprimer un message suivant son identifiant.
| Champ | Type | Description |
|---|---|---|
| mailid | integer | Identifiant de votre message Paramètre requis |
// Suppression d'un message $sgApi ->set('mailid', "12345"); $call = $sgApi->call('del_mail');