API SG-Autorépondeur

//Le code PHP indiqué ici est donné à titre indicatif

    include(__DIR__.'/sgapi.php');

    $membreid = [YOUR_ID];
    $codeactivation = '[YOUR_CODE]';

    //démarrage de l'api
    $sgApi = new SGApi($membreid, $codeactivation);

//on recherche les abonnés actifs de la liste 1234, inscrits le
        //20 Octobre 2015
        $sgApi->set('listeid', 1234)
        ->set('dateinscription', '2015-10-23')
        ->set('actif', 1);

        //appel
        try {
        $call = $sgApi->call('abonnes');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        [
        'idabonne' => 75869,
        'nom' => 'Dupont',
        'prenom' => 'Jean',
        'email' => 'jean.dupont@email.com',
        'dateinscription' => '2015-10-23',
        'listeid' => 1234,
        'actif' => 1,
        ],
        [
        'idabonne' => 76532,
        'nom' => 'Dupond',
        'prenom' => 'Robert',
        'email' => 'robert.dupond@email.com',
        'dateinscription' => '2014-09-12',
        'listeid' => 5678,
        'actif' => 1,
        ]
        ]
    

//on recherche l'abonné n°75869
        $sgApi->set('idabonne', 75869);

        //appel
        try {
        $call = $sgApi->call('abonne');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        'idabonne' => 75869,
        'nom' => 'Dupont',
        'prenom' => 'Jean',
        'email' => 'jean.dupont@email.com',
        'adresse' => '23 rue de l\'arche',
        'codepostal' => '1234',
        'ville' => 'HappyVille',
        'pays' => 'France',
        'dateinscription' => '2015-10-23',
        'ip' => '1.2.3.4',
        'listeid' => 1234,
        'champs_1' => 'contenu personnalisé',
        'actif' => 1,
        ]
    

//on inscrit l'abonné jean.dupont@email.com dans la liste 1234
        $sgApi->set('listeid', 1234)
        ->set('inscriptionnormale', 'non')
        ->set('email', 'jean.dupont@email.com')
        ->set('prenom', 'Jean')
        ->set('champs_1', 'test');

        //appel
        try {
        $call = $sgApi->call('inscription');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        'valid' => true || false,
        'message' => 'code de retour'
        ]
    

//on désactive l'abonné jean.dupont@email.com de la liste 1234
        $sgApi->set('listeid', 1234)
        ->set('email', 'jean.dupont@email.com');

        //appel
        try {
        $call = $sgApi->call('desinscription');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        'valid' => true || false,
        ]
    

