Ajouter un contact

Cette requête est utilisée pour créer un contact au sein d'un groupe

URL

POST https://api.smspartner.fr/v1/contact/add

Paramètres obligatoires

Nom
Valeur

groupId

L'id du groupe dans lequel sera le contact

phoneNumber

Numéros de téléphone du contact. Il doit être :

  • au format national (06xxxxxxxx) ou international (+336xxxxxxxx), pour des numéros français.

  • au format international (+496xxxxxxxx), pour des numéros hors France.

Paramètres optionnels

Nom
Valeur

firstname

Prénom (32 caractères max.)

lastname

Nomm (32 caractères max.)

date

Date au format YYYY-MM-DD. Pourra être utilisé pour des envois automatique (ex: anniversaire )

url

Url , elle doit commencer par http:// ou https://

custom1

Champ personnalisé 1

custom2

Champ personnalisé 2

custom3

Champ personnalisé 3

custom4

Champ personnalisé 4

Requête

{
  "curl_command": {
    "method": "POST",
    "url": "http://api.smspartner.fr/v1/contact/add",
    "headers": {
      "Content-Type": "application/json"
    },
    "data": {
      "apiKey": "YOUR_API_KEY",
      "groupId": "ID GROUP",
      "contact": {
        "phoneNumber": "xxxxxxxxx",
        "firstname": "prénom",
        "lastname": "nom",
        "date": "YYYY-MM-DD",
        "shortUrlPartnr": "http://",
        "url": "http://",
        "custom1": "custom 1",
        "custom2": "custom 2",
        "custom3": "custom 3",
        "custom4": "custom 4"
      }
    }
  }
}

Réponse

{
  "success": true,
  "code": 200,
  "contact": {
    "phoneNumber": "xxxxxxxx",
    "firstname": "Prénom",
    "lastname": "Nom",
    "date": "YYYY-MM-DD",
    "shortUrlPartnr": "http://",
    "url": "http://",
    "custom1": "custom 1",
    "custom2": "custom 2",
    "custom3": "custom 3",
    "custom4": "custom 4",
    "contactId": "ID CONTACT"
  }
}

Erreurs

{
  "success": false,
  "code": 10,
  "message": "Clef API incorrecte"
}

Code erreurs

Code de réponse
Réponse

1

Le groupId est requis

2

Contact infos sont requises

10

La Clé API est requise

15

Le numéro est déjà dans le groupe

Dernière mise à jour