With the closing of the Talkshoe API Ning site recently, some have asked for the documentation that was on that site so that you could continue to develop programs that would access Talkshoe from the API.
I have retrieved everything from the Ning site and have it posted here. One caveat though, I would like to point out that the API’s are not currently being developed, so if you have any issues with them, they will not be addressed at this time.
That being said, for those that are interested, here is the documentation along with some sample programs that were on the original Ning site.
TalkShoe Web Services Version 1.0
Documentation for the first version of the TalkShoe Web services which includes data access.
API example – WordPress plug in
[Download not found]
Twitter mashup example code (from screen cast)
New API Calls added October 29th, 2007
New API calls:
* getChatComments?episodeId= – This returns a list of Chat objects that you describe below.
* getCategories – returns a list of Strings representing the categories
* getTalkcastsByCategory?category= – returns a list of Talkcast objects for the given category
What is the definition of “live” show
There has been some confusion on what TalkShoe’s definition of “Live” means. This is because scheduled talkcasts appear in the Live listing on the website 15 min prior to the schedule date and time. This is to allow people to join in early including the host. For the APIs however Live shows are only ones where the Host has dialed into which causes the audio stream to start. This means if you use the getLiveShows method it will only return Talkcasts that the host has dialed into. Likewise, if you use the getEpisodes method the attribute will only be true if the host has dialed in. This is why the widget player only shows live when the host has dialed in and the stream is present (since it uses this API.
We are looking at changing this to basically return all talkcasts in the getLiveShows that show up on the live listing on the website. We will still provide a attribute on the getEpisodes to make sure people can find out if the host has dialed in and there is a stream.
Filter live and upcoming API by who follows
The getUpcomingShows and getLiveShows has been enhanced so that the results can be filtered by talkcasts a member is following. This is done by adding the userName=[username] parameter to the method.
Getting the stream URL
You can get the stream URL from the API getEpisodes?talkcastId=XXXXX where XXXXX is your call ID. The stream URL will be present for any episode that has True for tag streaming. The StreamingURL is located in the streamUrl tag and will look like this http://recordings.talkshoe.com:8000/TS-XXXXX.mp3) and to get it to play in a streaming player you can use the playlistUrl tag that will look like
Again, these Url tags will only appear for episodes that are currently streaming. If you want to know what the streaming URL will be prior to it going live you can get the episode Id for any scheduled call from the same API by grabbing the episodeId tag from any upcoming episode and then just replacing the XXXXX with the episodeId for the playlistUrl and streamUrl tags above. Example: if my episode Id for an upcoming episode is 4321 as returned in the tag, then the playlistUrl and streamUrl http://recordings.talkshoe.com:8000/TS-XXXXX.mp3You can get the stream URL from the API getEpisodes?talkcastId=XXXXX (where XXXXX is your call ID). The stream URL will be present for any episode that is True for tag true . The StreamingURL is located in the streamUrl tag (http://recordings.talkshoe.com:8000/TS-4321.mp3) and to get it to play in a streaming player you can use the playlistUrl tag like