OpenSIPs CP no Debian com OpenSIPs 1.9

2014-06-19T03:48:33Z

Mike:

OpenSIPs CP no Debian com OpenSIPs 1.9

2014-06-19T03:46:58Z

Mike:

2014-06-19T03:34:49Z

Mike:

OpenSIPs CP no Debian com OpenSIPs 1.9

2014-06-19T03:34:25Z

Mike:

==Prefacio==

O OpenSIPs CP é um painel de controle para as funções básicas do OpenSIPS sua instalação não é complexa, porém baseado na forma modular do OpenSIPs é necessário entender bem oque você precisa executar/instalar para o correto funcionamento.

==Dependencias==

Antes de mais nada é preciso ter o OpenSIPs instalado e funcionando, este tutorial é montado sobre a instalação da versão [[Opensips 1.9]] que temos neste wiki, apenas as funcionalidades desta instalação serão cobertas por este tutorial, então siga todas as instruções que descrevemos no tutorial para ter um perfeito funcionamento, logo você entenderá melhor cada função e poderá fazer uma instalação tanto do OpenSIPS quanto do OpenSIPS CP mais customizada para suas necessidades.

===Apache e PHP===

Para rodar esta aplicação precisamos instalar o apache e os módulos de php necessários, se você tiver familiaridade com outro servidor web como lighttpd ou outro fique avontade em testar a instalação, basicamente precisamos do suporte ao php ativado , vamos seguir utilizando o apache pois é o web server que costumo utilizar.

apt-get install apache2-mpm-prefork libapache2-mod-php5 php5-mysql php5-curl php5-xmlrpc

===PEAR===

pear install MDB2
pear install MDB2#mysql
pear install log

==OpenSIP CP==

cd /usr/src/
wget -c http://downloads.sourceforge.net/project/opensips-cp/opensips-cp/5.0/opensips-cp_5.0.tgz?r=http%3A%2F%2Fsourceforge.net%2Fprojects%2Fopensips-cp%2Ffiles%2F&ts=1403145228&use_mirror=ufpr

Renomeie o arquivo do download para opensips-cp-5.0.tgz e depois descompacte
tar -xzvf opensips-cp-5.0.tgz

==Instalando==

Dentro do diretorio 5.0 temos os seguintes diretórios
config - arquivos de configuração para o banco e outras funcionalidades
cron_job - arquivos de cron, em especial o arquivo que junta as informações de dialogos para gerar o cdr
doc - documentacao
web - Arquivos web
INSTALL - as mesmas instruções que temos aqui :)
README - explicação sobre oque é o que dentro da estrutura

Nós iremos seguir baseado no conteúdo do README

===Copiando os arquivos para o diretorio web===
cd /usr/src
mv 5.0 /var/www/opensips-cp

===Criando alias no apache===
Abra o arquivo /etc/apache2/sites-enable/000-default , acrescente ao fim do arquivo (antes da tag </VirtualHost>)
Alias /cp /var/www/opensips-cp/web

===Reiniciando o apache===
/etc/init.d/apache2 restart
chown www-data.www-data /var/www/opensips-cp/config/access.log

===Instalando as tabelas===
cd /var/www/opensips-cp/config/tools/admin/add_admin
mysql -uopensips -popensipsrw opensips < ocp_admin_privileges.mysql

cd /var/www/opensips-cp/config/tools/system/cdrviewer
mysql -uopensips -popensipsrw opensips < cdrs.mysql
mysql -uopensips -popensipsrw opensips < cdrs.mysql

Feito isso entre no mysql e adicione o usuário de administração
INSERT INTO ocp_admin_privileges (username,password,ha1,available_tools,permissions) values ('admin','admin',md5('admin:admin'),'all','all');

===Adicionando ao cron===
cd /var/www/opensips-cp/cron_job

Edite o arquivo generate-cdrs_mysql.sh e altere os parametros de conexão, também altere
call opensips_cdrs_1_6();
para
call opensips_cdrs();

Acrescente em seu arquivo /etc/crontab a seguinte entrada

*/3 * * * * root /var/www/opensips-cp/cron_job/generate-cdrs_mysql.sh

==Configuração Geral==
Agora que fizemos as configurações básicas, precisamos gerar as configurações nos módulos que utilizaremos.

Abra o arquivo /var/www/opensips-cp/config/db.inc.php e altere os parametros de banco de dados
Abra o arquivo /var/www/opensips-cp/config/boxes.global.inc.php , e descomente a linha
$boxes[$box_id]['mi']['conn']="/tmp/opensips_fifo";

==Acessando a interface==

Agora coloque em seu browser http://__SEU__IP__/cp , entre com usuario e senha admin e pronto, você está na tela do opensipscp, através desta você poderá criar usuários e realizar outras operações.

==Ajustando os módulos==

Não sei bem se por erro ou outra razão porém muitos módulos necessitam de alguns ajustes especiais, vamos tratar os mesmos aqui.

===dialog===
Arquivo: /var/www/opensips-cp/config/tools/system/dialog/local.inc.php
Altere o parametro:
$box[1]['mi']['conn']="/tmp/opensips_proxy_fifo";;
para
$box[1]['mi']['conn']="/tmp/opensips_fifo";;

Existem outros módulos ainda que você pode precisar criar algumas tabelas adicionais, porém vamos deixar isso para um outro tutorial, o objetivo deste é apenas por a ferramenta pra funcionar com funcionalidades básicas.

===siptrace===

O siptrace é necessário ativar pois ele não é coberto em nossa instalação, de forma básica, você deve chamar o módulo em seu opensips.cfg (após a configuração do dialog
<pre>
### SIP TRACE

loadmodule "siptrace.so"
modparam("siptrace", "db_url", "mysql://opensips:opensipsrw@localhost/opensips")
modparam("siptrace", "trace_flag", "TRACE_FLAG")
modparam("siptrace", "trace_on", 0)
modparam("siptrace", "enable_ack_trace", 1)
modparam("siptrace", "traced_user_avp", "$avp(traced_user)")

</pre>

finalmente localize a seguinte entrada
<pre>
if (is_method("INVITE")) {

# create dialog with timeout
if ( !create_dialog("B") ) {
send_reply("500","Internal Server Error");
exit;
}

setflag(ACC_DO); # do accounting

}

</pre>

E logo após o setflag, acrescente
trace_dialog();

Altere o arquivo /var/www/opensips-cp/config/tools/system/siptrace/local.inc.php e altere o conteúdo de proxy_list para os ips que você está usando em seu opensips
$proxy_list=array("udp:192.168.0.6:5060","tcp:192.168.0.6:5060");

Desta forma o siptrace esta desativado, para ativar durante a execução do seu opensips, basta enviar o comando
opensipsctl fifo sip_trace on

Ou então pela propria interface voce pode ativar e desativar o recurso.

Abaixo você pode ver o resultado desta utilização

<img src="http://www.tesliuk.com/imagens/siptrace01.jpg">

OpenSIPs CP no Debian com OpenSIPs 1.9

2014-06-19T03:31:38Z

Mike: /* siptrace */

OpenSIPs CP no Debian com OpenSIPs 1.9

2014-06-19T03:30:20Z

Mike:

OpenSIPs CP no Debian com OpenSIPs 1.9

2014-06-19T02:57:10Z

Mike:

Opensips 1.9

2014-06-19T02:19:10Z

Mike: /* Criando um alias */

Este tutorial tem por finalidade, demonstrar o processo de instalação e configuração do OpenSIPS 1.9 utilizando a opção do mesmo para gerar o arquivo de script.

==Informacoes==
Para este tutorial foi utilizado um Debian 6.0 com kernel 64bits
A versão utilizada do OpenSIPS foi 1.9.1

==Dependencias==
<pre>
apt-get install gcc make libncurses5-dev libnewt-dev libxml2-dev unixodbc \
unixodbc-dev libmysqlclient15-dev libxmlrpc-c3-dev libexpat1-dev zlib1g-dev \
m4 bison flex libpcre3-dev mysql-server vim apache2-mpm-prefork libapache2-mod-php5 \
php5-mysql php5-xmlrpc php-pear ngrep g++ libjpeg62-dev libssl-dev libcurl4-gnutls-dev
</pre>

==Download==
cd /usr/src/
wget -c http://opensips.org/pub/opensips/1.9.1/src/opensips-1.9.1_src.tar.gz
tar -xzvf opensips-1.9.1_src.tar.gz
cd opensips-1.9.1-tls

==Compilação==
make menuconfig

No menu selecione a opção '''Configure Compile Options''' , depois selecione '''Configure Excluded Modules'''

Selecione os seguintes módulos
* db_mysql
* dialplan
* regex
* mi_xmlrpc
* presence
* presence_dialoginfo
* presence_mwi
* presence_xml
* xcap
* xcap_client

Após as alterações salve os parametros e selecione no primeiro menu a opção '''Compile & Install OpenSIPS'''

O processo deverá demorar um pouco, ao termino você voltará ao menu, neste selecione a opção '''Generate OpenSIPS Script''' , selecione então '''Residential Script''', e depois '''Configure Residencial Script'''

Neste marque as seguintes opções

* USE_ALIASES
* USE_AUTH
* USE_DBACC
* USE_DBUSRLOC
* USE_DIALOG
* USE_MULTIDOMAIN
* USE_NAT
* USE_PRESENCE
* USE_DIALPLAN
* HAVE_INBOUND_PSTN
* HAVE_OUTBOUND_PSTN
* USE_DR_PSTN

Com todas as opções selecionadas selecione para gerar o script, o script será gerado no diretório '''etc''' dentro do diretório dos fontes, no meu caso o nome do arquivo foi '''opensips_residential_2013-8-17_11:37:45.cfg''' , no seu caso a data obviamente estará diferente.

==Configuração==

Precisamos executar alguns procedimentos para darmos continuidade, seguem os comandos abaixo.
cd /usr/src/opensips-1.9.1-tls
ln -s /usr/etc/opensips /etc/
cp packaging/debian/opensips.default /etc/default/opensips
cp packaging/debian/opensips.init /etc/init.d/opensips
chmod +x /etc/init.d/opensips
update-rc.d opensips defaults

Edite o arquivo /etc/default/opensips , a altere o parametro '''RUN_OPENSIPS''' para yes

groupadd opensips
mkdir /var/run/opensips
useradd -d /var/run/opensips/ -s /bin/false -g opensips opensips
chown -R opensips.opensips /var/run/opensips

Agora podemos dar continuidade.

===opensipsctlrc===
O arquivo /etc/opensips/opensipsctlrc possue alguns parametros que precisamos definir referente a nossa estrutura, você deve analisar o script para verificar oque mais você pode usar, mas em ambito geral abaixo estão as opções que precisamos.

SIP_DOMAIN:
* este parametro é o dominio que o script usará para gerar os dados no banco de dados, você pode usar o ip do seu servidor ou um nome de dominio se você possuir.

DBENGINE
DBHOST
DBNAME
DBRWUSER
DBRWPW
DBROOTUSER
* Estas opções são referentes ao banco de dados que utilizaremos, configure de acordo com seu ambiente

ALIASES_TYPE
* Esta opcão deve ser definida como DB, assim os alias das contas SIP estarão no banco de dados

MI_CONNECTOR_FIFO
* Defina esta opção como /tmp/opensips_fifo

Após configurar, vamos executar o comando abaixo para criar nosso banco de dados.
opensipsdbctl create opensips

===Instalando o RTP Proxy===
<pre>
cd /usr/src/
wget -c http://b2bua.org/chrome/site/rtpproxy-1.2.1.tar.gz
tar -xzvf rtpproxy-1.2.1.tar.gz
cd rtpproxy-1.2.1
./configure
make
make install
groupadd rtpproxy
useradd -d /var/run/rtpproxy -s /bin/true -g rtpproxy rtpproxy
mkdir /var/log/rtpproxy
mkdir /var/run/rtpproxy
chown -R rtpproxy.rtpproxy /var/log/rtpproxy
chown -R rtpproxy.rtpproxy /var/run/rtpproxy
</pre>

====Arquivo de inicialização====
'''/etc/init.d/rtpproxy'''
<pre>
#!/bin/bash
#
# Este script e de autoria de Mike Tesliuk
# qualquer falha no mesmo por favor informe
# atraves do email mike (a) tesliuk.com
#
### BEGIN INIT INFO
# Provides: rtpproxy
# Required-Start: $syslog $network $local_fs $time
# Required-Stop: $syslog $network $local_fs
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Start the RTPPROXY server
# Description: Start the RTPPROXY server
### END INIT INFO

PATH=/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin:/bin:/sbin
USELOG=1
USER=rtpproxy
# Altere o ip abaixo para o ip de seu sistema
IPADDR="_SEU_IP_AQUI_"

. /lib/lsb/init-functions

start(){
echo "Iniciando RTP PROXY "
if [ -z $(pidof rtpproxy) ]; then
if [ "${USELOG}" = "1" ]; then
echo "Iniciando com LOG"
/usr/local/bin/rtpproxy -l $IPADDR -s udp:127.0.0.1:7890 -u $USER -F -f -d DBUG 2&> /var/log/rtpproxy/rtpproxy.log &
else
echo "Iniciando sem LOG"
/usr/local/bin/rtpproxy -l $IPADDR -s udp:127.0.0.1:7890 -u $USER -F -f -d DBUG 2&> /dev/null
fi

if [ -n $(pidof rtpproxy) ]; then
echo "START OK"
fi
else
echo "Processo ja em execucao"
fi
}

stop(){

if [ -z $(pidof rtpproxy) ]; then
echo "Processo nao encontrado"
else
kill -9 $(pidof rtpproxy)
if [ -n $(pidof rtpproxy) ]; then
echo "STOP OK"
else
echo "Falha em realizar stop do servico"
fi

fi
}

case $1 in
start)
start
;;
stop)
stop
;;
restart)
stop
start

