Skip to content

New Caller ID feature #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Awatatah wants to merge 1 commit into
base: master
Choose a base branch
from
Open

New Caller ID feature #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 9 additions & 37 deletions applets/search/twiml.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,16 @@
//Needed because we're unserializing objects from the session, and this class
//isn't loaded.
include_once(APPPATH.'models/vbx_device.php');

//this should help with namespace problems
define('SESSION_KEY', AppletInstance::getInstanceId());
session_start();

//Note: in reverse chronological order for simpler condition tests, 'return' is
//used to stop further processing

//User in session means the call is being connected or it's been routed to
//voicemail. Both actions requre the user object.
if(isset($_SESSION[SESSION_KEY]['user'])){
//turn the user back into an object
$user = unserialize($_SESSION[SESSION_KEY]['user']);

//save the voicemail
if(isset($_REQUEST['RecordingUrl'])){
OpenVBX::addVoiceMessage(
Expand All @@ -25,12 +21,10 @@
$_REQUEST['Called'],
$_REQUEST['RecordingUrl'],
$_REQUEST['Duration']);

$response = new Response();
$response->addHangup();
$response->Respond();
return;

//dialstatus means an attempt to connect
} elseif(isset($_REQUEST['DialStatus']) OR isset($_REQUEST['DialCallStatus'])) {
//compatible with both API versions
Expand All @@ -42,24 +36,19 @@
$response = new Response();
$response->addHangup();
$response->Respond();

return;
}

//not answered, so try again
return connect(new Response(), $user)->Respond();

}

//something's wrong, let the caller know and start over.
return searchPrompt(errorResponse(new Response()))->Respond();
}

//Users in session means the caller should have selected a user.
if(isset($_SESSION[SESSION_KEY]['users'])) {
//turn users back into an array of user objects
$users = unserialize($_SESSION[SESSION_KEY]['users']);

$index = $_REQUEST['Digits'];
//dialing '0' will restart the process
if("0" == $index){
Expand All @@ -69,22 +58,17 @@
//send the menu again, the entry wasn't found
return promptMenu(addMessage(new Response(), 'invalidMessage', 'Not a valid selection.'), $users)->Respond();
}

//the caller selected a user, unset the 'users' session var
unset($_SESSION[SESSION_KEY]['users']);

//get the selected user
$user = $users[$index - 1];

//store the user in session and set the device index to 0
$_SESSION[SESSION_KEY]['user'] = serialize($user);
$_SESSION[SESSION_KEY]['number'] = 0;

$response = new Response();
$response->addSay("Connecting you to {$user->first_name} {$user->last_name}");
return connect($response, $user)->Respond();
}

//Digits in the request, with no users or user is session means the caller is
//searching for a user.
if(isset($_REQUEST['Digits'])){
Expand All @@ -93,47 +77,47 @@
if(0 == count($users)){
return searchPrompt(addMessage(new Response(), 'nomatchMessage', 'Sorry, no matches found.'))->Respond();
}

//add users to the session so the next request can select one
$_SESSION[SESSION_KEY]['users'] = serialize($users);
return promptMenu(addMessage(new Response(), 'menuPrompt', 'Please select a user, or press 0 to search again.'), $users)->Respond();
}

//prompt for search
return searchPrompt(new Response())->Respond();

//Essentially the logic of the dial applet in a different form.
function connect($response, $user)
{
//get a name to announce the call
$name = $user->first_name . " " . $user->last_name;

//Adding callerId
$callerId = AppletInstance::getValue('callerId', null);
if (empty($callerId) && !empty($_REQUEST['From']))
{
$callerId = $_REQUEST['From'];
}

//get the current device id and increment for the next attempt
$device = $_SESSION[SESSION_KEY]['number']++;

//try to connect the current device (if it exists)
if(isset($user->devices[$device])){
if(!$user->devices[$device]->is_active){
//just try the next device
return connect($response, $user);
}
//add a dial to the response
$dial = $response->addDial(array('action' => current_url()));
$dial = $response->addDial(array('action' => current_url(), 'callerId' => $callerId,));
//and a number to the dail, so the call can be announced.
$dial->addNumber($user->devices[$device]->value, array('url' => site_url('twiml/whisper?name='.urlencode($name))));

//when there are no more devices send to voicemail
} else {
$response->append(AudioSpeechPickerWidget::getVerbForValue($user->voicemail, new Say("Please leave a message.")));
$response->addRecord(array(
'transcribe' => 'true',
'transcribeCallback' => site_url('twiml/transcribe') ));
}

//return the response so it can be modified
return $response;
}

//List the search results, and offset the index by 1 because dialing 0 generally
//means something.
function promptMenu($response, $users)
Expand All @@ -147,34 +131,28 @@ function promptMenu($response, $users)
//return the response so it can be modified
return $response;
}

//Inital prompt.
function searchPrompt($response)
{
//since this is called on restart, make sure we clear everything
unset($_SESSION[SESSION_KEY]);

//add a gather to the rseponse then add the prompt to the gather
addMessage($response->addGather(), 'searchPrompt', 'Please enter the first few letters of the name, followed by the pound sign.');

//return the response so it can be modified
return $response;
}

function errorResponse($response)
{
return addMessage($response, 'errorMessage', 'Sorry, an error occured.');
}

function addMessage($response, $name, $fallback)
{
$message = AppletInstance::getAudioSpeechPickerValue($name);
$response->append(
AudioSpeechPickerWidget::getVerbForValue($message, new Say($fallback)));

return $response;
}

//Find users that possible match a series of digits.
//TODO: It's likely better to work it the other way, generating a list of
//numbers from the users and looking for a partial match.
Expand All @@ -191,7 +169,6 @@ function getMatches($digits)
$dialpad[7] = array('p','q','r', 's');
$dialpad[8] = array('t','u','v');
$dialpad[9] = array('w','x','y', 'z');

//start with an empty string
$words = array('');
//take each digit
Expand All @@ -206,23 +183,18 @@ function getMatches($digits)
}
}
}

if(count($words) == 0){
return array();
}

//TODO: This looks a little messy - should find a better way to query for
//all matching names. Or again, work it the other way, building a number
//for each user.

//create crazy query
foreach($words as $word){
$search[] = "first_name LIKE '%$word%' OR last_name LIKE '%$word%'";
}

$query = implode(" OR ", $search);

//get all users that are possible matches
$users = OpenVBX::getUsers(array("(" . $query . ') AND true = ' => 1, 'is_active' => 1));
return $users;
}
}
26 changes: 26 additions & 0 deletions applets/search/ui.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,35 @@
<?php
$ci =& get_instance();
$ci->load->model('vbx_incoming_numbers');

try {
$numbers = $ci->vbx_incoming_numbers->get_numbers();
}
catch (VBX_IncomingNumberException $e) {
log_message('Incoming numbers exception: '.$e->getMessage.' :: '.$e->getCode());
$numbers = array();
}
$callerId = AppletInstance::getValue('callerId', null);
?>

<div class="vbx-applet">
<h2>Directory Search</h2>
<p>Callers can search for users by dialing a few letters form the user's
first or last name. The can press pound when done, or simply wair for 5
seconds.

<h2>Caller ID</h2>
<div class="vbx-full-pane">
<fieldset class="vbx-input-container">
<select class="medium" name="callerId">
<option value="">Caller's Number</option>
<?php if(count($numbers)) foreach($numbers as $number): $number->phone = normalize_phone_to_E164($number->phone); ?>
<option value="<?php echo $number->phone; ?>"<?php echo $number->phone == $callerId ? ' selected="selected" ' : ''; ?>><?php echo $number->name; ?></option>
<?php endforeach; ?>
</select>
</fieldset>
</div>

<h3>Search Prompt</h3>
<p>When the caller reaches this menu they will hear this prompt:</p>
<?php echo AppletUI::audioSpeechPicker('searchPrompt'); ?>
Expand Down