Changes between Version 1 and Version 2 of WikiStart

Timestamp:

2013-08-09 08:17:34 (11 years ago)

Author:

solivas

Comment:

Initial wiki page describing how to use the plugin's functions.

WikiStart

@@ -1 @@
-= Welcome to Trac 0.12.3 =
+= Twilio.com API Interface =
 
-Trac is a '''minimalistic''' approach to '''web-based''' management of
-'''software projects'''. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress.
-
-All aspects of Trac have been designed with the single goal to 
-'''help developers write great software''' while '''staying out of the way'''
-and imposing as little as possible on a team's established process and
-culture.
-
-As all Wiki pages, this page is editable, this means that you can
-modify the contents of this page simply by using your
-web-browser. Simply click on the "Edit this page" link at the bottom
-of the page. WikiFormatting will give you a detailed description of
-available Wiki formatting commands.
-
-"[wiki:TracAdmin trac-admin] ''yourenvdir'' initenv" created
-a new Trac environment, containing a default set of wiki pages and some sample
-data. This newly created environment also contains 
-[wiki:TracGuide documentation] to help you get started with your project.
-
-You can use [wiki:TracAdmin trac-admin] to configure
-[http://trac.edgewall.org/ Trac] to better fit your project, especially in
-regard to ''components'', ''versions'' and ''milestones''. 
+Original code posted: http://forum.micasaverde.com/index.php/topic,15499.msg117950.html#msg117950
 
 
-TracGuide is a good place to start.
+== How to use ==
 
-Enjoy! [[BR]]
-''The Trac Team''
+This plugin, what I called the Twilio.com API Plugin, will allow to you have your Vera call and say text, or send SMS messages using the Twilio.com Call and SMS APIs.  You will have to register for an account at www.twilio.com in order to use this plugin.
 
-== Starting Points ==
+These are mandatory items that you need to configure before you can use the plugin:[[BR]]
+[[BR]]
+'''Account SID''' - Your Twilio.com account SID[[BR]]
+'''Auth Token''' - Your Twilio.com account Authenrication Token[[BR]]
+'''Caller ID''' - Phone number authorized to make calls[[BR]]
+[[BR]]
+These two items are optional (unless using the !CustomVoiceCall function):[[BR]]
+[[BR]]
+'''Custom MSG URL''' - URL that points to a custom TwiML creator[[BR]]
+'''Custom MSG Var Name''' - Custom Message variable passed in URL[[BR]]
 
- * TracGuide --  Built-in Documentation
- * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project
- * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions
- * TracSupport --  Trac Support
 
-For a complete list of local wiki pages, see TitleIndex.
+There are three functions that you can use:
+
+'''!InitiateVoiceCall'''[[BR]]
+'''SendSMSMessage'''[[BR]]
+'''!CustomVoiceCall'''[[BR]]
+
+The Twilio.com API's use what they have dubbed TwiML, which is an XML DTD that the API understands for passing it commands.
+
+
+----
+
+
+'''!InitiateVoiceCall''' will use the free twimlets.com/message TwiML generator to have Twilio's API speak the message you pass to the function.
+
+''(Note:  we will assume our plugin has an ID of 66 in the following examples.  Make sure you replace the 66 in the code below with the actual ID number of the plugin on your system)''
+
+Example:[[BR]]
+
+{{{
+luup.call_action("urn:twilioapi-org:serviceId:TwilioInterface1", "!InitiateVoiceCall",{ !PhoneNumber= "555-555-1212", Message="Greetings from your Vera Home Automation System"}, 66)
+}}}
+
+
+'''!PhoneNumber''' = number of recipient
+
+'''SendSMSMessage''' will send an SMS using Twilio's API:
+
+
+Example:[[BR]]
+
+{{{
+luup.call_action("urn:twilioapi-org:serviceId:TwilioInterface1", "SendSMSMessage",{ PhoneNumber= "555-555-1212", Message="Greetings from your Vera Home Automation System"}, 66)
+}}}
+
+
+'''!PhoneNumber''' = number of recipient
+
+'''!CustomVoiceCall''' will initiate a voice call, using the URL you specified in the Custom MSG URL by itself or with the Custom MSG Var Name config items.
+
+Example:[[BR]]
+
+{{{
+luup.call_action("urn:twilioapi-org:serviceId:TwilioInterface1", "!CustomVoiceCall",{ !PhoneNumber= "555-555-1212", Message="Hi there", !MsgFlag=2}, 66)
+}}}
+
+
+'''!PhoneNumber''' = number of recipient
+'''!MsgFlag''' = 1 to only use custom URL, 2 to use custom URL and message variable name
+