;;
*)
echo "Utilize: stop | start | restart"
;;
esac

</pre>

Vamos dar permissao e colocar na inicialização
chmod +x /etc/init.d/rtpproxy
update-rc.d rtpproxy defaults
/etc/init.d/rtpproxy start

===Arquivo autogerado===

copie o arquivo que foi gerado para você para /etc/opensips/opensips.cfg

O Arquivo padrão precisa de alguns ajustes, basicamente localize as opções '''CUSTOMIZE ME''' existentes no arquivo.

Um parametro extra que vamos adicionar é a opção db_url para o modulo uri, para isso localize a opção onde está sendo carregado modulo uri.so e então adicione abaixo.

<pre>
modparam("uri", "db_url",
"mysql://opensips:opensipsrw@localhost/opensips") # CUSTOMIZE ME
</pre>

Termine de alterar os parametros onde traz a opção CUTOMIZE ME para os dados referentes.

Ao terminar as configurações temos que então configurar o nosso plano de discagem para chamadas externas.

Localize a opção dp_translate, comente a mesma, nós não a usaremos aqui, abaixo acrescente
<pre>
# definimos aqui pstn como padrao 0
$avp(pstn)=0;
xlog("Verificando $rU para do_routing");

# Ligacao local (achar uma forma para pegar o ddd na base do usuario)
# routeid 0 para gateway de ligacoes locais (acrescentar 5511)
if ($rU=~"^0[0-9]{8}$") {
$avp(pstn)=1;
$avp(routeid)=0;

# ligacao ddd (0 + ddd + numero)
# routeid 1 para gateway para ddd (acrescenta 55)
}else if( $rU =~ "^0[0-9]{2}[0-9]{8}$" ){
$avp(pstn)=1;
$avp(routeid)=1;

# Ligacao ldn (00 + numero)
# routeid 2 para remover o 00 e enviar a chamada diretamente
}else if( $rU =~ "^00[0-9]+$" ){
$avp(pstn)=1;
$avp(routeid)=2;

}

# pstn esta definido e vamos rotear
if($avp(pstn) == 1){
xlog("Regra pre do_routing");

# utilizamos o routeid que definimos para achar o gateway
# correto para este perfil de chamada
if (!do_routing("$avp(routeid)")) {
send_reply("500","No PSTN Route found");
exit;
}

route(relay);
exit;
}

</pre>

