Last Update: 2024-03-21

Send transactional SMS

There are 4 variants how to send a transactional SMS. Whether to use an existing SMS template or if the whole message text is provided, and whether to use an existing address record as recipient or a provides mobile number.

Info: If the text is longer than 160 characters, than it will be splitted into multiple SMS (which will be automatically concatened again by every mobile phone). There are only 153 characters per SMS if it gets splitted. These numbers are only valid if all characters are within the 7-Bit GSM 3.38 charset. Otherwise the messages gets encoding with 16-Bit Unicode, where the max length of one SMS is 70 characters. (see https://de.wikipedia.org/wiki/GSM_03.38)

Request:

1. With Sms template and existing address record
<?xml version="1.0" encoding="UTF-8"?>
<smstrigger customerid="">
  <id></id>
  <address key="Attribute12"></address>
</smstrigger>
2. With Sms template and without existing address record
<?xml version="1.0" encoding="UTF-8"?>
<smstrigger customerid="">
  <id></id>
  <mobilenumber>43664...</mobilenumber>
</smstrigger>
3. Withou Sms template and existing address record
<?xml version="1.0" encoding="UTF-8"?>
<smstrigger customerid="">
  <message><![CDATA[...]]></message>
  <address key="Attribute12"></address>
</smstrigger>
4. Without Sms template and without existing address record
<?xml version="1.0" encoding="UTF-8"?>
<smstrigger customerid="">
    <message><![CDATA[...]]></message>
    <mobilenumber>43664...</mobilenumber>
</smstrigger>
Description of XML-Tags:
Element Format Description
smstrigger
↳ idintID of SMS
↳ messageintText of SMS
↳ addressvarcharRecipient is an existing address
  ↳ @keyvarcharKey-field by which the address is specified (default="Email")
↳ mobilenumberintRecipient is given mobilenumber (with country prefix)

Response:

On success the internal ID of the created job will be returned in response->data.

Für Rückfragen stehen wir Ihnen jederzeit gerne unter support@eyepin.com zur Verfügung.