-
Alpha Feature: API Access
We've now opened up simple API access in an Alpha stage.
This allows very advanced users to pass commands to the VOIPo system to control various features on their account just like the Control By SMS feature. You can use this to write your own scripts and programs to interact with us.
Right now, we added the basic commands and it's in a simple format. We'd like to get some feedback on it and if it's a popular feature we'll likely improve it so that it's a full SOAP based API. With this version, we just wanted to give you guys that were asking for it something basic to work with.
We can pretty easily add any commands to it and would like some feedback on what you'd like to see added to it.
API Activation
To use the service, simply go to BETA - API in vPanel. There you just need to Enable it and set an API password. We recommend that this be different than your account password.
Once you've done this, you can begin passing commands.
Do Not Disturb (DND)
Action: dnd
Arguments: vmail, busy, off
Example: api.voipo.com/?username=9491230000&password=test&action=dnd&argu ments[]=busy
Failover
Action: fail
Arguments: 10DigitNumber, vmail
Example: api.voipo.com/?username=9491230000&password=test&action=fail&arg uments[]=busy
Call Forwarding
Action: forward
Arguments: 10DigitNumber, off
Example: api.voipo.com/?username=9491230000&password=test&action=fwd&argu ments[]=off
-
Re: Alpha Feature: API Access
The forum software keeps manipulating the example URLs so I had to take off the http:// on the front of them so it wouldn't think they were a link and truncate them.
-
Re: Alpha Feature: API Access
Just testing something...
Code:
http://api.voipo.com/?username=9491230000&password=test&action=fwd&arguments[]=off
Yep- works... Just use code tags... :D
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
chpalmer
Just testing something...
Code:
http://api.voipo.com/?username=9491230000&password=test&action=fwd&arguments[]=off
Yep- works... Just use code tags... :D
Hmmm. I swear that wasn't working earlier. :)
-
Re: Alpha Feature: API Access
-
Re: Alpha Feature: API Access
Nice. Thanks for this! The cronjobs are setup. Take that dad-in-law!
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
bubbanc
Take that dad-in-law!
lol! Nice...
-
Re: Alpha Feature: API Access
The geek factor is impressive. But I wouldn't be surprised if I am in the minority by saying, I would have preferred to see a more flexible, updated 'Forwarding' feature rather than another way to activate a Basic Forwarding feature with limited options. Ma Bell Forwarding from the seventies had greater flexibility.
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
voipoh
The geek factor is impressive. But I wouldn't be surprised if I am in the minority by saying, I would have preferred to see a more flexible, updated 'Forwarding' feature rather than another way to activate a Basic Forwarding feature with limited options. Ma Bell Forwarding from the seventies had greater flexibility.
As I stated on other threads, I feel a basic no answer or a busy call forward are options that would be very useful.
-
Re: Alpha Feature: API Access
Is anyone using this yet?
If you are, you probably have a basic idea of how it works (manipulating database entries), so you have a basic idea of what's possible.
What features would you guys want to see added to it?
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
VOIPoTim
Is anyone using this yet?
Yes, I'm using it to set DND automatically at certain times of day. That one's huge for me. I don't really see any other features that would be more useful to me in the API than just via vPanel.
-
Re: Alpha Feature: API Access
I think I am going to write a little program to take advantage of this in Windows. Would be easier for the wife then logging in Vpanel.
Perhaps when I get the basics for it down I may have some suggestions for additional features. This is a really cool idea. I hope you do not give up on it due to lack of interest because its not something most people can take advantage of right away. Most have no idea how to use it.
Might be neat if you could use it to make a call which would then ring the ATA and when answered completes the call. Like the Vonage click to call software for example.
I found this site with some examples if anyone has a interest in it.
https://secure.click2callu.com/
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
VOIPoTim
What features would you guys want to see added to it?
I could see several uses for Voicemail:
- Enable/disable
- Return number of unread messages
- Return message details (Message ID, Caller Name & Number, Date/Time, Duration, etc.)
- File/delete messages using Message ID above
I would think the first two are pretty basic and the last two a little more complicated. I could see this tying into something cool like a Firefox voice mail plug in or something along those lines...
-
Re: Alpha Feature: API Access
I second this for the VM interaction. Would be great to integrate with my home web page so I can get a quick idea of what my messages are without having to login to the vPanel.
-
Re: Alpha Feature: API Access
How about a option for simul ring.
-
Re: Alpha Feature: API Access
What about a new option for DND called "status" which would report if it was enabled, and if so, which type of DND is enabled. This would be handy for a web page I want to put together for my wife that'll tell her what the status is and give her buttons to enable/disable from her iPhone so she can do so while dealing with our little one.
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
bubbanc
What about a new option for DND called "status" which would report if it was enabled, and if so, which type of DND is enabled. This would be handy for a web page I want to put together for my wife that'll tell her what the status is and give her buttons to enable/disable from her iPhone so she can do so while dealing with our little one.
Code:
http://api.voipo.com/?username=USER&password=PASS&action=dnd&arguments[]=status
There you go, enjoy!
________
Ferrari f2007 specifications
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
VOIPoBrandon
Code:
http://api.voipo.com/?username=USER&password=PASS&action=dnd&arguments[]=status
There you go, enjoy!
Oh sweet. Works like a charm!
Now if we could have an api call that would delete all messages from our voicemail (since we *usually* listen to them via email).
Perhaps also a "last X callers" where X is a number you could send to the api. The data returned should be customer caller ID aware.
-
Re: Alpha Feature: API Access
How about a message that says "Success!" on the API pages if successful for confirmation. If not I can work around it. Just seems to make since.
-
Re: Alpha Feature: API Access
I'm just getting started with iPhone development myself. Would there be any interest in creating an iPhone app that would interact with the existing services/future web services to allow you to control these settings quickly and easily through your iPhone?
Since I'd be using this as a learning exercise for myself, I'd be happy to put it up in the App Store as a free app.
And I agree with Xponder, a confirmation message for each service if it was successful would be nice. :)
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
CrownSeven
I'm just getting started with iPhone development myself. Would there be any interest in creating an iPhone app that would interact with the existing services/future web services to allow you to control these settings quickly and easily through your iPhone?
Since I'd be using this as a learning exercise for myself, I'd be happy to put it up in the App Store as a free app.
And I agree with Xponder, a confirmation message for each service if it was successful would be nice. :)
I have a fully working C# console application I made that will let the user control all of the features available when I finish. It takes the users phone number and password and goes from there. So far its fully working for DND and all its related options. Just have to finish coding the other commands. It would be great if it returned "Success!" so I do not have to code that too. :p
It does already tell you if your username/pass are incorrect which is nice.
It has been fun creating it and I have really enjoyed it.
Will have to think of more ideas for the API when I finish it.
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
Xponder1
I have a fully working C# console application I made that will let the user control all of the features available when I finish. It takes the users phone number and password and goes from there. So far its fully working for DND and all its related options. Just have to finish coding the other commands. It would be great if it returned "Success!" so I do not have to code that too. :p
It does already tell you if your username/pass are incorrect which is nice.
It has been fun creating it and I have really enjoyed it.
Will have to think of more ideas for the API when I finish it.
Nice. And of course I've got my iPhone app doing the same thing now so :P:P
Although I can tell you, as a current C# man, iPhone is a pain.
When you're done polishing it up, I'd love to see it.
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
JimDog
I could see several uses for Voicemail:
- Enable/disable
- Return number of unread messages
- Return message details (Message ID, Caller Name & Number, Date/Time, Duration, etc.)
- File/delete messages using Message ID above
I would think the first two are pretty basic and the last two a little more complicated. I could see this tying into something cool like a Firefox voice mail plug in or something along those lines...
I would also add my support for Voicemail commands via API. Is there any way Voicemail queries for sub-voicemail boxes (e.g. for virtual numbers) could be supported?
I'd be interested in seeing a mechanism for manipulating the Contacts database for a user account, as well. Add/delete/display/rename? Import and export would be cool, too, but that could probably be done via the add and display commands on the client side...
-
Re: Alpha Feature: API Access
Quote:
Return message details (Message ID, Caller Name & Number, Date/Time, Duration, etc.)
AKA Message Envelope
This is missing now when you dial in. Email includes it though.
It would be great if all features were available with each access method.
-
Re: Alpha Feature: API Access
New suggestion. Currently if you enter a invalid command it says "Your not authorized to do this". How about making it say "Invalid command!".
-
Re: Alpha Feature: API Access
Finished work on the .net console program I made in C# to use the API. It uses all currently available API commands.
Do Not Disturb (DND)
vmail, busy, off, status
Failover
10DigitNumber, vmail
Call Forwarding
10DigitNumber, off
If anyone wants to try it you can download it here.
This requires .net to be installed. You will need to login your Vpanel, go to the beta tab, and set your API password to something you can remember.
Current version is 1.0 I updated it so it had a icon besides the default and edited dnd status to make it display cleaner.
Until I get VOIPo to add a response on a success it will just go back to the main menu if its successful. If there is a error the error will display example (Invalid Username/Password ) indicates your phone number or password is incorrect (type logout and try again). If you get this error make sure you set your Beta API password in Vpanel.
Any questions send me a private message on the forums.
For legal reasons I am adding the disclosure that if you use this program you do so at your own risk. :)
UPDATE- uploaded new version with a debug option (the debug command toggles on/off). If you use the command debug it will show you what it is going to send the server before you send it (so you can see if your phone number, password, ect are correct).
Have not had any complaints so far but I would like to go ahead and ask that if you have a problem with this program or a question about it that you do not contact support. Just send me a private message.
Thanks.
-
Re: Alpha Feature: API Access
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
usa2k
Very cool!
My wife likes it. Takes just a few seconds to do anything in it.
-
Re: Alpha Feature: API Access
Could add a option to clear message waiting on voicemail.
-
Re: Alpha Feature: API Access
I thought I would clean this thread up and post the current suggestions all in one post.
1.
Quote:
Originally Posted by
mrkarron
I feel a basic no answer or a busy call forward are options that would be very useful.
2.
Quote:
Originally Posted by
JimDog
I could see several uses for Voicemail:
- Enable/disable
- Return number of unread messages
- Return message details (Message ID, Caller Name & Number, Date/Time, Duration, etc.)
- File/delete messages using Message ID above
I would think the first two are pretty basic and the last two a little more complicated. I could see this tying into something cool like a Firefox voice mail plug in or something along those lines...
and
Quote:
Originally Posted by
ropeguru
I second this for the VM interaction. Would be great to integrate with my home web page so I can get a quick idea of what my messages are without having to login to the vPanel.
and
Quote:
Originally Posted by
Xponder1
Could add a option to clear message waiting on voicemail.
and
Quote:
Originally Posted by
bubbanc
Now if we could have an api call that would delete all messages from our voicemail (since we *usually* listen to them via email).
Perhaps also a "last X callers" where X is a number you could send to the api. The data returned should be customer caller ID aware.
and
Quote:
Originally Posted by
fisamo
I would also add my support for Voicemail commands via API. Is there any way Voicemail queries for sub-voicemail boxes (e.g. for virtual numbers) could be supported?
I'd be interested in seeing a mechanism for manipulating the Contacts database for a user account, as well. Add/delete/display/rename? Import and export would be cool, too, but that could probably be done via the add and display commands on the client side...
3.
Quote:
Originally Posted by
Xponder1
How about a option for simul ring.
4.
Quote:
Originally Posted by
bubbanc
What about a new option for DND called "status" which would report if it was enabled, and if so, which type of DND is enabled. This would be handy for a web page I want to put together for my wife that'll tell her what the status is and give her buttons to enable/disable from her iPhone so she can do so while dealing with our little one.
This feature was implemented and I think it should be added to the first page :)
Quote:
Originally Posted by
VOIPoBrandon
Code:
http://api.voipo.com/?username=USER&password=PASS&action=dnd&arguments[]=status
There you go, enjoy!
5.
Quote:
Originally Posted by
Xponder1
How about a message that says "Success!" on the API pages if successful for confirmation.
and
Quote:
Originally Posted by
CrownSeven
And I agree with Xponder, a confirmation message for each service if it was successful would be nice. :)
6.
Quote:
Originally Posted by
usa2k
It would be great if all features were available with each access method.
7.
Quote:
Originally Posted by
Xponder1
New suggestion. Currently if you enter a invalid command it says "Your not authorized to do this". How about making it say "Invalid command!".
-
Re: Alpha Feature: API Access
I need to add a question: I noticed that the API is also available for Express accounts. Was that done in error, or are some commands available to Express users? (If so, which ones?) Once you integrate voicemail, it makes good sense to include the API. OTOH, with Express accounts, since one API password could control multiple different numbers (each of which have different routing instructions), that difference would need to be considered.
-
Re: Alpha Feature: API Access
Not that anyone cares, but this is what I threw together in 5 minutes to enable/disable DND from a webpage. There is no authentication, so don't give out your DND URL to people you dont trust :)
http://bubba.org/tmp/dnd.php.txt
http://bubba.org/tmp/curl.class.txt
Use at your own risk.
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
bubbanc
Could always password protect the directory its in.
-
Re: Alpha Feature: API Access
This is great news. I think I was one of the people who asked for it, and unfortunately, haven't been on the forums in a while to see this.
I would like a way to add/delete an incoming call route. I have my route that I add manually to route "restricted" to voicemail to keep the telemarketers away. My kids doctors office blocks their caller ID, so I have to go in and delete it when I am waiting on a callback, and re-add it later.
Also, I would be interested in this being a SOAP service with authentication. Becuase the password is in the URL, I believe that this can be gathered from proxy server logs, if you are using a web proxy to get to voipo.
Dan
-
Re: Alpha Feature: API Access
This is my first try at the api and I am having a problem..
http://api.voipo.com/?username=mypho...=dnd&arguments[]=status
returns a 0. Commands such as vmail or busy have no effect. Yes, I have activated the api in vpanel. Is there a problem or am I doing something wrong?
Ron
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
mrkarron
This is my first try at the api and I am having a problem..
Send me a private message with the exact string details you're using, wrapped in and I'll take a look.
-
Re: Alpha Feature: API Access
Returning a 0 on as status inquiry simply means DND is set to off. The other commands do not look like they have an effect (page comes back blank), but if you check VPanel, the setting is changed. You may need to reload the page.
Also, I was getting a password error until I remembered that the password needs to be the one I set in VPanel/Beta/API, not the password for getting into VPanel.
-
Re: Alpha Feature: API Access
Quote:
Originally Posted by
VOIPoJustin
Send me a private message with the exact string details you're using, wrapped in
and I'll take a look.
ok, using a different computer (at home) it works. Earlier I was trying to set it at work. I wonder since the work computers still use IE6 if that was the problem.
-
Re: Alpha Feature: API Access
Would it be possible to add something to the API to retreave the last x number of calls from the call log? I'm more interested in received calls than sent ones but I imagine you could do both for those that want it.
-
Re: Alpha Feature: API Access
I'd be reluctant to use this with the password as a URL parameter. I know that makes it easy to use, but URLs are sent in the clear and logged many places. Better would be to have a https URL and POST parameters, perhaps an XML form for extensibility. If you decide to move forward with this, please take this into account.