Call Us Today! 877.742.2583




Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update content and formatting (had to save)

...

About

The current up-to-date list of events can be found in src/switch_event.c in a char array called EVENT_NAMES and is summarized here.

Expand
titleClick here to expand Table of Contents


Panel
borderColorlightgray
bgColor#f7f7f7
borderWidth1
borderStyledotted

Table of Contents
maxLevel3
outlinetrue
indent1em
excludeAbout
stylenone
printablefalse

Event Types (Classes)

Most of FreeSWITCH events belongs to one of those types (grepped from source code):

  • ADD_SCHEDULE
  • API
  • BACKGROUND_JOB
  • CALL_DETAIL
  • CALL_SECURE
  • CALL_SETUP_REQ
  • CALL_UPDATE
  • CDR
  • CHANNEL_ANSWER
  • CHANNEL_APPLICATION
  • CHANNEL_BRIDGE
  • CHANNEL_CALLSTATE
  • CHANNEL_CREATE
  • CHANNEL_DATA
  • CHANNEL_DESTROY
  • CHANNEL_EXECUTE
  • CHANNEL_EXECUTE_COMPLETE
  • CHANNEL_GLOBAL
  • CHANNEL_HANGUP
  • CHANNEL_HANGUP_COMPLETE
  • CHANNEL_HOLD
  • CHANNEL_ORIGINATE
  • CHANNEL_OUTGOING
  • CHANNEL_PARK
  • CHANNEL_PROGRESS
  • CHANNEL_PROGRESS_MEDIA
  • CHANNEL_STATE
  • CHANNEL_UNBRIDGE
  • CHANNEL_UNHOLD
  • CHANNEL_UNPARK
  • CHANNEL_UUID
  • CLONE
  • CODEC
  • COMMAND
  • CONFERENCE_DATA
  • CONFERENCE_DATA_QUERY
  • CUSTOM
  • DEL_SCHEDULE
  • DETECTED_SPEECH
  • DETECTED_TONE
  • DEVICE_STATE
  • DTMF
  • EXE_SCHEDULE
  • FAILURE
  • GENERAL
  • HEARTBEAT
  • LOG
  • MEDIA_BUG_START
  • MEDIA_BUG_STOP
  • MESSAGE
  • MESSAGE_QUERY
  • MESSAGE_WAITING
  • MODULE_LOAD
  • MODULE_UNLOAD
  • NAT
  • NOTALK
  • NOTIFY
  • NOTIFY_IN
  • PHONE_FEATURE
  • PHONE_FEATURE_SUBSCRIBE
  • PLAYBACK_START
  • PLAYBACK_STOP
  • PRESENCE_IN
  • PRESENCE_OUT
  • PRESENCE_PROBE
  • PRIVATE_COMMAND
  • PUBLISH
  • QUEUE_LEN
  • RECORD_START
  • RECORD_STOP
  • RECV_INFO
  • RECV_MESSAGE
  • RECV_RTCP_MESSAGE
  • RECYCLE
  • RELOADXML
  • REQUEST_PARAMS
  • RE_SCHEDULE
  • ROSTER
  • SEND_INFO
  • SEND_MESSAGE
  • SESSION_HEARTBEAT
  • SHUTDOWN
  • STARTUP
  • SUBCLASS_ANY
  • TALK
  • TRAP
  • UNPUBLISH

CUSTOM events subclasses

CUSTOM events are characterized by their subclass. You can filter on it. Follow is a list of subclasses, grepped from source code.

  • alsa::ringing
  • bert::in_sync
  • bert::lost_sync
  • bert::timeout
  • callcenter::info
  • conference::cdr
  • conference::maintenance
  • cv::video_detect
  • dingaling::connected
  • dingaling::login_failure
  • dingaling::login_success
  • fifo::info
  • filestring::close
  • filestring::fail
  • filestring::open
  • freeswitchc::boot_freeswitch
  • gsmopen::alarm
  • gsmopen::dump_event
  • gsmopen::incoming_sms
  • khomp::maintenance
  • khomp::sms_received
  • khomp::sms_sent
  • limit::usage
  • menu::enter
  • menu::exit
  • multicast::event
  • multicast::peerdown
  • multicast::peerup
  • name::method_name
  • parking::info
  • portaudio::audio_dev_error
  • portaudio::callheld
  • portaudio::callresumed
  • portaudio::makecall
  • portaudio::ringing
  • rtmp::attach
  • rtmp::clientcustom
  • rtmp::connect
  • rtmp::custom
  • rtmp::detach
  • rtmp::disconnect
  • rtmp::login
  • rtmp::logout
  • rtmp::register
  • rtmp::unregister
  • sendfile::ack
  • skinny::alarm
  • skinny::call_state
  • skinny::device_to_user
  • skinny::expire
  • skinny::register
  • skinny::unregister
  • skinny::user_to_device
  • skinny::xml_alarm
  • skypopen::incoming_chatmessage
  • skypopen::incoming_raw
  • smpp::bind_transceiver_resp
  • sofia::error
  • sofia::expire
  • sofia::gateway_add
  • sofia::gateway_delete
  • sofia::gateway_state
  • sofia::intercepted
  • sofia::notify_refer
  • sofia::notify_watched_header
  • sofia::pre_register
  • sofia::profile_start
  • sofia::recovery_recovered
  • sofia::recovery_recv
  • sofia::recovery_send
  • sofia::register
  • sofia::register_attempt
  • sofia::register_failure
  • sofia::reinvite
  • sofia::replaced
  • sofia::sip_user_state
  • sofia::transferee
  • sofia::transferor
  • sofia::unregister
  • sofia::wrong_call_state
  • spandsp::rxfaxnegociateresult
  • spandsp::rxfaxpageresult
  • spandsp::rxfaxresult
  • spandsp::txfaxnegociateresult
  • spandsp::txfaxpageresult
  • spandsp::txfaxresult
  • test::cool
  • unimrcp::profile_close
  • unimrcp::profile_create
  • unimrcp::profile_open
  • verto::client_connect
  • verto::client_disconnect
  • verto::login
  • vmd::beep
  • vm::maintenance

Event fields

Below is an explanation of each event field.

Core-UUID

Unique ID of FreeSWITCH instance, changes on every reboot [1].

Example value:

11f751fa-47a7-11e2-9f24-bf76d9fc9ea3

Event-Calling-File

Source file that triggered this event

Example value:

mod_voicemail.c

Event-Calling-Function

Source function that triggered this event.

Example value:

sofia_reg_parse_auth

Event-Calling-Line-Number

Source file line that triggered this event

Example value:

710

Event-Date-GMT

Date/time including timezone from FreeSWITCH instance at the point the event was triggered

Example value:

Fri, 28 Dec 2012 19:08:39 GMT

Event-Date-Local

Local date/time from FreeSWITCH instance at the point the event was triggered

Example value:

2012-12-28 19:08:39

Event-Date-Timestamp

Unix epoch time from FreeSWITCH instance at the point the event was triggered. (in microseconds, divide by 1000 to get milliseconds)

Example value:

1356721719352143

Event-Name

Our channel event type, see Channel events below for accepted values

Example value:

REQUEST_PARAMS

Event-Sequence

Sequential ID of event on the FreeSWITCH instance. This resets to zero after every reboot, and is not unique to each instance. [1]

