-
<!--'''Welcome to the new Yate Wiki Project. This site is currently in development. Please fell free to help us to improve this Wiki!
|+ align="bottom" style="color:#e76700;" |[[File:yate.png|frameless|Yate]] ''Yate Documentation''
8 KB (1,086 words) - 09:08, 31 July 2018
-
Yate is available for multiple platforms.
...o to [[Download| download page]] to see on which platforms you can install Yate.
940 B (131 words) - 09:31, 4 November 2013
-
Yate is available for multiple platforms.
...re some official packages released on [http://yate.null.ro/tarballs/yate6/ Yate Download] for Windows and Mageia Linux.
4 KB (547 words) - 14:06, 17 March 2023
-
...33''' Send DTMFs as RFC2833 RTP signals. This method will be used if media is started and remote party advertised telephone event support in SDP.
...d, the tone generator module is loaded and there is a translator from PCM (yate 'slin' format) to current rtp format.
3 KB (493 words) - 08:59, 4 November 2013
-
A conference room is an N-way audio mixer to which an arbitrary number of conference legs are at
...fic room name, if the ''NAME'' is empty a new, unique conference room name is generated
6 KB (936 words) - 10:35, 4 November 2013
-
The '''VoIP Server''' is the piece of software that the client connects to it to make or to receive
... functionalities in general and an overview of the Yate Server components. Yate Server can control all the types of communication that could take part in a
5 KB (862 words) - 13:42, 21 March 2013
-
One of the most common features requested for Yate is proxying between the H.323 and SIP protocols. This allows equipment that on
[[File:yate_h323toSIP.png]]
6 KB (974 words) - 15:24, 31 October 2013
-
Yate can be used as a VoIP Client.
First of all you mustn’t think on the YateClient as being a totally different component beside the server.
3 KB (473 words) - 08:02, 3 April 2013
-
...tended. Voice, video, data and instant messenging can all be unified under Yate's flexible routing engine, maximizing communications efficiency and minimiz
==Yate usability==
3 KB (376 words) - 12:42, 4 November 2013
-
Yate has the functionality of a VoIP - PSTN gateway. It's main task is to provide signaling interworking and to transform the information it recei
Yate can be configured as a gateway from SIP to ISDN or from SIP to SS7(ISUP) by
10 KB (1,440 words) - 16:11, 31 October 2013
-
... the conclusion that H323 is pretty much the same thing as SIP. Often H323 is associated only with the call signaling part of a VoIP transmission. Actual
...n entire suite of protocols. The exact definition of H323 states that H323 is a recommendation published by the International Telecommunications Union (I
4 KB (562 words) - 15:04, 19 November 2012
-
...gistering and redirect just to mention a few. The implementation of SIP it is done using a VoIP SIP driver based on [[YASS]] library.
== Yate - SIP router ==
4 KB (564 words) - 14:00, 13 May 2013
-
...ocol for communication among others. Besides the SIP router functionality, Yate also can be used like a '''SIP border controller'''.
== What's SIP Border Controller? ==
2 KB (385 words) - 07:27, 27 May 2013
-
The Session Initiation Protocol provides the REGISTER functionality that is used mainly in a proxy configuration case. <br>
This is used to locate individual users in case of a call, which is similar to an INVITE message sent to the server.
3 KB (452 words) - 12:06, 11 April 2013
-
[[File:Yate_jingle_server_with jabber_account.png]]
Since jabberclient is a client module, it's not loaded when Yate is running in server mode. You must explicitly load it.
3 KB (432 words) - 15:20, 31 October 2013
-
'''Note:''' The options=allowplainauth parameter is required, otherwise login will fail.
... to set the gmail account in accfile so Yate will register to it. Then set Yate Server with Jingle in client mode.
2 KB (343 words) - 09:20, 4 November 2013
-
Yate has multiple routing modules. A routing module is a module that handles (sees) the [[call.route]] message.
...nation of modules. If more than one module is used, then the priority that is set in each configuration file determines the order of the modules processi
3 KB (433 words) - 09:01, 10 March 2016
-
When a cluster of multiple servers is used it is important to be able to tell the members of the cluster apart. For this pur
...ration file (usually '''yate.conf'''). A further highest priority override is provided by the '''-N''' command line parameter so the node name can be cha
1 KB (206 words) - 10:51, 15 October 2012
-
The OpenH323 library together with matching PWLib are available at: http://yate.null.ro/tarballs/openh323/
...H323 and PWLib to be installed in '''/usr''' directory. Recent versions of Yate will detect them from '''/usr/local''' as well but if you have multiple ver
3 KB (425 words) - 13:36, 13 December 2013
-
...es the routes using a configuration file in which each number or parameter is matched using regular expressions.
...d in a message parameter named '''context'''. Note that the preroute stage is skipped if the message already has a '''context''' parameter.
20 KB (3,110 words) - 10:27, 4 November 2013
-
...lt negotiation does not take into account possible transcodings since this is route dependent.<br>
Transcoding can work only if RTP passes through Yate. When ''rtp_forward'' is enabled transcoding won't work and you must '''not''' add formats to the li
2 KB (301 words) - 11:06, 3 April 2013
-
This module allows controlling Yate using a simple telnet client.
By controlling Yate means that from a remote console you can:
7 KB (1,041 words) - 13:24, 4 June 2014
-
This is a short list of commands that can be issued from the [[rmanager]] command l
...ds are available even when authentication is configured and the connection is not yet authenticated.
2 KB (335 words) - 13:12, 13 May 2013
-
Yate provides Debugging info on console.
The modalities to enable debug in Yate are:
6 KB (819 words) - 14:08, 16 August 2023
-
* is used for authentication, registration, and routing users stored in a databa
[yateadmin]
14 KB (2,155 words) - 10:47, 11 January 2014
-
Below you can find the database schema for PostgreSQL and MySQL for using yate's [[register]] module.
One of our users suggested a more complex approach. Below is the CDR table with an equivalent MySQL-Function to be called on cdr_insert,
7 KB (1,027 words) - 13:28, 6 August 2020
-
This is done from enumroute.conf file.
; priority: int: Priority in Yate's handlers chain
3 KB (500 words) - 10:28, 4 November 2013
-
This module is used to route a call to multiple alternative targets. The first target that
A call fork is implemented by connecting the incoming call to a ''fork master''.
12 KB (1,844 words) - 11:24, 5 June 2014
-
Regfile is a registration module. It can be used for autentication, registration, and
... another server. The user can use any protocol that allows registration in Yate like SIP, H323, IAX or Jabber.<br>
4 KB (539 words) - 13:59, 31 October 2013
-
...a user registers (on any protocol) the name of the server it registered to is added in front of the user's location.
...walls and NAT and with calls accepted only from the registrar the endpoint is connected to.
3 KB (521 words) - 13:52, 31 October 2013
-
...g inwards Yate and a routing decision needs to be made. The returned value is the logical destination of the call.
...rbitrary value. It must match one of the values defined and implemented in Yate.
2 KB (383 words) - 16:07, 18 November 2013
-
In order to route outside, a gateway is required. To set the gateway you must configure it in [[Accfile|accfile.con
This is the example.js script. <br>
3 KB (425 words) - 10:03, 22 March 2015
-
...es and signalling modules. Here you can find some how to's for configuring Yate using different modules.
{|class="yate-table"
9 KB (1,376 words) - 10:01, 27 October 2017
-
...oe'' is found in regfile.conf, and the originally called number ''123456'' is routed to the user ''johndoe''.
1 KB (151 words) - 13:58, 31 October 2013
-
The main Yate startup configuration is stored in the file yate.conf.
...has to be named "yate-service.conf" if you are running it as a service or "yate-console.conf" while running the console version.
3 KB (440 words) - 13:59, 31 October 2013
-
...slated back into protocol specific codes hopefully an adequate translation is choosen.
...o equivalent in other protocols. For telephony the most important encoding is [http://www.itu.int/rec/T-REC-Q.850/e Q.850] defining cause and location co
3 KB (380 words) - 09:25, 4 November 2013
-
Yate supports RTP forwarding and SDP forwarding (currently only in SIP).<br/>
...rding allows sending any media type or codec, even those not understood by Yate.<br/>
3 KB (449 words) - 09:20, 13 August 2013
-
The Accfile module is used to register Yate to outside gateways to terminate calls. The accounts that are defined in ac
...information will be configured in a file: accfile.conf. A basic connection is defined by: protocol, username, password and the server ip.
8 KB (1,225 words) - 10:07, 6 July 2018
-
The ability of handling a large number of calls is not only a matter of Yate configuration but also of system setup. Hardware devices and VoIP protocols
* CPU number (or cores) - The more you have the best Yate will behave. Hyperthreading also helps but less.
4 KB (758 words) - 16:06, 31 October 2013
-
...a bigger flexibility than with plain functions, mainly because messages in Yate can have an arbitrary number of parameters, and can be sent to more than on
Yate's four main components are:
811 B (119 words) - 13:48, 13 February 2013
-
...orts the Jingle protocol. The configuration file for Jingle channel module is yjinglechan.conf.
...he module detects Yate's run mode and behaves accordingly (as a Server, if is not set, otherwise reads run mode from configuration file).
9 KB (1,391 words) - 09:14, 4 November 2013
-
The implementation of SIP it is done using a VoIP SIP driver based on [[YASS]] library.
Yate can be used as a:
8 KB (1,261 words) - 08:43, 4 November 2013
-
The Session Initiation Protocol(SIP) is an signaling protocol widely used for controlling communication sessions su
{|class="yate-table"
8 KB (1,083 words) - 11:49, 27 October 2017
-
SIP routing in Yate can be done from a single routing module or from a combination of modules.
Another way to route the calls is by using a SIP line(gateway) configured in accfile.conf.
3 KB (422 words) - 08:08, 23 November 2017
-
The configuration file for this module is h323chan.conf.
==Compiling Yate with OpenH323 library==
13 KB (1,916 words) - 09:08, 4 November 2013
-
The '''chan.startup''' message is sent by channel modules when a new channel is instantiated.
...erefore make assumptions about the channel's state at the time the message is received.
1 KB (173 words) - 10:23, 21 January 2013
-
:::the module and module-specific address that is expected (by means of the routing decision) to service the call
''At least for Yate-0.9-CVS'', driver has been renamed to module.
2 KB (314 words) - 13:18, 22 January 2013
-
First, there is nothing to configure with the dumbchan module.
It is only useful for programmers developing applications with YATE. If the description below doesn't make sense to you, you don't need it so d
2 KB (400 words) - 10:10, 4 November 2013
-
Yate has a [[wavefile]] module which is capable of playing audio in a number of formats.
'''The output format should always be mono, 8 kHz as that is required for telephony.'''
2 KB (292 words) - 09:06, 8 October 2012
-
...e implementation of SIP protocol. It only depends on libyate and therefore is very small and flexible.
It can be found in Yate directory libs/ysip.
263 B (48 words) - 11:05, 13 December 2012
-
This documentation has been extracted from the source of ''Yate-0.9-CVS'' and as such it might not be accurate -- technically or semantical
This message is sent by a telephony channel (like ysipchan, h323chan, yiaxchan) when it got
960 B (147 words) - 10:35, 21 January 2013
-
This documentation has been extracted from the source of ''Yate-0.9-CVS'' and as such it might not be accurate -- technically or semantical
The first call in a queue is dropped by sending the queue_name as id. If you want to drop a specific cal
916 B (142 words) - 10:38, 21 January 2013
-
'''engine.halt''' is a message sent by the engine to the modules that have a message handler reg
... them that Yate is stopping and this is the last chance to clean up before Yate kills all module threads.
609 B (91 words) - 11:26, 18 January 2013
-
...t the status of the modules. In fact "status" command from rmanager module is sending this message and each module has to fill one line in the returned v
status (this is the rmanager command)
1 KB (158 words) - 15:58, 18 January 2013
-
...ikipedia.org/wiki/Media_Gateway_Control_Protocol_%28MGCP%29 MGCP] allowing Yate to control analog or digital Media Gateways.
...appear as voice circuits so you need to reference them in the [http://docs.yate.ro/wiki/Analog analog] or [[Ysigchan|signaling module]].
8 KB (1,151 words) - 12:20, 26 October 2017
-
Yate can be monitored with [http://munin-monitoring.org/ Munin].
# This program is free software; you can redistribute it and/or
3 KB (332 words) - 16:02, 31 October 2013
-
... in most cases where Yate is not forwarding (not proxying) RTP traffic and is only doing the signalling work.
# Insure VMware Tools is installed and running
3 KB (545 words) - 16:03, 31 October 2013
-
The analog signaling types supported by Yate are FXO(Foreign Exchange Office) and FXS(Foreign Exchange Station).
This module is used to monitor analog lines(recorders).
17 KB (2,660 words) - 08:04, 21 June 2018
-
...g a standard factory for the common lower layer of SIGTRAN protocols. Here is where the IP addresses, ports and protocols are configured.
Each connection defined by this module is referenced from [[Ysigchan|ysigchan]] or some other module.
4 KB (573 words) - 14:09, 26 October 2017
-
'''Note:''' In Yate's terminology, FXS/FXO indicates the local (Yate) end of the line, not the remote one.
... API calls), not at startup. The configuration file is read when a request is processed.<br>
11 KB (1,770 words) - 10:23, 4 November 2013
-
The wanpipe devices must be started before starting Yate (use the wanrouter script to start all or specific wanpipe device(s)).
... API calls), not at startup. The configuration file is read when a request is processed.<br>
9 KB (1,147 words) - 10:13, 4 November 2013
-
The configuration file is yrtpchan.conf. Below you can see the sections and their description.
: This parameter is applied on reload.
6 KB (870 words) - 14:12, 10 January 2014
-
* modify Yate's configuration files in order to use it as H.323 GateKeeper;
* use YateClient as an H.323 client;
12 KB (2,088 words) - 15:15, 31 October 2013
-
Configuring Yate to act as a SIP Server and YateClient to act as a SIP Client.
* modify Yate's configuration files in order to use it as SIP server;
2 KB (381 words) - 15:16, 31 October 2013
-
Yate can be used as IAX Server and YateClient as IAX Client. This configuration will be done on platforms that have
The purpose of this document is:
12 KB (1,986 words) - 15:13, 31 October 2013
-
...cribe how to use command line with all his available options when starting Yate server on different platforms.
==Instructions to start Yate on linux==
4 KB (588 words) - 09:43, 8 December 2021
-
<font color="red">Note!</font> Yate works with H323plus support but it is not stable.
...s recommended [[OpenH323]] library which is the stable version to use with Yate.
962 B (148 words) - 09:10, 4 November 2013
-
...mmand line with all his available options when starting Yate as server and Yate Client.
To start Yate from a command line you must open a console window.
5 KB (770 words) - 08:44, 7 August 2013
-
...end DTMFs as RFC2833 RTP signals. This method will be used if external RTP is started and remote party advertised RFC2833 support.
...d, the tone generator module is loaded and there is a translator from PCM (yate 'slin' format) to current rtp format.
2 KB (298 words) - 09:11, 4 November 2013
-
Starting with Yate 4.2 or SVN revision 5234, Yate provides a protection mechanism against several types of SIP flood attacks.
The aim of this document is to provide information about this protection and how can it be used.
4 KB (598 words) - 15:43, 31 October 2013
-
This module is used when:
* a user is subscribed to receive notification if another user is called or has messages.
3 KB (456 words) - 09:16, 9 April 2015
-
'''resource.notify''' is a message sent by a module to notify a resource event state change or a sub
:Optional subscription termination reason if subscriptionstate is terminated
2 KB (219 words) - 15:22, 21 January 2013
-
...iate source packages for OpenH323 and PwLib from our web server at: http://yate.null.ro/tarballs/openh323/<br>
Now, let’s see what steps are to be followed after unzipping the packages.
4 KB (721 words) - 13:01, 8 January 2013
-
This page documents how to configure Yate to handle a SIP attended call transfer for an unknown call leg in the clust
'''REMEMBER: It is mandatory to choose node names that can be easily resolved to an IP address
3 KB (472 words) - 09:00, 4 November 2013
-
A listener is a way of telling Yate on which network interfaces to listen.<br>
Yate supports 3 types of listeners: TCP, TLS, UDP and allows you to bind Yate one one ore more network interfaces on different ports.<br>
3 KB (556 words) - 07:52, 31 May 2013
-
...tocol. The module is called yiaxchan and the associated configuration file is yiaxchan.conf.
This module is a VoIP IAX2 driver based on ours [[Yiax]] library.
16 KB (2,483 words) - 09:12, 4 November 2013
-
...e implementation of IAX protocol. It only depends on libyate and therefore is very small and flexible.
It can be found in Yate directory/contrib/yiax
232 B (38 words) - 14:38, 16 November 2012
-
This notes describe how the yate IAX library (YIAX) is implemented. Below are the components of the library and some basic scenari
: Holds a single text Information Element that is attached to a message.
3 KB (399 words) - 11:45, 4 November 2013
-
By default Yate loads modules relevant to its current running mode:
** if yjinglechan is loaded also all modules from the jabber subdirectory
12 KB (1,662 words) - 13:25, 1 October 2019
-
The alsachan module can be used either to test your Yate or to use Yate as a VoIP client with [http://www.alsa-project.org/ ALSA] drivers.
...meter you use to call it from the routing module. The default settings are what you are going to use in most cases.
885 B (146 words) - 09:56, 4 November 2013
-
This module can be used either to test your Yate setup or to use Yate as a VoIP client.
The osschan is intialized depending on what parameter you use to call it from the routing module.
489 B (90 words) - 09:56, 4 November 2013
-
...wpchan or zapchan. Faxing over VoIP using the G.711 A-law or mu-law codecs is possible but unreliable. You can provide tiff files or you can receive faxe
...wnloads/spandsp/spandsp-0.0.6pre3.tgz 0.0.6 pre 3], also available [http://yate.null.ro/tarballs/spandsp-0.0.6pre3.tgz here]. Other versions may not be det
6 KB (1,040 words) - 10:09, 4 November 2013
-
The module is used to play or record wave sounds. The wave sounds are kept in binary data
Or new syntax since Yate 3.3.3
3 KB (409 words) - 10:10, 4 November 2013
-
The module pgsqldb(or mysqdb) can be used to make the connection between Yate and one or more PostgreSQL(or MySQL) databases.
; This parameter is used as groups list separator in messages dispatched by the module
7 KB (1,026 words) - 09:22, 4 November 2013
-
This page describes the steps to follow to build a Jabber server using Yate.
== Install Yate==
21 KB (3,052 words) - 09:24, 4 November 2013
-
The module pgsqldb is used to make the connection between Yate and one or more PostgreSQL databases.
Then in Yate sources run:
5 KB (763 words) - 07:19, 10 June 2014
-
Module mysqldb is used to make the connection between Yate and one or more MySQL databases.
...tep, normally the libraries needed for MySQL will be corrected detected by Yate, if the MySQL packages were installed.<br>
5 KB (810 words) - 11:18, 4 November 2013
-
...tunity of inspecting events generated by the caller and giving commands to Yate - all these by handling or generating Messages.
...ule.yate exist (is compiled and/or installed) and is not disabled from the yate.conf file. Also in extmodule.conf make sure you specify a proper scripts_di
2 KB (408 words) - 15:09, 31 October 2013
-
This is a special module that allows intercepting and mangling ISUP messages that p
...age is dispatched allowing its parameters to be changed before the message is forwarded.
2 KB (359 words) - 13:06, 26 October 2017
-
...resses are not known in advance - like the phones or clients registered to Yate.
...bers are known - not their currently registered location. Other common use is the handling of some [[ENUM Routing|ENUM]] routes pointing back to PSTN.
2 KB (356 words) - 07:22, 23 May 2014
-
YRadius Module adds support for RADIUS in Yate to bill calls using well known RADIUS billing mechanism.
YRadius supports both Authentication (may be Authorization is the best term there) and Accounting. It doesn't support Authentification (R
7 KB (947 words) - 10:30, 4 November 2013
-
...oute is used to make a late route decision in Yate's message flow and fork is used to route the call to multiple targets.
An alternative to forking using lateroute was introduced from Yate 3.3.3, fork with distributive parameters. But in some cases, when routing t
3 KB (419 words) - 14:03, 31 October 2013
-
Cdrbuild module is the module that builds live CDRs (call detail records) and creates a list f
Then it sends the "[[call.cdr]]" message. This message is caught by different [[Modules#CDR modules|cdr modules]] that intend to writ
10 KB (1,558 words) - 13:22, 13 January 2014
-
... to write the CDRs(call detail record) into a file. The configuration file is cdrfile.conf.
Cdrfile is a module that receives a [[call.cdr]] message (maybe from [[CDR Build Modul
6 KB (754 words) - 13:14, 11 January 2014
-
...om the SIP answer (which is supposed to be a 3xx Redirect) the information is extracted according to the query type.
* ''callername'' - if set (even empty) a query is not performed unless overridden
5 KB (700 words) - 10:31, 4 November 2013
-
... automatically create a parking orbit and transfer the call) picking it up is a bit more complicated and requires scripting.
...?repname=yate&path=/trunk/share/scripts/pickup.php pickup.php] included in yate's svn.
913 B (136 words) - 11:07, 4 November 2013
-
...From telnet you can start/stop/restart an external module without stopping Yate (operations needed when you want to update the changes in your script).<br>
Connect to Yate through telnet:
2 KB (255 words) - 15:59, 31 October 2013
-
External Module allows you to use channel or global scripts in Yate.<br>
These modules can be started from Yate and communicate through pipes to the extmodule.<br>
3 KB (459 words) - 11:15, 4 November 2013
-
...' is for you to probe all the messages being generated and, or received by Yate.
The loading of msgsniff.yate is controlled by yate.conf like any other module.
17 KB (1,082 words) - 13:07, 18 August 2022
-
...ed for load testing. It can generate large number of calls originated from Yate on an arbitrary protocol or to some number.
...rolled from the rmanager as it processes "engine.command" messages or from Yate's command line.
3 KB (388 words) - 11:12, 4 November 2013
-
...t works by analyzing if a probe signal generated by the [[tonegen]] module is received altered.
...nterruptions), cracks, stutter and short audio loops. The reported quality is not related to the subjective voice quality factor.
2 KB (376 words) - 07:16, 23 May 2014
-
This module is used to reject calls based on CPU load (depends on [[cpuload]]).
; This file is used by the ccongestion module
1 KB (139 words) - 11:26, 4 November 2013
-
; NOTE this file is used to setup CPU load information's
; The cpuload module inform YATE about system total CPU load and YATE CPU load
3 KB (424 words) - 12:54, 18 July 2016
-
...//yate.null.ro/mibs/YATE-MIB.txt YATE-MIB] definitions files (found in the YATE source directory in the ''share/data'' folder).
...th Net-SNMP by having the NULL-TEAM OIDs proxied by the Net-SNMP server to YATE.
11 KB (1,779 words) - 11:28, 4 November 2013
-
...nfiguration files directory]]: '''conf.d''' that is in the directory where Yate was build.<br>
This files are used to pass variables to a running Yate instance.
4 KB (706 words) - 11:47, 19 December 2022
-
...prefix of the name is turned in the file name and an extension of ''.log'' is added.
...turned into the file name. Most special characters and anything after them is removed:
2 KB (305 words) - 11:30, 4 November 2013
-
This module is used to monitor:
; after how many Yate restarts should the monitor send an alarm.
5 KB (817 words) - 11:29, 4 November 2013
-
...tocol. The module is called ysipchan and the associated configuration file is ysipchan.conf.
This module is a VoIP SIP driver based on [[YASS]] library.
25 KB (3,811 words) - 10:09, 6 July 2018
-
...ocols was added in Yate. Some of this modules are in the public version of Yate while others aren't.
Introductory information on SS7 is available for free on the Internet from various sources.
2 KB (263 words) - 08:25, 15 August 2013
-
... to solve the common problems with lossing voice when passing through NAT, YATE uses the RTP stream's IP+Port instead of the RTP IP+Port declared in SDP in
This small hack allows most of the SIP CLIENTS when Yate is the SERVER to pass the voice over NAT.
622 B (104 words) - 09:04, 4 November 2013
-
... as a SIP Client. An implementation for this is [http://yateclient.yate.ro Yate Client].
As a SIP Client, Yate has the following features:
2 KB (272 words) - 08:57, 4 November 2013
-
There are 4 modules for CDR in Yate:
...ills you received from other service providers, you will need to configure YATE to record [http://en.wikipedia.org/wiki/Call_detail_record CDRs]. CDRs can
7 KB (1,094 words) - 12:55, 11 January 2014
-
6th of August 2008, Yate and OpenSIPS (former OpenSER) join to build IP based clusters
Bucharest, Romania - August 6, 2008 - YATE Project and OpenSIPS decided to enhance the already informal collaboration
2 KB (343 words) - 15:13, 30 October 2012
-
This document assesses an approachable way to set your Yate server to handle all your Google Voice calls (both incoming and outgoing) -
* Yate/YateClient 4.1
8 KB (1,258 words) - 15:25, 31 October 2013
-
This document aims to describe the directories used by YATE and their location depending on the various operating systems that are used
Yate uses the following directories:
8 KB (1,314 words) - 09:40, 4 November 2013
-
An [[wikipedia:IVR|IVR]] ('''I'''nteractive '''v'''oice '''r'''esponse) is an application that can be used for playing prompts to users, register mess
From Yate's point of view the IVR (the application behind it) is just a channel. It can be written in any programming language.
3 KB (471 words) - 18:55, 10 March 2014
-
...ge all the other modules that are dependent, and also because we can debug what's happening much easier since we know which module passes which data to ano
[[File:yate-architecture.png]]
8 KB (1,217 words) - 20:38, 10 March 2014
-
The main library written in PHP is libyate.php that can be found in Yate's sources '''~/share/scripts'''. <br>
...our own scripts to handle events, send messages or set message handlers in Yate using [[External Module|external module]].
1 KB (168 words) - 07:23, 23 May 2014
-
... It allows to write YATE modules in PYTHON. PYTHON modules comunicate with YATE core via external protocol or run in python interperter embedded in pymodul
...s/core/documentation/howto/index.html Twisted] framework. Twisted project is very well documented, so look there for in-depth explanations of deferreds
5 KB (788 words) - 11:53, 4 November 2013
-
Here is a toy ivr. It routes calls to number 'ivr' to DumbChannel, answers them, th
def route(yate):
2 KB (223 words) - 11:54, 4 November 2013
-
...pt is given as an example, don't forget to change some information such as yate's extmodule binding ip address and port.
* 4 - once "1" is pressed, toto is called
8 KB (666 words) - 12:04, 4 November 2013
-
...pt is given as an example, don't forget to change some information such as yate's extmodule binding ip address and port.
* 4 - after "1" is pressed, 'toto' will be called
9 KB (821 words) - 12:17, 4 November 2013
-
Python 2.4(Python 2.5 is better as it allows to use inlineCallbacks - '''I used 2.5''')<br>
===Configuring in Yate===
1 KB (163 words) - 12:17, 4 November 2013
-
Yate handles [[wikipedia:List of SIP request methods|SIP requests]] differently,
...that are handled internally in [[ysipchan]] module or generically in other Yate's [[modules]] or in [[External Module|external scripts]].
8 KB (1,099 words) - 18:29, 13 March 2014
-
... way it handles SIP MESSAGE request method. If you have a newer version of yate or you can update we suggest you follow [[Using SIP MESSAGE or how to enabl
This explains how to use SIP MESSAGE and SIP PUBLISH requests with Yate.
5 KB (843 words) - 18:34, 13 March 2014
-
...m for Yet Another Telephony Engine) is a next-generation telephony engine, is a free and open source communications software with support for video, voic
<!--YateClient is an Instant Messenger and Voice application for Jabber/Jingle IM, SIP, H.323
5 KB (888 words) - 13:05, 10 March 2015
-
...//en.wikipedia.org/wiki/Secure_Real-time_Transport_Protocol SRTP protocol] is used. This will add confidentiality, message authentication, and replay pro
The protocol allows client/server applications to communicate in a way that is designed to prevent eavesdropping, tampering, or message forgery.
3 KB (431 words) - 08:45, 4 November 2013
-
The purpose of Yate's design is to provide an extensible telephony engine. Holding the base code as simple
The architecture of Yate is based on a [[Messages|message passing]] system. The architecture can be div
2 KB (324 words) - 11:32, 13 November 2015
-
...for it and tells them that Yate has finished first time initialization and is entering the main loop.
The return value of this message is ignored by the engine.
553 B (77 words) - 11:17, 18 January 2013
-
Bellow you can read about the coding style rules to preserve Yate's uniformity of the source code. You can find out about the files name conv
Yate's coding style (being enforced throughout the entire coding process) is clean and easy to understand. This will help you preserve the high standard
5 KB (872 words) - 11:43, 4 November 2013
-
...fault Yate communicates through pipes with any script, but in Windows this is not possible, so a listener in [[External Module|external module]] must be
... and don't forget to add the '''socket extensions''' (needed to connect to Yate via TCP).
2 KB (241 words) - 11:52, 4 November 2013
-
Yate's implementation provides classes for mutual exclusion and locking.
... threads]. This is a critical component of any multi-threaded program like Yate.
2 KB (245 words) - 11:45, 4 November 2013
-
Countless bugs can result from improper locking resources. Yate being a multithreaded program a multitude of problems can occur from bad pr
...Race_condition#Computing race condition] when the order of some operations is not guaranteed.
2 KB (356 words) - 11:46, 4 November 2013
-
In the code of Yate there are some noteworthy mutexes that have program-wide implications.
...the actual object destruction (when the reference counter dropped to zero) is performed with this mutex released.
2 KB (251 words) - 11:46, 4 November 2013
-
There are different ways of stopping and restarting Yate depending on how Yate was installed and configured.
=== Signals and keys for a running Yate===
2 KB (234 words) - 09:39, 4 November 2013
-
Follow the steps below to install and compile the latest version of Yate from SVN source on any server with linux system on it.
Since you are going the full process of fetching and building Yate you will need the following:
10 KB (1,738 words) - 12:55, 25 February 2014
-
... Yate, for future development. Your purpose is to compile your module with Yate packages, so others can used on different platforms. Bellow you can find so
==Install Yate==
5 KB (750 words) - 10:40, 2 March 2015
-
Follow the steps below to install and compile the latest version of Yate from SVN source on Debian GNU/Linux 6.0 system.
For fetching and building Yate from SVN you will need the following:
6 KB (962 words) - 11:10, 30 January 2014
-
Follow the steps below to install and compile the latest version of Yate from SVN source on FreeBSD9.
For fetching and building Yate from SVN you will need the following:
3 KB (514 words) - 09:38, 4 November 2013
-
There are two ways to install Yate under Windows:
* Download and install Yate from [http://yate.null.ro/pmwiki/index.php?n=Main.Download download] page following the setup
6 KB (967 words) - 14:56, 8 January 2014
-
...g the logs as specified in the configuration. It runs as a daily cron job. Yate doesn't rotate its own logs, but integrates into "logrotate" by providing a
===logrotate and Yate===
5 KB (809 words) - 21:57, 12 March 2014
-
...ow to use the embedded Javascript implementation to change the behavior of Yate.
{|class="yate-table"
2 KB (323 words) - 09:50, 21 August 2017
-
Yate Mail List can be used to report bugs or complex problems encoutered in Yate.
...subscribe@voip.null.ro Subscribe] - yate-subscribe@voip.null.ro - to the Yate mailing list.<br>
3 KB (425 words) - 08:50, 13 February 2013
-
Currently Yate does not automatically provide a prototype for objects. This can be added e
'''IMPORTANT:''' There's a semicolon after the closing brace as this is an assignment and not a function declaration
1 KB (187 words) - 13:32, 31 October 2013
-
...tware or other branches of engineering. We will try to fix the problems in Yate as soon as possible. Please note that our priorities may be different than
...ve and correct. It never makes sense to just say "It doesn't work!" - that is not going to get problems fixed or even investigated.
5 KB (943 words) - 09:36, 9 July 2013
-
Thank you for agreeing to moderate the yate@voip.null.ro
<yate-subscribe-john=host.domain@voip.null.ro>
3 KB (469 words) - 08:59, 13 February 2013
-
The history of Yate dates back to 2004 when NullTeam, the company behind Yate, launched the official website.
In 2005 Sangoma announced their support for Yate development on the Microsoft Windows platform.
437 B (61 words) - 09:46, 11 September 2017
-
To interact with databases the Javascript module uses Yate's database connections.<br>
* create a database connection in Yate
4 KB (563 words) - 13:35, 31 October 2013
-
The MessageQueues is a mechanism for organizing YATE's messages in different queues, identified by message name and some specifi
...pose of messageQueue mechanism is to streamline the messages processing in Yate.
2 KB (327 words) - 10:45, 14 May 2013
-
...ipt module (the same goes for external scripts) you can have access to all Yate's messages.
... need to handle a specific message, that takes too long to be processed by Yate.
776 B (108 words) - 11:54, 1 November 2013
-
If you want to get Yate up and running on your RedHat-based system, here is hopefully the quickest way to get going.
[[Download|Download the Yate RPM]] for your CPU type, into your favourite folder (we use /usr/src).
2 KB (269 words) - 11:01, 28 April 2014
-
...provider uses the IAX protocol, you will successfully make your calls with YateClient.
==How to use YateClient with IAX==
1 KB (218 words) - 14:45, 1 April 2013
-
Yate allows you to build a custom conference server application.
<!--Yate as a conference server can be customized as needed and also you can build y
3 KB (468 words) - 09:42, 20 May 2013
-
Yate was built to easily allow building applications based on it. Most of the ap
...ing from database, and it's called [[register]] and his configuration file is register.conf. It also allows to write the cdr(call logs) in the database.
5 KB (887 words) - 14:05, 31 October 2013
-
...ple (but relatively slow) method of communication between script instances is the use of messages.
One instance of the script [[Install handler for using Yate's messages in Javascript|installs a message handler]] for a mutually agreed
2 KB (267 words) - 13:33, 31 October 2013
-
===How to convert SIP headers into SIP parameters and in what messages===
...eaders are added in Yate messages as '''sip_headername''' where headername is the lowercase version of the received header.
2 KB (262 words) - 14:43, 31 October 2013
-
It is assumed that you have set an account in Yate, if you write your CDR in the database.
If the routing it is done from regexroute.conf. Route all calls through sip and set copyparams p
3 KB (495 words) - 14:44, 31 October 2013
-
In Yate there are several ways to debug issues that permits you to monitorize the s
...n use [[Debugging_and,_or_Investigation_of_messages|msgsniff]] to dump the Yate's messages to an output console or log them into a file.
7 KB (905 words) - 15:03, 14 October 2016
-
... configuration files are located and various command line options to start yate that will help you debug issues.
... page we assume Yate is installed in the default path: '''c:\Program Files\Yate'''.
3 KB (583 words) - 08:05, 19 August 2013
-
YateClient can be run on Intel platforms running Mac OS X 10.5.7 or later.
===Getting YateClient for Mac OS X===
5 KB (787 words) - 09:34, 4 November 2013
-
... the '''caller party''' and '''yate server''' and the other one between '''yate server''' and the '''called party'''. Cdrcombine module unifies the informa
There is no configuration file for cdrcombine module. In order to use set '''combine
4 KB (501 words) - 15:47, 31 October 2013
-
...mmunicate with external scripts. <br/>Look in share/scripts directory from yate's sources to find libraries in various languages that implement this protoc
*2 (stderr) - Has the usual meaning of reporting errors and is directed to the engine's stderr or logfile
15 KB (2,320 words) - 15:19, 24 March 2016
-
What I wanted to do, was change it into:
... johndoe is found in regfile.conf, and the originally called number 123456 is routed to the user johndoe.
6 KB (833 words) - 15:07, 31 October 2013
-
... PBX. Depending on the functionality you want you can use a combination of Yate modules and external scripts.
...hed [http://freesentral.com FreeSentral], a full IP PBX based on Yate that is easy to set up and use.
4 KB (715 words) - 15:20, 31 October 2013
-
This is the list of standard PBX keys. When choosing the keys for our PBX we tried
* [[Yate as a PBX]]
686 B (91 words) - 07:27, 19 August 2013
-
... in the server, especially when you have limited access to Yate (e.g. when Yate runs as daemon).
* SNMP data from Monitoring through YATE [[SNMP Agent]]
9 KB (1,268 words) - 15:48, 31 October 2013
-
... to find what you should do if you suspect that yate's database connection is not opened.<br/>
...clude a reference to the database connection you are going to use (account=yateadmin).
4 KB (587 words) - 08:36, 4 November 2013
-
... use [http://freesentral.com FreeSentral]. It offers all the features from YateAdmin and a lot of new ones.
I installed Yate, PostgreSQL and YateAdmin. I use lighttpd as a webserver, and PHP5.
1 KB (222 words) - 08:37, 4 November 2013
-
...ly helps a lot with debugging, and is IMHO easier than messing around with yate -vvvvv
* [[How_To's#Monitoring_and_debugging_Yate|Monitoring and debugging in Yate]]
797 B (134 words) - 08:36, 4 November 2013
-
...ntered an issue or think that your experience could help other users, this is the place to place that information.
...d. I entered the modules I wanted from the Documentation site, and as STUN is not listed there, I did not include it.
2 KB (272 words) - 08:38, 4 November 2013
-
... or, as the common user would name it, phone service over the Internet. It is a technique that brings communications at another level, allowing you to us
...ent phone to the VoIP network. No matter what solution you consider, there is also the possibility to disconnect it from the present network and making a
19 KB (3,169 words) - 11:20, 16 September 2013
-
Yate provides a default mapping from the call release cause of the call leg that
When a call leg is released a cause code is received over the protocol or is generated locally in case of an error.
2 KB (242 words) - 16:09, 31 October 2013
-
http://forum.yate.ro
A quick view of the [http://yate.null.ro/archive/ archive] is available and can be searched by Google - please use this feature to check
523 B (88 words) - 13:29, 26 July 2021
-
Retrieve Yate global
Does nothing if the list is the global variables list<br/>
3 KB (464 words) - 07:11, 29 September 2021
-
A number of organisations are using Yate, either internally or as part of their service or offering.
This list is not sanctioned or maintained by Null Team and it represents only the opinio
395 B (60 words) - 08:33, 22 August 2013
-
Although the String object is not directly supported by Yate's Javascript these methods are applicable to most non-object variables.
Returns a string containing a single character or empty if ''pos'' is out of bounds.
4 KB (607 words) - 15:01, 11 September 2013
-
Function that checks if its argument is Not A Number.
Static variable that is Not a Number.
3 KB (405 words) - 10:28, 27 October 2021
-
*FWD_number - is the number that FWD provides, in Null Team case it's 269629.
*FWD_password - is the password FWD provides, in Null Team case it's not public.
2 KB (326 words) - 15:35, 31 October 2013
-
*IAX_number - is the number that iaxtel.com provides, in bsd's case it's 17003009981.
*IAX_password - is the password IAX provides, in bsd's case it's not public.
988 B (152 words) - 15:40, 31 October 2013
-
When an IPv6 address is specified in a SIP URI it must be enclosed in square brackets.<br>
The URI parser will fail if the address is not enclosed in square brackets.<br>
3 KB (462 words) - 07:54, 21 October 2013
-
Starting with '''Yate 5 or svn revision 5629''' Yate changed the way it handles SIP MESSAGE request method. <br/><br/>
By default Yate doesn't accept SIP MESSAGE requests.
5 KB (739 words) - 15:42, 31 October 2013
-
To connect to Yate's rmanager interface
nip.js is a global script and sip/74 is a sip channel that is assisted by the configured routing script
3 KB (387 words) - 09:46, 21 August 2017
-
...= ["/usr/share/yate/sounds/", "/usr/local/share/yate/sounds/", "/var/spool/yatebts/"];
Channel.callJust("iax/iax:090@192.168.1.1/090",{"caller":"yatebts"});
5 KB (575 words) - 16:05, 27 February 2014
-
# To allow Yate to detect where to read from:
var conf = new ConfigFile("/usr/local/etc/yate/regfile.conf");
3 KB (485 words) - 14:10, 25 August 2015
-
This object is frozen.
Does nothing if the resulting string is empty.<br>
12 KB (1,870 words) - 11:25, 8 December 2022
-
Yate Message object
* ''filterName'' - String name of the filtering parameter (only if a filter is installed)
3 KB (464 words) - 13:02, 22 May 2017
-
|'''Product''' || '''Yate Version''' || '''Protocol''' || '''Comment''' || '''Tester'''
# I tried on HTC S730 but voip-client is the same for all WM6.0 smartphone
9 KB (1,256 words) - 07:01, 25 September 2015
-
; scripts if no full path is specified
; files via #include or #require if no full path is specified
4 KB (568 words) - 08:58, 10 March 2016
-
...ments [[External Module]] protocol and is suitable for developing external Yate scripts.
npm install yate-extmodule
725 B (89 words) - 04:02, 14 January 2018
-
== Run test in yate ==
...u will find a file called "cachegrind.out.filename" in the directory where yate was started from.
796 B (132 words) - 14:02, 7 June 2016
-
'''NOTE: This module is available in private version only.'''
* When a node or peer is dropped its statistics are lost. Global statistics are not lost: they will
43 KB (6,355 words) - 13:27, 1 October 2019
-
This is a short example on how to configure MTP2 in Yate.
Follow [http://docs.yate.ro/wiki/VoIP_PSTN_Gateway#Installing_Sangoma_cards_under_Linux this guide]
975 B (160 words) - 08:57, 27 October 2017
-
M2PA is a peer to peer SS7 layer 2 protocol. It was designed to replace MTP2 protoc
* The traffic is not limited to classical 64 Kb/s SS7 link speed.
6 KB (958 words) - 10:45, 26 October 2017
-
...g on if you plan to use SIGTRAN. The default configuration on most systems is inadequate for the tight timings required in telephony - timeouts range in
The actual settings are in the '''/etc/sysctl.conf''' file that is applied at boot time.
2 KB (253 words) - 09:27, 26 October 2017
-
...ermination in the IP network. It is designed in a gateway-client model and is able to control the Layer 2 links on the gateway side and to backhaul two S
...re raw material it books some airplanes from the airfield. Now the factory is in control of the airplanes and will use them to send it's products from th
13 KB (2,284 words) - 11:12, 13 December 2017
-
M3UA is part of SS7 SIGTRAN protocol stack and it was designed for remote processin
The only purpose of this protocol is to provide remote MTP User Part message processing.
11 KB (1,842 words) - 09:53, 27 October 2017
-
...agement and controls traffic when congestion occurs. When a MTP2 data link is no longer available it establishes alternative links and re-routes traffic
...k is uniquely identified by a Point Code (PC). The routing of the messages is performed according to the point code.
7 KB (1,115 words) - 10:47, 27 October 2017
-
...ires configuration in the Gateway (Cisco) and also in the Call Controller (Yate).
It is not possible to have multiple controllers each for part of the circuits.
6 KB (921 words) - 11:10, 26 October 2017
-
'''IMPORTANT''': Cisco gateways support a maximum of 4 SS7 links.<br/>This is enough for small configurations but insufficient to correctly connect to mu
'''Therefore for flexibility it is desirable to have several smaller gateways rather than a big one.'''
10 KB (1,328 words) - 09:09, 26 October 2017
-
We will setup a ISUP configuration in Yate to make calls.<br>
Below is a image that describes the configuration.<br>
5 KB (643 words) - 12:23, 26 October 2017
-
It is not possible to have multiple controllers each for part of the circuits.
'''Therefore for flexibility it is desirable to have several smaller gateways rather than a big one'''.
5 KB (761 words) - 09:12, 26 October 2017
-
It is possible to configure a Mediant gateway either from the Web interface or by
First settings that you are going to make are the boards. This setting is common for everything using the trunk, voice or signaling.
6 KB (975 words) - 13:22, 26 October 2017
-
This is a special non-standard feature of YATE.<br/>
...SCCP can be used as a SCCP message decoder. This case can be found if SCCP is used with M3UA-GW.<br/><br/>
726 B (121 words) - 14:10, 26 October 2017
-
Various configuration examples of combinations of SS7 features in Yate.
; voice is defined in mgcpca.conf
15 KB (1,985 words) - 10:45, 27 October 2017
-
... timer expires, it resend's the message. In this way packet loss detection is provided.<br>
B Detects that the message is not the next one in sequence and it puts the message in a queue and acknowl
5 KB (830 words) - 11:12, 26 October 2017
-
==SCCP in YATE==
The SCCP implementation in YATE can be found in ysig library, the configuration
11 KB (1,757 words) - 09:19, 27 October 2017
-
Below is the schema of the network we are trying to configure. We'll be configuring
** STP1 is a interconnect STP
9 KB (1,276 words) - 14:12, 26 October 2017
-
Introductory information on SS7 is available for free on the Internet from various sources.
* [[Terminology for Yate implementation of SS7]]
842 B (136 words) - 11:31, 26 October 2017
-
In Yate the following SS7 components are implemented:
...ules in Yate are [http://docs.yate.ro/wiki/Wpcard wpcard] and [http://docs.yate.ro/wiki/Zapcard zapcard]. Note that the same modules provide ISDN D-Channel
3 KB (569 words) - 08:36, 27 October 2017
-
...r module(s) (e.g. [http://docs.yate.ro/wiki/Zapcard zapcard], [http://docs.yate.ro/wiki/Wpcard wpcard]) to create interfaces and circuits used to transfer
In this module's terminology, a link is a protocol stack. These are the link types created by this module:
36 KB (5,180 words) - 12:18, 26 October 2017
-
...ef introduction on how the PSTN signalling modules are working together in Yate.
Supports FXS and FXO interfaces, signaling is associated to each channel
5 KB (749 words) - 12:56, 26 October 2017
-
.../ysig/yatesig.h and the implementation in libs/ysig/layer2.cpp. Class name is SS7MTP2.
; autoemergency: boolean: Emergency align link if owner linkset is down
2 KB (297 words) - 08:55, 27 October 2017
-
It is based on libcurl.
* '''wait''': Boolean (default: '''false'''). The sender is synchronously waiting for completion
15 KB (2,067 words) - 13:35, 9 November 2020
