.. _module-sms:

SMS
--------------------------

* **Identifier** - SMS
* **Description** - Allows to send and receive SMS.
* **Current Version** - 1
* **Initialization** - None
* **Destroy** - None
* **Dependencies** - :ref:`module-core`, :ref:`module-contacts`, :ref:`module-telephony`

Trigger Incoming SMS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------------------+----------------------+--------------+--------------------------------+
| Name         | INCOMING                                                                                               |
+--------------+---------------------------------+----------------------+--------------+--------------------------------+
| Description  | Executes when receiving an SMS.                                                                        |
+--------------+---------------------------------+----------------------+--------------+--------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+----------------------+--------------+--------------------------------+
|              | Type                            | Name                 | Required     | Description                    |
+==============+=================================+======================+==============+================================+
| Parameters   | CONTACTS.PHONE-NUMBER           | SENDER               | No           | If present, trigger is         |
|              |                                 |                      |              | executed only if SMS sender    |
|              |                                 |                      |              | matches with provided one.     |
+              +---------------------------------+----------------------+--------------+--------------------------------+
|              | CORE.TEXT-FILTER                | TEXT-FILTER          | No           | If present, trigger is         |
|              |                                 |                      |              | executed only if SMS content   |
|              |                                 |                      |              | matches filter.                |
+--------------+---------------------------------+----------------------+--------------+--------------------------------+
| Variables    | CORE.STRING                     | TEXT                                | Message content.               |
+              +---------------------------------+----------------------+--------------+--------------------------------+
|              | CORE.TIMESTAMP                  | TIMESTAMP                           | Message date and time.         |
+              +---------------------------------+----------------------+--------------+--------------------------------+
|              | CORE.STRING                     | SENDER.NAME                         | Eventual sender name,          |
|              |                                 |                                     | otherwise *null*.              |
+              +---------------------------------+----------------------+--------------+--------------------------------+
|              | CONTACTS.PHONE-NUMBER           | SENDER.PHONE-NUMBER                 | Eventual sender number,        |
|              |                                 |                                     | otherwise *null*.              |
+--------------+---------------------------------+----------------------+--------------+--------------------------------+

Performer Send SMS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------------------+----------------------+--------------+--------------------------------+
| Name         | SEND                                                                                                   |
+--------------+---------------------------------+----------------------+--------------+--------------------------------+
| Description  | Sends an SMS.                                                                                          |
+--------------+---------------------------------+----------------------+--------------+--------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+----------------------+--------------+--------------------------------+
|              | Type                            | Name                 | Required     | Description                    |
+==============+=================================+======================+==============+================================+
| Parameters   | CORE.STRING                     | TEXT                 | Yes          | Message content.               |
+              +---------------------------------+----------------------+--------------+--------------------------------+
|              | CONTACTS.PHONE-NUMBER           | RECIPIENT-NUMBER     | Yes          | Recipient number.              |
+--------------+---------------------------------+----------------------+--------------+--------------------------------+