Jump to content
Vodia PBX forum
Support

Newly developed REST API on Vodia PBX 58.0 and above.

Recommended Posts

Hello Contributors and Followers,

We are thankful for all the contributions and suggestion received from you over all our product versions and branches of it. We would like to gain a quick feedback from anyone and everyone who are using our APIs for their automation requirements with Vodia PBX 58.0 and above. 

Here is our API documentation page https://vodia.com/pbxapi . Although there is a lot of CSS and beautification needed (which we agree), we would like to have a feedback from you about:-

1) If any document which you regularly use, is missing.

2) If anything is incorrect.

3) If you would like us to add extra documents which you think might be cool (if you have seen it on some other website, which you regularly use etc.). Just let us know which APIs are the ones you use on a daily basis and would like to give it a try from Vodia's end point as well.

4) Criticism is welcomed too. :)

Share this post


Link to post
Share on other sites

It is great to see the REST API make so much progress since it was first announced. 

We are a hosted PBX provider so we have multiple servers each having many, many domains. Being able to query and set data for the servers will make maintenance much easier and faster. A very simple example we can look at all servers and all domains to pull lists for automated service flags that have holidays set and verify with the customers what holiday settings are needed for the up coming year. Since there is no mechanism in a service flag to handle floating holidays like Thanks Giving and Labor day, they need to be changed each year. Now we can produce a list of domains and service flags quickly to review with the customers. This will prevent the problem of service flags being set for the incorrect holiday each year.

It would be useful to have descriptions of the data returned or being set. For example in the Service Flag REST calls returns data like  mon: "00:00-8:AM 20:30-9:AM" which is clearly the hours for the service flag on Monday. There are also things like param1 and param2. What do these things do?

It would also be useful to query the config templates for each domain and each phone in the domain if that phone has its' own config template. 

Share this post


Link to post
Share on other sites

Hi,

 

Thank you taking time for writing this feedback. :)

1 hour ago, ahennis@voicespring.net said:

A very simple example we can look at all servers and all domains to pull lists for automated service flags that have holidays set and verify with the customers what holiday settings are needed for the up coming year. Since there is no mechanism in a service flag to handle floating holidays like Thanks Giving and Labor day, they need to be changed each year. Now we can produce a list of domains and service flags quickly to review with the customers. This will prevent the problem of service flags being set for the incorrect holiday each year.

Do you mean the PBX should detect the bank holidays by itself and auto assign them to for e.g. service flags every year right?

 

1 hour ago, ahennis@voicespring.net said:

It would be useful to have descriptions of the data returned or being set. For example in the Service Flag REST calls returns data like  mon: "00:00-8:AM 20:30-9:AM" which is clearly the hours for the service flag on Monday. There are also things like param1 and param2. What do these things do?

Also, yes description is also being noted down. Makes sense.

 

1 hour ago, ahennis@voicespring.net said:

It would also be useful to query the config templates for each domain and each phone in the domain if that phone has its' own config template. 

You would like to do that from domain and extension level respectively right?

Share this post


Link to post
Share on other sites
1 hour ago, Support said:

Do you mean the PBX should detect the bank holidays by itself and auto assign them to for e.g. service flags every year right?

No not automatically. I posted about this before. I have installed many Asterisk based system. Asterisk has function called GotoIfTime. Here is a link

https://www.voip-info.org/wiki/view/Asterisk+cmd+GotoIfTime

It works a lot like CRON. I can specify a time condition that the system evaluates and returns true or false based on that is programmed. Here is a great example for Thanksgiving

  *,thu,22-28,nov

Thanksgiving is always on the 3rd Thursday in November and the 3rd Thursday in November can only ever be on the 22nd or 23rd or 24th or 25th or 26th or 27th or 28th of November. Thanksgiving can't be on any other day of the month then those that I have listed.

Basically here is what is being evaluated.

Is it Thursday, November 22nd - No so it is not thanksgiving
Is it Thursday, November 23rd - Yes so it is thanksgiving
Is it Thursday, November 24th - No so it is not thanksgiving
Is it Thursday, November 25th - No so it is not thanksgiving
Is it Thursday, November 26th - No so it is not thanksgiving
Is it Thursday, November 27th - No so it is not thanksgiving
Is it Thursday, November 28th - No so it is not thanksgiving

Asterisk can do this. Asterisk is open source so the code is there to look at to see how it works and program something similar for Vodia PBX.

 

2 hours ago, Support said:

Also, yes description is also being noted down. Makes sense.

This would be very helpful. I understand how much work this is so and that it will take a long time to change the documentation.

2 hours ago, Support said:

You would like to do that from domain and extension level respectively right?

Yes. Basically being able to have a list of which phones have configs at the system level or the domain level or on the extension level.
 

Share this post


Link to post
Share on other sites

Hi,

 

Alright, your requests are justified and as you know this might take a while to go over and give it a re-finishing touch. Thanks a lot for your feedback though. We really appreciate it. :)

Share this post


Link to post
Share on other sites
13 hours ago, ahennis@voicespring.net said:

As I think about this more it would be ideal that just about anything that can be changed in the GUI should be able to be changed via REST

Absolutely. Thanks again.

Share this post


Link to post
Share on other sites

Hello,

how to connect to the API, we tried localhost and public IP and it aborts with the following error message.

root@labvodia:~# curl -u admin: GET -D - http://localhost:8080/rest/domain/vodia/user_settings/20
curl: (6) Could not resolve host: GET
curl: (7) Failed to connect to localhost port 8080: Verbindungsaufbau abgelehnt

 

root@labvodia:~# curl -u admin: GET -D - http://PublicIP:8080/rest/domain/vodia/user_settings/20
curl: (6) Could not resolve host: GET
curl: (7) Failed to connect to localhost port 8080: Verbindungsaufbau abgelehnt

 

thanks

 

 

Share this post


Link to post
Share on other sites

Hi,

 

Which page are you referring to? please make all the changes in the cURL command which caters to your PBX such as:

Your domain / IP address (and port if any) of the PBX, your PBX login credentials, your user extension number etc.

Those are simply examples for you to follow.

Share this post


Link to post
Share on other sites
Guest
You are commenting as a guest. If you have an account, please sign in.
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Loading...

×