Mod event socket - Revision history

Jlenk: /* .NET Client library */

Jlenk — Sat, 04 May 2013 17:32:46 GMT

.NET Client library

← Older revision		Revision as of 17:32, 4 May 2013
Line 154:		Line 154:

	== .NET Client library ==		== .NET Client library ==
		+	Support is included in tree for building under Windows. See libs/esl/managed managed_esl.201x.
		+
		+	There is a sample application included named ManagedEslTest. This will demonstrate how the start a simple inbound example as provided but also shows the other modes as well.
		+
		+	The managed portions are platform neutral but the esl swig wrapper (the ESL project in the managed solution) is platform dependent and must be built for the intended platform. You must also have previously built the main FreeSWITCH project as the native esl library is included from there otherwise you will receive a esl.lib not found error.
		+
		+
	[http://agbaravoip.codeplex.com/] AgbaraVOIP .NET Client		[http://agbaravoip.codeplex.com/] AgbaraVOIP .NET Client

Gerald Weber: /* bgapi */

Gerald Weber — Fri, 03 May 2013 07:30:45 GMT

bgapi

← Older revision		Revision as of 07:30, 3 May 2013
Line 192:		Line 192:
	bgapi status		bgapi status
	Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148		Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148
		+
		+	Reply:

	Content-Type: command/reply		Content-Type: command/reply
	Reply-Text: +OK Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148		Reply-Text: +OK Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148
	Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148		Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148
-
-	~~Content-Length: 850~~
-	~~Content-Type: text/event-plain~~
-
-	~~Event-Name: BACKGROUND_JOB~~
-	~~Core-UUID: 9c76d0e3-ce41-486c-9f6a-37e5093a726f~~
-	~~FreeSWITCH-Hostname: fstest~~
-	~~FreeSWITCH-Switchname: fstest~~
-	~~FreeSWITCH-IPv4: 192.168.20.73~~
-	~~FreeSWITCH-IPv6: %3A%3A1~~
-	~~Event-Date-Local: 2013-05-03%2009%3A25%3A25~~
-	~~Event-Date-GMT: Fri,%2003%20May%202013%2007%3A25%3A25%20GMT~~
-	~~Event-Date-Timestamp: 1367565925623745~~
-	~~Event-Calling-File: mod_event_socket.c~~
-	~~Event-Calling-Function: api_exec~~
-	~~Event-Calling-Line-Number: 1456~~
-	~~Event-Sequence: 58159~~
-	~~Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148~~
-	~~Job-Command: status~~
-	~~Content-Length: 304~~
-
-	~~UP 0 years, 3 days, 23 hours, 16 minutes, 39 seconds, 523 milliseconds, 950 microseconds~~
-	~~FreeSWITCH (Version 1.5.1b git c4e7c30 2013-04-27 13:19:18Z) is ready~~
-	~~0 session(s) since startup~~
-	~~0 session(s) - 0 out of max 30 per sec~~
-	~~1000 session(s) max~~
-	~~min idle cpu 0.00/99.00~~
-	~~Current Stack Size/Max 240K/8192K~~

	==linger==		==linger==

Gerald Weber: /* bgapi */

Gerald Weber — Fri, 03 May 2013 07:30:12 GMT

bgapi

← Older revision		Revision as of 07:30, 3 May 2013
Line 186:		Line 186:

	When the command is done executing, freeswitch fires an event with the result and you can compare that to the Job-UUID to see what the result was. In order to receive this event, you will need to subscribe to [[Event_List#BACKGROUND_JOB\|BACKGROUND_JOB]] events.		When the command is done executing, freeswitch fires an event with the result and you can compare that to the Job-UUID to see what the result was. In order to receive this event, you will need to subscribe to [[Event_List#BACKGROUND_JOB\|BACKGROUND_JOB]] events.
		+
		+
		+	If you want to set your own custom Job-UUID over plain socket:
		+
		+	bgapi status
		+	Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148
		+
		+	Content-Type: command/reply
		+	Reply-Text: +OK Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148
		+	Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148
		+
		+	Content-Length: 850
		+	Content-Type: text/event-plain
		+
		+	Event-Name: BACKGROUND_JOB
		+	Core-UUID: 9c76d0e3-ce41-486c-9f6a-37e5093a726f
		+	FreeSWITCH-Hostname: fstest
		+	FreeSWITCH-Switchname: fstest
		+	FreeSWITCH-IPv4: 192.168.20.73
		+	FreeSWITCH-IPv6: %3A%3A1
		+	Event-Date-Local: 2013-05-03%2009%3A25%3A25
		+	Event-Date-GMT: Fri,%2003%20May%202013%2007%3A25%3A25%20GMT
		+	Event-Date-Timestamp: 1367565925623745
		+	Event-Calling-File: mod_event_socket.c
		+	Event-Calling-Function: api_exec
		+	Event-Calling-Line-Number: 1456
		+	Event-Sequence: 58159
		+	Job-UUID: d8c7f660-37a6-4e73-9170-1a731c442148
		+	Job-Command: status
		+	Content-Length: 304
		+
		+	UP 0 years, 3 days, 23 hours, 16 minutes, 39 seconds, 523 milliseconds, 950 microseconds
		+	FreeSWITCH (Version 1.5.1b git c4e7c30 2013-04-27 13:19:18Z) is ready
		+	0 session(s) since startup
		+	0 session(s) - 0 out of max 30 per sec
		+	1000 session(s) max
		+	min idle cpu 0.00/99.00
		+	Current Stack Size/Max 240K/8192K

	==linger==		==linger==

Benlangfeld: /* Ruby Libraries */

Benlangfeld — Wed, 20 Mar 2013 16:39:56 GMT

Ruby Libraries

← Older revision		Revision as of 16:39, 20 March 2013
Line 126:		Line 126:
	* [http://code.rubyists.com/projects/fs FreeSWITCHeR]		* [http://code.rubyists.com/projects/fs FreeSWITCHeR]
	* [https://github.com/vangberg/librevox Librevox]		* [https://github.com/vangberg/librevox Librevox]
		+	* [https://github.com/adhearsion/ruby_fs RubyFS]

	== Python Client Library ==		== Python Client Library ==

Usama Zaidi: /* filter */

Usama Zaidi — Wed, 13 Feb 2013 11:00:37 GMT

filter

← Older revision		Revision as of 11:00, 13 February 2013
Line 282:		Line 282:
	This method is an alternative to the [[Mod_event_socket#Special_Case_-_.27myevents.27\|myevents]] event type. If you need ''only'' the events for a specific channel then use '''myevents''', otherwise use a combination of filters to narrow down the events you wish to receive on the socket.		This method is an alternative to the [[Mod_event_socket#Special_Case_-_.27myevents.27\|myevents]] event type. If you need ''only'' the events for a specific channel then use '''myevents''', otherwise use a combination of filters to narrow down the events you wish to receive on the socket.

-	To filter multiple unique IDs, you can just add another filter for events for each UUID. This can be useful for example if you want to receive start/stop-talking events for ~~all~~ users on a particular conference.	+	To filter multiple unique IDs, you can just add another filter for events for each UUID. This can be useful for example if you want to receive start/stop-talking events for multiple users on a particular conference.
	<code>		<code>
	filter plain all		filter plain all
	filter plain CUSTOM conference::maintenance		filter plain CUSTOM conference::maintenance
-	filter Unique-ID $~~{UUID Participant 1}~~	+	filter Unique-ID $participantB
-	filter Unique-ID $~~{UUID Participant 2}~~	+	filter Unique-ID $participantA
-	~~and so on...~~	+	filter Unique-ID $participantC
	</code>		</code>
		+
		+	This will give you events for Participant A,B and C on any conference. To receive events for all users on a conference you can use something like:
		+
		+	<code>
		+	filter Conference-Unique-ID $ConfUUID
		+	</code>
		+
		+	You can filter on any of the parameters you get in a freeSWITCH event:
		+
		+	<code>
		+	filter plain all
		+	filter call-direction Inbound
		+	filter Event-Calling-File mod_conference.c
		+	filter Conference-Unique-ID $ConfUUID
		+	</code>
		+
		+	You can use them individually or compound them depending on whatever end result you desire for the type of events you want to receive

	==filter delete==		==filter delete==

Usama Zaidi: /* filter */

Usama Zaidi — Tue, 12 Feb 2013 11:14:36 GMT

filter

← Older revision		Revision as of 11:14, 12 February 2013
Line 281:		Line 281:

	This method is an alternative to the [[Mod_event_socket#Special_Case_-_.27myevents.27\|myevents]] event type. If you need ''only'' the events for a specific channel then use '''myevents''', otherwise use a combination of filters to narrow down the events you wish to receive on the socket.		This method is an alternative to the [[Mod_event_socket#Special_Case_-_.27myevents.27\|myevents]] event type. If you need ''only'' the events for a specific channel then use '''myevents''', otherwise use a combination of filters to narrow down the events you wish to receive on the socket.
		+
		+	To filter multiple unique IDs, you can just add another filter for events for each UUID. This can be useful for example if you want to receive start/stop-talking events for all users on a particular conference.
		+	<code>
		+	filter plain all
		+	filter plain CUSTOM conference::maintenance
		+	filter Unique-ID ${UUID Participant 1}
		+	filter Unique-ID ${UUID Participant 2}
		+	and so on...
		+	</code>

	==filter delete==		==filter delete==

Mcollins: /* Command Documentation - add linger and nolinger */

Mcollins — Thu, 15 Nov 2012 22:25:20 GMT

Command Documentation - add linger and nolinger

← Older revision		Revision as of 22:25, 15 November 2012
Line 185:		Line 185:

	When the command is done executing, freeswitch fires an event with the result and you can compare that to the Job-UUID to see what the result was. In order to receive this event, you will need to subscribe to [[Event_List#BACKGROUND_JOB\|BACKGROUND_JOB]] events.		When the command is done executing, freeswitch fires an event with the result and you can compare that to the Job-UUID to see what the result was. In order to receive this event, you will need to subscribe to [[Event_List#BACKGROUND_JOB\|BACKGROUND_JOB]] events.
		+
		+	==linger==
		+	Tells FreeSWITCH not to close the socket connect when a channel hangs up. Instead, it keeps the socket connection open until the last event related to the channel has been received by the socket client.
		+	linger
		+
		+	==nolinger==
		+
		+	Disable socket lingering. See '''linger''' above.
		+	nolinger

	==event==		==event==

Cengler: Add node-esl to the library list

Cengler — Mon, 05 Nov 2012 16:14:04 GMT

Add node-esl to the library list

← Older revision		Revision as of 16:14, 5 November 2012
Line 143:		Line 143:

	== Javascript / Node.js library ==		== Javascript / Node.js library ==
		+
		+	* Node-esl module available on [https://github.com/englercj/node-esl GitHub] and on [https://npmjs.org/package/modesl npm]. Provides support for both Inbound and Outbound connections, a Server helper for multiple Outbound connections, and implements the [[Event Socket Library]] interface. Examples can be found in the [https://github.com/englercj/node-esl/tree/master/examples examples directory] of the source.

	* Node.js esl module [http://search.npmjs.org/#/esl (available using npm)] offers both a client and a server implementation. The code is [https://github.com/shimaore/esl on github] with [http://shimaore.github.com/esl/esl.html documentation]. Examples: [https://github.com/shimaore/ccnq3/tree/master/applications/voicemail/node Voicemail with CouchDB storage] and [https://github.com/shimaore/ccnq3/blob/master/private/cnam-client/node/cnam-client.coffee CNAM injection] (short example showing how to set a variable using an async web query).		* Node.js esl module [http://search.npmjs.org/#/esl (available using npm)] offers both a client and a server implementation. The code is [https://github.com/shimaore/esl on github] with [http://shimaore.github.com/esl/esl.html documentation]. Examples: [https://github.com/shimaore/ccnq3/tree/master/applications/voicemail/node Voicemail with CouchDB storage] and [https://github.com/shimaore/ccnq3/blob/master/private/cnam-client/node/cnam-client.coffee CNAM injection] (short example showing how to set a variable using an async web query).

SteveAyre: sendmsg is case insensitive, but lets keep it consistent with the ==sendmsg== usage example to be clear it's the same command

SteveAyre — Wed, 11 Jul 2012 14:42:51 GMT

sendmsg is case insensitive, but lets keep it consistent with the ==sendmsg== usage example to be clear it's the same command

← Older revision		Revision as of 14:42, 11 July 2012
Line 456:		Line 456:
	originate a call directly to park by making an ext the ext part of the originate command &park()		originate a call directly to park by making an ext the ext part of the originate command &park()

-	IMPORTANT! All ~~SendMsg~~ commands must be followed by 2 returns.	+	IMPORTANT! All sendmsg commands must be followed by 2 returns.

	Since messaging format is similar to RFC2882. If you are using any libraries that following line wrapping recommendation of RFC 2822 make sure that you disable line wrapping as [http://blog.godson.in/2010/12/freeswitch-eventsocket-header-length.html FreeSWITCH] will ignore wrapped line.		Since messaging format is similar to RFC2882. If you are using any libraries that following line wrapping recommendation of RFC 2822 make sure that you disable line wrapping as [http://blog.godson.in/2010/12/freeswitch-eventsocket-header-length.html FreeSWITCH] will ignore wrapped line.
Line 462:		Line 462:

	Example:		Example:
-	~~SendMsg~~ <uuid>	+	sendmsg <uuid>
	call-command: execute		call-command: execute
	execute-app-name: playback		execute-app-name: playback
Line 478:		Line 478:

	<pre>		<pre>
-	~~SendMsg~~ <uuid>	+	sendmsg <uuid>
	call-command: execute		call-command: execute
	execute-app-name: <one of the applications>		execute-app-name: <one of the applications>
Line 489:		Line 489:

	<pre>		<pre>
-	~~SendMsg~~ <uuid>	+	sendmsg <uuid>
	call-command: execute		call-command: execute
	execute-app-name: <one of the applications>		execute-app-name: <one of the applications>
Line 505:		Line 505:
	Format:		Format:
	<pre>		<pre>
-	~~SendMsg~~ <uuid>	+	sendmsg <uuid>
	call-command: hangup		call-command: hangup
	hangup-cause: <one of the causes listed below>		hangup-cause: <one of the causes listed below>
Line 527:		Line 527:

	<pre>		<pre>
-	~~SendMsg~~ <uuid>	+	sendmsg <uuid>
	call-command: unicast		call-command: unicast
	local-ip: <default is 127.0.0.1>		local-ip: <default is 127.0.0.1>
Line 543:		Line 543:

	<pre>		<pre>
-	~~SendMsg~~ <uuid>	+	sendmsg <uuid>
	call-command: nomedia		call-command: nomedia
	nomedia-uuid: <noinfo>		nomedia-uuid: <noinfo>

Avi Marcus: /* Javascript / Node.js library */

Avi Marcus — Wed, 27 Jun 2012 18:39:33 GMT

Javascript / Node.js library

← Older revision		Revision as of 18:39, 27 June 2012
Line 147:		Line 147:

	* [https://github.com/demchenkoe/njs-freeswitch-esc Node.js ESClient]		* [https://github.com/demchenkoe/njs-freeswitch-esc Node.js ESClient]
		+
		+	*Possible example of an IVR: http://freeswitch-users.2379917.n2.nabble.com/Javascript-Outbound-Event-Socket-Linger-Command-td7530943.html

	== .NET Client library ==		== .NET Client library ==