//appel
        try {
        $call = $sgApi->call('listes');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [valid] => 1
        [data] => Array (
            [0] => Array (
                [id] => {vos_infos}
                [membreid] => {vos_infos}
                [nom] => {vos_infos}
                [description] => {vos_infos}
                [siteweb] => {vos_infos}
                [emailexpediteur] => {vos_infos}
                [nomexpediteur] => {vos_infos}
                [adresseexpediteur] => {vos_infos}
                [mobile_expediteur] => {vos_infos}
                [reponseemail] => {vos_infos}
                [signature] => {vos_infos}
                [optin] => {vos_infos}
                [mailinscription] => {vos_infos}
                [mailconfirmation] => {vos_infos}
                [maildesinscription] => {vos_infos}
                [mailsommeil] => {vos_infos}
                [sujetinscription] => {vos_infos}
                [sujetconfirmation] => {vos_infos}
                [sujetdesinscription] => {vos_infos}
                [sujetsommeil] => {vos_infos}
                [lieninscription] => {vos_infos}
                [lieninscriptiondouble] => {vos_infos}
                [lienconfirmation] => {vos_infos}
                [liendesinscription] => {vos_infos}
                [formhtml] => {vos_infos}
                [formhtmlhidden] => {vos_infos}
                [formhtmlperso] => {vos_infos}
                [champsobligatoires] => {vos_infos}
                [form_image_fond] => {vos_infos}
                [langue] => {vos_infos}
                [liensiteentier] => {vos_infos}
                [codepartage] => {vos_infos}
                [formhtmldesign] => {vos_infos}
                [notification] => {vos_infos}
                [notification_desinscription] => {vos_infos}
                [titreaccroche] => {vos_infos}
                [texteaccroche] => {vos_infos}
                [nomdedomaine] => {vos_infos}
                [lienretoursite] => {vos_infos}
                [lienimageerreur] => {vos_infos}
                [texteconfirmationoptinnon] => {vos_infos}
                [dateexport] => {vos_infos}
                [forcerdateinscription] => {vos_infos}
                [etape1_minutes] => {vos_infos}
                [etape2_minutes] => {vos_infos}
                [mois_reactivation] => {vos_infos}
                [dkim_valid] => {vos_infos}
                [spf_valid] => {vos_infos}
                [nbr_envoi] => {vos_infos}
                [nbr_ouvre] => {vos_infos}
                [nbr_clic] => {vos_infos}
                [parent] => {vos_infos}
                [jour_desactivation] => {vos_infos}
                [decalage_retour] => {vos_infos}
                [fin_sequence] => {vos_infos}
                [fin_sequence_action] => {vos_infos}
                [sujetupsell] => {vos_infos}
                [msgupsell] => {vos_infos}
                [minutesupsell] => {vos_infos}
                ),
            [1] => Array ( ... )
    

//on recherche la liste n°1234
        $sgApi->set('listeid', 1234);

        //appel
        try {
        $call = $sgApi->call('liste');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        'nom' => 'Liste 1',
        'description' => 'Description de la liste',
        'siteweb' => 'http://monsite.com',
        'emailexpediteur' => 'email@email.com',
        'nomexpediteur' => 'Jean Dupont',
        'reponseemail' => 'reponse@email.com'
        'signature' => 'Cordialement, Jean Dupont'
        'optin' => 1,
        'mailinscription' => 'Confirmez votre inscription en cliquant sur le lien ci-dessous',
        'mailconfirmation' => 'Félicitations, vous êtes inscrit',
        'maildesinscription' => 'Votre désinscription a bien été prise en compte',
        'sujetinscription' => 'Il ne vous reste plus qu\'à confirmer',
        'sujetconfirmation' => 'Félicitations, vous êtes inscrit',
        'sujetdesinscription' => 'Votre désinscription a bien été prise en compte',
        'lieninscription' => 'http://monsite.com/felicitations',
        'lieninscriptiondouble' => 'http://monsite.com/confirmation',
        'lienconfirmation' => 'http://monsite.com/felicitations',
        'liendesinscription' => 'http://monsite.com/desinscription',
        'langue' => 'Français',
        'parent' => 573,
        ]
    

//on crée la liste "Liste 1"
        $sgApi->set('nom', 'Liste 1')
        ->set('emailexpediteur', 'jean.dupont@email.com')
        ->set('nomexpediteur', 'Jean Dupont')
        ->set('reponseemail', 'reponse@email.com')
        ->set('signature', 'Cordialement, Jean Dupont');

        //appel
        try {
        $call = $sgApi->call('createliste');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        'valid' => true,
        'listeid' => 'identifiant de la liste'
        ]
    

//appel
        try {
        $call = $sgApi->call('formulaires');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        [
        'id' => 1,
        'listeid' => 1234,
        'nom' => 'Formulaire 1',
        ],
        [
        'id' => 2,
        'listeid' => 2345,
        'nom' => 'Formulaire 2',
        ]

        ]
    

//on recherche le formulaire n°123
        $sgApi->set('id_formulaire', 123);

        //appel
        try {
        $call = $sgApi->call('formulaire');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        'id' => 123,
        'listeid' => 1245,
        'nom' => 'Formulaire 1',
        'html' => '<form method="post">...</form>',
        'redirect' => 'http://monsite.com/confirmation',
        'redirect_onlist' => 'http://monsite.com/confirmation',
        ]
    

    //on récupère 50 messages (après 50 premiers autres, idéal pour faire des boucles de récupération)
    $sgApi->set('limit_start', 0) //Récupération des 50 premiers messages;

    //appel
    try {
    $call = $sgApi->call('messages');
    } catch (Exception $e) {
    echo $e->getMessage();
    exit();
    }

    //Réponse
    [
        [
        'id' => 7536,
        'listeid' => 1234,
        'type' => 'auto',
        'format' => '',
        'titre' => 'Cadeau n°1',
        'sujet' => 'Voici votre cadeau n°1',
        ],
        [
        'id' => 7537,
        'listeid' => 1234,
        'type' => 'auto',
        'format' => '',
        'titre' => 'Cadeau n°2',
        'sujet' => 'Voici votre cadeau n°2',
        ],
        ...
    ]

//on recherche le message n°7536
        $sgApi->set('id_message', 7536);

        //appel
        try {
        $call = $sgApi->call('message');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        'id' => 7536,
        'listeid' => 1234,
        'type' => 'auto',
        'format' => '',
        'titre' => 'Cadeau n°1',
        'sujet' => 'Voici votre cadeau n°1',
        'msghtml' => 'Bonjour ++prenom++, etc.',
        ]
    

//on crée le message "Cadeau n°3"
        $sgApi->set('listeid', 1234)
        ->set('type', 'auto')
        ->set('format', 'email')
        ->set('titre', 'Cadeau n°3')
        ->set('sujet', 'Voici votre cadeau n°3')
        ->set('msghtml', 'Bonjour ++prenom++, etc.');

        //appel
        try {
        $call = $sgApi->call('createmessage');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        'valid' => true,
        'id_message' => 7538
        ]
    

//on recherche les messages automatiques de la liste n°1234
        $sgApi->set('listeid', 1234)
        ->set('type', 'auto');

        //appel
        try {
        $call = $sgApi->call('envois');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        [
        'id' => 6582,
        'listeid' => 1234,
        'listes' => [123,456],
        'listes_exclues' => [789],
        'mailid' => 123,
        'type' => 'auto',
        'echeancejour' => 4,
        'activation' => 1,
        ],
        [
        'id' => 6587,
        'listeid' => 1234,
        'listes' => [],
        'listes_exclues' => [],
        'mailid' => 124,
        'type' => 'auto',
        'echeancejour' => 12,
        'activation' => 1,
        ]

        ]
    

//on recherche l'envoi n°6582
        $sgApi->set('id_envoi', 6582);

        //appel
        try {
        $call = $sgApi->call('envoi');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }

        //Réponse
        [
        'id' => 6582,
        'listeid' => 1234,
        'listes' => [123,456],
        'listes_exclues' => [789],
        'mailid' => 123,
        'type' => 'auto',
        'echeancejour' => 4,
        'activation' => 1,
        'statistiques' => [
        'nb_envoi' => 1000,
        'nb_ouvertures' => 576,
        'nb_clics' => 245,
        'nb_plaintes' => 2,
        'taux_ouverture' => 57.6,
        'taux_clics' => 24.5,
        'taux_plaintes' => 0.20,
        ]
        ]
    

//on crée un envoi manuel prévu le 14 novembre 2015 à 14h
        $sgApi->set('listeid', 1234)
        ->set('mailid', 5874)
        ->set('type', 'man')
        ->set('optionurl', true)
        ->set('pasdanssequenceauto', false)
        ->set('listes', json_encode(array(1234)))
        ->set('listes_exclues', json_encode(array(4567,4568)))
        //Date envoi manuel :
        ->set('date', '2015-11-14 14');
        //OU
        //Date envoi automatique
        ->set('date',json_encode(
        array(
        'annee' => 1,
        'mois' => 4,
        'semaine' => 3,
        'jour' => 2,
        'heure' => 14,
        'joursemaine' => 'jeudi',
        'activation' => 1
        )
        ));
        //appel
        try {
        $call = $sgApi->call('createenvoi');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }
        //Réponse
        [
        'valid' => true,
        'id_envoi' => 7538
        ]
    

//on récupère la page 2 des abonnés de la liste 1234
        $sgApi->set('listeid', 1234)
        ->set('page', 2);

        //appel
        try {
        $call = $sgApi->call('abonnes');
        } catch (Exception $e) {
        echo $e->getMessage();
        exit();
        }
    

                                            //on provoque une erreur en appelant la fonction "test" qui n'existe pas
                                                $sgApi->set('listeid', 1234)
                                                ->set('email', 'jean.dupont@email.com');

                                                //appel
                                                try {
                                                $call = $sgApi->call('test');       //l'erreur est ici
                                                } catch (Exception $e) {
                                                echo $e->getMessage();
                                                exit();
                                                }

                                                //Réponse
                                                [
                                                'valid' => false,
                                                'error' => 'invalid_action',
                                                ]