server does not consider the timezone of caller #2
Comments
|
going to handle this by looking up the time zone of zipcode and assuming that you are there |
|
This has been fixed with this commit 459e5ce. |
Closed
dgershman
pushed a commit
that referenced
this issue
Mar 4, 2018
The purposes of yap are : * To be able to take the results of a BMLT root server and play it back through the telephone. * To be able to set up routing rules for zip codes and helpline numbers with optional extension dialing. Unlike it's predecessor bmlt-vox, this doesn't require any special infrastructure other than a server capable of delivering PHP over HTTP(S). We are taking advantage of using Twilio which essentially handles all the VOIP parts. You provision a number, set up an application, and point it your PHP server. ## Setup 1. Create a new virtual application or add the yap code to an existing folder. The easiest way to get the code there is to upload the latest version there: https://github.com/radius314/yap/archive/master.zip. 2. Once the application is configured you will need to customize the config.php file. There are several settings there that are documented in that file. There are a number of different ways to utilize the yap platform. 3. Try testing that your application actually is functioning properly by opening a browser http://example.com/index.php. 3. You will need to set up a Twilio account, and do the following: * Purchase a phone number (typically you would buy one for your locale, tollfree is pretty much unnecessary these days). * Configure that number to point to a Webook. It would be something like http://example.com/index.php. * Ensure that you are using HTTP GET and not HTTP POST. 4. Make a call to your number and try it out. If there is a problem the debugger in the Twilio console will let you know why. Most likely you did not setup your config.php file correctly. ## Results Counts Maximums ## The default number of meeting results is 5. You can change this in your `config.php` with the following: ```php static $result_count_max = 10; ``` This would set to a maximum of ten (10) results. ## Meeting Search Radius ## Change the default meeting search radius, this can be in miles or an integer (auto radius). You can change this in your `config.php` with the following: ```php static $meeting_search_radius = 30; ``` This would set the radius to a maximum of 30 miles. ```php static $meeting_search_radius = -50; ``` This would set the radius to a integer of -50 and is the default. ## Helpline Call Routing The helpline router utilizes a BMLT server (2.9.0 or later), that has helpline numbers properly configured in the "Service Body Administration" section. The yap platform will ask for a piece of location information in turn it will look up latitude and longitude and then send that information to the BMLT root server you have configured. You can also tie this into an existing extension based system, say for example Grasshopper. If you want to dial an extension just add something like `555-555-5555|wwww700` for example after the helpline field on the BMLT Service Body Administration. In this case it's instructing to dial 555-555-5555 and wait 4 seconds and then dial 700. ## Skipping Helpline Call Routing When configuring the TwiML app instead of pointing to `index.php` point to `input-method.php?Digits=2`. If you still want the title to display also point to `input-method.php?Digits=2&PlayTitle=1`. ## Including province prior to lookup It may be that your yap instance needs to search multiple states. By default yap will be biased towards the local number state (unless it's tollfree). To enable province lookup set the `$province_lookup`, variable to `true` in the `config.php` file. ## Tollfree bias Tollfree is independent of any state/province bias. To enable a specific bias, add `static $toll_free_province_bias` to your `config.php`, and set to the two letter state bias. Example `$toll_free_province_bias = "TX"`, will bias to Texas. ## Using hidden service bodies It is possible to create a service body with an unpublished group in order create additional routing for service bodies that may not exist in a given root server. Once those service bodies have been populated and the unpublished meetings are added, you can make use of the helpline field to route calls. You will also need to add to the config.php three additional variables. This allows yap to authenticate to the root server and retrieve the unpublished meetings. This is required as a BMLT root server by design will not return unpublished meetings in the semantic interface. ```php static $helpline_search_unpublished = true; static $bmlt_username = ""; static $bmlt_password = ""; ``` You will need to also ensure that PHP has write access to write to this folder, in order to store the authentication cookie from the BMLT root server. **NOTE: This will not work for a sandwich server, because there is currently no concept of authentication.** ## Using as a separate BMLT server for call routing In order to specify a different BMLT root server for call routing but not for meeting list lookups, set the following variable in config.php. ```php static $helpline_bmlt_root_server = ""; ``` ## To upgrade easy ## You will need `make`. Once you have that, run `make upgrade`. ## Checking the call routing There is a very simple way to check where a could would be routed to. ```shell curl https://example.com/yap/helpline-search.php?Digits=Turkey,NC ``` ## Making SMS results for voice calls optional The default of the system is to send an SMS after each voice meeting result. As an option to you audience you can add the following parameter to your `config.php` file. ```php $sms_ask = true; ``` By setting this, a prompt will be played at the end of the results, asking if they would like the results texted to them. If they do not respond the call will automatically hang up in 10 seconds. ## SMS Gateway In order to use SMS to get a list of meetings you will configure Messaging to point to Webook sms-gateway.php. Ensure that it's using HTTP GET. Then you can send a zip code, county or city to your phone number and get back a response. ## Fallback There may be times when a root server is down, it's possible to redirect a call to another if this happens. In your `config.php`, specify the following. ```php $helpline_fallback = "1919555555"; ``` ## Volunteer Dialer (Beta) You can also supply a list of volunteers in a BMLT server. 1) Create a new format called "HV" 2) In the service body under the helpline specify "yap". 3) Make a new meeting (do not publish it). 4) For the meeting name use the volunteer's name. 5) Select the appropriate service body in the dropdown. (Note: this service body must be set to "yap" as the helpline in Step #2) 6) Set the Start Time and Duration which will determine the length of the shift (this will recur every day unless you create additional volunteer entries that match the name) 7) Set the Location, this is currently used to specify what timezone the volunteer is in (in the future it may help with more succinct locating). 8) Select "HV" as the format. 9) Under the phone 1 field, enter this persons phone number. 10) Since this will be querying unpublished values you must set in `config.php` the BMLT server credentials. ``` static $bmlt_username = ""; static $bmlt_password = ""; ``` Some additional details on this: - You can visualize the shift schedule by going to http://example.com/yap/schedule.html and selecting from the dropdown. ## Contribute Fork this repo and send a pull request. For testing locally, run the yap server and then use `ngrok`. Grab the ngrok hostname that is generated and then use that in your Twilio settings. You get an instant proxy to your local services to step through and debug. ## Call Flow 
dgershman
pushed a commit
that referenced
this issue
Mar 4, 2018
* To be able to take the results of a BMLT root server and play it back through the telephone. * To be able to set up routing rules for zip codes and helpline numbers with optional extension dialing. Unlike it's predecessor bmlt-vox, this doesn't require any special infrastructure other than a server capable of delivering PHP over HTTP(S). We are taking advantage of using Twilio which essentially handles all the VOIP parts. You provision a number, set up an application, and point it your PHP server. 1. Create a new virtual application or add the yap code to an existing folder. The easiest way to get the code there is to upload the latest version there: https://github.com/radius314/yap/archive/master.zip. 2. Once the application is configured you will need to customize the config.php file. There are several settings there that are documented in that file. There are a number of different ways to utilize the yap platform. 3. Try testing that your application actually is functioning properly by opening a browser http://example.com/index.php. 3. You will need to set up a Twilio account, and do the following: * Purchase a phone number (typically you would buy one for your locale, tollfree is pretty much unnecessary these days). * Configure that number to point to a Webook. It would be something like http://example.com/index.php. * Ensure that you are using HTTP GET and not HTTP POST. 4. Make a call to your number and try it out. If there is a problem the debugger in the Twilio console will let you know why. Most likely you did not setup your config.php file correctly. The default number of meeting results is 5. You can change this in your `config.php` with the following: ```php static $result_count_max = 10; ``` This would set to a maximum of ten (10) results. Change the default meeting search radius, this can be in miles or an integer (auto radius). You can change this in your `config.php` with the following: ```php static $meeting_search_radius = 30; ``` This would set the radius to a maximum of 30 miles. ```php static $meeting_search_radius = -50; ``` This would set the radius to a integer of -50 and is the default. The helpline router utilizes a BMLT server (2.9.0 or later), that has helpline numbers properly configured in the "Service Body Administration" section. The yap platform will ask for a piece of location information in turn it will look up latitude and longitude and then send that information to the BMLT root server you have configured. You can also tie this into an existing extension based system, say for example Grasshopper. If you want to dial an extension just add something like `555-555-5555|wwww700` for example after the helpline field on the BMLT Service Body Administration. In this case it's instructing to dial 555-555-5555 and wait 4 seconds and then dial 700. When configuring the TwiML app instead of pointing to `index.php` point to `input-method.php?Digits=2`. If you still want the title to display also point to `input-method.php?Digits=2&PlayTitle=1`. It may be that your yap instance needs to search multiple states. By default yap will be biased towards the local number state (unless it's tollfree). To enable province lookup set the `$province_lookup`, variable to `true` in the `config.php` file. Tollfree is independent of any state/province bias. To enable a specific bias, add `static $toll_free_province_bias` to your `config.php`, and set to the two letter state bias. Example `$toll_free_province_bias = "TX"`, will bias to Texas. It is possible to create a service body with an unpublished group in order create additional routing for service bodies that may not exist in a given root server. Once those service bodies have been populated and the unpublished meetings are added, you can make use of the helpline field to route calls. You will also need to add to the config.php three additional variables. This allows yap to authenticate to the root server and retrieve the unpublished meetings. This is required as a BMLT root server by design will not return unpublished meetings in the semantic interface. ```php static $helpline_search_unpublished = true; static $bmlt_username = ""; static $bmlt_password = ""; ``` You will need to also ensure that PHP has write access to write to this folder, in order to store the authentication cookie from the BMLT root server. **NOTE: This will not work for a sandwich server, because there is currently no concept of authentication.** In order to specify a different BMLT root server for call routing but not for meeting list lookups, set the following variable in config.php. ```php static $helpline_bmlt_root_server = ""; ``` You will need `make`. Once you have that, run `make upgrade`. There is a very simple way to check where a could would be routed to. ```shell curl https://example.com/yap/helpline-search.php?Digits=Turkey,NC ``` The default of the system is to send an SMS after each voice meeting result. As an option to you audience you can add the following parameter to your `config.php` file. ```php $sms_ask = true; ``` By setting this, a prompt will be played at the end of the results, asking if they would like the results texted to them. If they do not respond the call will automatically hang up in 10 seconds. In order to use SMS to get a list of meetings you will configure Messaging to point to Webook sms-gateway.php. Ensure that it's using HTTP GET. Then you can send a zip code, county or city to your phone number and get back a response. There may be times when a root server is down, it's possible to redirect a call to another if this happens. In your `config.php`, specify the following. ```php $helpline_fallback = "1919555555"; ``` You can also supply a list of volunteers in a BMLT server. 1) Create a new format called "HV" 2) In the service body under the helpline specify "yap". 3) Make a new meeting (do not publish it). 4) For the meeting name use the volunteer's name. 5) Select the appropriate service body in the dropdown. (Note: this service body must be set to "yap" as the helpline in Step #2) 6) Set the Start Time and Duration which will determine the length of the shift (this will recur every day unless you create additional volunteer entries that match the name) 7) Set the Location, this is currently used to specify what timezone the volunteer is in (in the future it may help with more succinct locating). 8) Select "HV" as the format. 9) Under the phone 1 field, enter this persons phone number. 10) Since this will be querying unpublished values you must set in `config.php` the BMLT server credentials. ``` static $bmlt_username = ""; static $bmlt_password = ""; ``` Some additional details on this: - You can visualize the shift schedule by going to http://example.com/yap/schedule.html and selecting from the dropdown. Fork this repo and send a pull request. For testing locally, run the yap server and then use `ngrok`. Grab the ngrok hostname that is generated and then use that in your Twilio settings. You get an instant proxy to your local services to step through and debug. 
Closed
Closed
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
when you call in, there is currently no way for the server to know what time you are in to distinguish what meetings are coming up.
The text was updated successfully, but these errors were encountered: