5. Asterisk AGI程序編寫指南???
5.1概述

很多時候，我們需要在撥號方案中做某些業(yè)務邏輯的判斷或者外部數(shù)據庫的查詢，根據具體地需要，有幾種做法：

1．使用Asterisk的通道變量、Goto函數(shù)、Gotoif函數(shù)等實現(xiàn)某些簡單跳轉，通過幾個這樣的函數(shù)的組合，實現(xiàn)簡單的業(yè)務。

2．對終端接入用戶的呼叫請求中的某些屬性，進行簡單的數(shù)據庫增刪改查，在Asterisk官方發(fā)布的asterisk-addons開發(fā)包中安裝MYSQL模塊，具體地方法在這不細述。使用類似下面的方式：

exten => _0[0-9].,1, MYSQL(Connect connid dhhost dbuser dbpass dbname)

exten => _0[0-9].,2., MYSQL(Query resultid ${connid} query-string)

exten => _0[0-9].,3，MYSQL(Fetch fetchid ${resultid} var1\ var2\ ...\ varN)

exten => _0[0-9].,4，MYSQL(Disconnect ${connid})

3．如果碰到了結合了1、2的業(yè)務需求，這時候撥號方案配置文件中就會出現(xiàn)大量地與業(yè)務邏輯有關的復雜代碼，造成技術人員閱讀上不方便，并且代碼也不好維護，如下面這段配置文件：

……

