Cette documentation vous est proposé au format Open API; vous pouvez générer différents clients (PHP, Android, C#, .NET, Javascript…) en ouvrant ce fichier de définition d'API dans l'éditeur swagger de l'initiative.
Tous les appels à l'API REST nécessitent une authentification. Pour cela, nous utilisons la méthode d'authentification spécifiée par la rfc2617.
La méthode consiste a renseigner le numéro de compte (affiché dans l'interface du compte en haut à gauche) et une clé api valide (que vous aurez générée préalablement dans la rubrique Plus > Paramètres > API et Connecteurs) lors de chaque appel à l'api sous la forme « MB_ACCOUNT_ID:MB_API_KEY ».
Les appels à l'api se font en https avec la racine suivante : https://services.message-business.com/api/rest/v4/
- Voir les exemples d’appel avec authentificationExemple curl sous shell
curl -s --user "MB_ACCOUNT_ID:MB_API_KEY" -X GET 'https://services.message-business.com/api/rest/v4/Segment'
Exemple PHP utilisant la lib curl
$MB_ACCOUNT_ID = 'Your_numerical_account'; $MB_API_KEY = 'Your_api_key'; $curl_handle = curl_init(); curl_setopt($curl_handle, CURLOPT_URL, $url); curl_setopt($curl_handle, CURLOPT_USERAGENT, 'MessageBusinessApi/1; PHP v. ' . phpversion()); curl_setopt($curl_handle, CURLOPT_USERPWD, $MB_ACCOUNT_ID.':'.$MB_API_KEY);
Listes des méthodes
Limitations des différents appels API suivants:
– contacts/purge/add /contacts/export/add /contacts/import/add /contacts/attribute : 2 appels par seconde maximum,
– contacts/import/emailing/operation : 1 appel par seconde,
– 30 appels par seconde maximum pour les autres appels API.
-
-
-
Classe de la réponse (Statut 200)
Inline Model [ContactField]
ContactField {id (integer):Id du champ
,creationDate (string, optional):Par défaut la date courante
,description (string, optional):Non affiché dans le compte
,format (string, optional):La valeur par défaut est "ShortText"
,options (string, optional):Value depending on the format
,name (string):}Nom du champ
[ { "id": 0, "creationDate": "string", "description": "string", "format": "string", "options": "string", "name": "string" } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur ContactField
paramètre Information / Valeur possible id Cet identifiant sera ignoré format "DateTime", "MultipleSelection", "Number", "SingleSelection", "ShortText" creationDate Cette valeur doit être au format de date UTC "yyyy-MM-dd HH:mm:ss" options Ce champ est optionnel et dépend du champ format. Voir ci-dessous pour les valeurs possibles. name Le nom de ce champ sera verifié pour vérifier si ce nom n'est pas déjà déclaré Options par type de format
Format Information / Valeur possible DateTime "yyyy.mm.dd", "yy.mm.dd", "dd.mm.yyyy", "dd.mm.yy", "mm.dd.yyyy", "mm.dd.yy" MultipleSelection "true", "false" sur un fichier d'import si la valeur est à "true" les nouvelles valeurs seront ajoutées SingleSelection "true", "false" sur un fichier d'import si la valeur est à "true" les nouvelles valeurs seront ajoutées Classe de la réponse (Statut 201)
ContactField {id (integer):Id du champ
,creationDate (string, optional):Par défaut la date courante
,description (string, optional):Non affiché dans le compte
,format (string, optional):La valeur par défaut est "ShortText"
,options (string, optional):Value depending on the format
,name (string):}Nom du champ
{ "id": 0, "creationDate": "string", "description": "string", "format": "string", "options": "string", "name": "string" }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur ContactField
paramètre Information / Valeur possible id L'identifiant doit correspondre au champ que vous voulez mettre à jour format Le format sera ignorée, il ne peut être changé creationDate La creationDate sera ignorée, elle ne peut être changée options Ce champ est optionnel et dépend du champ format. Voir ci-dessous pour les valeurs possibles. name Le nom de ce champ sera verifié pour vérifier si ce nom n'est pas déjà déclaré Options par type de format
Format Information / Valeur possible DateTime "yyyy.mm.dd", "yy.mm.dd", "dd.mm.yyyy", "dd.mm.yy", "mm.dd.yyyy", "mm.dd.yy" MultipleSelection "true", "false" on an import file, if the value is at "true", new values will be added SingleSelection "true", "false" on an import file, if the value is at "true", new values will be added Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
CreditsInformation {used (integer, optional),remaining (integer, optional),total (integer, optional)}{ "used": 0, "remaining": 0, "total": 0 }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
ContactField {id (integer):Id du champ
,creationDate (string, optional):Par défaut la date courante
,description (string, optional):Non affiché dans le compte
,format (string, optional):La valeur par défaut est "ShortText"
,options (string, optional):Value depending on the format
,name (string):}Nom du champ
{ "id": 0, "creationDate": "string", "description": "string", "format": "string", "options": "string", "name": "string" }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Inline Model [ContactFieldValue]
ContactFieldValue {id (integer, optional):Id
,creationDate (string, optional):Date de création
,index (integer, optional):0 par défaut
,text (string):}Valeur du champ affichée
[ { "id": 0, "creationDate": "string", "index": 0, "text": "string" } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur ContactFieldValue
paramètre Information / Valeur possible id Cet identifiant sera ignoré creationDate La date sera renseignée par défaut avec la date courante index Position où sera enregistrée la valeur (par défaut, en dernière position) text Le texte qui sera affiché pour cette valeur Classe de la réponse (Statut 201)
ContactFieldValue {id (integer, optional):Id
,creationDate (string, optional):Date de création
,index (integer, optional):0 par défaut
,text (string):}Valeur du champ affichée
{ "id": 0, "creationDate": "string", "index": 0, "text": "string" }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur ContactFieldValue
paramètre Information / Valeur possible id L'id doit correspondre au champ que vous voulez mettre à jour creationDate La date sera renseignée par défaut avec la date courante index Position où sera enregistrée la valeur, cette nouvelle position doit être vide text Le texte qui sera affiché pour cette valeur Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
SettingsInformation body notes
paramètre Information / Valeur possible attributeType {key, value} array Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Inline Model [ContactData]
ContactData {id (integer, optional),idEncrypted (string, optional),contactKey (string, optional),attributes (Array[ContactAttribute])}
ContactAttribute {id (string, optional),fieldName (string, optional),fieldValue (string, optional)}[ { "id": 0, "idEncrypted": "string", "contactKey": "string", "attributes": [ { "id": "string", "fieldName": "string", "fieldValue": "string" } ] } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Inline Model [ContactData]
ContactData {id (integer, optional),idEncrypted (string, optional),contactKey (string, optional),attributes (Array[ContactAttribute])}
ContactAttribute {id (string, optional),fieldName (string, optional),fieldValue (string, optional)}[ { "id": 0, "idEncrypted": "string", "contactKey": "string", "attributes": [ { "id": "string", "fieldName": "string", "fieldValue": "string" } ] } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Inline Model [ContactData]
ContactData {id (integer, optional),idEncrypted (string, optional),contactKey (string, optional),attributes (Array[ContactAttribute])}
ContactAttribute {id (string, optional),fieldName (string, optional),fieldValue (string, optional)}[ { "id": 0, "idEncrypted": "string", "contactKey": "string", "attributes": [ { "id": "string", "fieldName": "string", "fieldValue": "string" } ] } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Inline Model [ContactData]
ContactData {id (integer, optional),idEncrypted (string, optional),contactKey (string, optional),attributes (Array[ContactAttribute])}
ContactAttribute {id (string, optional),fieldName (string, optional),fieldValue (string, optional)}[ { "id": 0, "idEncrypted": "string", "contactKey": "string", "attributes": [ { "id": "string", "fieldName": "string", "fieldValue": "string" } ] } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Si vous avez un champ de type MultipleSelection vous devrez insérer les id d'attributs separés par des "," Ex: "53,54" où 53 et 54 sont l'id de l'attribute values (vous pouvez avoir les id en faisant un appel à GET /account/contactattribute/value/{id}
Informations sur ContactData
paramètre Information / Valeur possible id La valeur est ignorée contactKey Ceci est le champ de clé d'unicité de la base attributes La liste des champs d'un contact. Voir ContactAttribute en dessous Informations sur ContactAttribute
paramètre Information / Valeur possible id Le nom du champ (voir en dessous) - Vous devez utiliser ce champs pour faire une insertion / mise à jour de la valeure fieldName Le nom du champ (voir en dessous) - Vous ne devez pas utiliser ce champ pour faire une insertion / mise à jour de la valeur fieldValue La valeur donnée au champ (voir en dessous) Information sur le nom des champs et leurs valeurs
Liste des noms possible Type de valeur "salutation", "firstname", "lastname", "companyname", "jobtitle" Type string libre "email", "emailunsubscriptionreason", "emailstatus" Type string libre "emailstatusdetail", "emailcapping", "mobile" Type string libre "mobileunsubscriptionreason", "mobilestatus", "mobilestatusdetail" Type string libre "mobilecapping", "phone", "fax", "address1", "address2" Type string libre "zipcode", "city", "country", "type" Type string libre "activity", "comments", "source", "activityrank", "influencerank" Type string libre "emailunsubscriptiondate", "emailstatusdate", "mobileunsubscriptiondate", "mobilestatusdate" Un type string au format UTC "yyyy-MM-dd HH:mm:ss+0000" "emailoptinpartners", "mobileoptinpartners", "emailoptin", "mobileoptin" Un type string comme "true" ou "yes1" ou "no" {Personalised_id} Type string libre Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Si vous avez un champ de type MultipleSelection vous devrez insérer les id d'attributs separés par des "," Ex: "53,54" où 53 et 54 sont l'id de l'attribute values (vous pouvez avoir les id en faisant un appel à GET /account/contactattribute/value/{id})
Informations sur ContactData
paramètre Information / Valeur possible id Si un id est fourni, celui-ci sera utilisé pour récupérer le contact contactKey Ceci est le champ de clé d'unicité de la base (ignoré si l'id est fourni) attributes La liste des champs d'un contact. Voir ContactAttribute en dessous Informations sur ContactAttribute
paramètre Information / Valeur possible id Le nom du champ (voir en dessous) - Vous devez utiliser ce champs pour faire une insertion / mise à jour de la valeure fieldName Le nom du champ (voir en dessous) fieldValue La valeur donnée au champ (voir en dessous) Information sur le nom des champs et leurs valeurs
Liste des noms possible Type de valeur "salutation", "firstname", "lastname", "companyname", "jobtitle" Type string libre "email", "emailunsubscriptionreason", "emailstatus" Type string libre "emailstatusdetail", "emailcapping", "mobile" Type string libre "mobileunsubscriptionreason", "mobilestatus", "mobilestatusdetail" Type string libre "mobilecapping", "phone", "fax", "address1", "address2" Type string libre "zipcode", "city", "country", "type" Type string libre "activity", "comments", "source", "activityrank", "influencerank" Type string libre "emailunsubscriptiondate", "emailstatusdate", "mobileunsubscriptiondate", "mobilestatusdate" Un type string au format UTC "yyyy-MM-dd HH:mm:ss+0000" "emailoptinpartners", "mobileoptinpartners", "emailoptin", "mobileoptin" Un type string comme "true" ou "yes1" ou "no" {Personalised_id} Type string libre Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Par defaut, les 50 dernières activitées du contact sont renvoyées. Vous pouvez laisser ce champ vide
Classe de la réponse (Statut 200)
ContactHistory {contactKey (string):Clé du contact
,contactFound (integer, optional):Nombre de contact trouvés
,records (integer, optional):Nombre d'enregistrement trouvés
,logs (Array[ContactLog], optional):}Log trouvés
ContactLog {Id (integer, optional):Id du log
,Type (string, optional):Type de log
,Object (string, optional):Information sur le log
,Title (string, optional):Titre du log
,Date (string, optional):Date d'insertion du log
,Group (string, optional):Groupe du log
,OperationId (integer, optional):Id de l'opération
,LogDate (string, optional):}Date d'enregsitrement du log
{ "contactKey": "string", "contactFound": 0, "records": 0, "logs": [ { "Id": 0, "Type": "string", "Object": "string", "Title": "string", "Date": "string", "Group": "string", "OperationId": 0, "LogDate": "string" } ] }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur ContactHistory
paramètre Information / Valeur possible contactKey Ceci est la clé d'unicité actuellement paramétrée sur le compte contactFound La valeur est ignorée records La valeur est ignorée logs Ceci est la liste des activités que vous souhaitez enregistrer Informations sur ContactLog
paramètre Information / Valeur possible Id La valeur est ignorée Type La valeur est ignorée Object La valeur est ignorée Title Titre (affiché dans l'interface) Date La valeur est ignorée Group La valeur est ignorée OperationId L'id de l'opération que vous souhaité affecté a ce log. Important pour les triggers LogDate La date de l'activité est enregistrée est au format de date UTC "yyyy-MM-dd HH:mm:ss+0000", make sure you add the +0000 to make it a UTC hour Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur les champs
- firstLine doit être supérieur à 1
- firstLineAs un entête avec comme valeur "true" ou "false"
- encoding peut être "UTF-8", "Unicode", "ISO-8859-1", "ISO-8859-15", "UTF-32", "UTF-7"
- separator peut être ',', ';', ' ', '\t', '-', '|', '*', ':', '.', '&', '/', '\', '+', '"'
- keyColumn est le nombre indiquant la colonne du fichier incluant la clé d'unicité des contacts à supprimer dans la base
- file est le fichier (.txt, .csv) à utiliser pour la purge
Classe de la réponse (Statut 201)
PurgeOperation {Id (integer, optional),StartDate (string, optional),Status (string, optional),Link (string, optional),LineRead (integer, optional)}{ "Id": 0, "StartDate": "string", "Status": "string", "Link": "string", "LineRead": 0 }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Link indique l'url où télécharger le fichier d'archive une fois disponible
Classe de la réponse (Statut 200)
Inline Model [PurgeOperation]
PurgeOperation {Id (integer, optional),StartDate (string, optional),Status (string, optional),Link (string, optional),LineRead (integer, optional)}[ { "Id": 0, "StartDate": "string", "Status": "string", "Link": "string", "LineRead": 0 } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Link indique l'url où télécharger le fichier d'archive une fois disponible
Classe de la réponse (Statut 200)
PurgeOperation {Id (integer, optional),StartDate (string, optional),Status (string, optional),Link (string, optional),LineRead (integer, optional)}{ "Id": 0, "StartDate": "string", "Status": "string", "Link": "string", "LineRead": 0 }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur ContactExportNfo
paramètre Information / Valeur possible name Le nom qui sera affiché sur votre interface description Indiquez segment:<id_du_segment> pour ajouter un export d'un segment particulier plutôt que l'ensemble des contacts fields "salutation", "firstname", "lastname", "companyname", "jobtitle", "email", "emailoptin", "emailunsubscriptiondate", "emailunsubscriptionreason", "emailstatus", "emailstatusdate", "emailstatusdetail", "emailcapping", "mobile", "mobileoptin", "mobileunsubscriptiondate", "mobileunsubscriptionreason", "mobilestatus", "mobilestatusdate", "mobilestatusdetail", "mobilecapping", "phone", "fax", "address1", "address2", "zipcode", "city", "country", "emailoptinpartners", "mobileoptinpartners", "creationdate", "importcreation", "modificationdate", "importmodification", "type", "activity", "comments", "source", "activityrank", "remotedate", "remoteos", "remoteip", "remoteuamail", "remoteuaweb", "emailopenings", "emailopeninglastdate", "emailopeninglastname", "emailclicks", "emailclickinglastdate", "emailclickinglastname", "emailclickinglastlink", "{Personalised_id}" filters "emailingoptin", "mobileoptin", "emailingoptout", "mobileoptout", "emailingsoft", "emailinghard" Classe de la réponse (Statut 201)
ExportOperation {Id (integer, optional),Name (string, optional),StartDate (string, optional),Status (string, optional),Link (string, optional),TotalContact (integer, optional)}{ "Id": 0, "Name": "string", "StartDate": "string", "Status": "string", "Link": "string", "TotalContact": 0 }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Link indique l'url où télécharger le fichier d'archive une fois disponible
Classe de la réponse (Statut 200)
Inline Model [ExportOperation]
ExportOperation {Id (integer, optional),Name (string, optional),StartDate (string, optional),Status (string, optional),Link (string, optional),TotalContact (integer, optional)}[ { "Id": 0, "Name": "string", "StartDate": "string", "Status": "string", "Link": "string", "TotalContact": 0 } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
ExportOperation {Id (integer, optional),Name (string, optional),StartDate (string, optional),Status (string, optional),Link (string, optional),TotalContact (integer, optional)}{ "Id": 0, "Name": "string", "StartDate": "string", "Status": "string", "Link": "string", "TotalContact": 0 }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Link indique l'url où télécharger le fichier d'archive une fois disponible
Classe de la réponse (Statut 200)
Inline Model [ImportOperation]
ImportOperation {Id (integer, optional),Name (string, optional),StartDate (string, optional),Status (string, optional),Link (string, optional),LineRead (integer, optional),LineDuplicate (integer, optional),LineAdd (integer, optional),LineUpdate (integer, optional),LineImport (integer, optional),LineError (integer, optional)}[ { "Id": 0, "Name": "string", "StartDate": "string", "Status": "string", "Link": "string", "LineRead": 0, "LineDuplicate": 0, "LineAdd": 0, "LineUpdate": 0, "LineImport": 0, "LineError": 0 } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
ImportOperation {Id (integer, optional),Name (string, optional),StartDate (string, optional),Status (string, optional),Link (string, optional),LineRead (integer, optional),LineDuplicate (integer, optional),LineAdd (integer, optional),LineUpdate (integer, optional),LineImport (integer, optional),LineError (integer, optional)}{ "Id": 0, "Name": "string", "StartDate": "string", "Status": "string", "Link": "string", "LineRead": 0, "LineDuplicate": 0, "LineAdd": 0, "LineUpdate": 0, "LineImport": 0, "LineError": 0 }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur les champs
- firstLine doit être supérieur à 1
- firstLineAs un entête avec comme valeur "true" ou "false"
- encoding peut être "UTF-8", "Unicode", "ISO-8859-1", "ISO-8859-15", "UTF-32", "UTF-7"
- separator peut être ',', ';', ' ', '\t', '-', '|', '*', ':', '.', '&', '/', '\', '+', '"'
- duplicateOption peut être "disallowdupupdate", "disallowdup", "allowdup"
- matchings est un tableau de type string décrit ci dessous
- file est le fichier (.txt, .csv) à utiliser pour la purge
Le POST doit avoir comment content-type: multipart/form-data Il faut aussi que la variable matching soit sous la forme d'un tableau ex: ["email", "firstname"]
Détail des différentes options de duplicateOption
disallowdupupdate: Mettre à jour les informations de votre Base Contacts par celles du fichier.
disallowdup: N'importer dans la Base Contacts que les nouveaux Contacts du fichier. Les Contacts déjà présents dans votre Base ne seront pas modifiés..
allowdup: Cette option n'est possible que si la paramètre de la base de contact du compte est positionné sur l'autorisation d'avoir des doublons (non-recommandé) dans la base de contacts.
Les valeurs correspondantes possibles
Liste des valeurs "firstname", "lastname", "companyname", "email", "emailoptin", "emailstatus", "mobile", "mobileoptin", "mobilestatus", "phone" "salutation", "jobtitle", "fax", "address1", "address2", "zipcode", "city", "country", "emailoptinpartners", "mobileoptinpartners", "type", "activity", "comments", "source" {Personalised_id} L'id de personalisation peut être trouvé dans votre compte Sendethic, vous devez mettre l'id ex: "26"
Classe de la réponse (Statut 201)
ImportOperation {Id (integer, optional),Name (string, optional),StartDate (string, optional),Status (string, optional),Link (string, optional),LineRead (integer, optional),LineDuplicate (integer, optional),LineAdd (integer, optional),LineUpdate (integer, optional),LineImport (integer, optional),LineError (integer, optional)}{ "Id": 0, "Name": "string", "StartDate": "string", "Status": "string", "Link": "string", "LineRead": 0, "LineDuplicate": 0, "LineAdd": 0, "LineUpdate": 0, "LineImport": 0, "LineError": 0 }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur ContactData
paramètre Information / Valeur possible id La valeur est ignorée contactKey Ceci est le champ de clé d'unicité de la base attributes La liste des champs d'un contact. Voir ContactAttribute en dessous Informations sur ContactAttribute
paramètre Information / Valeur possible id Le nom du champ (voir en dessous) - Vous devez utiliser ce champs pour faire une insertion / mise à jour de la valeure fieldName Le nom du champ (voir en dessous) fieldValue La valeur donnée au champ (voir en dessous) Information sur le nom des champs et leurs valeurs
Liste des noms possible Type de valeur "salutation", "firstname", "lastname", "companyname", "jobtitle" Type string libre "email", "emailunsubscriptionreason", "emailstatus" Type string libre "emailstatusdetail", "emailcapping", "mobile" Type string libre "mobileunsubscriptionreason", "mobilestatus", "mobilestatusdetail" Type string libre "mobilecapping", "phone", "fax", "address1", "address2" Type string libre "zipcode", "city", "country", "type" Type string libre "activity", "comments", "source", "activityrank", "influencerank" Type string libre "emailunsubscriptiondate", "emailstatusdate", "mobileunsubscriptiondate", "mobilestatusdate" Un type string au format UTC "yyyy-MM-dd HH:mm:ss+0000" "emailoptinpartners", "mobileoptinpartners", "emailoptin", "mobileoptin" Un type string comme "true" ou "yes1" ou "no" {Personalised_id} Type string libre Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur ContactData
paramètre Information / Valeur possible id La valeur est ignorée contactKey Ceci est le champ de clé d'unicité de la base attributes La liste des champs d'un contact. Voir ContactAttribute en dessous Informations sur ContactAttribute
paramètre Information / Valeur possible id Le nom du champ (voir en dessous) - Vous devez utiliser ce champs pour faire une insertion / mise à jour de la valeure fieldName Le nom du champ (voir en dessous) fieldValue La valeur donnée au champ (voir en dessous) Information sur le nom des champs et leurs valeurs
Liste des noms possible Type de valeur "salutation", "firstname", "lastname", "companyname", "jobtitle" Type string libre "email", "emailunsubscriptionreason", "emailstatus" Type string libre "emailstatusdetail", "emailcapping", "mobile" Type string libre "mobileunsubscriptionreason", "mobilestatus", "mobilestatusdetail" Type string libre "mobilecapping", "phone", "fax", "address1", "address2" Type string libre "zipcode", "city", "country", "type" Type string libre "activity", "comments", "source", "activityrank", "influencerank" Type string libre "emailunsubscriptiondate", "emailstatusdate", "mobileunsubscriptiondate", "mobilestatusdate" Un type string au format UTC "yyyy-MM-dd HH:mm:ss+0000" "emailoptinpartners", "mobileoptinpartners", "emailoptin", "mobileoptin" Un type string comme "true" ou "yes1" ou "no" {Personalised_id} Type string libre Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
-
-
Implementation Notes
La classe receiver et schedule seront toujours null, utilisez l'appel d'opération avec son id pour obtenir plus d'informations
Classe de la réponse (Statut 200)
Inline Model [EmailingOperation]
EmailingOperation {id (integer, optional):Operation number
,culture (string, optional):Language and localisation ex fr-FR
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,subject (string):Objet du message
,fromName (string, optional):Nom d'expéditeur affiché
,fromMail (string, optional):Mail used to send the email
,replyTo (string):L'adresse email ou vous voulez recevoir les réponses
,htmlEditor (string, optional):Message content Html format to be edited in the MB editor
,html (string, optional):Message content Html format
,text (string, optional):Contenu du message au format text
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional),options (EmailingOption, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
EmailingOption {mirror (string, optional):Mirror page "false", "account", "true"
,mirrorParagraph (string, optional):Mirror text if the mirror value is set to true
,encoding (string, optional):Encoding format of the message ex UTF-8
,importance (string, optional):Importance of the mail: "normal", "low", "high"
,contentFormat (string, optional):Mail format can have two value "html" ou "text", vous pouvez utiliser la variable text aussi si vous choisissez le html
,recipientDisplay (string, optional):Format d'affichage de l'adresse des destinataires : "mb_email", "mb_firstname mb_lastname", "mb_lastname mb_firstname", "mb_firstname", "{personalised}"
,redirectBounce (string, optional):Renseignez l'adresse email sur laquelle rediriger les retours serveur (bounce)
,redirectValidation (string, optional):Renseignez l'adresse email sur laquelle rediriger les spam-challenge
,routingOption (string, optional):Rediriger l'envoi vers une adresse d'un champs personnalisé ou une adresse email que celui du destinataire
,analyticsOption (string, optional):If you want to add analytics to your links, "no" "xiti" "google"
,xitiPrefix (string, optional):Préfixe des URLs sur lesquels utiliser les paramètres Xiti
,xitiTag (string, optional):Xiti tag
,gaSource (string, optional):google analytics utm_source
,gaMedium (string, optional):google analytics utm_medium
,gaCampaign (string, optional):google analytics utm_campaign
,gaContent (string, optional):google analytics utm_content
,gaTerm (string, optional):google analytics utm_Term
,gaPrefix (string, optional):}Préfixe des URLs sur lesquels utiliser les paramètres Google Analytics
[ { "id": 0, "culture": "string", "status": "string", "name": "string", "description": "string", "date": "string", "subject": "string", "fromName": "string", "fromMail": "string", "replyTo": "string", "htmlEditor": "string", "html": "string", "text": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" }, "options": { "mirror": "string", "mirrorParagraph": "string", "encoding": "string", "importance": "string", "contentFormat": "string", "recipientDisplay": "string", "redirectBounce": "string", "redirectValidation": "string", "routingOption": "string", "analyticsOption": "string", "xitiPrefix": "string", "xitiTag": "string", "gaSource": "string", "gaMedium": "string", "gaCampaign": "string", "gaContent": "string", "gaTerm": "string", "gaPrefix": "string" } } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Status possible values "edited", "running", "completed", "suspended" La classe receiver et schedule seront toujours null, utilisez l'appel d'opération avec son id pour obtenir plus d'informations
Classe de la réponse (Statut 200)
Inline Model [EmailingOperation]
EmailingOperation {id (integer, optional):Operation number
,culture (string, optional):Language and localisation ex fr-FR
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,subject (string):Objet du message
,fromName (string, optional):Nom d'expéditeur affiché
,fromMail (string, optional):Mail used to send the email
,replyTo (string):L'adresse email ou vous voulez recevoir les réponses
,htmlEditor (string, optional):Message content Html format to be edited in the MB editor
,html (string, optional):Message content Html format
,text (string, optional):Contenu du message au format text
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional),options (EmailingOption, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
EmailingOption {mirror (string, optional):Mirror page "false", "account", "true"
,mirrorParagraph (string, optional):Mirror text if the mirror value is set to true
,encoding (string, optional):Encoding format of the message ex UTF-8
,importance (string, optional):Importance of the mail: "normal", "low", "high"
,contentFormat (string, optional):Mail format can have two value "html" ou "text", vous pouvez utiliser la variable text aussi si vous choisissez le html
,recipientDisplay (string, optional):Format d'affichage de l'adresse des destinataires : "mb_email", "mb_firstname mb_lastname", "mb_lastname mb_firstname", "mb_firstname", "{personalised}"
,redirectBounce (string, optional):Renseignez l'adresse email sur laquelle rediriger les retours serveur (bounce)
,redirectValidation (string, optional):Renseignez l'adresse email sur laquelle rediriger les spam-challenge
,routingOption (string, optional):Rediriger l'envoi vers une adresse d'un champs personnalisé ou une adresse email que celui du destinataire
,analyticsOption (string, optional):If you want to add analytics to your links, "no" "xiti" "google"
,xitiPrefix (string, optional):Préfixe des URLs sur lesquels utiliser les paramètres Xiti
,xitiTag (string, optional):Xiti tag
,gaSource (string, optional):google analytics utm_source
,gaMedium (string, optional):google analytics utm_medium
,gaCampaign (string, optional):google analytics utm_campaign
,gaContent (string, optional):google analytics utm_content
,gaTerm (string, optional):google analytics utm_Term
,gaPrefix (string, optional):}Préfixe des URLs sur lesquels utiliser les paramètres Google Analytics
[ { "id": 0, "culture": "string", "status": "string", "name": "string", "description": "string", "date": "string", "subject": "string", "fromName": "string", "fromMail": "string", "replyTo": "string", "htmlEditor": "string", "html": "string", "text": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" }, "options": { "mirror": "string", "mirrorParagraph": "string", "encoding": "string", "importance": "string", "contentFormat": "string", "recipientDisplay": "string", "redirectBounce": "string", "redirectValidation": "string", "routingOption": "string", "analyticsOption": "string", "xitiPrefix": "string", "xitiTag": "string", "gaSource": "string", "gaMedium": "string", "gaCampaign": "string", "gaContent": "string", "gaTerm": "string", "gaPrefix": "string" } } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur SearchOperation
paramètre Information / Valeur possible importIds liste d'ids Classe de la réponse (Statut 200)
Inline Model [EmailingOperation]
EmailingOperation {id (integer, optional):Operation number
,culture (string, optional):Language and localisation ex fr-FR
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,subject (string):Objet du message
,fromName (string, optional):Nom d'expéditeur affiché
,fromMail (string, optional):Mail used to send the email
,replyTo (string):L'adresse email ou vous voulez recevoir les réponses
,htmlEditor (string, optional):Message content Html format to be edited in the MB editor
,html (string, optional):Message content Html format
,text (string, optional):Contenu du message au format text
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional),options (EmailingOption, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
EmailingOption {mirror (string, optional):Mirror page "false", "account", "true"
,mirrorParagraph (string, optional):Mirror text if the mirror value is set to true
,encoding (string, optional):Encoding format of the message ex UTF-8
,importance (string, optional):Importance of the mail: "normal", "low", "high"
,contentFormat (string, optional):Mail format can have two value "html" ou "text", vous pouvez utiliser la variable text aussi si vous choisissez le html
,recipientDisplay (string, optional):Format d'affichage de l'adresse des destinataires : "mb_email", "mb_firstname mb_lastname", "mb_lastname mb_firstname", "mb_firstname", "{personalised}"
,redirectBounce (string, optional):Renseignez l'adresse email sur laquelle rediriger les retours serveur (bounce)
,redirectValidation (string, optional):Renseignez l'adresse email sur laquelle rediriger les spam-challenge
,routingOption (string, optional):Rediriger l'envoi vers une adresse d'un champs personnalisé ou une adresse email que celui du destinataire
,analyticsOption (string, optional):If you want to add analytics to your links, "no" "xiti" "google"
,xitiPrefix (string, optional):Préfixe des URLs sur lesquels utiliser les paramètres Xiti
,xitiTag (string, optional):Xiti tag
,gaSource (string, optional):google analytics utm_source
,gaMedium (string, optional):google analytics utm_medium
,gaCampaign (string, optional):google analytics utm_campaign
,gaContent (string, optional):google analytics utm_content
,gaTerm (string, optional):google analytics utm_Term
,gaPrefix (string, optional):}Préfixe des URLs sur lesquels utiliser les paramètres Google Analytics
[ { "id": 0, "culture": "string", "status": "string", "name": "string", "description": "string", "date": "string", "subject": "string", "fromName": "string", "fromMail": "string", "replyTo": "string", "htmlEditor": "string", "html": "string", "text": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" }, "options": { "mirror": "string", "mirrorParagraph": "string", "encoding": "string", "importance": "string", "contentFormat": "string", "recipientDisplay": "string", "redirectBounce": "string", "redirectValidation": "string", "routingOption": "string", "analyticsOption": "string", "xitiPrefix": "string", "xitiTag": "string", "gaSource": "string", "gaMedium": "string", "gaCampaign": "string", "gaContent": "string", "gaTerm": "string", "gaPrefix": "string" } } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
EmailingOperation {id (integer, optional):Operation number
,culture (string, optional):Language and localisation ex fr-FR
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,subject (string):Objet du message
,fromName (string, optional):Nom d'expéditeur affiché
,fromMail (string, optional):Mail used to send the email
,replyTo (string):L'adresse email ou vous voulez recevoir les réponses
,htmlEditor (string, optional):Message content Html format to be edited in the MB editor
,html (string, optional):Message content Html format
,text (string, optional):Contenu du message au format text
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional),options (EmailingOption, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
EmailingOption {mirror (string, optional):Mirror page "false", "account", "true"
,mirrorParagraph (string, optional):Mirror text if the mirror value is set to true
,encoding (string, optional):Encoding format of the message ex UTF-8
,importance (string, optional):Importance of the mail: "normal", "low", "high"
,contentFormat (string, optional):Mail format can have two value "html" ou "text", vous pouvez utiliser la variable text aussi si vous choisissez le html
,recipientDisplay (string, optional):Format d'affichage de l'adresse des destinataires : "mb_email", "mb_firstname mb_lastname", "mb_lastname mb_firstname", "mb_firstname", "{personalised}"
,redirectBounce (string, optional):Renseignez l'adresse email sur laquelle rediriger les retours serveur (bounce)
,redirectValidation (string, optional):Renseignez l'adresse email sur laquelle rediriger les spam-challenge
,routingOption (string, optional):Rediriger l'envoi vers une adresse d'un champs personnalisé ou une adresse email que celui du destinataire
,analyticsOption (string, optional):If you want to add analytics to your links, "no" "xiti" "google"
,xitiPrefix (string, optional):Préfixe des URLs sur lesquels utiliser les paramètres Xiti
,xitiTag (string, optional):Xiti tag
,gaSource (string, optional):google analytics utm_source
,gaMedium (string, optional):google analytics utm_medium
,gaCampaign (string, optional):google analytics utm_campaign
,gaContent (string, optional):google analytics utm_content
,gaTerm (string, optional):google analytics utm_Term
,gaPrefix (string, optional):}Préfixe des URLs sur lesquels utiliser les paramètres Google Analytics
{ "id": 0, "culture": "string", "status": "string", "name": "string", "description": "string", "date": "string", "subject": "string", "fromName": "string", "fromMail": "string", "replyTo": "string", "htmlEditor": "string", "html": "string", "text": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" }, "options": { "mirror": "string", "mirrorParagraph": "string", "encoding": "string", "importance": "string", "contentFormat": "string", "recipientDisplay": "string", "redirectBounce": "string", "redirectValidation": "string", "routingOption": "string", "analyticsOption": "string", "xitiPrefix": "string", "xitiTag": "string", "gaSource": "string", "gaMedium": "string", "gaCampaign": "string", "gaContent": "string", "gaTerm": "string", "gaPrefix": "string" } }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
- L'objet receiver vous donnera une liste d'id pour chaque ressource respective
- L'objet schedule vous donnera une liste d'id pour chaque ressource respective
Schedule type
type variable and explanation "asap" Ce type fera partir l'operation dès que possible "scheduled" Ce type fera partir l'operation à la date que vous trouverez dans la variable data "triggered" Ce type fera partir l'opération dès que les critères renseignés dans la variable criterias seront atteint. Cette variable sera à remplir au format xml. C'est le même format utilisé dans les segments. Classe de la réponse (Statut 200)
EmailingOperation {id (integer, optional):Operation number
,culture (string, optional):Language and localisation ex fr-FR
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,subject (string):Objet du message
,fromName (string, optional):Nom d'expéditeur affiché
,fromMail (string, optional):Mail used to send the email
,replyTo (string):L'adresse email ou vous voulez recevoir les réponses
,htmlEditor (string, optional):Message content Html format to be edited in the MB editor
,html (string, optional):Message content Html format
,text (string, optional):Contenu du message au format text
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional),options (EmailingOption, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
EmailingOption {mirror (string, optional):Mirror page "false", "account", "true"
,mirrorParagraph (string, optional):Mirror text if the mirror value is set to true
,encoding (string, optional):Encoding format of the message ex UTF-8
,importance (string, optional):Importance of the mail: "normal", "low", "high"
,contentFormat (string, optional):Mail format can have two value "html" ou "text", vous pouvez utiliser la variable text aussi si vous choisissez le html
,recipientDisplay (string, optional):Format d'affichage de l'adresse des destinataires : "mb_email", "mb_firstname mb_lastname", "mb_lastname mb_firstname", "mb_firstname", "{personalised}"
,redirectBounce (string, optional):Renseignez l'adresse email sur laquelle rediriger les retours serveur (bounce)
,redirectValidation (string, optional):Renseignez l'adresse email sur laquelle rediriger les spam-challenge
,routingOption (string, optional):Rediriger l'envoi vers une adresse d'un champs personnalisé ou une adresse email que celui du destinataire
,analyticsOption (string, optional):If you want to add analytics to your links, "no" "xiti" "google"
,xitiPrefix (string, optional):Préfixe des URLs sur lesquels utiliser les paramètres Xiti
,xitiTag (string, optional):Xiti tag
,gaSource (string, optional):google analytics utm_source
,gaMedium (string, optional):google analytics utm_medium
,gaCampaign (string, optional):google analytics utm_campaign
,gaContent (string, optional):google analytics utm_content
,gaTerm (string, optional):google analytics utm_Term
,gaPrefix (string, optional):}Préfixe des URLs sur lesquels utiliser les paramètres Google Analytics
{ "id": 0, "culture": "string", "status": "string", "name": "string", "description": "string", "date": "string", "subject": "string", "fromName": "string", "fromMail": "string", "replyTo": "string", "htmlEditor": "string", "html": "string", "text": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" }, "options": { "mirror": "string", "mirrorParagraph": "string", "encoding": "string", "importance": "string", "contentFormat": "string", "recipientDisplay": "string", "redirectBounce": "string", "redirectValidation": "string", "routingOption": "string", "analyticsOption": "string", "xitiPrefix": "string", "xitiTag": "string", "gaSource": "string", "gaMedium": "string", "gaCampaign": "string", "gaContent": "string", "gaTerm": "string", "gaPrefix": "string" } }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Ceci créera une opération, chaque valeur non-renseignée aura par défaut la valeur configurée sur le compte Pour valider l'envoi d'une opération, vous devrez faire un appel de type PUT car ce type d'opération est effectué de manière asynchrone. Les valeurs name, subject et replyTo sont obligatoires.
EmailingOperation notes
paramètre Information / Valeur possible id Cette valeur sera ignorée status Cette valeur sera ignorée (read only) culture "en-us", "es-es", "pt-pt", "it-it", "de-de", "nl-nl", "zh-cn", "zh-ht", "fr-fr" name Le nom de l'opération avec un maximum de 256 caractères description Description de l'opération date La date de début de l'opération au format UTC "yyyy-MM-dd HH:mm:ss+0000", Toujours mettre le +0000 afin que la periode s'affiche bien au format UTC. Dépend du type de la classe schedule subject Objet du message fromName Nom d'expéditeur affiché fromMail Adresse email d'envoi (doit être préalablement paramétré dans Votre compte > Paramètres > Emailings) replyTo L'adresse email ou vous voulez recevoir les réponses htmlEditor Contenu du message au format html à editer dans L'Editeur du compte Sendethic avant envoi (option - uniquement si le contenu doit être édité dans L'Editeur par un utilisateur du compte Sendethic) html Contenu du message au format html à envoyer text Contenu du message au format text receivers Sélection des destinataires, voir ci-dessous pour plus de détails schedule Planning d'envoi d'une opération, voir ci-dessous pour plus de details options Options avancées, voir ci-dessous pour plus de détails EmailingOption notes
paramètre Information / Valeur possible mirror "false", "account", "true" mirrorParagraph Contenu au format html repris si la valeur mirror est positionnée à true encoding "utf-8", "iso-8859-15", "utf-7", "us-ascii", "iso-8859-6", "windows-1256", "iso-8859-4", "windows-1257", "iso-8859-2", "windows-1250", "gb2312", "hz-gb-2312", "GB18030", "Big5", "iso-8859-5", "windows-1251", "koi8-r", "koi8-u", "iso-8859-7", "iso-8859-8-i", "windows-1255", "euc-jp", "iso-2022-jp", "csISO2022JP", "shift_jis", "euc-kr", "iso-2022-kr", "ks_c_5601-1987", "iso-8859-3", "windows-874", "iso-8859-9", "windows-1254", "windows-1258", "iso-8859-1", "windows-1252" importance "normal", "low", "high" contentFormat "html", "text", vous pouvez utiliser la variable text aussi si vous choisissez le html recipientDisplay Format d'affichage de l'adresse des destinataires : " **mb_email**", "**mb_firstname****mb_lastname**", "**mb_lastname****mb_firstname**", "**mb_firstname**" ou your own valueredirectBounce Renseignez l'adresse email sur laquelle rediriger les retours serveur (bounce) redirectValidation Renseignez l'adresse email sur laquelle rediriger les spam-challenge routingOption Rediriger l'envoi vers une adresse d'un champs personnalisé ou une adresse email que celui du destinataire analyticsOption "no", "xiti", "google", xitiPrefix Préfixe des URLs sur lesquels utiliser les paramètres Xiti xitiTag Xiti tag gaSource google analytics utm_source gaMedium google analytics utm_medium gaCampaign google analytics utm_campaign gaContent google analytics utm_content gaTerm google analytics utm_Term gaPrefix Préfixe des URLs sur lesquels utiliser les paramètres Google Analytics Détail de ReceiversOperation
paramètre Information / Valeur possible segmentIds Liste d'id de segment importIds Liste d'id d'import contactIds Liste d'id de contact conditionsXml Format XML Détails de ScheduleOperation
Assurez-vous de renseigner le type pour que la mise à jour soit enregistrée
paramètre Information / Valeur possible type "asap", "triggered", "scheduled". La classe Scheduled est dependant de la variable date de EmailingOperation criterias Les critères au format XML criteriasMode "intersect", "union", la valeur par défault est intersect criteriasTime Le temps qui s'écoulera entre l'atteinte des critères et le début de l'envoi de l'operation, vous avez la possibilité de choisir le temps en heure, jour, semaine ou mois comme ceci h[0-24], d[1-14], w[2-3], m[1-3]. Par exemple "h0" enverra quelques minutes apres l'atteinte des critères, "h3" 3 heures après, "w2" 2 semaines après criteriasLimit Limiter à un seul envoi de l'opération par destinataire, "true", "false" Classe de la réponse (Statut 201)
EmailingOperation {id (integer, optional):Operation number
,culture (string, optional):Language and localisation ex fr-FR
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,subject (string):Objet du message
,fromName (string, optional):Nom d'expéditeur affiché
,fromMail (string, optional):Mail used to send the email
,replyTo (string):L'adresse email ou vous voulez recevoir les réponses
,htmlEditor (string, optional):Message content Html format to be edited in the MB editor
,html (string, optional):Message content Html format
,text (string, optional):Contenu du message au format text
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional),options (EmailingOption, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
EmailingOption {mirror (string, optional):Mirror page "false", "account", "true"
,mirrorParagraph (string, optional):Mirror text if the mirror value is set to true
,encoding (string, optional):Encoding format of the message ex UTF-8
,importance (string, optional):Importance of the mail: "normal", "low", "high"
,contentFormat (string, optional):Mail format can have two value "html" ou "text", vous pouvez utiliser la variable text aussi si vous choisissez le html
,recipientDisplay (string, optional):Format d'affichage de l'adresse des destinataires : "mb_email", "mb_firstname mb_lastname", "mb_lastname mb_firstname", "mb_firstname", "{personalised}"
,redirectBounce (string, optional):Renseignez l'adresse email sur laquelle rediriger les retours serveur (bounce)
,redirectValidation (string, optional):Renseignez l'adresse email sur laquelle rediriger les spam-challenge
,routingOption (string, optional):Rediriger l'envoi vers une adresse d'un champs personnalisé ou une adresse email que celui du destinataire
,analyticsOption (string, optional):If you want to add analytics to your links, "no" "xiti" "google"
,xitiPrefix (string, optional):Préfixe des URLs sur lesquels utiliser les paramètres Xiti
,xitiTag (string, optional):Xiti tag
,gaSource (string, optional):google analytics utm_source
,gaMedium (string, optional):google analytics utm_medium
,gaCampaign (string, optional):google analytics utm_campaign
,gaContent (string, optional):google analytics utm_content
,gaTerm (string, optional):google analytics utm_Term
,gaPrefix (string, optional):}Préfixe des URLs sur lesquels utiliser les paramètres Google Analytics
{ "id": 0, "culture": "string", "status": "string", "name": "string", "description": "string", "date": "string", "subject": "string", "fromName": "string", "fromMail": "string", "replyTo": "string", "htmlEditor": "string", "html": "string", "text": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" }, "options": { "mirror": "string", "mirrorParagraph": "string", "encoding": "string", "importance": "string", "contentFormat": "string", "recipientDisplay": "string", "redirectBounce": "string", "redirectValidation": "string", "routingOption": "string", "analyticsOption": "string", "xitiPrefix": "string", "xitiTag": "string", "gaSource": "string", "gaMedium": "string", "gaCampaign": "string", "gaContent": "string", "gaTerm": "string", "gaPrefix": "string" } }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Ceci vous permet de mettre à jour les paramétres d'une opération d'emailing, si vous laissez une valeur à null celui-ci sera ignorée.
EmailingOperation notes
paramètre Information / Valeur possible id L'id qui identifie l'opération a modifier status Cette valeur sera ignorée (read only) culture "en-us", "es-es", "pt-pt", "it-it", "de-de", "nl-nl", "zh-cn", "zh-ht", "fr-fr" name Le nom de l'opération avec un maximum de 256 caractères description Description de l'opération date La date de début de l'opération au format UTC "yyyy-MM-dd HH:mm:ss +0000", Toujours mettre le +0000 afin que la periode s'affiche bien au format UTC. Dépend du type de la classe schedule subject Objet du message fromName Nom d'expéditeur affiché fromMail Mail used to send the email (must be defined in your account parameters) replyTo L'adresse email ou vous voulez recevoir les réponses htmlEditor Contenu du message au format html à editer dans L'Editeur du compte Sendethic avant envoi (option - uniquement si le contenu doit être édité dans L'Editeur par un utilisateur du compte Sendethic) html Contenu du message au format html à envoyer text Contenu du message au format text receivers Sélection des destinataires, voir ci-dessous pour plus de détails schedule Planning d'envoi d'une opération, voir ci-dessous pour plus de details options Options avancées, voir ci-dessous pour plus de détails EmailingOption notes
paramètre Information / Valeur possible mirror "false", "account", "true" mirrorParagraph Contenu au format html repris si la valeur mirror est positionnée à true encoding "utf-8", "iso-8859-15", "utf-7", "us-ascii", "iso-8859-6", "windows-1256", "iso-8859-4", "windows-1257", "iso-8859-2", "windows-1250", "gb2312", "hz-gb-2312", "GB18030", "Big5", "iso-8859-5", "windows-1251", "koi8-r", "koi8-u", "iso-8859-7", "iso-8859-8-i", "windows-1255", "euc-jp", "iso-2022-jp", "csISO2022JP", "shift_jis", "euc-kr", "iso-2022-kr", "ks_c_5601-1987", "iso-8859-3", "windows-874", "iso-8859-9", "windows-1254", "windows-1258", "iso-8859-1", "windows-1252" importance "normal", "low", "high" contentFormat "html", "text", vous pouvez utiliser la variable text aussi si vous choisissez le html recipientDisplay Format d'affichage de l'adresse des destinataires : " **mb_email**", "**mb_firstname****mb_lastname**", "**mb_lastname****mb_firstname**", "**mb_firstname**" ou your own valueredirectBounce Renseignez l'adresse email sur laquelle rediriger les retours serveur (bounce) redirectValidation Renseignez l'adresse email sur laquelle rediriger les spam-challenge routingOption Rediriger l'envoi vers une adresse d'un champs personnalisé ou une adresse email que celui du destinataire analyticsOption "no", "xiti", "google", xitiPrefix Préfixe des URLs sur lesquels utiliser les paramètres Xiti xitiTag Xiti tag gaSource google analytics utm_source gaMedium google analytics utm_medium gaCampaign google analytics utm_campaign gaContent google analytics utm_content gaTerm google analytics utm_Term gaPrefix Préfixe des URLs sur lesquels utiliser les paramètres Google Analytics Détail de ReceiversOperation
paramètre Information / Valeur possible segmentIds Liste d'id de segment importIds Liste d'id d'import contactIds Liste d'id de contact conditionsXml Format XML Détails de ScheduleOperation
paramètre Information / Valeur possible type "asap", "triggered", "scheduled". La classe Scheduled est dependant de la variable date de EmailingOperation criterias Les critères au format XML criteriasMode "intersect", "union", the la valeur par défault est intersect criteriasTime Le temps qui s'écoulera entre l'atteinte des critères et le début de l'envoi de l'operation, vous avez la possibilité de choisir le temps en heure, jour, semaine ou mois comme ceci h[0-24], d[1-14], w[2-3], m[1-3]. Par exemple "h0" enverra quelques minutes apres l'atteinte des critères, "h3" 3 heures après, "w2" 2 semaines après criteriasLimit Limiter à un seul envoi de l'opération par destinataire, "true", "false" Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur TestEmail
paramètre Information / Valeur possible recipientUser email de l'utilisateur destinataire (to) testContact email du contact utilisé pour la personnalisation de l'envoi de test titlePrefix prefixe de l'objet Classe de la réponse (Statut 201)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Inline Model [EmailingOperationExport]
EmailingOperationExport {name (string, optional):Export name
,status (string, optional):Export operation status
,startDate (string, optional):Export operation status
,endDate (string, optional):Export operation status
,link (string, optional):Export link
,id (integer, optional):Id of the emailing export
,referenceId (integer, optional):}Id of the emailing export
[ { "name": "string", "status": "string", "startDate": "string", "endDate": "string", "link": "string", "id": 0, "referenceId": 0 } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
EmailingOperationExport {name (string, optional):Export name
,status (string, optional):Export operation status
,startDate (string, optional):Export operation status
,endDate (string, optional):Export operation status
,link (string, optional):Export link
,id (integer, optional):Id of the emailing export
,referenceId (integer, optional):}Id of the emailing export
{ "name": "string", "status": "string", "startDate": "string", "endDate": "string", "link": "string", "id": 0, "referenceId": 0 }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
EmailingOperationExport notes
paramètre Information / Valeur possible startDate Date de début. Cette valeur doit être au format de date UTC "yyyy-MM-dd HH:mm:ss" endDate Date de fin. Cette valeur doit être au format de date UTC "yyyy-MM-dd HH:mm:ss" Classe de la réponse (Statut 200)
EmailingOperationExport {name (string, optional):Export name
,status (string, optional):Export operation status
,startDate (string, optional):Export operation status
,endDate (string, optional):Export operation status
,link (string, optional):Export link
,id (integer, optional):Id of the emailing export
,referenceId (integer, optional):}Id of the emailing export
{ "name": "string", "status": "string", "startDate": "string", "endDate": "string", "link": "string", "id": 0, "referenceId": 0 }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
SmtpEmail notes
paramètre Information / Valeur possible recipientEmail Adresse email du destinataire recipientName Nom du destinataire recipientDatas Tableau des données de personnalisation sous forme de liste "id" : "valeur" Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Cette méthode ne peut être utilisé que par les partenaires de Sendethic. Merci de nous contacter si vous voulez plus d'informations sur le programme partenaire. Un objet vous sera retourné avec les informations du nouveau contact. Si une erreur se produit, l'objet aura une variable erreur décrivant l'erreur. Un objet vous sera retourné avec les informations du nouveau contact. Si une erreur se produit, l'objet aura une variable erreur décrivant l'erreur
Informations sur PartnerSignUp
paramètre Information / Valeur possible mbcode Le code fourni par Sendethic salutation "M", "Mlle", "Mme" firstname Le prénom de votre client lastname Le nom de famille de votre client email L'adresse email du premier utilisateur du compte jobtitle La fonction ou titre votre client dans son entreprise phonenumber Le numéro de téléphone de votre client companyName Le nom de l'entreprise de votre client address L'adresse de l'entreprise de votre client zipcode Le code postal de votre client city La ville où se trouve l'entreprise de votre client country Le pays où se trouve l'entreprise de votre client culture Culture de la langue utilisée, specifiée par deux lettres en minuscules par le code ISO 693-1 suivi par '-' puis deux lettres en majuscule au format ISO 3166 par exemple pour le français de France: "fr-FR" website The url of your website resellerNfo Informations supplémentaires si besoin (ex: numéro de licence spécifique) sendingEmails Définit les adresses utilisées en tant qu’adresses d’envoi dans les opérations Classe de la réponse (Statut 200)
PartnerInformation {acoountId (integer, optional),apiKey (string, optional),error (string, optional)}{ "acoountId": 0, "apiKey": "string", "error": "string" }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
-
-
Classe de la réponse (Statut 200)
Inline Model [Segment]
Segment {id (integer, optional):id
,description (string, optional):description
,creationDate (string, optional):UTC yyyy-MM-dd HH:mm:ss
,name (string):name
,mode (string):Union par défaut
,details (string):}information
[ { "id": 0, "description": "string", "creationDate": "string", "name": "string", "mode": "string", "details": "string" } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur Segment
paramètre Information / Valeur possible id Cet identifiant sera ignoré description Un texte décrivant votre segment creationDate La date sera renseignée par défaut avec la date courante au moment de l'appel name Nom du segment affiché dans le compte mode "intersect", "union" details Un type string en xml décrit en bas - Ceci est un exemple de details d'un segment (vous pouvez faire un GET sur un segment pour voir la structure)
<Criterias> <Criteria guid="ff551463-5614-4174-af40-f26c41942ee4" reference="op-unsubscribing-emailing" type="Operation" id="0,5,0" op="unsubscribingemailing" is="true" value1="" value2="" /> <Criteria guid ="ff551463-5614-4174-af40-f26c41942ee5" reference="op-unsubscribing-emailing" type="Operation" id="0,5,0" op="unsubscribingemailing" is="true" value1="" value2="" /> </Criterias>
Classe de la réponse (Statut 201)
Segment {id (integer, optional):id
,description (string, optional):description
,creationDate (string, optional):UTC yyyy-MM-dd HH:mm:ss
,name (string):name
,mode (string):Union par défaut
,details (string):}information
{ "id": 0, "description": "string", "creationDate": "string", "name": "string", "mode": "string", "details": "string" }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur Segment
paramètre Information / Valeur possible id L'id sera utilisé pour mettre à jour le segment description Un texte décrivant votre segment creationDate La date sera renseignée par défaut avec la date courante au moment de l'appel name Nom du segment affiché dans le compte mode "intersect", "union" details Un type string en xml (Regarder la description du POST pour plus de details) Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Segment {id (integer, optional):id
,description (string, optional):description
,creationDate (string, optional):UTC yyyy-MM-dd HH:mm:ss
,name (string):name
,mode (string):Union par défaut
,details (string):}information
{ "id": 0, "description": "string", "creationDate": "string", "name": "string", "mode": "string", "details": "string" }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
-
-
Implementation Notes
Cette méthode vous permet d'envoyer un SMS à un contact en spécifiant son numéro - Assurez-vous que vous disposez d'assez de crédit d'envoi avant de procéder.
Informations sur SmsMessage
paramètre Information / Valeur possible oadc Si vous souhaitez personnaliser le nom de l'émetteur (optionnel) mobile Le numéro de portable sur lequel vous souhaitez envoyer votre message, utiliser le format international (ex pour la france +33612340001) message Le message que vous souhaitez envoyer Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
La classe receiver et schedule seront toujours null, utilisez l'appel d'opération avec son id pour obtenir plus d'informations
Classe de la réponse (Statut 200)
Inline Model [SmsOperation]
SmsOperation {oadc (string, optional),message (string, optional),id (integer, optional):Operation number
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
[ { "oadc": "string", "message": "string", "id": 0, "status": "string", "name": "string", "description": "string", "date": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" } } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
SmsOperation {oadc (string, optional),message (string, optional),id (integer, optional):Operation number
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
{ "oadc": "string", "message": "string", "id": 0, "status": "string", "name": "string", "description": "string", "date": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" } }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
- L'objet receiver vous donnera une liste d'id pour chaque ressource respective
- L'objet schedule vous donnera une liste d'id pour chaque ressource respective
Schedule type
type variable and explanation "asap" Ce type fera partir l'operation dès que possible "scheduled" Ce type fera partir l'operation à la date que vous trouverez dans la variable data "triggered" Ce type fera partir l'opération dès que les critères renseignés dans la variable criterias seront atteint. Cette variable sera à remplir au format xml. C'est le même format utilisé dans les segments. Classe de la réponse (Statut 200)
SmsOperation {oadc (string, optional),message (string, optional),id (integer, optional):Operation number
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
{ "oadc": "string", "message": "string", "id": 0, "status": "string", "name": "string", "description": "string", "date": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" } }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Status possible values "edited", "running", "completed", "suspended" La classe receiver et schedule seront toujours null, utilisez l'appel d'opération avec son id pour obtenir plus d'informations
Classe de la réponse (Statut 200)
Inline Model [SmsOperation]
SmsOperation {oadc (string, optional),message (string, optional),id (integer, optional):Operation number
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
[ { "oadc": "string", "message": "string", "id": 0, "status": "string", "name": "string", "description": "string", "date": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" } } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Informations sur SearchOperation
paramètre Information / Valeur possible importIds liste d'ids Classe de la réponse (Statut 200)
Inline Model [SmsOperation]
SmsOperation {oadc (string, optional),message (string, optional),id (integer, optional):Operation number
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
[ { "oadc": "string", "message": "string", "id": 0, "status": "string", "name": "string", "description": "string", "date": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" } } ]
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Ceci créera une opération, chaque valeur non-renseignée aura par défaut la valeur configurée sur le compte Pour valider l'envoi d'une opération, vous devrez faire un appel de type PUT car ce type d'opération est effectué de manière asynchrone. La valeur name est obligatoire.
SmsOperation notes
paramètre Information / Valeur possible id Cette valeur sera ignorée status Cette valeur sera ignorée (read only) name Le nom de l'opération avec un maximum de 256 caractères description Description de l'opération date La date de début de l'opération au format UTC "yyyy-MM-dd HH:mm:ss+0000", Toujours mettre le +0000 afin que la periode s'affiche bien au format UTC. Dépend du type de la classe schedule oadc Si vous souhaitez personnaliser le nom de l'émetteur (optionnel) message Le message que vous souhaitez envoyer receivers Sélection des destinataires, voir ci-dessous pour plus de détails schedule Planning d'envoi d'une opération, voir ci-dessous pour plus de details Détail de ReceiversOperation
paramètre Information / Valeur possible segmentIds Liste d'id de segment importIds Liste d'id d'import contactIds Liste d'id de contact conditionsXml Format XML Détails de ScheduleOperation
Assurez-vous de renseigner le type pour que la mise à jour soit enregistrée
paramètre Information / Valeur possible type "asap", "triggered", "scheduled". Scheduled is dependent on the SmsOption date and triggered on the variables below criterias Les critères au format XML criteriasMode "intersect", "union", la valeur par défault est intersect criteriasTime Le temps qui s'écoulera entre l'atteinte des critères et le début de l'envoi de l'operation, vous avez la possibilité de choisir le temps en heure, jour, semaine ou mois comme ceci h[0-24], d[1-14], w[2-3], m[1-3]. Par exemple "h0" enverra quelques minutes apres l'atteinte des critères, "h3" 3 heures après, "w2" 2 semaines après criteriasLimit Limit to one operation per recipient, "true", "false" Classe de la réponse (Statut 201)
SmsOperation {oadc (string, optional),message (string, optional),id (integer, optional):Operation number
,status (string, optional):Operation status
,name (string):Operation name
,description (string, optional):Description de l'opération
,date (string, optional):Operation start date
,reportLink (string, optional):Url of the report
,receivers (ReceiversOperation, optional),schedule (ScheduleOperation, optional)}
ReceiversOperation {segmentIds (Array[integer], optional):Liste d'id de segment
,importIds (Array[integer], optional):Liste d'id d'import
,contactIds (Array[integer], optional):Liste d'id de contact
,conditionsXml (string, optional):Format XML
,conditionsMode (string, optional):}Criterias mode "intersect" ou "union"
ScheduleOperation {type (string, optional):Schedule mode
,criterias (string, optional):In XML format
,criteriasTime (string, optional):Amount of time after the criteria are met to send
,criteriasLimit (string, optional):}Mail limit for one contact
{ "oadc": "string", "message": "string", "id": 0, "status": "string", "name": "string", "description": "string", "date": "string", "reportLink": "string", "receivers": { "segmentIds": [ 0 ], "importIds": [ 0 ], "contactIds": [ 0 ], "conditionsXml": "string", "conditionsMode": "string" }, "schedule": { "type": "string", "criterias": "string", "criteriasTime": "string", "criteriasLimit": "string" } }
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Implementation Notes
Ceci vous permet de mettre à jour les paramétres d'une opération d'emailing, si vous laissez une valeur à null celui-ci sera ignorée.
SmsOperation notes
paramètre Information / Valeur possible id L'id qui identifie l'opération a modifier status Cette valeur sera ignorée (read only) name Le nom de l'opération avec un maximum de 256 caractères description Description de l'opération date La date de début de l'opération au format UTC "yyyy-MM-dd HH:mm:ss+0000", Toujours mettre le +0000 afin que la periode s'affiche bien au format UTC. Dépend du type de la classe schedule oadc Si vous souhaitez personnaliser le nom de l'émetteur (optionnel) message Le message que vous souhaitez envoyer receivers Sélection des destinataires, voir ci-dessous pour plus de détails schedule Planning d'envoi d'une opération, voir ci-dessous pour plus de details Détail de ReceiversOperation
paramètre Information / Valeur possible segmentIds Liste d'id de segment importIds Liste d'id d'import contactIds Liste d'id de contact conditionsXml Format XML Détails de ScheduleOperation
paramètre Information / Valeur possible type "asap", "triggered", "scheduled". Scheduled is dependent on the SmsOption date and triggered on the variables below criterias Les critères au format XML criteriasMode "intersect", "union", the la valeur par défault est intersect criteriasTime Le temps qui s'écoulera entre l'atteinte des critères et le début de l'envoi de l'operation, vous avez la possibilité de choisir le temps en heure, jour, semaine ou mois comme ceci h[0-24], d[1-14], w[2-3], m[1-3]. Par exemple "h0" enverra quelques minutes apres l'atteinte des critères, "h3" 3 heures après, "w2" 2 semaines après criteriasLimit Limit to one operation per recipient, "true", "false" Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-
-
Classe de la réponse (Statut 200)
Curl
URL appelée
Corps de la réponse
Code de la réponse
En-têtes de la réponse
-
-