[archive] API SOAP : ContactDatas

Gestion des données de vos contacts

Nom de la méthodeGetContactData
DescriptionRetourne la ou les valeurs d’un champ pour le ou les contacts correspondant à une clé d’unicité spécifique
Paramètresint accountId : numéro du compte

string apiKey : clé API du compte

string contactKey : valeur du champ défini comme clé d’unicité de votre compte et sur lequel la recherche va s’effectuer

int attributeId : Identifiant du champ

Résultatstring : liste des valeurs dans le format correspondant aux entêtes « Accept » ou « Content-Type » de la requête SOAP

exemple :

<Contacts>

<Contact Id = »Identifiant du contact « ><Attribute Id= »Identifiant du champ »>Valeur du champ</Attribute></Contact>

</Contacts>

Exemple de code PHP5
 <?php
$soapClient = new SoapClient('https://services.message-business.com/v3/api/PublicInterface.svc/wsdl');
try
{
 $soapResult = $soapClient-> GetContactData (array('accountId' => 12345, 'apiKey' => '00000000-0000-0000-0000-000000000000', 'contactKey' => '
 test@test.com', 'attributeId' => 'lastname'));
 echo str_replace('<', '< ',$soapResult-> GetContactDataResult);
}
catch (Exception $e) 
{ 
 echo 'Caught exception: ' . $e->getMessage(); 
}
?>
Nom de la méthodeSetContactData
DescriptionAffecte une nouvelle valeur d’un champ à tous les contacts correspondant à la clé d’unicité spécifiée
Paramètresint accountId : numéro du compte

string apiKey : clé API du compte

string contactKey : valeur du champ défini comme clé d’unicité de votre compte et sur lequel la recherche va s’effectuer

int attributeId : Identifiant du champ

string data : Nouvelle valeur

bool createIfKeyNotExisting : Indique si une nouvelle fiche contact doit être créée au cas où aucun contact ne corresponde à la valeur de clé d’unicité spécifiée

Résultatint : nombre de contacts modifiés
Exemple de code PHP5NOTA BENE : Dans le cas particulier des listes à choix simple et multiples, la valeur indiquée lors de l’appel de SetContactDatas pour ce champ ne doit pas être le texte de la valeur choisie dans la liste des valeurs disponibles mais doit être l’identifiant de cette valeur telle qu’indiqué en effectuant un appel à GetAccountContactAttributeValues. De ce fait, les valeurs à indiquer sont les identifiants tel qu’indiqués par GetAccountContactAttributeValues.
<?php
$soapClient = new SoapClient('https://services.message-business.com/v3/api/PublicInterface.svc/wsdl');
try
{
 $soapResult = $soapClient-> SetContactData (array('accountId' => 12345, 'apiKey' => '00000000-0000-0000-0000-000000000000', 'contactKey' => '
 test@test.com', 'attributeId' => 'companyname', 'data' => 'Message Business', 'createIfKeyNotExisting' => true));
 echo str_replace('<', '< ',$soapResult-> SetContactDataResult);
}
catch (Exception $e) 
{ 
 echo 'Caught exception: ' . $e->getMessage(); 
}
?>
Nom de la méthodeGetContactDatas
DescriptionRetourne les valeurs de tous les champs pour le ou les contacts correspondant à une clé d’unicité spécifique
Paramètresint accountId : numéro du compte

string apiKey : clé API du compte

string contactKey : valeur du champ défini comme clé d’unicité de votre compte et sur lequel la recherche va s’effectuer

Résultatstring : liste des valeurs dans le format correspondant aux entêtes « Accept » ou « Content-Type » de la requête SOAP

exemple :

<Contacts>

<Contact Id = »Identifiant du contact « >

<Attribute Id= »Identifiant du champ »>Valeur du champ</Attribute>

<Attribute Id= »Identifiant du champ »>Valeur du champ</Attribute>

<Attribute Id= »Identifiant du champ »>Valeur du champ</Attribute>

</Contact>

</Contacts>

Exemple de code PHP5
<?php
$soapClient = new SoapClient('https://services.message-business.com/v3/api/PublicInterface.svc/wsdl');
try
{
 $soapResult = $soapClient-> GetContactDatas (array('accountId' => 12345, 'apiKey' => '00000000-0000-0000-0000-000000000000', 'contactKey' => '
 test@test.com'));
 echo str_replace('<', '< ',$soapResult-> GetContactDatasResult);
}
catch (Exception $e) 
{ 
 echo 'Caught exception: ' . $e->getMessage(); 
}
?>
Nom de la méthodeSetContactDatas
DescriptionAffecte des nouvelles valeurs à plusieurs champs à tous les contacts correspondant à la clé d’unicité spécifiée
Paramètresint accountId : numéro du compte

string apiKey : clé API du compte

string contactKey : valeur du champ défini comme clé d’unicité de votre compte et sur lequel la recherche va s’effectuer

string xmlDatas : Structure XML partielle ou complète identique à celle retournée par GetContactData ou GetContactDatas

bool createIfKeyNotExisting : Indique si une nouvelle fiche contact doit être créée au cas où aucun contact ne corresponde à la valeur de clé d’unicité spécifiée

Résultatint : nombre de contacts modifiés
Exemple de code PHP5 NOTA BENE : Dans le cas particulier des listes à choix simple et multiples, la valeur indiquée lors de l’appel de SetContactDatas pour ce champ ne doit pas être le texte de la valeur choisie dans la liste des valeurs disponibles mais doit être l’identifiant de cette valeur telle qu’indiqué en effectuant un appel à GetAccountContactAttributeValues. De ce fait, les valeurs à indiquer sont les identifiants tel qu’indiqués par GetAccountContactAttributeValues.
<?php
$soapClient = new SoapClient('https://services.message-business.com/v3/api/PublicInterface.svc/wsdl');
try
{
 $soapResult = $soapClient-> SetContactDatas (array('accountId' => 12345, 'apiKey' => '00000000-0000-0000-0000-000000000000', 'contactKey' => '
 test@test.com', 'xmlDatas' => '<Contacts><Contact><Attribute Id="companyname">MessageBusiness</Attribute><Attribute Id="emailoptin">yes1</Attribute></Contact></Contacts>', 'createIfKeyNotExisting' => true));
 echo str_replace('<', '< ',$soapResult-> SetContactDatasResult);
}
catch (Exception $e) 
{ 
 echo 'Caught exception: ' . $e->getMessage(); 
}
?>