Descendo um pouco o arquivo, após a sessão do if(!lookup('location','m'), acrescente a seguinte opção.
rtpproxy_offer();

Esta opção deve estar na linha anterior a linha abaixo
if (isbflagset(NAT)) setflag(NAT);

Seu arquivo deverá estar semelhante ao arquivo abaixo.

<pre>

#
# $Id: opensips_residential.m4 9742 2013-02-05 10:24:48Z vladut-paiu $
#
# OpenSIPS residential configuration script
# by OpenSIPS Solutions <team@opensips-solutions.com>
#
# This script was generated via "make menuconfig", from
# the "Residential" scenario.
# You can enable / disable more features / functionalities by
# re-generating the scenario with different options.#
#
# Please refer to the Core CookBook at:
# http://www.opensips.org/Resources/DocsCookbooks
# for a explanation of possible statements, functions and parameters.
#

####### Global Parameters #########

debug=3
log_stderror=no
log_facility=LOG_LOCAL0

fork=yes
children=4

/* uncomment the following lines to enable debugging */
debug=6
fork=no
log_stderror=yes

/* uncomment the next line to enable the auto temporary blacklisting of
not available destinations (default disabled) */
#disable_dns_blacklist=no

/* uncomment the next line to enable IPv6 lookup after IPv4 dns
lookup failures (default disabled) */
#dns_try_ipv6=yes

/* comment the next line to enable the auto discovery of local aliases
based on revers DNS on IPs */
auto_aliases=no

listen=udp:_SEU_IP_AQUI_:5060 # CUSTOMIZE ME

disable_tcp=yes

disable_tls=yes

####### Modules Section ########

#set module path
mpath="/usr/lib/opensips/modules/"

#### SIGNALING module
loadmodule "signaling.so"

#### StateLess module
loadmodule "sl.so"

#### Transaction Module
loadmodule "tm.so"
modparam("tm", "fr_timer", 5)
modparam("tm", "fr_inv_timer", 30)
modparam("tm", "restart_fr_on_each_reply", 0)
modparam("tm", "onreply_avp_mode", 1)

#### Record Route Module
loadmodule "rr.so"
/* do not append from tag to the RR (no need for this script) */
modparam("rr", "append_fromtag", 0)

#### MAX ForWarD module
loadmodule "maxfwd.so"

#### SIP MSG OPerationS module
loadmodule "sipmsgops.so"

#### FIFO Management Interface
loadmodule "mi_fifo.so"
modparam("mi_fifo", "fifo_name", "/tmp/opensips_fifo")
modparam("mi_fifo", "fifo_mode", 0666)

#### URI module
loadmodule "uri.so"
modparam("uri", "use_uri_table", 0)
modparam("uri", "db_url", "mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips")

#### MYSQL module
loadmodule "db_mysql.so"

#### USeR LOCation module
loadmodule "usrloc.so"
modparam("usrloc", "nat_bflag", "NAT")
modparam("usrloc", "db_mode", 2)
modparam("usrloc", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

#### REGISTRAR module
loadmodule "registrar.so"
modparam("registrar", "tcp_persistent_flag", "TCP_PERSISTENT")
modparam("registrar", "received_avp", "$avp(received_nh)")
/* uncomment the next line not to allow more than 10 contacts per AOR */
#modparam("registrar", "max_contacts", 10)

#### ACCounting module
loadmodule "acc.so"
/* what special events should be accounted ? */
modparam("acc", "early_media", 0)
modparam("acc", "report_cancels", 0)
/* by default we do not adjust the direct of the sequential requests.
if you enable this parameter, be sure the enable "append_fromtag"
in "rr" module */
modparam("acc", "detect_direction", 0)
modparam("acc", "failed_transaction_flag", "ACC_FAILED")
/* account triggers (flags) */
modparam("acc", "db_flag", "ACC_DO")
modparam("acc", "db_missed_flag", "ACC_MISSED")
modparam("acc", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

#### AUTHentication modules
loadmodule "auth.so"
loadmodule "auth_db.so"
modparam("auth_db", "calculate_ha1", yes)
modparam("auth_db", "password_column", "password")
modparam("auth_db", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME
modparam("auth_db", "load_credentials", "")

#### ALIAS module
loadmodule "alias_db.so"
modparam("alias_db", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

#### DOMAIN module
loadmodule "domain.so"
modparam("domain", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME
modparam("domain", "db_mode", 1) # Use caching
modparam("auth_db|usrloc|uri", "use_domain", 1)

### XCAP
loadmodule "xcap.so"
modparam("xcap", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME
modparam("xcap", "integrated_xcap_server", 1)

#### PRESENCE modules
loadmodule "presence.so"
loadmodule "presence_xml.so"
modparam("presence", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME
modparam("presence_xml", "force_active", 1)
modparam("presence", "server_address", "sip:127.0.0.1:5060") # CUSTOMIZE ME

#### DIALOG module
loadmodule "dialog.so"
modparam("dialog", "dlg_match_mode", 1)
modparam("dialog", "default_timeout", 21600) # 6 hours timeout
modparam("dialog", "db_mode", 2)
modparam("dialog", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

#### NAT modules
loadmodule "nathelper.so"
modparam("nathelper", "natping_interval", 10)
modparam("nathelper", "ping_nated_only", 1)
modparam("nathelper", "received_avp", "$avp(received_nh)")

loadmodule "rtpproxy.so"
modparam("rtpproxy", "rtpproxy_sock", "udp:localhost:7890") # CUSTOMIZE ME

#### DIALPLAN module
loadmodule "dialplan.so"
modparam("dialplan", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

#### DYNAMMIC ROUTING module
loadmodule "drouting.so"
modparam("drouting", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

####### Routing Logic ########

# main request routing logic

route{
force_rport();

if (nat_uac_test("8")) {
if (is_method("REGISTER")) {
fix_nated_register();
setbflag(NAT);
} else {
fix_nated_contact();
setflag(NAT);
}
}

if (!mf_process_maxfwd_header("10")) {
sl_send_reply("483","Too Many Hops");
exit;
}

if (has_totag()) {
# sequential request withing a dialog should
# take the path determined by record-routing
if (loose_route()) {

# validate the sequential request against dialog
if ( $DLG_status!=NULL && !validate_dialog() ) {
xlog("In-Dialog $rm from $si (callid=$ci) is not valid according to dialog\n");
## exit;
}

if (is_method("BYE")) {
setflag(ACC_DO); # do accounting ...
setflag(ACC_FAILED); # ... even if the transaction fails
} else if (is_method("INVITE")) {
# even if in most of the cases is useless, do RR for
# re-INVITEs alos, as some buggy clients do change route set
# during the dialog.
record_route();
}

if (check_route_param("nat=yes"))
setflag(NAT);

# route it out to whatever destination was set by loose_route()
# in $du (destination URI).
route(relay);
} else {
if (is_method("SUBSCRIBE") && $rd == "_SEU_IP_AQUI_:5060") { # CUSTOMIZE ME
# in-dialog subscribe requests
route(handle_presence);
exit;
}
if ( is_method("ACK") ) {
if ( t_check_trans() ) {
# non loose-route, but stateful ACK; must be an ACK after
# a 487 or e.g. 404 from upstream server
t_relay();
exit;
} else {
# ACK without matching transaction ->
# ignore and discard
exit;
}
}
sl_send_reply("404","Not here");
}
exit;
}

# CANCEL processing
if (is_method("CANCEL"))
{
if (t_check_trans())
t_relay();
exit;
}

t_check_trans();

if ( !(is_method("REGISTER") || is_from_gw() ) ) {

if (is_from_local())
{

# authenticate if from local subscriber
# authenticate all initial non-REGISTER request that pretend to be
# generated by local subscriber (domain from FROM URI is local)
if (!proxy_authorize("", "subscriber")) {
proxy_challenge("", "0");
exit;
}
if (!db_check_from()) {
sl_send_reply("403","Forbidden auth ID");
exit;
}

consume_credentials();
# caller authenticated

} else {
# if caller is not local, then called number must be local

if (!is_uri_host_local()) {
send_reply("403","Rely forbidden");
exit;
}
}

}

# preloaded route checking
if (loose_route()) {
xlog("L_ERR",
"Attempt to route with preloaded Route's [$fu/$tu/$ru/$ci]");
if (!is_method("ACK"))
sl_send_reply("403","Preload Route denied");
exit;
}

# record routing
if (!is_method("REGISTER|MESSAGE"))
record_route();

# account only INVITEs
if (is_method("INVITE")) {

if(has_totag()){
engage_rtp_proxy();
}
# create dialog with timeout
if ( !create_dialog("B") ) {
send_reply("500","Internal Server Error");
exit;
}

setflag(ACC_DO); # do accounting
}

if (!is_uri_host_local()) {
append_hf("P-hint: outbound\r\n");

route(relay);
}

# requests for my domain

if( is_method("PUBLISH|SUBSCRIBE"))
route(handle_presence);

if (is_method("REGISTER"))
{

# authenticate the REGISTER requests
if (!www_authorize("", "subscriber"))
{
www_challenge("", "0");
exit;
}

if (!db_check_to())
{
sl_send_reply("403","Forbidden auth ID");
exit;
}

if ( 0 ) setflag(TCP_PERSISTENT);

if (!save("location"))
sl_reply_error();

exit;
}

if ($rU==NULL) {
# request with no Username in RURI
sl_send_reply("484","Address Incomplete");
exit;
}

# apply DB based aliases
alias_db_lookup("dbaliases");

# apply transformations from dialplan table
#xlog("Verificando se temos rota para este destino $ru/$ru");
#dp_translate("0","$rU/$rU");

# definimos aqui pstn como padrao 0
$avp(pstn)=0;
xlog("Verificando $rU para do_routing");

# Ligacao local (achar uma forma para pegar o ddd na base do usuario)
# routeid 0 para gateway de ligacoes locais (acrescentar 5511)
if ($rU=~"^0[0-9]{8}$") {
$avp(pstn)=1;
$avp(routeid)=0;

# ligacao ddd (0 + ddd + numero)
# routeid 1 para gateway para ddd (acrescenta 55)
}else if( $rU =~ "^0[0-9]{2}[0-9]{8}$" ){
$avp(pstn)=1;
$avp(routeid)=1;

# Ligacao ldn (00 + numero)
# routeid 2 para remover o 00 e enviar a chamada diretamente
}else if( $rU =~ "^00[0-9]+$" ){
$avp(pstn)=1;
$avp(routeid)=2;

}

# pstn esta definido e vamos rotear
if($avp(pstn) == 1){
xlog("Regra pre do_routing");

# utilizamos o routeid que definimos para achar o gateway
# correto para este perfil de chamada
if (!do_routing("$avp(routeid)")) {
send_reply("500","No PSTN Route found");
exit;
}

route(relay);
exit;
}

# do lookup with method filtering
if (!lookup("location","m")) {
if (!db_does_uri_exist()) {
send_reply("420","Bad Extension");
exit;
}

t_newtran();
t_reply("404", "Not Found");
exit;
}

# esta entrada fez a magica do sdp
rtpproxy_offer();
if (isbflagset(NAT)) setflag(NAT);

# when routing via usrloc, log the missed calls also
setflag(ACC_MISSED);
route(relay);
}

route[relay] {
# for INVITEs enable some additional helper routes
if (is_method("INVITE")) {

if (isflagset(NAT)) {
rtpproxy_offer();
}

t_on_branch("per_branch_ops");
t_on_reply("handle_nat");
t_on_failure("missed_call");
}

if (isflagset(NAT)) {
add_rr_param(";nat=yes");
}

if (!t_relay()) {
send_reply("500","Internal Error");
};
exit;
}

# Presence route
route[handle_presence]
{
if (!t_newtran())
{
sl_reply_error();
exit;
}

if(is_method("PUBLISH"))
{
handle_publish();
}
else
if( is_method("SUBSCRIBE"))
{
handle_subscribe();
}

exit;
}

branch_route[per_branch_ops] {
xlog("new branch at $ru\n");
}

onreply_route[handle_nat] {
#fix_nated_sdp("3");
rtpproxy_answer();

if (nat_uac_test("1"))
fix_nated_contact();
if ( isflagset(NAT) )
rtpproxy_answer("ro");
xlog("incoming reply\n");
}

failure_route[missed_call] {
if (t_was_cancelled()) {
exit;
}

# uncomment the following lines if you want to block client
# redirect based on 3xx replies.
##if (t_check_status("3[0-9][0-9]")) {
##t_reply("404","Not found");
## exit;
##}

}

local_route {
if (is_method("BYE") && $DLG_dir=="UPSTREAM") {

acc_db_request("200 Dialog Timeout", "acc");

}
}

</pre>

Agora precisamos criar usuários, alias, e rota de saida.

==Criando um usuario==
opensipsctl add NOME_DO_USUARIO SENHA_DO_USUARIO
opensipsctl add USUARIO2 SENHA_USUARIO2

==Criando um alias==
O alias normalmente é utilizado para um número referente a este usuário, seja um número de telefone ou um ramal.
opensipsctl alias_db add 05551234@IP_OU_DOMINIO NOME_DO_USUARIO@IP_OU_DOMINIO

Neste caso, se um usuário ou uma chamada de fora vier para 05551234 ela será direcionada para o usuário especificado

==Criando os troncos==
Agora precisamos criar os troncos de saida, você deve inserir no banco de dados, veja abaixo um exemplo.

<pre>
mysql> select * from dr_gateways;
+----+------+------+-------------+-------+------------+-------+------------+-------------+
| id | gwid | type | address | strip | pri_prefix | attrs | probe_mode | description |
+----+------+------+-------------+-------+------------+-------+------------+-------------+
| 1 | 1 | 2 | IP_DO_TRONCO| 0 | 5511 | | 2 | LOCAL SP |
| 3 | 2 | 2 | IP_DO_TRONCO| 1 | 55 | | 0 | LDN |
| 4 | 3 | 2 | IP_DO_TRONCO| 2 | | | 0 | LDI |
+----+------+------+-------------+-------+------------+-------+------------+-------------+
</pre>

Veja que temos duas opções especificas ali, que é o strip, o strip é para remover um digito do numero recebido,
a opção pri_prefix é para adicionar um prefixo antes da discagem

Com esta opção agora precisamos criar a regra que vai entrar para um tronco o outro, abaixo
segue as entradas do banco de dados.

<pre>
mysql> select * from dr_rules;
+--------+---------+--------+---------+----------+---------+--------+-------+-------------+
| ruleid | groupid | prefix | timerec | priority | routeid | gwlist | attrs | description |
+--------+---------+--------+---------+----------+---------+--------+-------+-------------+
| 4 | 0 | | | 0 | 1 | 1 | | Local |
| 5 | 1 | | | 0 | 1 | 2 | | LDN |
| 6 | 2 | | | 0 | 1 | 3 | | LDI |
+--------+---------+--------+---------+----------+---------+--------+-------+-------------+
</pre>

Neste caso o detalhe está gwlist e no groupid, nós no nosso arquivo opensips.cfg nas regras para as ligações externas, definimos que ele buscará pelo grupo 0 para local, pelo grupo 1 para ldn , e pelo grupo 2 para internacional, e cada um destes grupos corresponde a um ip da tabela da anterior.

Com estes dados criados, podemos dar inicio nos testes.

==Iniciando o OpenSIPS==

Precisamos iniciar o OpenSIPS antes de mais nada, então para isso execute o comando abaixo.
/etc/init.d/opensips start

Se o sistema levantar, então é só dar sequencia, se não levantar, habilite as opções de debug do arquivo e então execute o comando abaixo para tnetar localizar o erro.
/etc/init.d/opensips debug

==Fazendo chamadas==

Para fazer as chamadas as instruções são:
LOCAL: 0 + 8 DIGITOS
LDN : 0 + DDD + 8 DIGITOS
LDI : 00 + NUMERO

Para chamar um usuário você pode discar o alias que voce atribuiu ou o proprio nome do usuário se for softphone

Opensips 1.9

2014-06-19T02:16:49Z

Mike: /* Arquivo de inicialização */

Este tutorial tem por finalidade, demonstrar o processo de instalação e configuração do OpenSIPS 1.9 utilizando a opção do mesmo para gerar o arquivo de script.

==Informacoes==
Para este tutorial foi utilizado um Debian 6.0 com kernel 64bits
A versão utilizada do OpenSIPS foi 1.9.1

==Dependencias==
<pre>
apt-get install gcc make libncurses5-dev libnewt-dev libxml2-dev unixodbc \
unixodbc-dev libmysqlclient15-dev libxmlrpc-c3-dev libexpat1-dev zlib1g-dev \
m4 bison flex libpcre3-dev mysql-server vim apache2-mpm-prefork libapache2-mod-php5 \
php5-mysql php5-xmlrpc php-pear ngrep g++ libjpeg62-dev libssl-dev libcurl4-gnutls-dev
</pre>

==Download==
cd /usr/src/
wget -c http://opensips.org/pub/opensips/1.9.1/src/opensips-1.9.1_src.tar.gz
tar -xzvf opensips-1.9.1_src.tar.gz
cd opensips-1.9.1-tls

==Compilação==
make menuconfig

No menu selecione a opção '''Configure Compile Options''' , depois selecione '''Configure Excluded Modules'''

Selecione os seguintes módulos
* db_mysql
* dialplan
* regex
* mi_xmlrpc
* presence
* presence_dialoginfo
* presence_mwi
* presence_xml
* xcap
* xcap_client

Após as alterações salve os parametros e selecione no primeiro menu a opção '''Compile & Install OpenSIPS'''

O processo deverá demorar um pouco, ao termino você voltará ao menu, neste selecione a opção '''Generate OpenSIPS Script''' , selecione então '''Residential Script''', e depois '''Configure Residencial Script'''

Neste marque as seguintes opções

* USE_ALIASES
* USE_AUTH
* USE_DBACC
* USE_DBUSRLOC
* USE_DIALOG
* USE_MULTIDOMAIN
* USE_NAT
* USE_PRESENCE
* USE_DIALPLAN
* HAVE_INBOUND_PSTN
* HAVE_OUTBOUND_PSTN
* USE_DR_PSTN

Com todas as opções selecionadas selecione para gerar o script, o script será gerado no diretório '''etc''' dentro do diretório dos fontes, no meu caso o nome do arquivo foi '''opensips_residential_2013-8-17_11:37:45.cfg''' , no seu caso a data obviamente estará diferente.

==Configuração==

Precisamos executar alguns procedimentos para darmos continuidade, seguem os comandos abaixo.
cd /usr/src/opensips-1.9.1-tls
ln -s /usr/etc/opensips /etc/
cp packaging/debian/opensips.default /etc/default/opensips
cp packaging/debian/opensips.init /etc/init.d/opensips
chmod +x /etc/init.d/opensips
update-rc.d opensips defaults

Edite o arquivo /etc/default/opensips , a altere o parametro '''RUN_OPENSIPS''' para yes

groupadd opensips
mkdir /var/run/opensips
useradd -d /var/run/opensips/ -s /bin/false -g opensips opensips
chown -R opensips.opensips /var/run/opensips

Agora podemos dar continuidade.

===opensipsctlrc===
O arquivo /etc/opensips/opensipsctlrc possue alguns parametros que precisamos definir referente a nossa estrutura, você deve analisar o script para verificar oque mais você pode usar, mas em ambito geral abaixo estão as opções que precisamos.

SIP_DOMAIN:
* este parametro é o dominio que o script usará para gerar os dados no banco de dados, você pode usar o ip do seu servidor ou um nome de dominio se você possuir.

DBENGINE
DBHOST
DBNAME
DBRWUSER
DBRWPW
DBROOTUSER
* Estas opções são referentes ao banco de dados que utilizaremos, configure de acordo com seu ambiente

ALIASES_TYPE
* Esta opcão deve ser definida como DB, assim os alias das contas SIP estarão no banco de dados

MI_CONNECTOR_FIFO
* Defina esta opção como /tmp/opensips_fifo

Após configurar, vamos executar o comando abaixo para criar nosso banco de dados.
opensipsdbctl create opensips

===Instalando o RTP Proxy===
<pre>
cd /usr/src/
wget -c http://b2bua.org/chrome/site/rtpproxy-1.2.1.tar.gz
tar -xzvf rtpproxy-1.2.1.tar.gz
cd rtpproxy-1.2.1
./configure
make
make install
groupadd rtpproxy
useradd -d /var/run/rtpproxy -s /bin/true -g rtpproxy rtpproxy
mkdir /var/log/rtpproxy
mkdir /var/run/rtpproxy
chown -R rtpproxy.rtpproxy /var/log/rtpproxy
chown -R rtpproxy.rtpproxy /var/run/rtpproxy
</pre>

====Arquivo de inicialização====
'''/etc/init.d/rtpproxy'''
<pre>
#!/bin/bash
#
# Este script e de autoria de Mike Tesliuk
# qualquer falha no mesmo por favor informe
# atraves do email mike (a) tesliuk.com
#
### BEGIN INIT INFO
# Provides: rtpproxy
# Required-Start: $syslog $network $local_fs $time
# Required-Stop: $syslog $network $local_fs
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Start the RTPPROXY server
# Description: Start the RTPPROXY server
### END INIT INFO

PATH=/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin:/bin:/sbin
USELOG=1
USER=rtpproxy
# Altere o ip abaixo para o ip de seu sistema
IPADDR="_SEU_IP_AQUI_"

. /lib/lsb/init-functions

start(){
echo "Iniciando RTP PROXY "
if [ -z $(pidof rtpproxy) ]; then
if [ "${USELOG}" = "1" ]; then
echo "Iniciando com LOG"
/usr/local/bin/rtpproxy -l $IPADDR -s udp:127.0.0.1:7890 -u $USER -F -f -d DBUG 2&> /var/log/rtpproxy/rtpproxy.log &
else
echo "Iniciando sem LOG"
/usr/local/bin/rtpproxy -l $IPADDR -s udp:127.0.0.1:7890 -u $USER -F -f -d DBUG 2&> /dev/null
fi

if [ -n $(pidof rtpproxy) ]; then
echo "START OK"
fi
else
echo "Processo ja em execucao"
fi
}

stop(){

if [ -z $(pidof rtpproxy) ]; then
echo "Processo nao encontrado"
else
kill -9 $(pidof rtpproxy)
if [ -n $(pidof rtpproxy) ]; then
echo "STOP OK"
else
echo "Falha em realizar stop do servico"
fi

fi
}

case $1 in
start)
start
;;
stop)
stop
;;
restart)
stop
start

;;
*)
echo "Utilize: stop | start | restart"
;;
esac

</pre>

Vamos dar permissao e colocar na inicialização
chmod +x /etc/init.d/rtpproxy
update-rc.d rtpproxy defaults
/etc/init.d/rtpproxy start

===Arquivo autogerado===

copie o arquivo que foi gerado para você para /etc/opensips/opensips.cfg

O Arquivo padrão precisa de alguns ajustes, basicamente localize as opções '''CUSTOMIZE ME''' existentes no arquivo.

Um parametro extra que vamos adicionar é a opção db_url para o modulo uri, para isso localize a opção onde está sendo carregado modulo uri.so e então adicione abaixo.

<pre>
modparam("uri", "db_url",
"mysql://opensips:opensipsrw@localhost/opensips") # CUSTOMIZE ME
</pre>

Termine de alterar os parametros onde traz a opção CUTOMIZE ME para os dados referentes.

Ao terminar as configurações temos que então configurar o nosso plano de discagem para chamadas externas.

Localize a opção dp_translate, comente a mesma, nós não a usaremos aqui, abaixo acrescente
<pre>
# definimos aqui pstn como padrao 0
$avp(pstn)=0;
xlog("Verificando $rU para do_routing");

# Ligacao local (achar uma forma para pegar o ddd na base do usuario)
# routeid 0 para gateway de ligacoes locais (acrescentar 5511)
if ($rU=~"^0[0-9]{8}$") {
$avp(pstn)=1;
$avp(routeid)=0;

# ligacao ddd (0 + ddd + numero)
# routeid 1 para gateway para ddd (acrescenta 55)
}else if( $rU =~ "^0[0-9]{2}[0-9]{8}$" ){
$avp(pstn)=1;
$avp(routeid)=1;

# Ligacao ldn (00 + numero)
# routeid 2 para remover o 00 e enviar a chamada diretamente
}else if( $rU =~ "^00[0-9]+$" ){
$avp(pstn)=1;
$avp(routeid)=2;

}

# pstn esta definido e vamos rotear
if($avp(pstn) == 1){
xlog("Regra pre do_routing");

# utilizamos o routeid que definimos para achar o gateway
# correto para este perfil de chamada
if (!do_routing("$avp(routeid)")) {
send_reply("500","No PSTN Route found");
exit;
}

route(relay);
exit;
}

</pre>

Descendo um pouco o arquivo, após a sessão do if(!lookup('location','m'), acrescente a seguinte opção.
rtpproxy_offer();

Esta opção deve estar na linha anterior a linha abaixo
if (isbflagset(NAT)) setflag(NAT);

Seu arquivo deverá estar semelhante ao arquivo abaixo.

<pre>

#
# $Id: opensips_residential.m4 9742 2013-02-05 10:24:48Z vladut-paiu $
#
# OpenSIPS residential configuration script
# by OpenSIPS Solutions <team@opensips-solutions.com>
#
# This script was generated via "make menuconfig", from
# the "Residential" scenario.
# You can enable / disable more features / functionalities by
# re-generating the scenario with different options.#
#
# Please refer to the Core CookBook at:
# http://www.opensips.org/Resources/DocsCookbooks
# for a explanation of possible statements, functions and parameters.
#

####### Global Parameters #########

debug=3
log_stderror=no
log_facility=LOG_LOCAL0

fork=yes
children=4

/* uncomment the following lines to enable debugging */
debug=6
fork=no
log_stderror=yes

/* uncomment the next line to enable the auto temporary blacklisting of
not available destinations (default disabled) */
#disable_dns_blacklist=no

/* uncomment the next line to enable IPv6 lookup after IPv4 dns
lookup failures (default disabled) */
#dns_try_ipv6=yes

/* comment the next line to enable the auto discovery of local aliases
based on revers DNS on IPs */
auto_aliases=no

listen=udp:_SEU_IP_AQUI_:5060 # CUSTOMIZE ME

disable_tcp=yes

disable_tls=yes

####### Modules Section ########

#set module path
mpath="/usr/lib/opensips/modules/"

#### SIGNALING module
loadmodule "signaling.so"

#### StateLess module
loadmodule "sl.so"

#### Transaction Module
loadmodule "tm.so"
modparam("tm", "fr_timer", 5)
modparam("tm", "fr_inv_timer", 30)
modparam("tm", "restart_fr_on_each_reply", 0)
modparam("tm", "onreply_avp_mode", 1)

#### Record Route Module
loadmodule "rr.so"
/* do not append from tag to the RR (no need for this script) */
modparam("rr", "append_fromtag", 0)

#### MAX ForWarD module
loadmodule "maxfwd.so"

#### SIP MSG OPerationS module
loadmodule "sipmsgops.so"

#### FIFO Management Interface
loadmodule "mi_fifo.so"
modparam("mi_fifo", "fifo_name", "/tmp/opensips_fifo")
modparam("mi_fifo", "fifo_mode", 0666)

#### URI module
loadmodule "uri.so"
modparam("uri", "use_uri_table", 0)
modparam("uri", "db_url", "mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips")

#### MYSQL module
loadmodule "db_mysql.so"

#### USeR LOCation module
loadmodule "usrloc.so"
modparam("usrloc", "nat_bflag", "NAT")
modparam("usrloc", "db_mode", 2)
modparam("usrloc", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

#### REGISTRAR module
loadmodule "registrar.so"
modparam("registrar", "tcp_persistent_flag", "TCP_PERSISTENT")
modparam("registrar", "received_avp", "$avp(received_nh)")
/* uncomment the next line not to allow more than 10 contacts per AOR */
#modparam("registrar", "max_contacts", 10)

#### ACCounting module
loadmodule "acc.so"
/* what special events should be accounted ? */
modparam("acc", "early_media", 0)
modparam("acc", "report_cancels", 0)
/* by default we do not adjust the direct of the sequential requests.
if you enable this parameter, be sure the enable "append_fromtag"
in "rr" module */
modparam("acc", "detect_direction", 0)
modparam("acc", "failed_transaction_flag", "ACC_FAILED")
/* account triggers (flags) */
modparam("acc", "db_flag", "ACC_DO")
modparam("acc", "db_missed_flag", "ACC_MISSED")
modparam("acc", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

#### AUTHentication modules
loadmodule "auth.so"
loadmodule "auth_db.so"
modparam("auth_db", "calculate_ha1", yes)
modparam("auth_db", "password_column", "password")
modparam("auth_db", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME
modparam("auth_db", "load_credentials", "")

#### ALIAS module
loadmodule "alias_db.so"
modparam("alias_db", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

#### DOMAIN module
loadmodule "domain.so"
modparam("domain", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME
modparam("domain", "db_mode", 1) # Use caching
modparam("auth_db|usrloc|uri", "use_domain", 1)

### XCAP
loadmodule "xcap.so"
modparam("xcap", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME
modparam("xcap", "integrated_xcap_server", 1)

#### PRESENCE modules
loadmodule "presence.so"
loadmodule "presence_xml.so"
modparam("presence", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME
modparam("presence_xml", "force_active", 1)
modparam("presence", "server_address", "sip:127.0.0.1:5060") # CUSTOMIZE ME

#### DIALOG module
loadmodule "dialog.so"
modparam("dialog", "dlg_match_mode", 1)
modparam("dialog", "default_timeout", 21600) # 6 hours timeout
modparam("dialog", "db_mode", 2)
modparam("dialog", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

#### NAT modules
loadmodule "nathelper.so"
modparam("nathelper", "natping_interval", 10)
modparam("nathelper", "ping_nated_only", 1)
modparam("nathelper", "received_avp", "$avp(received_nh)")

loadmodule "rtpproxy.so"
modparam("rtpproxy", "rtpproxy_sock", "udp:localhost:7890") # CUSTOMIZE ME

#### DIALPLAN module
loadmodule "dialplan.so"
modparam("dialplan", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

#### DYNAMMIC ROUTING module
loadmodule "drouting.so"
modparam("drouting", "db_url",
"mysql://opensips:_SUA_SENHA_AQUI_@localhost/opensips") # CUSTOMIZE ME

####### Routing Logic ########

# main request routing logic

route{
force_rport();

if (nat_uac_test("8")) {
if (is_method("REGISTER")) {
fix_nated_register();
setbflag(NAT);
} else {
fix_nated_contact();
setflag(NAT);
}
}

if (!mf_process_maxfwd_header("10")) {
sl_send_reply("483","Too Many Hops");
exit;
}

if (has_totag()) {
# sequential request withing a dialog should
# take the path determined by record-routing
if (loose_route()) {

# validate the sequential request against dialog
if ( $DLG_status!=NULL && !validate_dialog() ) {
xlog("In-Dialog $rm from $si (callid=$ci) is not valid according to dialog\n");
## exit;
}

if (is_method("BYE")) {
setflag(ACC_DO); # do accounting ...
setflag(ACC_FAILED); # ... even if the transaction fails
} else if (is_method("INVITE")) {
# even if in most of the cases is useless, do RR for
# re-INVITEs alos, as some buggy clients do change route set
# during the dialog.
record_route();
}

if (check_route_param("nat=yes"))
setflag(NAT);

# route it out to whatever destination was set by loose_route()
# in $du (destination URI).
route(relay);
} else {
if (is_method("SUBSCRIBE") && $rd == "_SEU_IP_AQUI_:5060") { # CUSTOMIZE ME
# in-dialog subscribe requests
route(handle_presence);
exit;
}
if ( is_method("ACK") ) {
if ( t_check_trans() ) {
# non loose-route, but stateful ACK; must be an ACK after
# a 487 or e.g. 404 from upstream server
t_relay();
exit;
} else {
# ACK without matching transaction ->
# ignore and discard
exit;
}
}
sl_send_reply("404","Not here");
}
exit;
}

# CANCEL processing
if (is_method("CANCEL"))
{
if (t_check_trans())
t_relay();
exit;
}

t_check_trans();

if ( !(is_method("REGISTER") || is_from_gw() ) ) {

if (is_from_local())
{

# authenticate if from local subscriber
# authenticate all initial non-REGISTER request that pretend to be
# generated by local subscriber (domain from FROM URI is local)
if (!proxy_authorize("", "subscriber")) {
proxy_challenge("", "0");
exit;
}
if (!db_check_from()) {
sl_send_reply("403","Forbidden auth ID");
exit;
}

consume_credentials();
# caller authenticated

} else {
# if caller is not local, then called number must be local

if (!is_uri_host_local()) {
send_reply("403","Rely forbidden");
exit;
}
}

}

# preloaded route checking
if (loose_route()) {
xlog("L_ERR",
"Attempt to route with preloaded Route's [$fu/$tu/$ru/$ci]");
if (!is_method("ACK"))
sl_send_reply("403","Preload Route denied");
exit;
}

# record routing
if (!is_method("REGISTER|MESSAGE"))
record_route();

# account only INVITEs
if (is_method("INVITE")) {

if(has_totag()){
engage_rtp_proxy();
}
# create dialog with timeout
if ( !create_dialog("B") ) {
send_reply("500","Internal Server Error");
exit;
}

setflag(ACC_DO); # do accounting
}

if (!is_uri_host_local()) {
append_hf("P-hint: outbound\r\n");

route(relay);
}

# requests for my domain

if( is_method("PUBLISH|SUBSCRIBE"))
route(handle_presence);

if (is_method("REGISTER"))
{

# authenticate the REGISTER requests
if (!www_authorize("", "subscriber"))
{
www_challenge("", "0");
exit;
}

if (!db_check_to())
{
sl_send_reply("403","Forbidden auth ID");
exit;
}

if ( 0 ) setflag(TCP_PERSISTENT);

if (!save("location"))
sl_reply_error();

exit;
}

if ($rU==NULL) {
# request with no Username in RURI
sl_send_reply("484","Address Incomplete");
exit;
}

# apply DB based aliases
alias_db_lookup("dbaliases");

# apply transformations from dialplan table
#xlog("Verificando se temos rota para este destino $ru/$ru");
#dp_translate("0","$rU/$rU");

# definimos aqui pstn como padrao 0
$avp(pstn)=0;
xlog("Verificando $rU para do_routing");

# Ligacao local (achar uma forma para pegar o ddd na base do usuario)
# routeid 0 para gateway de ligacoes locais (acrescentar 5511)
if ($rU=~"^0[0-9]{8}$") {
$avp(pstn)=1;
$avp(routeid)=0;

# ligacao ddd (0 + ddd + numero)
# routeid 1 para gateway para ddd (acrescenta 55)
}else if( $rU =~ "^0[0-9]{2}[0-9]{8}$" ){
$avp(pstn)=1;
$avp(routeid)=1;

# Ligacao ldn (00 + numero)
# routeid 2 para remover o 00 e enviar a chamada diretamente
}else if( $rU =~ "^00[0-9]+$" ){
$avp(pstn)=1;
$avp(routeid)=2;

}

# pstn esta definido e vamos rotear
if($avp(pstn) == 1){
xlog("Regra pre do_routing");

# utilizamos o routeid que definimos para achar o gateway
# correto para este perfil de chamada
if (!do_routing("$avp(routeid)")) {
send_reply("500","No PSTN Route found");
exit;
}

route(relay);
exit;
}

# do lookup with method filtering
if (!lookup("location","m")) {
if (!db_does_uri_exist()) {
send_reply("420","Bad Extension");
exit;
}

t_newtran();
t_reply("404", "Not Found");
exit;
}

# esta entrada fez a magica do sdp
rtpproxy_offer();
if (isbflagset(NAT)) setflag(NAT);

# when routing via usrloc, log the missed calls also
setflag(ACC_MISSED);
route(relay);
}

route[relay] {
# for INVITEs enable some additional helper routes
if (is_method("INVITE")) {

if (isflagset(NAT)) {
rtpproxy_offer();
}

t_on_branch("per_branch_ops");
t_on_reply("handle_nat");
t_on_failure("missed_call");
}

if (isflagset(NAT)) {
add_rr_param(";nat=yes");
}

if (!t_relay()) {
send_reply("500","Internal Error");
};
exit;
}

# Presence route
route[handle_presence]
{
if (!t_newtran())
{
sl_reply_error();
exit;
}

if(is_method("PUBLISH"))
{
handle_publish();
}
else
if( is_method("SUBSCRIBE"))
{
handle_subscribe();
}

exit;
}

branch_route[per_branch_ops] {
xlog("new branch at $ru\n");
}

onreply_route[handle_nat] {
#fix_nated_sdp("3");
rtpproxy_answer();

if (nat_uac_test("1"))
fix_nated_contact();
if ( isflagset(NAT) )
rtpproxy_answer("ro");
xlog("incoming reply\n");
}

failure_route[missed_call] {
if (t_was_cancelled()) {
exit;
}

# uncomment the following lines if you want to block client
# redirect based on 3xx replies.
##if (t_check_status("3[0-9][0-9]")) {
##t_reply("404","Not found");
## exit;
##}

}

local_route {
if (is_method("BYE") && $DLG_dir=="UPSTREAM") {

acc_db_request("200 Dialog Timeout", "acc");

}
}

</pre>

Agora precisamos criar usuários, alias, e rota de saida.

==Criando um usuario==
opensipsctl add NOME_DO_USUARIO SENHA_DO_USUARIO
opensipsctl add USUARIO2 SENHA_USUARIO2

==Criando um alias==
O alias normalmente é utilizado para um número referente a este usuário, seja um número de telefone ou um ramal.
opensipsctl alias_db add 05551234 NOME_DO_USUARIO

Neste caso, se um usuário ou uma chamada de fora vier para 05551234 ela será direcionada para o usuário especificado

==Criando os troncos==
Agora precisamos criar os troncos de saida, você deve inserir no banco de dados, veja abaixo um exemplo.

<pre>
mysql> select * from dr_gateways;
+----+------+------+-------------+-------+------------+-------+------------+-------------+
| id | gwid | type | address | strip | pri_prefix | attrs | probe_mode | description |
+----+------+------+-------------+-------+------------+-------+------------+-------------+
| 1 | 1 | 2 | IP_DO_TRONCO| 0 | 5511 | | 2 | LOCAL SP |
| 3 | 2 | 2 | IP_DO_TRONCO| 1 | 55 | | 0 | LDN |
| 4 | 3 | 2 | IP_DO_TRONCO| 2 | | | 0 | LDI |
+----+------+------+-------------+-------+------------+-------+------------+-------------+
</pre>

Veja que temos duas opções especificas ali, que é o strip, o strip é para remover um digito do numero recebido,
a opção pri_prefix é para adicionar um prefixo antes da discagem

Com esta opção agora precisamos criar a regra que vai entrar para um tronco o outro, abaixo
segue as entradas do banco de dados.

<pre>
mysql> select * from dr_rules;
+--------+---------+--------+---------+----------+---------+--------+-------+-------------+
| ruleid | groupid | prefix | timerec | priority | routeid | gwlist | attrs | description |
+--------+---------+--------+---------+----------+---------+--------+-------+-------------+
| 4 | 0 | | | 0 | 1 | 1 | | Local |
| 5 | 1 | | | 0 | 1 | 2 | | LDN |
| 6 | 2 | | | 0 | 1 | 3 | | LDI |
+--------+---------+--------+---------+----------+---------+--------+-------+-------------+
</pre>

Neste caso o detalhe está gwlist e no groupid, nós no nosso arquivo opensips.cfg nas regras para as ligações externas, definimos que ele buscará pelo grupo 0 para local, pelo grupo 1 para ldn , e pelo grupo 2 para internacional, e cada um destes grupos corresponde a um ip da tabela da anterior.

Com estes dados criados, podemos dar inicio nos testes.

==Iniciando o OpenSIPS==

Precisamos iniciar o OpenSIPS antes de mais nada, então para isso execute o comando abaixo.
/etc/init.d/opensips start

Se o sistema levantar, então é só dar sequencia, se não levantar, habilite as opções de debug do arquivo e então execute o comando abaixo para tnetar localizar o erro.
/etc/init.d/opensips debug

==Fazendo chamadas==

Para fazer as chamadas as instruções são:
LOCAL: 0 + 8 DIGITOS
LDN : 0 + DDD + 8 DIGITOS
LDI : 00 + NUMERO

Para chamar um usuário você pode discar o alias que voce atribuiu ou o proprio nome do usuário se for softphone

Mike:

O '''OpenSIPS''' prove varios tipos de variaveis para serem usados no script de roteamento, as diferenças entre os tipos de variaveis são:
* 1. A visibilidade da variavel
* 2. Onde a variavel é relacionada (onde a mesma reside)
* 3. Status read-write da variavel ( algumas variaveis são apenas de leitura)
* 4. Como multiplos valores (da mesma variavel) são manipulados.

As variáveis do '''OpenSIPS''' podem facilmente ser identificadas no script apartir de seus nomes (ou nota'ões) iniciando com o simbolo '''$'''

Sintaxe:

A sintaxe completa de uma pseudo-variavel é:

$('<context>'''name'''(subname)[index]{transformation}'')

The fields written in green are optional.
The fields meaning is:
* '''name'''(compulsory) - the pseudo-variable name(type).\\
Ex: pvar, avp, ru, DLG_status, etc.
* '''subname''' - the identifier of a certain pv from the given type.\\
Ex: hdr(From), avp(name).
* '''index''' - a pv can store more than one value - it can refer to a list of values. You can access a certain value from the list if you specify its index. You can also specify indexes with negative values, -1 means the last inserted, -2 the value before the previous inserted one.
* '''transformation''' - a series of processing actions can be applied on pseudo-variable. You can find the whole list of possible transformations [[Documentation.Script-Tran-1-9| here]]. The transformations can be cascaded, using the output of one transformation as the input of another.
* '''context''' - the context in which the pseudo0variable will be evaluated. Now there are 2 pv contexts: reply and request. The reply context can be used in the failure route to request for the pseudo-variable to be evaluated in the context of the reply message. The request context can be used if in a reply route is desired for the pv to be evaluated in the context of the corresponding request.

Usage examples:
* Only '''name''': %green%$ru
* '''Name''' and '''subname'': %green%$hdr(Contact)%%
* '''Name''' and '''index''': %green%$(ct[0])%%
* '''Name''', '''subname''' and '''index''': %green%$(avp(i:10)[2])
* '''Context'''
** %green%$(<request>ru)%% from a reply route will get the Request-URI from the request
** %green%$(<reply>hdr(Contact))%% context can be used from failure route to access information from the reply

Types of variables:

* [[#varscript | '''script variables''']] - as the name says, these variables are strictly bound to the script routes. The variables are visible only in the routing blocks - they are not message or transaction related, but they are process related (script variables will be inherited by script routes executed by the same '''OpenSIPS''' process).\\
Script variables are read write and they can have integer or string values. A script variable can have only a single value. A new assignment (or write operation) will overwrite the existing value.

* [[#varavps | '''AVP - Attribute Value Pair''']] - the AVPs are dynamic variables (as name) that can be created - the AVPS are linked to a singular message or transaction (if stateful processing is used). A message or a transaction will initially (when received or created) have an empty list of AVPS attached to it. During the routing script, the script directly or functions called from script may create new AVPS that will automatically attached to the message/transaction. The AVPS will be visible in all routes where any message (reply or request) of the transaction will be processed - branch_route , failure_route, onreply_route (for this last route you need to enable the TM parameter ''onreply_avp_mode'').\\
AVPs are read write and an existing AVP can be even deleted (removed). An AVP may contain multiple values - a new assignment (or write operation) will add a new value to the AVP; the values are kept in "last added first to be used" order (stack).

* [[#varpv | '''pseudo variables''']] - pseudo-variables (or PV) provide access to information from the processed SIP message (headers, RURI, transport level info, a.s.o) or from '''OpenSIPS''' inners (time values, process PID, return code of a function). Depending of what info they provide, the PVs are either bound to the message, either to nothing (global). Most of the PVs are read-only and only several allow write operations. A PV may return several values or only one, depending of the referred info (if can have multiple values or not).\\
Standard PV is read-only and returns a single value (if not otherwise documented).

* [[#varesc | '''escape sequences''']] - escape sequences used to format the strings; they are actually not variables, but rather formatters.

[[#varscript]]
!!!Script variables

'''Naming''': **$var(name)**

'''Hints''':
# if you want to start using a script variable in a route, better initialize it with same value (or reset it), otherwise you may inherit a value from a previous route that was executed by the same process.
# script variables are faster the AVPs, being referenced directly to memory location.
# the value of script variables persists over a '''OpenSIPS''' process.
# a script value can have only one value.

Example of usage:

[@
$var(a) = 2; # sets the value of variable 'a' to integer '2'
$var(a) = "2"; # sets the value of variable 'a' to string '2'
$var(a) = 3 + (7&(~2)); # arithmetic and bitwise operation
$var(a) = "sip:" + $au + "@" + $fd; # compose a value from authentication username and From URI domain

# using a script variable for tests
if( [ $var(a) & 4 ] ) {
xlog("var a has third bit set\n");
}
@]

Setting a variable to NULL is actually initializing the value to integer '0'. Script variables don't have NULL value.

[[#varavps]]
!!!AVP variables

'''Naming''': **$avp(name)** or **$(avp(name)[N])**

When using the index "N" you can force the AVP to return a certain value (the N-th value). If no index is given, the first value will be returned.

'''Hints''':
# to enable AVPs in onreply_route, use "modparam("tm", "onreply_avp_mode", 1)"
# if multiple values are used for a single AVP, the values are index in revert order than added
# AVPs are part of the transaction context, so they will be visible everywhere where the transaction is present.
# the value of an AVP can be deleted

Example of usage:
# Transaction persistence example
[@
# enable avps in onreply route
modparam("tm", "onreply_avp_mode", 1)
...
route{
...
$avp(tmp) = $Ts ; # store the current time (at request processing)
...
t_onreply("1");
t_relay();
...
}

onreply_route[1] {
if (t_check_status("200")) {
# calculate the setup time
$var(setup_time) = $Ts - $avp(tmp);
}
}
@]

# Multilple values example
[@
$avp(17) = "one";
# we have a single value
$avp(17) = "two";
# we have two values ("two","one")
$avp(17) = "three";
# we have three values ("three","two","one")

xlog("accessing values with no index: $avp(17)\n");
# this will print the first value, which is the last added value -> "three"

xlog("accessing values with no index: $(avp(17)[2])\n");
# this will print the index 2 value (third one), -> "one"

# remove the last value of the avp; if there is only one value, the AVP itself will be destroyed
$avp(17) = NULL;

# delete all values and destroy the AVP
avp_delete("$avp(17)/g");

# delete the value located at a certain index
$(avp(17)[1]) = NULL;

#overwrite the value at a certain index
$(avp(17)[0]) = "zero";
@]

The '''AVPOPS''' module provides a lot of useful functions to operate AVPs (like checking values, pushing values into different other locations, deleting AVPs, etc).

[[#varpv]]
!!!Pseudo Variables

'''Naming''': $name

'''Hints''':
# the PV tokens can be given as parameters to different script functions and they will be replaced with a value before the execution of the function.
# most of PVs are made available by '''OpenSIPS''' core, but there are also module exporting PV (to make available info specific to that module) - check the modules documentation.

Predefined (provided by core) PVs are listed in alphabetical order.

!!!!URI in SIP Request's P-Asserted-Identity header

'''$ai''' - reference to URI in request's P-Asserted-Identity header (see RFC 3325)

!!!!Authentication Digest URI

'''$adu''' - URI from Authorization or Proxy-Authorization header. This URI is used when calculating the HTTP Digest Response.

!!!!Authentication realm

'''$ar''' - realm from Authorization or Proxy-Authorization header

!!!!Auth username user

'''$au''' - user part of username from Authorization or Proxy-Authorization header

!!!!Auth username domain

'''$ad''' - domain part of username from Authorization or Proxy-Authorization header

!!!!Auth nonce

'''$an''' - the nonce from Authorization or Proxy-Authorization header

!!!!Auth response

'''$auth.resp''' - the authentication response from Authorization or Proxy-Authorization header

!!!!Auth nonce

'''$auth.nonce''' - the nonce string from Authorization or Proxy-Authorization header

!!!!Auth opaque

'''$auth.opaque''' - the opaque string from Authorization or Proxy-Authorization header

!!!!Auth algorithm

'''$auth.alg''' - the algorithm string from Authorization or Proxy-Authorization header

!!!!Auth QOP

'''$auth.qop''' - the value of qop parameter from Authorization or Proxy-Authorization header

!!!!Auth nonce count (nc)

'''$auth.nc''' - the value of nonce count parameter from Authorization or Proxy-Authorization header

!!!!Auth whole username

'''$aU''' - whole username from Authorization or Proxy-Authorization header

!!!!Acc username

'''$Au''' - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise.

!!!!Argument options

'''$argv''' - provides access to command line arguments specified with '-o' option.
Examples:
[@
# for option '-o foo=0'
xlog("foo is $argv(foo) \n");
@]

!!!!Branch flags

'''$bf''' - displays a list with the branch flags set for the current SIP request

!!!!Branch flags (hexadecimal) %red%(Removed in OpenSIPS 1.9)%%

'''$bF''' - reference to branch flags - hexa output

!!!!Branch

'''$branch''' - this variable is used for creating new branches by writing into it the value of a SIP URI.
Examples:
[@
# creates a new branch
$branch = "sip:new@doamin.org";
# print its URI
xlog("last added branch has URI $(branch(uri)[-1]) \n");
@]

!!!!Branch fields

'''$branch()''' - this variable provides read/write access to all fields/attributes of an already existing branch (priorly created with append_branch() ). The fields of the branch are:
* uri - the RURI of the branch (string value)
* duri - destination URI of the branch (outbound proxy of the branch) (string value)
* q - q value of the branch (int value)
* path - the PATH string for this branch (string value)
* flags - the branch flags of this branch (int value)
* socket - the local socket to be used for relaying this branch (string value)
The variable accepts also index '''$(branch(uri)[1])''' for accessing a specific branch (multiple branches can be defined at a moment). The index starts from 0 (first branch). If the index is negative, it is considered the n-th branch from the end ( index -1 means the last branch).\\
To get all branches, use the * index - $(branch(uri)[*]).\\
Examples:
[@
# creates the first branch
append_branch();
# creates the second branch
force_send_socket(udp:192.168.1.10:5060);
$du = "sip:192.168.2.10";
append_branch("sip:foo@bar.com","0.5");

# display branches
xlog("----- branch 0: $(branch(uri)[0]) , $(branch(q)[0]), $(branch(duri)[0]), $(branch(path)[0]), $(branch(flags)[0]), $(branch(socket)[0]) \n");
xlog("----- branch 1: $(branch(uri)[1]) , $(branch(q)[1]), $(branch(duri)[1]), $(branch(path)[1]), $(branch(flags)[1]), $(branch(socket)[1]) \n");

# do some changes over the branches
$branch(uri) = "sip:user@domain.ro"; # set URI for the first branch
$(branch(q)[0]) = 1000; # set to 1.00 for the first branch
$(branch(socket)[1]) = NULL; # reset the socket of the second branch
$branch(duri) = NULL; # reset the destination URI or the first branch
@]

%red%It is R/W variable (you can assign values to it from routing logic)%%

!!!!Call-Id

'''$ci''' - reference to body of call-id header

!!!!Content-Length

'''$cl''' - reference to body of content-length header

!!!!CSeq number

'''$cs''' - reference to cseq number from cseq header

!!!!Contact instance

'''$ct''' - reference to contact instance/body from the contact header. A contact instance is display_name + URI + contact_params. As a Contact header may contain multiple Contact instances and a message may contain multiple Contact headers, an index was added to the $ct variable:
* $ct -first contact instance from message
* $(ct[n]) - the n-th contact instance form the beginning of message, starting with index 0
* $(ct[-n]) - the n-th contact instance form the end of the message, starting with index -1 (the last contact instance)

!!!!Fields of a contact instance

'''$ct.fields()''' - reference to the fields of a contact instance/body (see above). Supported fields are:
* name - display name
* uri - contact uri
* q - q param (value only)
* expires - expires param (value only)
* methods - methods param (value only)
* received - received param (value only)
* params - all params (including names)

Examples:
* $ct.fields(uri) - the URI of the first contact instance
* $(ct.fields(name)[1]) - the display name of the second contact instance

!!!!Content-Type

'''$cT''' - reference to body of content-type header

!!!!Domain of destination URI

'''$dd''' - reference to domain of destination uri

%red%It is R/W variable (you can assign values to it from routing logic)%%

!!!!Diversion header URI

'''$di''' - reference to Diversion header URI

!!!!Diversion "privacy" parameter

'''$dip''' - reference to Diversion header "privacy" parameter value

!!!!Diversion "reason" parameter

'''$dir''' - reference to Diversion header "reason" parameter value

!!!!Port of destination URI

'''$dp''' - reference to port of destination uri

%red%It is R/W variable (you can assign values to it from routing logic)%%

!!!!Transport protocol of destination URI

'''$dP''' - reference to transport protocol of destination uri

!!!!Destination set

'''$ds''' - reference to destination set

!!!!Destination URI

'''$du''' - reference to destination uri (outbound proxy to be used for sending the request)
If loose_route() returns TRUE a destination uri is set according to the first Route header.

%red%It is R/W variable (you can assign values to it from routing logic)%%

!!!!Error class

'''$err.class''' - the class of error (now is '1' for parsing errors)

!!!!Error level

'''$err.level''' - severity level for the error

!!!!Error info

'''$err.info''' - text describing the error

!!!!Error reply code

'''$err.rcode''' - recommended reply code

!!!!Error reply reason

'''$err.rreason''' - recommended reply reason phrase

!!!!From URI domain

'''$fd''' - reference to domain in URI of 'From' header

!!!!From display name

'''$fn''' - reference to display name of 'From' header

!!!!Forced socket

'''$fs''' - reference to the forced socket for message sending (if any) in the form proto:ip:port

%red%It is R/W variable (you can assign values to it routing script)%%

!!!!From tag

'''$ft''' - reference to tag parameter of 'From' header

!!!!From URI

'''$fu''' - reference to URI of 'From' header

!!!!From URI username

'''$fU''' - reference to username in URI of 'From' header

!!!!SIP message buffer

'''$mb''' - reference to SIP message buffer

!!!!Message Flags

'''$mf''' - displays a list with the message/transaction flags set for the current SIP request

!!!!Message Flags (hexadecimal) %red%(Removed in OpenSIPS 1.9)%%

'''$mF''' -reference to message/transaction flags set for current SIP request in hexa

!!!!SIP message ID

'''$mi''' - reference to SIP message id

!!!!SIP message length

'''$ml''' - reference to SIP message length

!!!!Domain in SIP Request's original URI

'''$od''' - reference to domain in request's original R-URI

!!!!Port of SIP request's original URI

'''$op''' - reference to port of original R-URI

!!!!Transport protocol of SIP request original URI

'''$oP''' - reference to transport protocol of original R-URI

!!!!SIP Request's original URI

'''$ou''' - reference to request's original URI

!!!!Username in SIP Request's original URI

'''$oU''' - reference to username in request's original URI

!!!!Route parameter
'''$param(idx)''' - retrieves the parameters of the route. The index can be an integer, or a pseudo-variable (index starts at 1).\\
Example:
[@
route {
...
$var(debug) = "DBUG:"
route(PRINT_VAR, $var(debug), "param value");
...
}

route[PRINT_VAR] {
$var(index) = 2;
xlog("$param(1): The parameter value is <$param($var(index))>\n");
}
@]

!!!!Domain in SIP Request's P-Preferred-Identity header URI

'''$pd''' - reference to domain in request's P-Preferred-Identity header URI (see RFC 3325)

!!!!Display Name in SIP Request's P-Preferred-Identity header

'''$pn''' - reference to Display Name in request's P-Preferred-Identity header (see RFC 3325)

!!!!Process id

'''$pp''' - reference to process id (pid)

!!!!Protocol of received message
'''$pr''' or '''$proto''' - protocol of received message (UDP, TCP, TLS, SCTP)

!!!!User in SIP Request's P-Preferred-Identity header URI

'''$pU''' - reference to user in request's P-Preferred-Identity header URI (see RFC 3325)

!!!!URI in SIP Request's P-Preferred-Identity header

'''$pu''' - reference to URI in request's P-Preferred-Identity header (see RFC 3325)

!!!!Domain in SIP Request's URI

'''$rd''' - reference to domain in request's URI

%red%It is R/W variable (you can assign values to it routing script)%%

!!!!Body of request/reply

'''$rb''' - reference to message body

!!!!Returned code

'''$rc''' - reference to returned code by last invoked function

'''$retcode''' - same as **$rc**

!!!!Remote-Party-ID header URI

'''$re''' - reference to Remote-Party-ID header URI

!!!!SIP request's method

'''$rm''' - reference to request's method

!!!!SIP request's port

'''$rp''' - reference to port of R-URI

%red%It is R/W variable (you can assign values to it routing script)%%

!!!!Transport protocol of SIP request URI

'''$rP''' - reference to transport protocol of R-URI

!!!!SIP reply's reason

'''$rr''' - reference to reply's reason

!!!!SIP reply's status

'''$rs''' - reference to reply's status

!!!!Refer-to URI

'''$rt''' - reference to URI of refer-to header

!!!!SIP Request's URI

'''$ru''' - reference to request's URI

%red%It is R/W variable (you can assign values to it routing script)%%

!!!!Username in SIP Request's URI

'''$rU''' - reference to username in request's URI

%red%It is R/W variable (you can assign values to it routing script)%%

!!!!Q value of the SIP Request's URI

'''$ru_q''' - reference to q value of the R-URI

%red%It is R/W variable (you can assign values to it routing script)%%

!!!!Received IP address

'''$Ri''' - reference to IP address of the interface where the request has been received

!!!!Received port

'''$Rp''' - reference to the port where the message was received

!!!!Script flags

'''$sf''' - displays a list with the script flags set for the current SIP request

!!!!Script flags (hexadecimal) %red%(Removed in OpenSIPS 1.9)%%

'''$sF''' - reference to script flags - hexa output

!!!!IP source address

'''$si''' - reference to IP source address of the message

!!!!Source port

'''$sp''' - reference to the source port of the message

!!!!To URI Domain

'''$td''' - reference to domain in URI of 'To' header

!!!!To display name

'''$tn''' - reference to display name of 'To' header

!!!!To tag

'''$tt''' - reference to tag parameter of 'To' header

!!!!To URI

'''$tu''' - reference to URI of 'To' header

!!!!To URI Username

'''$tU''' - reference to username in URI of 'To' header

!!!!Formatted date and time

'''$time(format)''' - returns the string formatted time according to UNIX date (see: '''man date''').

!!!!Branch index

'''$T_branch_idx''' - the index (starting with 1 for the first branch) of the branch for which is executed the branch_route[]. If used outside of branch_route[] block, the value is '0'. This is exported by TM module.

!!!!String formatted time

'''$Tf''' - reference string formatted time

!!!!Current unix time stamp in seconds

'''$Ts''' - reference to current unix time stamp in seconds

!!!!Current microseconds of the current second

'''$Tsm''' - reference to current microseconds of the current second

!!!!Startup unix time stamp

'''$TS''' - reference to startup unix time stamp

!!!!User agent header

'''$ua''' - reference to user agent header field

!!!!SIP Headers

'''$(hdr(name)[N])''' - represents the body of the N-th header identified by 'name'. If [N] is omitted then the body of the first header is printed. The first header is got when N=0, for the second N=1, a.s.o. To print the last header of that type, use -1, no other negative values are supported now. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all headers of that type are printed.

The module should identify most of compact header names (the ones recognized by '''OpenSIPS''' which should be all at this moment), if not, the compact form has to be specified explicitly. It is recommended to use dedicated specifiers for headers (e.g., %ua for user agent header), if they are available -- they are faster.

'''$(hdrcnt(name))''' -- returns number of headers of type given by 'name'. Uses same rules for specifying header names as '''$hdr(name)''' above. Many headers (e.g., Via, Path, Record-Route) may appear more than once in the message. This variable returns the number of headers of a given type.

Note that some headers (e.g., Path) may be joined together with commas and appear as a single header line. This variable counts the number of header lines, not header values.

For message fragment below, '''$hdrcnt(Path)''' will have value 2 and '''$(hdr(Path)[0])''' will have value '''<a.com>''':
[@
Path: <a.com>
Path: <b.com>
@]

For message fragment below, '''$hdrcnt(Path)''' will have value 1 and '''$(hdr(Path)[0])''' will have value '''<a.com>,<b.com>''':
[@
Path: <a.com>,<b.com>
@]

Note that both examples above are semantically equivalent but the variables take on different values.

[[#varavps]]

!!!Escape Sequences

These sequences are exported, and mainly used, by xlog module to print messages in many colors (foreground and background) using escape sequences.

!!!!Foreground and background colors

$C(xy) - reference to an escape sequence. ¿x¿ represents the foreground color and ¿y¿ represents the background color.

Colors could be:

* x : default color of the terminal
* s : Black
* r : Red
* g : Green
* y : Yellow
* b : Blue
* p : Purple
* c : Cyan
* w : White

!!!!Examples

A few examples of usage.

[@
...
route {
...
$avp(uuid)="caller_id";
$avp(tmp)= $avp(uuid) + ": " + $fu;
xdbg("$(C(bg))avp(tmp)$(C(xx)) [$avp(tmp)] $(C(br))cseq$(C(xx))=[$hdr(cseq)]\n");
...
}
...
@]