Example value:

9274

FreeSWITCH-IPv4

IPv4 address of FreeSWITCH instance.

Example value:

192.168.0.2

FreeSWITCH-IPv6

IPv6 address of FreeSWITCH instance.

Example value:

::1

FreeSWITCH-Hostname

Hostname of machine that FreeSWITCH instance is running on.

Example value:

server123.example.com
server123

FreeSWITCH-Switchname

Switch name of FreeSWITCH instance, this is normally the same as #FreeSWITCH-Hostname unless you have a complex configuration (for example, fail over, multihoming etc).

Example value:

server123.example.com
server123


...

0. About

The current up-to-date list of events can be found in src/switch_event.c in a char array called EVENT_NAMES and is summarized here.

0.1 Minimum event information

The minimum amount of information sent for an event are:(no matter what the type of event it is) is in the example below. See the sections below for event fields/headers descriptions.

Code Block
Event-Name: RE_SCHEDULE
Core-UUID: 6d2375b0-5183-11e1-b24c-f527b57af954
FreeSWITCH-Hostname: freeswitch.local
FreeSWITCH-Switchname: freeswitch.local
FreeSWITCH-IPv4: 127.0.0.1
FreeSWITCH-IPv6: ::1
Event-Date-Local: 2012-02-07 19:36:31
Event-Date-GMT: Tue, 07 Feb 2012 18:36:31 GMT
Event-Date-Timestamp: 1328639791116026
Event-Calling-File: switch_scheduler.c
Event-Calling-Function: switch_scheduler_execute
Event-Calling-Line-Number: 65
Event-Sequence: 3349

...

0.2 Event body

Most events do not have a body but some do, such as the MESSAGE_WAITING event which contains the protocol specific MWI data. Also the MESSAGE event contains the composed text of the message much like an email.

