DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

SMSKAUFEN Gateway¶

Author:	Nicole Cordes
Created:	2013-03-12T20:05:08.300000000
Changed by:	Nicole Cordes
Changed:	2013-03-13T01:39:44.950000000
Classification:	cps_smskaufen
Description:	The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) ----
Keywords:	forAdmins, forDevelopers, forBeginners, forIntermediates, sms, api, smskaufen
Author:	Nicole Cordes
Email:	cordes@cps-it.de
Language:	en

SMSKAUFEN Gateway¶

Extension Key: cps_smskaufen

Language: en

Version: 1.0.0

Keywords: forAdmins, forDevelopers, forBeginners, forIntermediates, sms, api, smskaufen

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.org

Table of Contents¶

`SMSKAUFEN Gateway 1 <#__RefHeading__5708_1738894311>`_

`Introduction 3 <#__RefHeading__5710_1738894311>`_

What does it do? 3

Screenshot 3

Need help or found a bug? 4

`Users manual 5 <#__RefHeading__467_413120346>`_

`Configuration 7 <#__RefHeading__31511_818911409>`_

`Integration 9 <#__RefHeading__31515_818911409>`_

Introduction¶

What does it do?¶

This extension provides different ways to send SMS through TYPO3. Therefore the service of SMSKAUFEN (http://www.smskaufen.com) is used where you have to register for free. The advantages of that service is that you don't have any fix costs and pay only for sent SMS.

Features for editors¶

Backend module to send text messages to tt_address records as recipients

Features for developers¶

Connection API to the service of SMSKAUFEN which you can include in your own extensions

Screenshot¶

Image 1 : Form to send a text messages

Need help or found a bug?¶

Please provide your bugs, feature requests or commands on the project page at http://forge.typo3.org/projects/extension-cps_smskaufen

Don't forget to add your environment settings (especially TYPO3 and PHP versions) and as much information to the current configuration as possible.

Users manual¶

To send a text message you have to choose any page with tt_address records. Then you be able to input your message and to choose any date to schedule your message. Please notice that any date in the past will result in a direct dispatch of your text message.

After you pushed the send button the dispatch process gets started and you receive a status information for each recipient.

f there are any errors or conflicts with your configuration the dispatch is canceled and you see the error messages.

Configuration¶

You can define some global settings in the extension configuration. All changes are checked (esp. dependencies to type) after saving and you immediately see any misconfiguration.

If you need any special changes on some pages you be able to redefine them via page TSConfig. You only have to provide the settings you want to change.

mod.web_txcpssmskaufenM1 {
        useSSL =
        username =
        apiKey =
        type =
        sender =
        reply =
        replyEmail =
        status =
        massMail =
        maxi =
}

Integration¶

You might want to disable the backend module and send the text messages on your own (e.g. as a part of a scheduler task or any other monitoring extension). Therefore you only have to get an instance of the gateway class Tx_CpsSmskaufen_Gateway_SmsGateway.

This class provides getter and setter functions for each setting option as well as the opportunity to apply a whole (extension) setting array.

You can run a global configuration check any time to find out any misconfiguration.

If you start the dispatch of the text message(s) the check is called on its own. If the function returns a string some errors are returned. Otherwise an array with request and response information will be returned.