Advanced Developer Interface
Here are a few more API calls that you might find handy. Most sites using the API will do just fine using only the basic API calls, but these ones will let you go to 11:
- Create User - to programatically create a new Twiddla meeting.
- List Snapshots - to get a list of Snapshots that have been saved in your meetings
- Delete Meeting - to completely delete a meeting, including all transcripts, snapshots and viewed webpages.
Creating a new Twiddla User:
You can create a new Twiddla user by means of a simple HTTP POST to
http://www.twiddla.com/API/CreateUser.aspx
containing your Twiddla username and password,
along with some basic information about the user to be created.
Successful requests will return the Username of newly created user. Failed requests will return -1 along with an error message. Regardless, all responses will take the form of plain text, with nary an angle bracket in sight.
You may encrypt this request via SSL if you'd like, by directing it to https://www.twiddla.com/API/CreateUser.aspx instead.
A Create User request may supply the following parameters:
| http://www.twiddla.com/API/CreateUser.aspx | |
username (required)
|
Your Twiddla username
|
password (required)
|
Your Twiddla password.
Yes, in plaintext over the internet.
Send it via SSL if you're afraid they're watching you.
|
newusername (required)
|
The username you'd like to use for this new user. (Be warned that we have half a million usernames registered and they all need to be unique. Best practice here is to prepend your sitename to a unique string, e.g., "mytutoringsite_kenny") |
newpassword (required)
|
A password for your new user. |
displayname (required)
|
Your user's full name, for display in Twiddla meetings. |
email (optional)
|
Your user's email, if you want. |
| Try it out: | |
Listing Saved Snapshots:
You can get a list of Twiddla snapshots that your users have saved by sending off a HTTP POST to
http://www.twiddla.com/API/ListSnapshots.aspx
containing your Twiddla username and password.
Successful requests will return a comma-separated list of Snapshot URLs. Failed requests will return -1 along with an error message. Note that a successful request will simply return nothing in the case that your account has no active meetings in progress (since that's what a comma-separated list of zero length looks like.)
You may encrypt this request via SSL if you'd like, by directing it to https://www.twiddla.com/API/ListSnapshots.aspx instead.
A List Snapshots request may supply the following parameters:
| http://www.twiddla.com/API/ListSnapshots.aspx | |
username (required)
|
Your Twiddla username
|
password (required)
|
Your Twiddla password.
Yes, in plaintext over the internet.
Send it via SSL if you're afraid they're watching you.
|
sessionid (optional)
|
The SessionID for which you'd like to list snapshots. If omitted, all snapshots for the supplied user will be returned. |
format (optional)
|
Valid formats are:
xml for this parameter and we'll hand you back a big
chunk of XML containing a list of all your Snapshots along with a bunch of
extra information about them. There's plenty of information there to do anything
you want, so parse away!
|
| Try it out: | |
Delete a Meeting:
You can completely delete a Twiddla meeting by sending a HTTP POST to
http://www.twiddla.com/API/DeleteSession.aspx
containing your Twiddla username and password, along with the sessionid of the meeting in question.
Successful requests will a positive integer. Failed requests will return -1 along with an error message.
You may encrypt this request via SSL if you'd like, by directing it to https://www.twiddla.com/API/DeleteSession.aspx instead.
A Delete Meeting request may supply the following parameters:
| http://www.twiddla.com/API/DeleteSession.aspx | |
username (required)
|
Your Twiddla username
|
password (required)
|
Your Twiddla password.
Yes, in plaintext over the internet.
Send it via SSL if you're afraid they're watching you.
|
sessionid (required)
|
The SessionID of the meeting you'd like to delete. |
| Try it out: | |