A client should do the framing of the socket by reading headers until 2 line feeds (LFs) are encountered. All the bytes up to that point will be a list of name: value pairs, one line each. (

Note

Any multiline header data is URL-encoded so it still appears as 1 line

...

.

0.3 Content-Length header

If a Content-Length header is encountered you , then read exactly that many bytes from the socket. Note that since this is TCP, this may take more than one read so if you are supposed to read 200 bytes and the next read only returns 50, you must continue to read another 150and so on until you have read 200 bytes or the socket has an error. Once you have read all the bytes in the content length the the Content-Length header, the next packet will start on the subsequent byte.

...

Note

Content-Length is the length of the event beginning AFTER the double LF line ("\n\n") of the event header!

Example:

Content-Length: <size>\n
Content-Type: text/event-plain\n
\n
event-hdr1: a\n       <-- size starts here
event-hdr2: b\n
...
event-hdrN: x\n
\n                    <-- size ends here

Pseudo Code:

Look for \n\n in your receive buffer

Examine data for existence of Content-Length

If NOT present, process event and remove from receive buffer

IF present, Shift buffer to remove 'header'
Evaluate content-length value

Loop until receive buffer size is >= Content-length
Extract content-length bytes from buffer and process

...

1. Event fields/headers

Field/HeaderDescriptionExample
Action

Used with conference::* subclasses. See mod_conference,

and grep the source for "Action" to get the complete list.

conference-create

Core-UUID

Unique ID of FreeSWITCH instance, changes on every

reboot [1].

11f751fa-47a7-11e2-9f24-bf76d9fc9ea3
Event-Calling-FileSource file that triggered this event.mod_voicemail.c
Event-Calling-Function

Source function that triggered this event.

sofia_reg_parse_auth
Event-Calling-Line-Number

Source file line that triggered this event.

710
Event-Date-GMT

Date/time including timezone from FreeSWITCH instance

at the point the event was triggered.

Fri, 28 Dec 2012 19:08:39 GMT
Event-Date-Local

Local date/time from FreeSWITCH instance at the point

the event was triggered.

2012-12-28 19:08:39
Event-Date-Timestamp

Unix epoch time from FreeSWITCH instance at the point

the event was triggered. (in microseconds, divide by

1000 to get milliseconds).

1356721719352143
Event-Name

Event type or class. See 2. Classes (or event types)

below.

RE_SCHEDULE
Event-Sequence

Sequential ID of event on the FreeSWITCH instance.

This resets to zero after every reboot, and is not unique

to each instance. [1]

9274
FreeSWITCH-IPv4

IPv4 address of FreeSWITCH instance.

192.168.0.2
FreeSWITCH-IPv6IPv6 address of FreeSWITCH instance.::1
FreeSWITCH-Hostname

Hostname of machine that FreeSWITCH instance is

running on.

server123.example.com
server123
FreeSWITCH-Switchname

Switch name of FreeSWITCH instance, this is normally

the same as FreeSWITCH-Hostname unless you have a

complex configuration (for example, fail over,

multihoming etc).

server123.example.com
server123

2. Event hierarchy

2.1 Classes (or event types)

Most FreeSWITCH event belongs to one of the following types (grepped from source code):

Info

These are the possible values for the Event-Name field in an event. See 1. Event fields/headers above.

  • ADD_SCHEDULE
  • API
  • BACKGROUND_JOB
  • CALL_DETAIL
  • CALL_SECURE
  • CALL_SETUP_REQ
  • CALL_UPDATE
  • CDR
  • CHANNEL_ANSWER
  • CHANNEL_APPLICATION
  • CHANNEL_BRIDGE
  • CHANNEL_CALLSTATE
  • CHANNEL_CREATE
  • CHANNEL_DATA
  • CHANNEL_DESTROY
  • CHANNEL_EXECUTE
  • CHANNEL_EXECUTE_COMPLETE
  • CHANNEL_GLOBAL
  • CHANNEL_HANGUP
  • CHANNEL_HANGUP_COMPLETE
  • CHANNEL_HOLD
  • CHANNEL_ORIGINATE
  • CHANNEL_OUTGOING
  • CHANNEL_PARK
  • CHANNEL_PROGRESS
  • CHANNEL_PROGRESS_MEDIA
  • CHANNEL_STATE
  • CHANNEL_UNBRIDGE
  • CHANNEL_UNHOLD
  • CHANNEL_UNPARK
  • CHANNEL_UUID
  • CLONE
  • CODEC
  • COMMAND
  • CONFERENCE_DATA
  • CONFERENCE_DATA_QUERY
  • CUSTOM
  • DEL_SCHEDULE
  • DETECTED_SPEECH
  • DETECTED_TONE
  • DEVICE_STATE
  • DTMF
  • EXE_SCHEDULE
  • FAILURE
  • GENERAL
  • HEARTBEAT
  • LOG
  • MEDIA_BUG_START
  • MEDIA_BUG_STOP
  • MESSAGE
  • MESSAGE_QUERY
  • MESSAGE_WAITING
  • MODULE_LOAD
  • MODULE_UNLOAD
  • NAT
  • NOTALK
  • NOTIFY
  • NOTIFY_IN
  • PHONE_FEATURE
  • PHONE_FEATURE_SUBSCRIBE
  • PLAYBACK_START
  • PLAYBACK_STOP
  • PRESENCE_IN
  • PRESENCE_OUT
  • PRESENCE_PROBE
  • PRIVATE_COMMAND
  • PUBLISH
  • QUEUE_LEN
  • RECORD_START
  • RECORD_STOP
  • RECV_INFO
  • RECV_MESSAGE
  • RECV_RTCP_MESSAGE
  • RECYCLE
  • RELOADXML
  • REQUEST_PARAMS
  • RE_SCHEDULE
  • ROSTER
  • SEND_INFO
  • SEND_MESSAGE
  • SESSION_HEARTBEAT
  • SHUTDOWN
  • STARTUP
  • SUBCLASS_ANY
  • TALK
  • TRAP
  • UNPUBLISH

2.2 Subclasses (or CUSTOM events)

A CUSTOM event (i.e., events with an Event-Name: CUSTOM field) is a generic class to define events that is specific to a module, a feature, or to a service. 

CUSTOM events are used with the Event-Subclass field denoting the event's role and meaning.

CUSTOM events are employed by

See CUSTOM Event SUBCLASSES (Event-Subclass) for a complete list of subclasses.

3. Channel events

The channel events are event types/classes that can be used to monitor which calls come into an extension gets, and in what state states are the calls currently arein.

Channel events can carry additional information for the protocol (i.e. SIP) used to transport the call. This information can safely be ignored, you don't have to use it to be able to track calls.

The minimum information sent for channel events is (plus the headers in 0.1 Minimum event information above should of course be included):

Code Block
Channel-State: CS_NEW
Channel-State-Number: 0
Channel-Name: sofia/192.168.0.58/jonas%40192.168.0.58%3A5060

...


Info
titleChannel states

...

The state the channel can be in

...

. Indicated by the Channel-State and Channel-State-Number, which are sent with all CHANNEL events.

...

See Channel States for the complete list.

3.1 CHANNEL_CALLSTATE event

Status
colourYellow
titleTODO

Expand
titleWhat is the difference between CHANNEL_CALLSTATE and CHANNEL_STATE? (click to expand)


Panel
bgColor#ffe79e
borderStyledashed

There seems to be a correspondence between channel states and CHANNEL_*STATE events. For example, only saw CHANNEL_CALLSTATE with channel states RINGING and HANGUP, and CHANNEL_STATE with the rest.

Also corroborated by a mailing list thread: https://lists.freeswitch.org/pipermail/freeswitch-users/2012-February/080189.html, and the answer may lies in switch_core_state_machine.c.

David Artuñedo Guillén David at jajah.com
Tue Feb 7 12:05:13 MSK 2012


Hi,

I'm new to FreeSwitch world. I'm looking at using the
mod_event_socket interface to write some simple call
control app. The Events I'm interested at are
CHANNEL_STATE and CHANNEL_CALLSTATE to recognize the
status of the calls and how they progress. I have not
found any docs describing the state machines for
channels and Calls. I look up in the Source code as
well and couldn't find the place where the state machine
is implemented. Does anybody know where can I find this info? EG, when setting up some call through FS these are the
events I am getting with the uuids associated:
bbac39e0-9025-4969-a6ba-b49c89b12237 CHANNEL_STATE CS_INIT bbac39e0-9025-4969-a6ba-b49c89b12237 CHANNEL_CALLSTATE RINGING bbac39e0-9025-4969-a6ba-b49c89b12237

...

 

...

 

...

 

...

CHANNEL_STATE   CS_ROUTING
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_STATE   CS_CONSUME_MEDIA
9a66eaf9-e11e-4f9c-9623-19deac73fc2e 

...

 

...

 

...

 

...

CHANNEL_CALLSTATE 

...

 

...

 

...

 

...

   ACTIVE
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_CALLSTATE       EARLY
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_CALLSTATE       ACTIVE
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_STATE   CS_EXECUTE
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_STATE   CS_HIBERNATE
9a66eaf9-e11e-4f9c-9623-19deac73fc2e    CHANNEL_STATE   CS_HIBERNATE
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_STATE   CS_RESET
9a66eaf9-e11e-4f9c-9623-19deac73fc2e    CHANNEL_STATE   CS_RESET
9a66eaf9-e11e-4f9c-9623-19deac73fc2e    CHANNEL_STATE   CS_SOFT_EXECUTE
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_STATE   CS_SOFT_EXECUTE
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_STATE   CS_CONSUME_MEDIA

...

bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_STATE   CS_EXCHANGE_MEDIA
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_CALLSTATE       HANGUP
bbac39e0-9025-4969-a6ba-b49c89b12237 

...

 

...

 

...

 

...

CHANNEL_STATE 

...

 

...

 CS_

...

HANGUP
9a66eaf9-e11e-4f9c-9623-19deac73fc2e    CHANNEL_STATE   CS_PARK
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_STATE   CS_REPORTING
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_CALLSTATE    

...

 

...

 

...

 

...

See also Channel States

CHANNEL_CALLSTATE

DOWN
bbac39e0-9025-4969-a6ba-b49c89b12237    CHANNEL_STATE   CS_DESTROY

Thanks in advance.

David

The reply:

João Mesquita jmesquita at freeswitch.org
Tue Feb 7 19:47:32 MSK 2012


The documentation of this state machine is something that I would love to 
have documented somewhere. Unfortunately, very few people really know how
it works and most of them are busy actually coding the core of freeswitch. I wonder if someday someone will accept this challenge and document it, it
would help a lot of other not-so-core developers to understand how things
work inside FS. Regards, -- João Mesquita





Code Block
languagetext
titleCHANNEL_CALLSTATE example
collapsetrue
Content-Length: 1754
Content-Type: text/event-plain

Event-Name: CHANNEL_CALLSTATE
Core-UUID: f852daae-6da9-4979-8dc8-fa11651a7891
FreeSWITCH-Hostname: test
FreeSWITCH-IPv4: 1.2.3.4
FreeSWITCH-IPv6: %3A%3A1
Event-Date-Local: 2010-12-21%2014%3A21%3A54
Event-Date-GMT: Tue,%2021%20Dec%202010%2013%3A21%3A54%20GMT
Event-Date-Timestamp: 1292937714788536
Event-Calling-File: switch_channel.c
Event-Calling-Function: switch_channel_perform_set_callstate
Event-Calling-Line-Number: 213
Original-Channel-Call-State: HANGUP
Channel-State: CS_DESTROY
Channel-Call-State: DOWN
Channel-State-Number: 12
Channel-Name: sofia/internal_et/8000%40sipdomain.de
Unique-ID: 005f03fa-c803-428e-92cb-10534ac780dd
Call-Direction: inbound
Presence-Call-Direction: inbound
Channel-Presence-ID: 8000%40sipdomain.de
Answer-State: hangup
Channel-Read-Codec-Name: G722
Channel-Read-Codec-Rate: 16000
Channel-Read-Codec-Bit-Rate: 64000
Channel-Write-Codec-Name: G722
Channel-Write-Codec-Rate: 16000
Channel-Write-Codec-Bit-Rate: 64000
Caller-Direction: inbound
Caller-Username: 8000
Caller-Dialplan: LUA
Caller-Caller-ID-Name: Helmut%20Kuper
Caller-Caller-ID-Number: 8000
Caller-Network-Addr: 2.2.2.2
Caller-ANI: 8000
Caller-Destination-Number: ***6
Caller-Unique-ID: 005f03fa-c803-428e-92cb-10534ac780dd
Caller-Source: mod_sofia
Caller-Context: internal.lua
Caller-Channel-Name: sofia/internal_et/8000%40sipdomain.de
Caller-Profile-Index: 1
Caller-Profile-Created-Time: 1292937711184483
Caller-Channel-Created-Time: 1292937711184483
Caller-Channel-Answered-Time: 1292937711200482
Caller-Channel-Progress-Time: 0
Caller-Channel-Progress-Media-Time: 1292937711200482
Caller-Channel-Hangup-Time: 1292937714786536
Caller-Channel-Transfer-Time: 0
Caller-Screen-Bit: true
Caller-Privacy-Hide-Name: false
Caller-Privacy-Hide-Number: false

...

3.2 CHANNEL_CREATE

...

event

CHANNEL_CREATE is sent when an extension is going to do something. It can either be dialing someone or it can be an incoming call to an extension.

The This event does not have any additional information.

Code Block
titleCHANNEL_CREATE example
collapsetrue
Event-Name: CHANNEL_CREATE
Core-UUID: 17c1c070-8a13-11de-9ab6-91a5c9f91e77
FreeSWITCH-Hostname: jmesquita-dell
FreeSWITCH-IPv4: 186.18.21.203
FreeSWITCH-IPv6: %3A%3A1
Event-Date-Local: 2009-08-16%2000%3A26%3A08
Event-Date-GMT: Sun,%2016%20Aug%202009%2003%3A26%3A08%20GMT
Event-Date-Timestamp: 1250393168131798
Event-Calling-File: switch_channel.c
Event-Calling-Function: switch_channel_set_caller_profile
Event-Calling-Line-Number: 1428
Channel-State: CS_NEW
Channel-State-Number: 0
Channel-Name: sofia/internal/1000%40192.168.1.100
Unique-ID: 89aaa4da-8a14-11de-9ab6-91a5c9f91e77
Call-Direction: inbound
Presence-Call-Direction: inbound
Answer-State: ringing

...


3.3 CHANNEL_DESTROY event

Called when a channel should get destroyed.

Example:

Code Block
titleCHANNEL_DESTROY example
collapsetrue
Channel-Read-Codec-Name: PCMU
Channel-Read-Codec-Rate: 8000
Channel-Write-Codec-Name: PCMU
Channel-Write-Codec-Rate: 8000
Caller-Username: jonas
Caller-Dialplan: XML
Caller-Caller-ID-Name: jonas
Caller-Caller-ID-Number: jonas
Caller-Network-Addr: 192.168.0.58
Caller-Destination-Number: 192.168.0.58/arne%25192.168.0.58
Caller-Unique-ID: f66e8e31-c9fb-9b41-a9a2-a1586facb97f
Caller-Source: mod_sofia
Caller-Context: default
Caller-Channel-Name: sofia/192.168.0.58/arne
Caller-Screen-Bit: yes
Caller-Privacy-Hide-Name: no
Caller-Privacy-Hide-Number: no
Originator-Username: jonas
Originator-Dialplan: XML
Originator-Caller-ID-Name: jonas
Originator-Caller-ID-Number: jonas
Originator-Network-Addr: 192.168.0.58
Originator-Destination-Number: 541
Originator-Unique-ID: 0dd4e4f7-36ed-a04d-a8f7-7aebb683af50
Originator-Source: mod_sofia
Originator-Context: default
Originator-Channel-Name: sofia/192.168.0.58/jonas%40192.168.0.58%3A5060
Originator-Screen-Bit: yes
Originator-Privacy-Hide-Name: no
Originator-Privacy-Hide-Number: no

...

3.4 CHANNEL_STATE event

Sent when a channel has switched its call state.

This event does not contain any additional information.

Code Block
titleCHANNEL_STATE example
collapsetrue
Content-Length: 646
Content-Type: text/event-plain

Channel-State: CS_EXECUTE
Channel-State-Number: 4
Channel-Name: sofia/default/1006%4010.0.1.250%3A5060
Unique-ID: 74775b0d-b112-46e2-95af-c28258650b1b
Call-Direction: inbound
Answer-State: ringing
Event-Name: CHANNEL_STATE
Core-UUID: 2130a7d1-c1f7-44cd-8fae-8ed5946f3cec
FreeSWITCH-Hostname: localhost.localdomain
FreeSWITCH-IPv4: 10.0.1.250
FreeSWITCH-IPv6: 127.0.0.1
Event-Date-Local: 2007-12-16%2022%3A33%3A18
Event-Date-GMT: Mon,%2017%20Dec%202007%2004%3A33%3A18%20GMT
Event-Date-timestamp: 1197865998931097
Event-Calling-File: switch_channel.c
Event-Calling-Function: switch_channel_perform_set_running_state
Event-Calling-Line-Number: 620

...


3.5 CHANNEL_ANSWER event

Someone calls and answer

Example:

Code Block
titleCHANNEL_ANSWER - outbound example
collapsetrue
Answer-State:  answered
Call-Direction:  outbound
Caller-ANI:  100
Caller-Callee-ID-Name:  Outbound%20Call
Caller-Callee-ID-Number:  1000
Caller-Caller-ID-Name:  Extension%20100
Caller-Caller-ID-Number:  100
Caller-Channel-Answered-Time:  1358091528753446
Caller-Channel-Bridged-Time:  0
Caller-Channel-Created-Time:  1358091527433428
Caller-Channel-Hangup-Time:  0
Caller-Channel-Hold-Accum:  0
Caller-Channel-Last-Hold:  0
Caller-Channel-Name:  sofia/internal/sip%3A1000%40192.168.1.11%3A5062
Caller-Channel-Progress-Media-Time:  0
Caller-Channel-Progress-Time:  1358091527433428
Caller-Channel-Resurrect-Time:  0
Caller-Channel-Transfer-Time:  0
Caller-Context:  default
Caller-Destination-Number:  1000
Caller-Dialplan:  XML
Caller-Direction:  outbound
Caller-Network-Addr:  192.168.1.11
Caller-Privacy-Hide-Name:  false
Caller-Privacy-Hide-Number:  false
Caller-Profile-Created-Time:  1358091527433428
Caller-Profile-Index:  1
Caller-Screen-Bit:  true
Caller-Source:  mod_sofia
Caller-Unique-ID:  81273088-c31f-4469-85a6-c878e42210e5
Caller-Username:  100
Channel-Call-State:  ACTIVE
Channel-Call-UUID:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
Channel-HIT-Dialplan:  false
Channel-Name:  sofia/internal/sip%3A1000%40192.168.1.11%3A5062
Channel-Presence-ID:  1000%40192.168.1.11
Channel-Read-Codec-Bit-Rate:  64000
Channel-Read-Codec-Name:  PCMU
Channel-Read-Codec-Rate:  8000
Channel-State:  CS_CONSUME_MEDIA
Channel-State-Number:  7
Channel-Write-Codec-Bit-Rate:  64000
Channel-Write-Codec-Name:  PCMU
Channel-Write-Codec-Rate:  8000
Core-UUID:  347c8e76-2a34-423a-8199-50860933a276
Event-Calling-File:  switch_channel.c
Event-Calling-Function:  switch_channel_perform_mark_answered
Event-Calling-Line-Number:  3397
Event-Date-GMT:  Sun,%2013%20Jan%202013%2015%3A38%3A48%20GMT
Event-Date-Local:  2013-01-13%2010%3A38%3A48
Event-Date-Timestamp:  1358091528753446
Event-Name:  CHANNEL_ANSWER
Event-Sequence:  6726
FreeSWITCH-Hostname:  aztrock-home
FreeSWITCH-IPv4:  192.168.1.11
FreeSWITCH-IPv6:  %3A%3A1
FreeSWITCH-Switchname:  aztrock-home
Other-Leg-ANI:  100
Other-Leg-Caller-ID-Name:  100
Other-Leg-Caller-ID-Number:  100
Other-Leg-Channel-Answered-Time:  0
Other-Leg-Channel-Bridged-Time:  0
Other-Leg-Channel-Created-Time:  0
Other-Leg-Channel-Hangup-Time:  0
Other-Leg-Channel-Hold-Accum:  0
Other-Leg-Channel-Last-Hold:  0
Other-Leg-Channel-Name:  sofia/internal/100%40192.168.1.11
Other-Leg-Channel-Progress-Media-Time:  0
Other-Leg-Channel-Progress-Time:  1358091527433428
Other-Leg-Channel-Resurrect-Time:  0
Other-Leg-Channel-Transfer-Time:  0
Other-Leg-Context:  default
Other-Leg-Destination-Number:  1000
Other-Leg-Dialplan:  XML
Other-Leg-Direction:  inbound
Other-Leg-Network-Addr:  192.168.1.11
Other-Leg-Privacy-Hide-Name:  false
Other-Leg-Privacy-Hide-Number:  false
Other-Leg-Profile-Created-Time:  0
Other-Leg-Screen-Bit:  true
Other-Leg-Source:  mod_sofia
Other-Leg-Unique-ID:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
Other-Leg-Username:  100
Other-Type:  originator
Presence-Call-Direction:  outbound
Unique-ID:  81273088-c31f-4469-85a6-c878e42210e5
variable_RFC2822_DATE:  Sun,%2013%20Jan%202013%2010%3A38%3A47%20-0500
variable_absolute_codec_string:  PCMU%408000h%4020i%4064000b,PCMA%408000h%4020i%4064000b
variable_advertised_media_ip:  192.168.1.11
variable_call_uuid:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
variable_channel_name:  sofia/internal/sip%3A1000%40192.168.1.11%3A5062
variable_dialed_domain:  192.168.1.11
variable_dialed_extension:  1000
variable_dialed_user:  1000
variable_direction:  outbound
variable_dtmf_type:  info
variable_ep_codec_string:  PCMU%408000h%4020i%4064000b
variable_export_vars:  RFC2822_DATE,dialed_extension
variable_is_outbound:  true
variable_local_media_ip:  192.168.1.11
variable_local_media_port:  20342
variable_max_forwards:  69
variable_originate_early_media:  true
variable_originating_leg_uuid:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
variable_originator:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
variable_originator_codec:  PCMU%408000h%4020i%4064000b,PCMA%408000h%4020i%4064000b
variable_presence_id:  1000%40192.168.1.11
variable_read_codec:  PCMU
variable_read_rate:  8000
variable_recovery_profile_name:  internal
variable_remote_media_ip:  192.168.1.11
variable_remote_media_port:  30882
variable_rtp_use_ssrc:  3506474416
variable_session_id:  66
variable_signal_bond:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
variable_sip_audio_recv_pt:  0
variable_sip_call_id:  29869441-d83a-1230-d6a0-60eb69774d98
variable_sip_contact_host:  192.168.1.11
variable_sip_contact_port:  5062
variable_sip_contact_uri:  1000%40192.168.1.11%3A5062
variable_sip_contact_user:  1000
variable_sip_cseq:  38709699
variable_sip_destination_url:  sip%3A1000%40192.168.1.11%3A5062
variable_sip_from_display:  Extension%20100
variable_sip_from_host:  192.168.1.11
variable_sip_from_tag:  814HZmprB9N5m
variable_sip_from_uri:  100%40192.168.1.11
variable_sip_from_user:  100
variable_sip_full_from:  %22Extension%20100%22%20%3Csip%3A100%40192.168.1.11%3E%3Btag%3D814HZmprB9N5m
variable_sip_full_to:  %3Csip%3A1000%40192.168.1.11%3E%3Btag%3D90972448-fb32-4a25-b753-2c6a56174df1
variable_sip_full_via:  SIP/2.0/UDP%20192.168.1.11%3Brport%3D5060%3Breceived%3D192.168.1.11%3Bbranch%3Dz9hG4bK174m9mUp22Bej
variable_sip_invite_domain:  192.168.1.11
variable_sip_local_network_addr:  181.133.83.254
variable_sip_local_sdp_str:  v%3D0%0Ao%3DFreeSWITCH%201358071185%201358071186%20IN%20IP4%20192.168.1.11%0As%3DFreeSWITCH%0Ac%3DIN%20IP4%20192.168.1.11%0At%3D0%200%0Am%3Daudio%2020342%20RTP/AVP%200%208%20101%2013%0Aa%3Drtpmap%3A101%20telephone-event/8000%0Aa%3Dfmtp%3A101%200-16%0Aa%3Dptime%3A20%0Aa%3Dsendrecv%0A
variable_sip_network_ip:  192.168.1.11
variable_sip_network_port:  5062
variable_sip_outgoing_contact_uri:  %3Csip%3Amod_sofia%40192.168.1.11%3A5060%3E
variable_sip_profile_name:  internal
variable_sip_recover_contact:  %3Csip%3A1000%40192.168.1.11%3A5062%3E
variable_sip_recover_via:  SIP/2.0/UDP%20192.168.1.11%3Brport%3D5060%3Breceived%3D192.168.1.11%3Bbranch%3Dz9hG4bK174m9mUp22Bej
variable_sip_reply_host:  192.168.1.11
variable_sip_reply_port:  5062
variable_sip_req_uri:  1000%40192.168.1.11%3A5062
variable_sip_to_host:  192.168.1.11
variable_sip_to_tag:  90972448-fb32-4a25-b753-2c6a56174df1
variable_sip_to_uri:  1000%40192.168.1.11
variable_sip_to_user:  1000
variable_sip_use_codec_name:  PCMU
variable_sip_use_codec_ptime:  20
variable_sip_use_codec_rate:  8000
variable_sip_use_pt:  0
variable_sofia_profile_name:  internal
variable_switch_m_sdp:  v%3D0%0D%0Ao%3Daztrock-home%203567080327%200%20IN%20IP4%20192.168.1.11%0D%0As%3Dsflphone%0D%0Ac%3DIN%20IP4%20192.168.1.11%0D%0At%3D0%200%0D%0Am%3Daudio%2032770%20RTP/AVP%200%203%208%209%20110%20111%20112%0D%0Aa%3Drtpmap%3A0%20PCMU/8000%0D%0Aa%3Drtpmap%3A3%20GSM/8000%0D%0Aa%3Drtpmap%3A8%20PCMA/8000%0D%0Aa%3Drtpmap%3A9%20G722/8000%0D%0Aa%3Drtpmap%3A110%20speex/8000%0D%0Aa%3Drtpmap%3A111%20speex/16000%0D%0Aa%3Drtpmap%3A112%20speex/32000%0D%0A
variable_switch_r_sdp:  v%3D0%0D%0Ao%3Daztrock-home%203567080327%201%20IN%20IP4%20192.168.1.11%0D%0As%3Dsflphone%0D%0Ac%3DIN%20IP4%20192.168.1.11%0D%0At%3D0%200%0D%0Am%3Daudio%2030882%20RTP/AVP%200%0D%0Aa%3Drtpmap%3A0%20PCMU/8000%0D%0A
variable_uuid:  81273088-c31f-4469-85a6-c878e42210e5
variable_write_codec:  PCMU
variable_write_rate:  8000

...

Someone has answered the call.

Example:



Code Block
titleCHANNEL_ANSWER - inbound example
collapsetrue
Answer-State:  answered
Call-Direction:  inbound
Caller-ANI:  100
Caller-Callee-ID-Name:  Outbound%20Call
Caller-Callee-ID-Number:  1000
Caller-Caller-ID-Name:  100
Caller-Caller-ID-Number:  100
Caller-Channel-Answered-Time:  1358091528773430
Caller-Channel-Bridged-Time:  0
Caller-Channel-Created-Time:  1358091527413417
Caller-Channel-Hangup-Time:  0
Caller-Channel-Hold-Accum:  0
Caller-Channel-Last-Hold:  0
Caller-Channel-Name:  sofia/internal/100%40192.168.1.11
Caller-Channel-Progress-Media-Time:  1358091527453440
Caller-Channel-Progress-Time:  1358091527433428
Caller-Channel-Resurrect-Time:  0
Caller-Channel-Transfer-Time:  0
Caller-Context:  default
Caller-Destination-Number:  1000
Caller-Dialplan:  XML
Caller-Direction:  inbound
Caller-Network-Addr:  192.168.1.11
Caller-Privacy-Hide-Name:  false
Caller-Privacy-Hide-Number:  false
Caller-Profile-Created-Time:  1358091527413417
Caller-Profile-Index:  1
Caller-Screen-Bit:  true
Caller-Source:  mod_sofia
Caller-Unique-ID:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
Caller-Username:  100
Channel-Call-State:  ACTIVE
Channel-Call-UUID:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
Channel-HIT-Dialplan:  true
Channel-Name:  sofia/internal/100%40192.168.1.11
Channel-Presence-ID:  100%40192.168.1.11
Channel-Read-Codec-Bit-Rate:  64000
Channel-Read-Codec-Name:  PCMU
Channel-Read-Codec-Rate:  8000
Channel-State:  CS_EXECUTE
Channel-State-Number:  4
Channel-Write-Codec-Bit-Rate:  64000
Channel-Write-Codec-Name:  PCMU
Channel-Write-Codec-Rate:  8000
Core-UUID:  347c8e76-2a34-423a-8199-50860933a276
Event-Calling-File:  switch_channel.c
Event-Calling-Function:  switch_channel_perform_mark_answered
Event-Calling-Line-Number:  3397
Event-Date-GMT:  Sun,%2013%20Jan%202013%2015%3A38%3A48%20GMT
Event-Date-Local:  2013-01-13%2010%3A38%3A48
Event-Date-Timestamp:  1358091528773430
Event-Name:  CHANNEL_ANSWER
Event-Sequence:  6730
FreeSWITCH-Hostname:  aztrock-home
FreeSWITCH-IPv4:  192.168.1.11
FreeSWITCH-IPv6:  %3A%3A1
FreeSWITCH-Switchname:  aztrock-home
Presence-Call-Direction:  inbound
Unique-ID:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
variable_DIALSTATUS:  INVALIDARGS
variable_DP_MATCH:  ARRAY%3A%3A1000%7C%3A1000
variable_RFC2822_DATE:  Sun,%2013%20Jan%202013%2010%3A38%3A47%20-0500
variable_accountcode:  100
variable_advertised_media_ip:  192.168.1.11
variable_call_timeout:  30
variable_call_uuid:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
variable_called_party_callgroup:  techsupport
variable_callgroup:  techsupport
variable_channel_name:  sofia/internal/100%40192.168.1.11
variable_continue_on_fail:  true
variable_current_application:  bridge
variable_current_application_data:  user/1000%40192.168.1.11
variable_default_areacode:  918
variable_default_gateway:  example.com
variable_dialed_domain:  192.168.1.11
variable_dialed_extension:  1000
variable_dialed_user:  1000
variable_direction:  inbound
variable_domain_name:  192.168.1.11
variable_dtmf_type:  info
variable_effective_caller_id_name:  Extension%20100
variable_effective_caller_id_number:  100
variable_endpoint_disposition:  EARLY%20MEDIA
variable_ep_codec_string:  PCMU%408000h%4020i%4064000b,PCMA%408000h%4020i%4064000b
variable_export_vars:  RFC2822_DATE,dialed_extension
variable_hangup_after_bridge:  true
variable_inherit_codec:  true
variable_local_media_ip:  192.168.1.11
variable_local_media_port:  25992
variable_max_forwards:  70
variable_number_alias:  100
variable_originate_disposition:  failure
variable_originate_signal_bond:  81273088-c31f-4469-85a6-c878e42210e5
variable_originated_legs:  81273088-c31f-4469-85a6-c878e42210e5%3BOutbound%20Call%3B1000
variable_outbound_caller_id_name:  FreeSWITCH
variable_outbound_caller_id_number:  0000000000
variable_presence_id:  100%40192.168.1.11
variable_read_codec:  PCMU
variable_read_rate:  8000
variable_record_stereo:  true
variable_recovery_profile_name:  internal, variable_remote_media_ip:  192.168.1.11, variable_remote_media_port:  32770, variable_ringback:  %25(2000,4000,440,480), variable_rtp_use_ssrc:  3371543935, variable_session_id:  65, variable_sip_audio_recv_pt:  0, variable_sip_auth_realm:  192.168.1.11, variable_sip_auth_username:  100, variable_sip_authorized:  true, variable_sip_call_id:  137c98dc-bc0d-4cb0-891c-585ec8b6226f, variable_sip_contact_host:  192.168.1.11, variable_sip_contact_port:  5062, variable_sip_contact_uri:  100%40192.168.1.11%3A5062, variable_sip_contact_user:  100, variable_sip_from_host:  192.168.1.11, variable_sip_from_tag:  35a4c26c-4960-4cf1-8368-9e1aa2c65b48, variable_sip_from_uri:  100%40192.168.1.11, variable_sip_from_user:  100, variable_sip_from_user_stripped:  100, variable_sip_full_from:  %3Csip%3A100%40192.168.1.11%3E%3Btag%3D35a4c26c-4960-4cf1-8368-9e1aa2c65b48, variable_sip_full_to:  %3Csip%3A1000%40192.168.1.11%3E, variable_sip_full_via:  SIP/2.0/UDP%20192.168.1.11%3A5062%3Brport%3D5062%3Bbranch%3Dz9hG4bKPje320db2f-e7a2-4ee1-8013-017337e5cab3, variable_sip_local_network_addr:  181.133.83.254
variable_sip_local_sdp_str:  v%3D0%0Ao%3DFreeSWITCH%201358065535%201358065537%20IN%20IP4%20192.168.1.11%0As%3DFreeSWITCH%0Ac%3DIN%20IP4%20192.168.1.11%0At%3D0%200%0Am%3Daudio%2025992%20RTP/AVP%200%0Aa%3Drtpmap%3A0%20PCMU/8000%0Aa%3DsilenceSupp%3Aoff%20-%20-%20-%20-%0Aa%3Dptime%3A20%0Aa%3Dsendrecv%0A
variable_sip_network_ip:  192.168.1.11
variable_sip_network_port:  5062
variable_sip_number_alias:  100
variable_sip_received_ip:  192.168.1.11
variable_sip_received_port:  5062
variable_sip_req_host:  192.168.1.11
variable_sip_req_uri:  1000%40192.168.1.11
variable_sip_req_user:  1000
variable_sip_to_host:  192.168.1.11
variable_sip_to_uri:  1000%40192.168.1.11
variable_sip_to_user:  1000
variable_sip_use_codec_name:  PCMU
variable_sip_use_codec_ptime:  20
variable_sip_use_codec_rate:  8000
variable_sip_use_pt:  0
variable_sip_via_host:  192.168.1.11
variable_sip_via_port:  5062
variable_sip_via_protocol:  udp
variable_sip_via_rport:  5062
variable_sofia_profile_name:  internal
variable_switch_m_sdp:  v%3D0%0D%0Ao%3Daztrock-home%203567080327%201%20IN%20IP4%20192.168.1.11%0D%0As%3Dsflphone%0D%0Ac%3DIN%20IP4%20192.168.1.11%0D%0At%3D0%200%0D%0Am%3Daudio%2030882%20RTP/AVP%200%0D%0Aa%3Drtpmap%3A0%20PCMU/8000%0D%0A
variable_switch_r_sdp:  v%3D0%0D%0Ao%3Daztrock-home%203567080327%200%20IN%20IP4%20192.168.1.11%0D%0As%3Dsflphone%0D%0Ac%3DIN%20IP4%20192.168.1.11%0D%0At%3D0%200%0D%0Am%3Daudio%2032770%20RTP/AVP%200%203%208%209%20110%20111%20112%0D%0Aa%3Drtpmap%3A0%20PCMU/8000%0D%0Aa%3Drtpmap%3A3%20GSM/8000%0D%0Aa%3Drtpmap%3A8%20PCMA/8000%0D%0Aa%3Drtpmap%3A9%20G722/8000%0D%0Aa%3Drtpmap%3A110%20speex/8000%0D%0Aa%3Drtpmap%3A111%20speex/16000%0D%0Aa%3Drtpmap%3A112%20speex/32000%0D%0A
variable_toll_allow:  domestic,international,local
variable_transfer_fallback_extension:  operator
variable_transfer_ringback:  local_stream%3A//moh
variable_user_context:  default
variable_user_name:  100
variable_uuid:  c9bbde8b-379b-45d4-b193-3f761a44f3e2
variable_write_codec:  PCMU
variable_write_rate:  8000

...


3.6 CHANNEL_HANGUP event

One of the users has hangup. (How

Status
colourYellow
titleTODO
 How do we know which one?)

Code Block
titleCHANNEL_HANGUP example
collapsetrue
Hangup-Cause: NORMAL_CLEARING
Channel-Read-Codec-Name: PCMU
Channel-Read-Codec-Rate: 8000
Channel-Write-Codec-Name: PCMU
Channel-Write-Codec-Rate: 8000
Caller-Username: jonas
Caller-Dialplan: XML
Caller-Caller-ID-Name: jonas
Caller-Caller-ID-Number: jonas
Caller-Network-Addr: 192.168.0.58
Caller-Destination-Number: 541
Caller-Unique-ID: 0dd4e4f7-36ed-a04d-a8f7-7aebb683af50
Caller-Source: mod_sofia
Caller-Context: default
Caller-Channel-Name: sofia/192.168.0.58/jonas%40192.168.0.58%3A5060
Caller-Screen-Bit: yes
Caller-Privacy-Hide-Name: no
Caller-Privacy-Hide-Number: no
Originatee-Username: jonas
Originatee-Dialplan: XML
Originatee-Caller-ID-Name: jonas
Originatee-Caller-ID-Number: jonas
Originatee-Network-Addr: 192.168.0.58
Originatee-Destination-Number: 192.168.0.58/arne%25192.168.0.58
Originatee-Unique-ID: f66e8e31-c9fb-9b41-a9a2-a1586facb97f
Originatee-Source: mod_sofia
Originatee-Context: default
Originatee-Channel-Name: sofia/192.168.0.58/arne
Originatee-Screen-Bit: yes
Originatee-Privacy-Hide-Name: no
Originatee-Privacy-Hide-Number: no

...

Additional information


Tip

Read more about possible hangup causes.


3.7 CHANNEL_HANGUP_COMPLETE event


Code Block
titleCHANNEL_HANGUP_COMPLETE example
collapsetrue
RECV EVENT
Event-Name: CHANNEL_HANGUP_COMPLETE
Core-UUID: 9b0de0b8-f55e-40d8-a2bd-179310b53493
FreeSWITCH-Hostname: myhost                    
FreeSWITCH-IPv4: 192.168.0.2                   
FreeSWITCH-IPv6: ::1                           
Event-Date-Local: 2009-10-09 20:08:26          
Event-Date-GMT: Sat, 10 Oct 2009 00:08:26 GMT  
Event-Date-Timestamp: 1255133306952270         
Event-Calling-File: switch_core_state_machine.c
Event-Calling-Function: switch_core_session_hangup_state
Event-Calling-Line-Number: 503                          
Hangup-Cause: NORMAL_CLEARING                           
Channel-State: CS_HANGUP                                
Channel-State-Number: 10                                
Channel-Name: sofia/internal/1000@192.168.0.2           
Unique-ID: e5a82e39-6dc1-4d7d-a300-aa9cd4284073         
Call-Direction: inbound                                 
Presence-Call-Direction: inbound                        
Answer-State: answered                                  
Channel-Read-Codec-Name: GSM                            
Channel-Read-Codec-Rate: 8000                           
Channel-Write-Codec-Name: GSM                           
Channel-Write-Codec-Rate: 8000                          
Caller-Username: 1000                                   
Caller-Dialplan: XML                                    
Caller-Caller-ID-Name: 1000                             
Caller-Caller-ID-Number: 1000                           
Caller-Network-Addr: 192.168.0.104                      
Caller-Destination-Number: 3030                         
Caller-Unique-ID: e5a82e39-6dc1-4d7d-a300-aa9cd4284073  
Caller-Source: mod_sofia                                
Caller-Context: default                                 
Caller-Channel-Name: sofia/internal/1000@192.168.0.2    
Caller-Profile-Index: 1                                 
Caller-Profile-Created-Time: 1255133286498223           
Caller-Channel-Created-Time: 1255133286498223           
Caller-Channel-Answered-Time: 1255133286504829          
Caller-Channel-Progress-Time: 0                         
Caller-Channel-Progress-Media-Time: 0                   
Caller-Channel-Hangup-Time: 1255133306952270            
Caller-Channel-Transfer-Time: 0                         
Caller-Screen-Bit: true                                 
Caller-Privacy-Hide-Name: false                         
Caller-Privacy-Hide-Number: false                       
variable_sip_received_ip: 192.168.0.104                 
variable_sip_received_port: 5060                        
variable_sip_via_protocol: udp                          
variable_sip_authorized: true                           
variable_sip_number_alias: 1000                         
variable_sip_auth_username: 1000                        
variable_sip_auth_realm: 192.168.0.2                    
variable_number_alias: 1000                             
variable_user_name: 1000                                
variable_domain_name: 192.168.0.2                       
variable_toll_allow: domestic,international,local       
variable_accountcode: 1000                              
variable_user_context: default                          
variable_effective_caller_id_name: Extension 1000       
variable_effective_caller_id_number: 1000               
variable_outbound_caller_id_name: FreeSWITCH            
variable_outbound_caller_id_number: 0000000000          
variable_callgroup: techsupport                         
variable_record_stereo: true                            
variable_default_gateway: example.com                   
variable_default_areacode: 918                          
variable_transfer_fallback_extension: operator          
variable_sip_from_params: transport=UDP                 
variable_sip_from_user: 1000                            
variable_sip_from_uri: 1000@192.168.0.2                 
variable_sip_from_host: 192.168.0.2                     
variable_sip_from_user_stripped: 1000                   
variable_sip_from_tag: 7bae8202                         
variable_sofia_profile_name: internal                   
variable_sip_req_params: transport=UDP                  
variable_sip_req_user: 3030                             
variable_sip_req_uri: 3030@192.168.0.2                  
variable_sip_req_host: 192.168.0.2                      
variable_sip_to_params: transport=UDP                   
variable_sip_to_user: 3030                              
variable_sip_to_uri: 3030@192.168.0.2                   
variable_sip_to_host: 192.168.0.2                       
variable_sip_contact_params: transport=UDP              
variable_sip_contact_user: 1000                         
variable_sip_contact_port: 60780                        
variable_sip_contact_uri: 1000@190.52.138.225:60780     
variable_sip_contact_host: 190.52.138.225               
variable_channel_name: sofia/internal/1000@192.168.0.2  
variable_sip_call_id: ODZhNDk5YzlmZDg3YTExOWU4NDU3NmM2ZmI1MzFmNDU.
variable_sip_via_host: 190.52.138.225                             
variable_sip_via_port: 60780                                      
variable_sip_via_rport: 5060                                      
variable_max_forwards: 70                                         
variable_presence_id: 1000@192.168.0.2                            
variable_switch_r_sdp: v=0                                        
o=Z 0 0 IN IP4 190.52.138.225                                     
s=Z                                                               
c=IN IP4 190.52.138.225                                           
t=0 0                                                             
m=audio 60790 RTP/AVP 3 110 98 8 0 101                            
a=rtpmap:3 GSM/8000                                               
a=rtpmap:110 speex/8000                                           
a=rtpmap:98 iLBC/8000                                             
a=fmtp:98 mode=30                                                 
a=rtpmap:8 PCMA/8000                                              
a=rtpmap:0 PCMU/8000                                              
a=rtpmap:101 telephone-event/8000                                 
a=fmtp:101 0-15                                                   

variable_remote_media_ip: 190.52.138.225
variable_remote_media_port: 60790       
variable_write_codec: GSM               
variable_write_rate: 8000               
variable_local_media_ip: 192.168.0.2    
variable_local_media_port: 19878        
variable_endpoint_disposition: ANSWER   
variable_current_application_data: $1-192.168.0.2@default
variable_current_application: conference                 
variable_conference_name: $1-192.168.0.2                 
variable_sip_term_status: 200                            
variable_sip_term_cause: 16                              
variable_sip_user_agent: Zoiper rev.4688                 
variable_sip_hangup_disposition: recv_bye                
variable_read_codec: GSM                                 
variable_read_rate: 8000                                 
variable_hangup_cause: NORMAL_CLEARING                   
variable_hangup_cause_q850: 16                           
variable_digits_dialed: none                             
variable_start_stamp: 2009-10-09 20:08:06                
variable_profile_start_stamp: 2009-10-09 20:08:06        
variable_answer_stamp: 2009-10-09 20:08:06               
variable_end_stamp: 2009-10-09 20:08:26                  
variable_start_epoch: 1255133286                         
variable_start_uepoch: 1255133286498223                  
variable_profile_start_epoch: 1255133286                 
variable_profile_start_uepoch: 1255133286498223          
variable_answer_epoch: 1255133286                        
variable_answer_uepoch: 1255133286504829                 
variable_progress_epoch: 0                               
variable_progress_uepoch: 0                              
variable_progress_media_epoch: 0                         
variable_progress_media_uepoch: 0                        
variable_end_epoch: 1255133306                           
variable_end_uepoch: 1255133306952270                    
variable_last_app: conference                            
variable_last_arg: $1-192.168.0.2@default                
variable_caller_id: "1000" <1000>                        
variable_duration: 20                                    
variable_billsec: 20                                     
variable_progresssec: 0                                  
variable_answersec: 0                                    
variable_progress_mediasec: 0                            
variable_flow_billsec: 20                                
variable_mduration: 20454                                
variable_billmsec: 20448                                 
variable_progressmsec: 0                                 
variable_answermsec: 6                                   
variable_progress_mediamsec: 0                           
variable_flow_billmsec: 20454                            
variable_uduration: 20454047                             
variable_billusec: 20447441                              
variable_progressusec: 0                                 
variable_answerusec: 6606                                
variable_progress_mediausec: 0                           
variable_flow_billusec: 20454047                         
variable_rtp_audio_in_raw_bytes: 45765                   
variable_rtp_audio_in_media_bytes: 45630                 
variable_rtp_audio_in_packet_count: 1017                 
variable_rtp_audio_in_media_packet_count: 1014           
variable_rtp_audio_in_skip_packet_count: 8               
variable_rtp_audio_in_jb_packet_count: 0                 
variable_rtp_audio_in_dtmf_packet_count: 0               
variable_rtp_audio_in_cng_packet_count: 0                
variable_rtp_audio_in_flush_packet_count: 0              
variable_rtp_audio_out_raw_bytes: 44055                  
variable_rtp_audio_out_media_bytes: 44055                
variable_rtp_audio_out_packet_count: 979                 
variable_rtp_audio_out_media_packet_count: 979           
variable_rtp_audio_out_skip_packet_count: 0              
variable_rtp_audio_out_dtmf_packet_count: 0              
variable_rtp_audio_out_cng_packet_count: 0

...

CHANNEL_EXECUTE

This event indicates that the PBX is doing something with the call. (Typically looking in the dial plan).

...

CHANNEL_PROGRESS_MEDIA

See Also

CHANNEL_PROGRESS

CHANNEL_OUTGOING

An outgoing call is created.

...

The following modules have CUSTOM events:

mod_sofia - Sofia-SIP module.

mod_dingaling - Jabber/GoogleTalk Talk integration module.

mod_portaudio - Host machine sound card.

mod_conference - Conference module.

mod_event_multicast

mod_skinny - Skinny (aka SCCP) module.

mod_callcenter - Call queuing application for call center needs.

mod_spandsp - SpanDSP module including T.38 fax support.

IVR Menu - Built IVR Engine events since FreeSWITCH 1.6