Kampagne mit einer Liste

Mit dieser Methode können Sie eine Kampagne an eine Liste von Empfängern senden.

POST

/send/lists

Body-Parameter

text notwendig	Ihre Nachricht
value notwendig	ID der Liste
pushtype	Die Art des Versands (`alert` oder `marketing`)
delay	Versanddatum `Y-m-d H:i:s`
sender	Ermöglicht das Personalisieren des Absenders
unicode (default 0)	Aktiviert den Unicode-Modus, wodurch die Grösse der SMS auf 70 Zeichen reduziert wird.

Über die Art der Sendung und den Absender

If you havn't already read the basic informations about the SMS and how pushtype and sender work, you might be interested in doing so.

Beispiele


POST /send/lists HTTP/1.1
Host: api.smsfactor.com
Authorization: Bearer your.token
Accept: application/json

{
  "sms": {
    "message": {
      "text": "Message via API",
      "pushtype": "alert",
      "sender": "Ganondorf",
      "delay": "2024-04-29 10:53:19",
      "unicode": 0
    },
    "lists": [
      {
        "value": 45190
      },
      {
        "value": 47854
      }
    ]
  }
}


POST /send/lists HTTP/1.1
Host: api.smsfactor.com
Authorization: Bearer your.token
Accept: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<sms>
  <message>
    <text>Message via API</text>
    <pushtype>alert</pushtype>
    <sender>Ganondorf</sender>
    <delay>2024-04-29 10:53:19</delay>
    <unicode>0</unicode>
  </message>
  <lists>
    <value>45190</value>
  </lists>
  <lists>
    <value>47854</value>
  </lists>
</sms>


\SMSFactor\SMSFactor::setApiToken('your token');

$response = \SMSFactor\Campaign::sendToLists([
  'sms' => [
    'message' => [
      'text' => 'Message via API',
      'pushtype' => 'alert',
      'sender' => 'Ganondorf',
      'delay' => '2024-04-29 10:53:19',
      'unicode' => 0
    ],
    'lists' => [
      [
        'value' => 45190
      ],
      [
        'value' => 47854
      ]
    ]
], false); // True to simulate the campaign (no SMS sent)

Ergebnisformat

A status -8 doesn't mean your SMS won't be sent. No need to retry unless you want to send the same SMS multiple times 😉


{
  "status": 1,      
  "message": "OK",
  "ticket": "14672468",   //The id of your campaign
  "cost": 2,              //The cost of your campaign
  "credits": 642,         //Your credits after your campaign has been created
  "total": 2,             //Number of message before filtering  
  "sent": 2,              //Number of message after filtering
  "blacklisted": 0,       //Number of blacklisted numbers
  "duplicated": 0,        //Number of duplicated numbers
  "invalid": 0,           //Number of invalid numbers
  "npai": 0               //Number of npai numbers
}


<response>
  <status>1</status>
  <message>OK</message>
  <ticket>14672468</ticket>
  <cost>2</cost>
  <credits>642</credits>
  <total>2</total>
  <sent>2</sent>
  <blacklisted>0</blacklisted>
  <duplicated>0</duplicated>
  <invalid>0</invalid>
  <npai>0</npai>
</response>