exten => 888,1,MYSQL(Connect connid localhost ipcontact passwd ipcontact)
exten => 888,n,GotoIf($["${connid}" = ""]?error,1)
exten => 888,n,MYSQL(Query resultid ${connid} SELECT\ `number`\ FROM\ `phones`\ WHERE\ `channel`=\'${chan}\')
……

exten => 888,n,GotoIf($["${foundRow}" = "1"]?done) ; leave loop if no row found
exten => 888,n,NoOp(${number})
exten => 888,n,Goto(fetchrow) ; continue loop if row found
exten => 888,n(done),MYSQL(Clear ${resultid})
exten => 888,n,MYSQL(Disconnect ${connid})

……

上面綜合了通道變量、Goto、Gotoif、MYSQL數(shù)據查詢等操作，其實如果配置文件中只是幾行這樣的操作閱讀起來沒問題，但業(yè)務需求具有可變性，代碼維護起來就比較麻煩。所以，我們就尋找另外一種方案，即在配置文件中不進行數(shù)據庫查詢等重量級的操作，而是將它交到一個外部應用程序或者腳本中，即封裝到Asterisk的AGI后臺中，可以實現(xiàn)各種復雜的業(yè)務需求。使用類似PHP、JAVA、C等編程語言內置的判斷語句，而不是Asterisk封裝的類似Goto、Gotoif等函數(shù)，會更加快地實現(xiàn)業(yè)務需求，代碼也更好維護。下面先看看如何在撥號方案中使用AGI程序。

5.2 使用AGI腳本

執(zhí)行AGI腳本時，Application應用就是'agi'，參數(shù)是腳本的文件名，同時腳本需要滿足以下條件：

l??????? 必須可執(zhí)行，chomd 755

l??????? 必須放置在指定目錄，如標準目錄：/var/lib/asterisk/agi-bin

l??????? 必須指定完整的extension信息

比如說執(zhí)行一個用PHP語言實現(xiàn)的AGI程序，有可能就是這樣：

exten => 1,2,AGI(test.php, ${CALLERID(name)})

腳本執(zhí)行時，可以從控制臺上得到不同基本的詳細信息，例如，文件不能被執(zhí)行，或者找不到文件等等。

通過向Asterisk控制臺信息輸出，可以得到AGI腳本的執(zhí)行信息，至少在開發(fā)初期中，控制臺信息輸出是個好辦法。

通過agi VERBOSE命令，可以將信息發(fā)送到asterisk控制臺上，并且而通過verbosity設置可以關閉開啟這個功能。

如果直接，可以采用各種語言很方便的通過AGI接口編寫實施腳本。腳本和Asterisk之間通過標準的輸入輸出進行交互。

5.3 AGI(Asterisk Gateway Interface)技術實現(xiàn)原理

l??????? 傳遞參數(shù)到AGI腳本

在腳本名稱后緊跟以英文半角狀態(tài)下的逗號,分隔的字符串，就可以把需要的參數(shù)傳入腳本：AGI(dial_agi.php,${EXTEN:11},${CALLERID(name)})，AGI腳本總是接收2種參數(shù)，1是腳本的完整路徑，2是撥號方案中'Exten'傳遞的參數(shù)，其中第1種參數(shù)，如果AGI程序放在了Asterisk默認路徑，可以省略，只寫AGI程序名。第2種參數(shù)是AGI程序需要撥號方案中'Exten'傳遞進來的參數(shù)，比如說本文中${EXTEN:11},${CALLERID(name)}，一個是被叫的電話號碼，一個是主叫的賬號ID。

l??????? 通過標準的輸出，發(fā)送命令到Asterisk

我們可以在AGI腳本程序中向Asterisk發(fā)送各種命令從而調用Asterisk的某些應用程序，如Dial、Goto、Monitor等，也可以直接發(fā)送命令獲得或者設置某些Asterisk通道變量的值。對于基于PHP的AGI腳本程序，可以按照如下步驟：

1．打開PHP輸出文件描述符：

$stdout = fopen('php://stdout', 'w');

2．向Asterisk發(fā)送命令：

fputs($stdout," SET CONTEXT media_gw1\n"); ");
??? fflush($stdout);

上述步驟是對于SET 或者 GET Asterisk的某些通道變量時的使用方法，如果需要調用Asterisk內置的應用，如執(zhí)行跳轉到某個context下的某個priority的Goto應用函數(shù)，可以調用EXEC命令后面緊跟Asterisk，如：fputs($stdout," EXEC Goto media_gw1|s|2\n"); ");命令必須以換行符結束，AGI命令返回文本字符串，如下格式：200 Result=<number>，有時會在number數(shù)字后附加一些信息。如果向Asterisk發(fā)送了無效的命令，信息如下：510 Invalid or unknown command。對應上面的命令，如下所示：

AGI Rx << SET CONTEXT media_gw1

AGI Tx >> 200 result=0

l??????? 通過標準的輸入，從Asterisk接收信息

當AGI腳本執(zhí)行時，Asterisk會向腳本發(fā)送各種的信息，可以在做其他事情之前通過標準輸入獲取這些信息，每項數(shù)據都是一行，發(fā)送完畢Asterisk會發(fā)送一個空行，表示結束，如：

AGI Tx >> agi_request: dial_agi.php

AGI Tx >> agi_channel: SIP/25946-0821ea88

AGI Tx >> agi_language: en

AGI Tx >> agi_type: SIP

AGI Tx >> agi_uniqueid: 1209093478.477

AGI Tx >> agi_callerid: 0000123456

AGI Tx >> agi_calleridname: beigaolin

AGI Tx >> agi_dnid: 998866015810370728

AGI Tx >> agi_context: default

AGI Tx >> agi_extension: 998866015810370728

AGI Tx >> agi_priority: 1

根據項目需求，如果需要這些數(shù)據，就先保存起來，否則不用處理它。保存步驟按如下過程。

1．打開PHP輸出文件描述符：

$in = fopen("php://stdin","r");

?????? 2．分析從Asterisk傳到AGI的頭信息，如需要在AGI程序中獲取終端用戶的ID，那么從“agi_calleridname: beigaolin”這個頭信息可以獲取，我們通過分析每一行這樣以:分隔的字符串，取到需要后續(xù)處理的字符串

while (!feof($stdin)) {
$temp = fgets($stdin);
$temp = str_replace("\n","",$temp);
$s = explode(":",$temp);
$agivar[$s[0]] = trim($s[1]);
if (($temp == "") || ($temp == "\n")) {
???? break;
???? }
}

5.4 使用開源PHP AGI類函數(shù)PHPAGI

像上一小節(jié)那樣先是獲取輸入流，分析從輸入頭字符串中獲取對應某個輸入變量的值，或者獲取輸出流然后發(fā)送各種標準命令執(zhí)行某些Asterisk內置應用，如果在AGI程序中實現(xiàn)很復雜的業(yè)務邏輯，這樣的流程會顯得有點累贅，所以需要提取某些常用的操作，我們使用的時候不用關心這些操作，直接以調用類似Asterisk內置應用那樣的方式。PHPAGI就是這樣的一個開源PHP類函數(shù)。它封裝了對應Asterisk內置應用的常用函數(shù)調用接口，比如說從PHP向Asterisk發(fā)送Dial命令的操作，可以直接調用PHP AGI類函數(shù)中的exec_dial。使用PHP AGI能夠很容易的操作Asterisk AGI常用接口。使用這個類函數(shù)也很簡單：

l??????? 下載準備phpagi 函數(shù)文件：

cd /var/lib/asterisk/agi-bin/(也有可能在用戶自定義的路徑中)

wget http://nchc.dl.sourceforge.net/sourceforge/phpagi/phpagi-2.14.tgz

tar zxvf phpagi-2.14.tgz

l??????? 在代碼中使用：

include ("phpagi.php");//包含文件

include ("phpagi-asmanager.php");

$agi = new AGI;//引用PHPAGI類函數(shù)

5.5 使用AGI實現(xiàn)主叫號碼透傳功能

??? 在這里以一個例子來說明AGI程序在VoIP開發(fā)中的作用以及開發(fā)思路。

假設說有個普通電話為02412345678，手機號為15810370728，而網絡電話虛擬號碼是0000123456，如果想讓撥打出去的電話號碼在被叫方(手機或者帶有來電顯示功能的座機)的來電顯示為02412345678或者15810370728，那么他們回復電話的時候就可以直接打到這個普通電話上，方便與主叫的業(yè)務聯(lián)系。這個需求就叫主叫號碼透傳，能不能進行主叫號碼的透傳，取決于VoIP落地網關運營商，語音網關可以設置IP側送過來的主叫號碼是否透傳。在保證號碼規(guī)范的前提下，透傳什么樣的主叫號碼，則取決于IP-PBX系統(tǒng)，即Asterisk的設計了。

l??????? 設計思路

1.增加一個針對終端用戶賬戶ID的綁定管理系統(tǒng)，如圖用戶在第二項中輸入自己的賬戶ID，然后再輸入想要作為來顯示的主叫號碼完成綁定操作，后臺php程序向數(shù)據庫中插入一條新記錄(X-Lite ID對應電話號碼或者手機號碼)。

圖5-2 AGI后臺管理系統(tǒng)頁面

2.使用綁定了主叫號碼的X-Lite呼叫某個被叫(手機或者座機)

Asterisk的后臺PHP AGI程序的詳細設計主叫號碼透傳流程設計如圖4-4所示。

圖5-3 Asterisk 主叫號碼透傳的后臺PHP AGI流程圖

l??????? 代碼實現(xiàn)

以下代碼片斷展示的是PHP AGI中部分代碼，并且作了簡化。

#!/usr/local/php.5.2.5/bin/php –q

<?php

include_once("phpagi.php");//開源PHP類函數(shù)

......

//判斷當前這個id是否做了主叫號碼來電顯示的綁定操作

$query_string = "select * from xliteid where xliteid = '{$caller_name}'";

$query_result = mysql_query($query_string, $db_connection);

//如果當前這個id做了綁定操作，調用PHPAGI類函數(shù)，設置Asterisk主叫號碼

if($query_result && mysql_num_rows($query_result) > 0)

{???????

???????? caller_phone_display_agi ();

}??????????????

????????????????

//沒有做綁定，設置一個隨機的號碼

else?????????????????????????????????????????????????????????????

{??????

?????? caller_name = $argv[2];

????????? $rand_num1 = rand(0,9);

????????? $rand_num2 = rand(0,9);

????????? $rand_num3 = rand(0,9);

????????? $caller_phone= "024{$rand_num1}{$rand_num2}650{$rand_num3}{$rand_num4}";

land_media_gw1($caller_phone);

exit();????????????????????????

}??????

/**

主叫號碼特殊顯示

*/

function caller_phone_display_agi()

{

global $db_connection, $callee_phone, $caller_name;

?????? $query_string = "select caller_phone from caller_phone_display _xliteid where skype_id = '{$caller_name}'";

?????? $query_result = mysql_query($query_string, $db_connection);

??????

if($query_result && mysql_num_rows($query_result) > 0)

?????? {

????????????? $row = mysql_fetch_array($query_result);

????????????? $caller_phone = $row[0];

?????????? $callerid_cli = "\"{$caller_name}\"<{$caller_phone}>";

?????????? land_media_gw1($callerid_cli);

?????????? exit();

?????? }

}

/**

*@ land_media_gw1 VoIP語音網關media_gw1

*/????????????????????????????????????????????????????????

function land_media_gw1($callerid_num)

{

?? global $agi, $callee_phone_withpre;

?? $agi->set_context("media_gw1");

?? $agi->set_extension($callee_phone_withpre);

?? $agi->set_priority(1);

?? //調用phpagi封裝的set_callerid方法，向Asterisk傳遞設置主叫號碼的指令

?? $agi->set_callerid($callerid_num);

}

對X-Lite賬戶gaolinb作了主叫號碼綁定，使用X-Lite軟終端呼叫普通的手機，在Asterisk中設置了agi debug，從Asterisk后臺我們可以清晰地看到：

1．AGI Tx >> *CLI>上面部分，全是從Asterisk輸入到當前AGI的環(huán)境變量信息，它包含了當前這個呼叫的詳細信息，如Channel的類型，是SIP還是H.323，calleridname，即終端用戶是gaolinb等重要信息。

2．AGI Tx >> *CLI>下面部分，全是在上面調用PHPAGI類函數(shù)后將命令傳給了AGI程序執(zhí)行，對于主叫號碼來電顯示的命令是：

SET CALLERID ‘gaolinb’<15810370728>，Asterisk將15810370728傳到能夠支持主叫號碼透傳的VoIP運營商，從而被叫用戶在接聽電話前能夠顯示一個有意義的電話號碼。

圖5-4 Asterisk服務器上AGI的輸入輸出信息

總結

以上是生活随笔為你收集整理的基于Asterisk的VoIP开发指南(2)——Asterisk AGI程序编写指南的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。