Documentation API-SMS: Ajouter un contact

POST

https://api.octopush.com/v1/public/contact/create

Encodage : UTF-8

Authentification

Vos identifiants « api-key » et « api-login » doivent être ajoutés dans les headers.

Définition

Ce web service vous permet d’ajouter un contact à une liste.

Paramètres particuliers

Nom	Type	Description
`contacts`	array	Liste d’objets de type contact : [ { "phone_number": "+111222233334444", "first_name": "Axelle", "last_name": "Durand", "param1": null, "param2": null, "param3": Mme, "param4": null, "param5": null }, ..., { "phone_number": "+2222333334444555", "first_name": "John", "last_name": "Smith", "param3": "M" } ]
`list_name`	string	(optionnel) [max length 30 chars] Nom de la liste à laquelle le contact doit être ajouté.
`tag_name`	string	(optionnel) [max length 20 chars] Nom du tag qui sera affecté au(x) contact(s).
`auto_remove_blacklisted_numbers`	boolean	(optionnel) Si ce champ est transmis et qu’il a la valeur true, les numéros blacklistés seront automatiquement supprimés de votre liste de numéros.
`do_not_overwrite`	boolean	(optionnel) Si ce champ est transmis et qu’il a la valeur true, alors si vous tentez d’ajouter un contact dont le numéro existe déjà, au lieu d’enregistrer les nouvelles données, nous ignorerons votre requête.

Exemple Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/contact/create' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "contacts": [
    {
      "phone_number": "+111222233334444",
      "first_name": "Axelle",
      "last_name": "Durand",
      "param3": "Mme"
    },
    {
      "phone_number": "+2222333334444555",
      "first_name": "John",
      "last_name": "Smith",
      "param3": "M"
    }
  ],
  "list_name": "my_list",
  "tag_name": "vip"
}'

Code à copier-coller

curl -X POST 'https://api.octopush.com/v1/public/contact/create' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"contacts": [{"phone_number": "+111222233334444","first_name": "Axelle","last_name": "Durand","param3": "Mme"},{"phone_number": "+2222333334444555","first_name": "John","last_name": "Smith","param3": "M"}],"list_name": "my_list","tag_name": "vip"}'

Retour Server en json

Succès : 201 CREATED

Exemple de retour

{
    "items": [
        {
            "phone_number": "+3735555555560",
            "email": "[email protected]",
            "status": "added"
        },
        {
            "phone_number": "+3735555555561",
            "email": "[email protected]",
            "status": "updated"
        },
        {
            "phone_number": "+3735555555562",
            "email": "[email protected]",
            "status": "skipped"
        }
    ]
}