| |
To become a developer, you must request an API Key. This allows you to use our API's to confirm that they will fit in your environment. A test API Key of "XMethods" will make an entry to the data bases, generate emails, and will allow you to cancel the entry (for test purposes). It also works with REST and SOAP operations.
API Types.
REST and SOAP API's are supported.
Current Functionality.
As of February 6, 2007, there are 2 functions to the Mindgram API set:
Schedule a Mindgram
Cancel a Mindgram
REST Functions
Each function assumes you have a valid API Key and will include the notation: {API_Key_Here} - which is where you would substitute your API Key.
To schedule a Mindgram, use:
http://www.Mindgram.com/api/SchedRest.php
To that URL, you would pass the following, method POST:
from = the sender’s name which will be announced,
phone = the ten digits of area code and phone number which Mindgram will dial,
message = the text that Mindgram will "speak" to the caller,
sendoptn = "Send Immediately" or "Schedule Delivery",
hr = 01, 02, ..., 11, 12, - choose one,
min = 00, 01, 02, ..., 57, 58, 59, - choose one,
mo = 01, ..., 12, - choose one,
day = 01, ..., 12, - choose one,
year = yyyy, e.g. 2007,
ampm = "AM" or "PM",
zone = "EST" or "CST" or "MST" or "PST", - choose one,
email = email of sender where confirmations will be sent,
api_key = {API_Key_Here}
You are returned one the following:
A 25 character "Mindgram Key String", if the scheduling of the Mindgram was successful.
or
If the operation was not successful:
API Key not found, 0 records found.
a status message if the account is not active & funded, e.g. Account Expired
Call Cannot Be Scheduled
To Cancel a Mindgram, use:
http://www.Mindgram.com/api/CancelRest.php
To that URL, you would pass the Mindgram Key String which you received when you Scheduled the Mindgram, and the API Key.
Again, you would use the POST method. (Element names: key_str and api_key).
You are returned one of the following messages:
Call Cancelled
API Key not found, 0 records found.
Call Already Cancelled
Call Cannot Be Cancelled
Call {key_str} {api_key} Not Found
Note: {key_str} and {api_key} are replaced by the values you supplied.
SOAP Use.
There are two WSDL's. One for Scheduling a Mindgram, and one for Cancelling a Mindgram.
http://www.Mindgram.com/mindgramcall/sched_call.wsdl
http://www.Mindgram.com/mindgramcall/cancel_call.wsdl
The use parallels the REST functions above, and the same kind of information is returned.
Sample PHP code may be downloaded from here. Note that the call key must be changed to cancel the right call.
Feel Free to Email us with any questions. Or use the "Call Me Now" function below.
|
|
| |
|
