Créer une liste

Cette méthode vous permet de créer une liste de contacts. Chaque contact peut posséder jusqu'à 4 informations personnalisées. Ces informations peuvent ensuite être affichées dans chaque message. Par exemple, si vous insérez [info1] dans votre texte, ce sera automatiquement remplacé par l'information du contact correspondante.

POST

/list

Paramètres du body

value requis	Le numéro du destinataire au format E.164
name	Le nom de la liste. Si aucun nom n'est fourni, la date de création sera le nom par défaut
info1	Information 1
info2	Information 2
info3	Information 3
info4	Information 4

Exemples


POST /list HTTP/1.1
Host: api.smsup.ch
Authorization: Bearer your.token
Accept: application/json

{
  "list": {
    "name": "My list",
    "contacts": {
      "gsm": [
        {
          "value": "41781234567",
          "info1": "Louis",
          "info2": "de Broglie",
          "info3": "1892",
          "info4": "Dieppe"
        },
        {
          "value": "41781234566",
          "info1": "Richard",
          "info2": "Feynman",
          "info3": "1918",
          "info4": "New-York"
        }
      ]
    }
  }
}


POST /list HTTP/1.1
Host: api.smsup.ch
Authorization: Bearer your.token
Accept: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<list>
  <name>My list</name>
  <contacts>
    <gsm>
      <value>41781234567</value>
      <info1>Louis</info1>
      <info2>de Broglie</info2>
      <info3>1892</info3>
      <info4>Dieppe</info4>
    </gsm>
    <gsm>
      <value>41781234566</value>
      <info1>Richard</info1>
      <info2>Feynman</info2>
      <info3>1918</info3>
      <info4>New-York</info4>
    </gsm>
  </contacts>
</list>


$response = \SMSFactor\ContactList::create([
    'list' => [
      'name' => 'My list',
      'contacts' => [
        'gsm' => [
          [
            'value' => '41781234567',
            'info1' => 'Louis',
            'info2' => 'de Broglie',
            'info3' => '1892',
            'info4' => 'Dieppe'
          ],
          [
            'value' => '41781234566',
            'info1' => 'Richard',
            'info2' => 'Feynman',
            'info3' => '1918',
            'info4' => 'New-York'
          ]
        ]
      ]
    ]
]);

Format de la réponse


{
  "status": 1,
  "message": "OK",
  "contacts": 2,
  "invalid": 0,
  "duplicates": 0,
  "id": "5a0331bffc5886074551ce97"     //the id of the created list. It's an ObjectId type (string of 12 chars)
}


<response>
  <status>1</status>
  <message>OK</message>
  <contacts>2</contacts>
  <invalid>0</invalid>
  <duplicates>0</duplicates>
  <id>50433</id>
</response>