### Example SCGI Binding Configuration

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/xml-interfaces/mod_xml_scgi.mdx

This example shows a trimmed configuration for an SCGI binding named 'example'. It includes commented-out parameters for host, port, timeout, and enabling specific channel variables.

```xml
<configuration name="xml_scgi.conf" description="SCGI XML Gateway">
  <bindings>
    <binding name="example">
      <!-- one or more |-delim of configuration|directory|dialplan -->
      <!-- <param name="host" value="127.0.0.1" bindings="dialplan"/> -->
      <!-- <param name="port" value="8080"/> -->
      <!-- <param name="timeout" value="10"/> -->
      <!-- one or more of these imply you want to pick the exact variables that are transmitted -->
      <!--<param name="enable-post-var" value="Unique-ID"/>-->
    </binding>
  </bindings>
</configuration>
```

--------------------------------

### EasyRoute Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_easyroute.mdx

An example excerpt from the shipped easyroute.conf.xml file, showing how to set various parameters.

```xml
<configuration name="easyroute.conf" description="EasyRoute Module">
  <settings>
    <param name="db-username" value="root"/>
    <param name="db-password" value="password"/>
    <param name="db-dsn" value="easyroute"/>
    <param name="default-techprofile" value="sofia/default"/>
    <param name="default-gateway" value="192.168.66.6"/>
    <param name="odbc-retries" value="120"/>
    <!-- <param name="custom-query" value="call  FS_GET_SIP_LOCATION(%s);"/> -->
  </settings>
</configuration>
```

--------------------------------

### mod_osp Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_osp.mdx

An example excerpt from osp.conf.xml showing global settings and a default profile configuration for OSP connections.

```xml
<configuration name="osp.conf" description="OSP Module Configuration">
  <settings>
    <param name="debug-info" value="disabled"/>
    <param name="log-level" value="info"/>
    <param name="crypto-hardware" value="disabled"/>
    <param name="sip" module="sofia" profile="external"/>
    <param name="default-protocol" value="sip"/>
  </settings>

  <profiles>
    <profile name="default">
      <param name="service-point-url" value="http://127.0.0.1:5045/osp"/>
      <param name="device-ip" value="127.0.0.1:5080"/>
      <param name="ssl-lifetime" value="300"/>
      <param name="http-max-connections" value="20"/>
      <param name="http-persistence" value="60"/>
      <param name="http-retry-delay" value="0"/>
      <param name="http-retry-limit" value="2"/>
      <param name="http-timeout" value="10000"/>
      <param name="work-mode" value="direct"/>
      <param name="service-type" value="voice"/>
      <param name="max-destinations" value="12"/>
    </profile>
  </profiles>
</configuration>
```

--------------------------------

### Memcache Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/data-stores/mod_memcache.mdx

This is a real example from the shipped memcache.conf.xml file, showing how to specify Memcached server addresses.

```xml
<configuration name="memcache.conf" description="memcache Configuration">
  <settings>
    <!-- comma sep list of servers: eg:  localhost,otherhost:port,anotherone -->
    <param name="memcache-servers" value="localhost"/>
  </settings>
</configuration>
```

--------------------------------

### Sequential Originate Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/dialplan/dptools-reference.mdx

Example demonstrating sequential (failover) originate using a pipe separator. Legs are tried in order.

```freeswitch
sofia/internal/1001@pbx.example.com|sofia/internal/1002@pbx.example.com
```

--------------------------------

### mod_mongo Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/data-stores/mod_mongo.mdx

A minimal example of the mongo.conf.xml file, showing how to set the connection string for MongoDB.

```xml
<configuration name="mongo.conf">
  <settings>
    <!--
         mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]
    -->
    <param name="connection-string" value="mongodb://127.0.0.1:27017/?connectTimeoutMS=10000"/>

<!--
    <param name="map" value="function() { emit(this.a, 1); }"/>
    <param name="reduce" value="function(key, values) { return Array.sum(values); }"/>
    <param name="finalize" value="function(key, value) { return value;}"/>
-->

  </settings>
</configuration>
```

--------------------------------

### Memcache Get Command Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/data-stores/mod_memcache.mdx

Shows how to retrieve a value from Memcached using the 'memcache get' command in fs_cli.

```freeswitch-cli
freeswitch@> memcache get mykey
hello world
```

--------------------------------

### mod_directory Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_directory.mdx

This is an example of the `directory.conf.xml` file, showing global settings and a default profile configuration with various parameters for controlling search behavior and key mappings.

```xml
<configuration name="directory.conf" description="Directory">
  <settings>
    <!--<param name="odbc-dsn" value="dsn:user:pass"/>-->
    <!--<param name="dbname" value="directory"/>-->
  </settings>
  <profiles>
    <profile name="default">
      <param name="max-menu-attempts" value="3"/>
      <param name="min-search-digits" value="3"/>
      <param name="terminator-key" value="#"/>
      <param name="digit-timeout" value="3000"/>
      <param name="max-result" value="5"/>
      <param name="next-key" value="6"/>
      <param name="prev-key" value="4"/>
      <param name="switch-order-key" value="*"/>
      <param name="select-name-key" value="1"/>
      <param name="new-search-key" value="3"/>
      <param name="search-order" value="last_name"/>
    </profile>
  </profiles>
</configuration>
```

--------------------------------

### PocketSphinx Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/asr-tts/mod_pocketsphinx.mdx

This is an example excerpt from the shipped `pocketsphinx.conf.xml` file, showing common configuration parameters for the PocketSphinx ASR module.

```xml
<configuration name="pocketsphinx.conf" description="PocketSphinx ASR Configuration">
  <settings>
    <param name="threshold" value="400"/>
    <param name="silence-hits" value="25"/>
    <param name="listen-hits" value="1"/>
    <param name="auto-reload" value="true"/>
    <!--<param name="language-weight" value="1"/>-->
    <!--<param name="narrowband-model" value="communicator"/>-->
    <!--<param name="wideband-model" value="wsj1"/>-->
    <!--<param name="dictionary" value="default.dic"/>-->
  </settings>
</configuration>
```

--------------------------------

### mod_hiredis Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/data-stores/mod_hiredis.mdx

This example shows how to configure profiles, connections, and parameters for mod_hiredis in hiredis.conf.xml. It includes primary and secondary Redis connection details.

```xml
<configuration name="hiredis.conf" description="mod_hiredis">
  <profiles>
    <profile name="default">
      <connections>
        <connection name="primary">
          <param name="hostname" value="172.18.101.101"/>
          <param name="password" value="redis"/>
          <param name="port" value="6379"/>
          <param name="timeout_ms" value="500"/>
        </connection>
        <connection name="secondary">
          <param name="hostname" value="localhost"/>
          <param name="password" value="redis"/>
          <param name="port" value="6380"/>
          <param name="timeout_ms" value="500"/>
        </connection>
      </connections>
      <params>
        <param name="ignore-connect-fail" value="true"/>
      </params>
    </profile>
  </profiles>
</configuration>
```

--------------------------------

### mod_perl Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/integration/scripting.mdx

Example of how to configure mod_perl in perl.conf.xml, specifying XML handler script, bindings, and startup scripts.

```xml
<configuration name="perl.conf" description="PERL Configuration">
  <settings>
    <param name="xml-handler-script" value="$${temp_dir}/xml.pl"/>
    <param name="xml-handler-bindings" value="dialplan"/>
    <param name="startup-script" value="startup_script_1.pl"/>
  </settings>
</configuration>
```

--------------------------------

### Simultaneous Originate Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/dialplan/dptools-reference.mdx

Example demonstrating simultaneous (parallel) originate using a comma separator. The first leg to answer wins.

```freeswitch
sofia/internal/1001@pbx.example.com,sofia/internal/1002@pbx.example.com
```

--------------------------------

### Enterprise Parallel Originate Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/dialplan/dptools-reference.mdx

Example of enterprise parallel originate using ':_:' separator for concurrent leg dispatch with independent tracking.

```freeswitch
sofia/internal/1001@pbx.example.com:_:sofia/internal/1002@pbx.example.com
```

--------------------------------

### Start FreeSWITCH in Foreground

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/foundations/getting-started.mdx

Run the FreeSWITCH binary directly to start the service attached to the console. This is useful for monitoring startup and immediate output.

```bash
freeswitch
```

--------------------------------

### Install FreeSWITCH Packages and Sounds (Debian/Ubuntu)

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/foundations/getting-started.mdx

Installs the 'vanilla' FreeSWITCH meta package, which includes modules for the default configuration, along with US English call sounds and music on hold. This command assumes the repository has already been added.

```bash
apt-get install -y freeswitch-meta-vanilla \
  freeswitch-sounds-en-us-callie freeswitch-sounds-music
```

--------------------------------

### Limit Application Dialplan Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/applications/utility-applications.mdx

An example demonstrating the `limit` application within a FreeSWITCH dialplan extension, including a fallback extension for when the limit is exceeded.

```xml
<extension name="limit" continue="true">
  <condition>
    <action application="limit" data="db $${domain} ${sip_auth_username} ${max_calls}"/>
  </condition>
</extension>

<extension name="limit_exceeded">
  <condition field="destination_number" expression="^limit_exceeded$">
    <action application="playback" data="/sounds/overthelimit.wav"/>
    <action application="hangup"/>
  </condition>
</extension>
```

--------------------------------

### Valet Parking XML API Response Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/applications/utility-applications.mdx

Example XML output from the valet_info API command, showing active parking lots and their extensions.

```xml
<lots>
  <lot name="valet_parking_lot">
    <extension uuid="...">6001</extension>
  </lot>
</lots>
```

--------------------------------

### Start FreeSWITCH as a Daemon

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/foundations/getting-started.mdx

Run the FreeSWITCH binary with the -nc flag to start it in the background as a daemon. This allows the terminal to be used for other tasks.

```bash
freeswitch -nc
```

--------------------------------

### mod_python3 Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/integration/scripting.mdx

Example of configuring mod_python3 in python.conf.xml. Note that script values refer to Python modules, not file paths.

```xml
<configuration name="python.conf" description="PYTHON Configuration">
  <settings>
    <param name="xml-handler-script" value="dp"/>
    <param name="xml-handler-bindings" value="dialplan"/>
    <param name="startup-script" value="startup_script_1"/>
  </settings>
</configuration>
```

--------------------------------

### Chatplan Example: Echo, Local Routing, and Drop

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/dialplan/xml-dialplan.mdx

A comprehensive chatplan example demonstrating how to echo messages back, route to local SIP endpoints, and log/drop all other messages.

```xml
<?xml version="1.0" encoding="utf-8"?>
<include>
  <context name="default">

    <!-- Echo the message body back to the sender -->
    <extension name="echo">
      <condition field="to" expression="^echo@">
        <action application="reply" data="You said: ${_body}"/>
        <action application="stop"/>
      </condition>
    </extension>

    <!-- Route messages addressed to a local extension to that user's SIP endpoint -->
    <extension name="local_sms">
      <condition field="to_user" expression="^(10[0-9]{2})$">
        <action application="send" data="sofia"/>
      </condition>
    </extension>

    <!-- Log and drop everything else -->
    <extension name="default_drop">
      <condition field="to" expression="^(.*)$">
        <action application="info"/>
        <action application="stop"/>
      </condition>
    </extension>

  </context>
</include>
```

--------------------------------

### Example tts_commandline.conf.xml Configuration

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/asr-tts/mod_tts_commandline.mdx

This configuration example pipes the text through Festival's text2wave tool at the requested sample rate and writes the WAV to the temporary output path. The 'command' parameter defines the shell command template with placeholders.

```xml
<configuration name="tts_commandline.conf" description="TextToSpeech Commandline configuration">
  <settings>
    <param name="command" value="echo ${text} | text2wave -f ${rate} > ${file}"/>
  </settings>
</configuration>
```

--------------------------------

### FreeSWITCH Logging Command Examples

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/troubleshooting/diagnostic-toolbox.mdx

Provides examples of commands for adjusting log verbosity. Use '/log <level>' for watching a specific console session, 'console loglevel' for terminal output, and 'fsctl loglevel' for global core logging.

```text
/log <level>
```

```text
console loglevel <level>
```

```text
fsctl loglevel <level>
```

--------------------------------

### mod_nibblebill Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_nibblebill.mdx

This is a trimmed example of the nibblebill.conf.xml file, showing essential settings for connecting to an ODBC database and configuring billing parameters like heartbeat, low balance thresholds, and actions.

```xml
<configuration name="nibblebill.conf" description="Nibble Billing">
  <settings>
    <param name="odbc-dsn" value="bandwidth.com"/>
    <param name="db_table" value="accounts"/>
    <param name="db_column_cash" value="cash"/>
    <param name="db_column_account" value="id"/>
    <param name="global_heartbeat" value="60"/>
    <param name="lowbal_amt" value="5"/>
    <param name="lowbal_action" value="play ding"/>
    <param name="nobal_amt" value="0"/>
    <param name="nobal_action" value="hangup"/>
    <param name="percall_max_amt" value="100"/>
    <param name="percall_action" value="hangup"/>
  </settings>
</configuration>
```

--------------------------------

### Event Socket Worked Session Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/integration/event-socket.mdx

This example demonstrates a full interaction with the Event Socket, including authentication, API commands, background jobs, event subscriptions, and disconnection.

```text
< Content-Type: auth/request
< 

> auth ClueCon
> 

< Content-Type: command/reply
< Reply-Text: +OK accepted
< 

> api status
> 

< Content-Type: api/response
< Content-Length: 1234
< 
< UP 0 years, 0 days, 2 hours, 14 minutes, 22 seconds, 647 milliseconds, 552 microseconds
< ...

> bgapi originate sofia/gateway/mygw/15551234567 &echo
> 

< Content-Type: command/reply
< Reply-Text: +OK Job-UUID: a1b2c3d4-e5f6-7890-abcd-ef1234567890
< Job-UUID: a1b2c3d4-e5f6-7890-abcd-ef1234567890
< 

< Content-Type: text/event-plain
< Content-Length: 502
< 
< Event-Name: BACKGROUND_JOB
< Job-UUID: a1b2c3d4-e5f6-7890-abcd-ef1234567890
< Job-Command: originate
< Job-Command-Arg: sofia/gateway/mygw/15551234567 &echo
< 
< +OK b7f1e2a0-1234-5678-abcd-000000000001

> event plain HEARTBEAT
> 

< Content-Type: command/reply
< Reply-Text: +OK event listener enabled plain
< 

< Content-Type: text/event-plain
< Content-Length: 432
< 
< Event-Name: HEARTBEAT
< Core-UUID: ...
< Event-Date-Timestamp: ...
< ...

> exit
> 

< Content-Type: command/reply
< Reply-Text: +OK bye
< 
< Content-Type: text/disconnect-notice
< Content-Length: 14
< 
< Disconnected.

```

--------------------------------

### mod_redis Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/data-stores/mod_redis.mdx

This is an example of the redis.conf.xml file. It configures the Redis server host, port, and connection timeout. The 'ignore_connect_fail' parameter defaults to false if not specified.

```xml
<configuration name="redis.conf" description="mod_redis Configuration">
  <settings>
    <param name="host" value="localhost"/>
    <param name="port" value="6379"/>
    <param name="timeout" value="10000"/>
  </settings>
</configuration>
```

--------------------------------

### Event Multicast Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/event-handlers/mod_event_multicast.mdx

This example shows a basic configuration for mod_event_multicast, specifying the multicast address, port, and event bindings. The 'psk' parameter is commented out, indicating unencrypted communication.

```xml
<configuration name="event_multicast.conf" description="Multicast Event">
  <settings>
    <param name="address" value="225.1.1.1"/>
    <param name="port" value="4242"/>
    <param name="bindings" value="all"/>
    <param name="ttl" value="1"/>
    <!-- <param name="loopback" value="no"/> -->
    <!-- <param name="psk" value="ClueCon"/> -->
  </settings>
</configuration>
```

--------------------------------

### mod_db Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/applications/utility-applications.mdx

Example configuration for mod_db, specifying the ODBC DSN or native DSN for database connectivity. If not specified, FreeSWITCH defaults to a local SQLite database.

```xml
<configuration name="db.conf" description="LIMIT DB Configuration">
  <settings>
    <!--<param name="odbc-dsn" value="dsn:user:pass"/>-->
  </settings>
</configuration>
```

--------------------------------

### Copy Default Configuration to /etc/freeswitch

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/foundations/getting-started.mdx

Copies the vanilla FreeSWITCH profile from the installation directory to the active configuration directory (/etc/freeswitch). This is necessary if the packaging only installs sample configurations and not the default profile directly into /etc/freeswitch.

```bash
cp -a /usr/share/freeswitch/conf/vanilla/. /etc/freeswitch/
```

--------------------------------

### Enable and Start FreeSWITCH Systemd Service

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/foundations/getting-started.mdx

Enables the FreeSWITCH systemd service to start automatically on boot and starts the service immediately. This command is used after installing FreeSWITCH packages.

```bash
systemctl enable --now freeswitch
```

--------------------------------

### FreeSWITCH CLI Session Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/reference/cli-and-api.mdx

Demonstrates a typical operator workflow including checking system status, inspecting channels, transferring calls, and managing logging and configuration.

```bash
freeswitch@pbx> status
UP 0 years, 0 days, 2 hours, 14 minutes, 33 seconds, 412 milliseconds, 744 microseconds
FreeSWITCH (Version 1.10.x) is ready
2 session(s) since startup
1 session(s) - peak 1, last 5min 1
0 session(s) per Sec out of max 30, peak 1, last 5min 1
1000 session(s) max
min idle cpu 0.00/99.60
Current Stack Size/Max 240K/8192K

freeswitch@pbx> show channels
uuid,direction,created,created_epoch,name,state,cid_name,cid_num,...
5a3f1c2e-...,inbound,2026-06-02 10:31:00,...

freeswitch@pbx> uuid_transfer 5a3f1c2e-... 2000 XML default
+OK

freeswitch@pbx> sofia status profile internal
=================================
Name             internal
...
RUNNING (2)

freeswitch@pbx> fsctl loglevel debug

freeswitch@pbx> reloadxml
+OK [Success]
```

--------------------------------

### Making an HTTP GET Request

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_curl.mdx

Use the `curl` command to make a GET request to a specified URL. This is a basic example of fetching status information.

```freeswitch-cli
freeswitch@> curl https://api.example.com/status get
```

--------------------------------

### Presence Map Configuration

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/users-endpoints/sip-profiles-sofia.mdx

Defines presence mappings in presence_map.conf.xml. This example maps extensions starting with '3' to the 'conf' presence protocol and extensions starting with '4' to the 'park' presence protocol.

```xml
<configuration name="presence_map.conf" description="PRESENCE MAP">
  <domains>
    <domain name="pbx.example.com">
      <!-- Extensions matching 3xxx map to conference presence -->
      <exten regex="3\d+" proto="conf"/>
      <!-- Extensions matching 4xxx map to park presence -->
      <exten regex="4\d+" proto="park"/>
    </domain>
  </domains>
</configuration>
```

--------------------------------

### Start Chroma Key Effect

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_video_filter.mdx

Initiate a chroma key effect on a specific channel using the chromakey API command. This example starts a chroma key with a green background and a specified image.

```bash
chromakey <uuid> start #00ff00 300 /images/office.png
```

--------------------------------

### Memcache Get in Dialplan

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/data-stores/mod_memcache.mdx

Example of using the memcache module within FreeSWITCH dialplan to retrieve a cached value and set it to a variable.

```xml
<action application="set" data="cached_val=${memcache(get mykey)}"/>
```

--------------------------------

### Configuring dialplan_directory.conf.xml

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/dialplans/mod_dialplan_directory.mdx

This example shows the required parameters for connecting to a directory service. Ensure all parameters are correctly set for the module to function.

```xml
<configuration name="dialplan_directory.conf" description="Dialplan Directory">
  <settings>
    <param name="directory-name" value="ldap"/>
    <param name="host" value="ldap.freeswitch.org"/>
    <param name="dn" value="cn=Manager,dc=freeswitch,dc=org"/>
    <param name="pass" value="test"/>
    <param name="base" value="dc=freeswitch,dc=org"/>
  </settings>
</configuration>
```

--------------------------------

### mod_curl Usage Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_curl.mdx

Demonstrates how to use the `curl` application to make an HTTP GET request and store the response body in a channel variable.

```freeswitch
<action application="curl" data="https://api.example.com/lookup?ani=${caller_id_number} json"/>
<action application="set" data="lookup_result=${curl_response_data}"/>
```

--------------------------------

### Originate CLI Error Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/troubleshooting/call-setup-failures.mdx

When using the `originate` command from the `fs_cli`, an error response indicates a call setup failure. The string following `-ERR` specifies the cause of the failure.

```text
freeswitch@host> originate sofia/gateway/my_gateway/18005551212 &echo
-ERR GATEWAY_DOWN
```

--------------------------------

### Asterisk Goto Application Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/dialplans/mod_dialplan_asterisk.mdx

Shows how to transfer a session to a different extension within a context using Asterisk's Goto syntax.

```asterisk
exten => _1XXXXX,n,Goto(default|music)
```

--------------------------------

### Set Variable with Substring

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/dialplan/xml-dialplan.mdx

Demonstrates using variable modifiers to extract substrings. The first example removes the first character, and the second extracts three characters starting from the second position.

```xml
<!-- Remove the first character of caller_id_number -->
<action application="set" data="stripped=${caller_id_number:1}"/>

<!-- Take 3 characters starting at position 1 -->
<action application="set" data="area_code=${caller_id_number:1:3}"/>
```

--------------------------------

### Playback Examples with mod_vlc

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/formats/mod_vlc.mdx

Demonstrates how to use the `playback` dialplan application with different media sources supported by mod_vlc, including local files, HTTP streams, and VLC URIs.

```xml
<action application="playback" data="/tmp/promo.mp4"/>
```

```xml
<action application="playback" data="http://streams.example.com:8000/on-hold.mp3"/>
```

```xml
<action application="playback" data="vlc://ftp://media.example.com/greeting.ogg"/>
```

--------------------------------

### Start Capture via uuid_snapshot (fs_cli)

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_snapshot.mdx

Initiates a 30-second rolling capture on a specific channel identified by its UUID. This example captures the 'read' (inbound) leg and uses 'mycall' as the filename prefix.

```text
uuid_snapshot 1234abcd-... start 30 read mycall
```

--------------------------------

### Add SignalWire FreeSWITCH Repository (Debian/Ubuntu)

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/foundations/getting-started.mdx

Installs necessary packages, adds the SignalWire repository signing key authenticated with a Personal Access Token, and registers the package source for apt. Ensure you replace YOUR_SIGNALWIRE_TOKEN with your actual token.

```bash
TOKEN=YOUR_SIGNALWIRE_TOKEN

apt-get update && apt-get install -y gnupg2 wget lsb-release

# Add the repository signing key, authenticated with your token
wget --http-user=signalwire --http-password="$TOKEN" \
  -O /usr/share/keyrings/signalwire-freeswitch-repo.gpg \
  https://freeswitch.signalwire.com/repo/deb/debian-release/signalwire-freeswitch-repo.gpg

# Store the repository credentials for apt
echo "machine freeswitch.signalwire.com login signalwire password $TOKEN" \
  > /etc/apt/auth.conf.d/freeswitch.conf
chmod 600 /etc/apt/auth.conf.d/freeswitch.conf

# Register the package source for this distribution release
echo "deb [signed-by=/usr/share/keyrings/signalwire-freeswitch-repo.gpg] https://freeswitch.signalwire.com/repo/deb/debian-release/ $(lsb_release -sc) main" \
  > /etc/apt/sources.list.d/freeswitch.list

apt-get update
```

--------------------------------

### avmd <uuid> start

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_avmd.mdx

Starts audio event detection on an existing session identified by its UUID.

```APIDOC
## avmd <uuid> start

### Description
Starts audio event detection on an existing session identified by its UUID.

### Method
API Command

### Endpoint
N/A (fs_cli or ESL command)

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the session.

#### Command Arguments
- **start** (string) - Required - Keyword to start detection.
```

--------------------------------

### Example opal.conf.xml Configuration

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/endpoints/mod_opal.mdx

This snippet shows a complete example of the `opal.conf.xml` file, including global settings and a listener configuration. It demonstrates how to set parameters like trace level, context, dialplan, DTMF type, jitter size, and gatekeeper interface, as well as binding an H.323 listener to a specific IP and port.

```xml
<configuration name="opal.conf" description="Opal Endpoints">
  <settings>
    <param name="trace-level" value="3"/>
    <param name="context"     value="default"/>
    <param name="dialplan"    value="XML"/>
    <param name="dtmf-type"   value="signal"/>
    <param name="jitter-size" value="40,100"/>
    <!-- <param name="codec-prefs"          value="PCMU,PCMA"/> -->
    <!-- <param name="disable-transcoding"  value="true"/> -->
    <param name="gk-address"   value=""/>
    <param name="gk-identifer" value=""/>
    <param name="gk-interface" value="$${local_ip_v4}"/>
  </settings>
  <listeners>
    <listener name="default">
      <param name="h323-ip"   value="$${local_ip_v4}"/>
      <param name="h323-port" value="1720"/>
    </listener>
  </listeners>
</configuration>
```

--------------------------------

### fs_cli Examples for avmd

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_avmd.mdx

Examples of using avmd commands in the FreeSWITCH Command Line Interface (fs_cli).

```bash
avmd 3e7a2707-cd5a-4b5e-8c7f-1234abcd start
avmd 3e7a2707-cd5a-4b5e-8c7f-1234abcd stop
avmd reload
avmd show
```

--------------------------------

### Playback PNG as Video Source with Audio

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/formats/mod_png.mdx

This dialplan example demonstrates how to use the playback application to stream a PNG image as a video source. It includes an optional audio file to play simultaneously and sets a maximum duration for the stream.

```xml
<action application="playback" data="{audio_file=/tmp/hold_music.wav,png_ms=30000}/tmp/logo.png"/>
```

--------------------------------

### Start avmd with global defaults

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_avmd.mdx

Starts audio media detection using the global default configuration for the session.

```xml
<action application="avmd_start"/>
```

--------------------------------

### Lua Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/integration/scripting.mdx

This XML configuration sets up script directories for Lua modules, defines an XML handler script, and registers a startup script and an event hook.

```xml
<configuration name="lua.conf" description="LUA Configuration">
  <settings>

    <!-- Add directories to LUA_PATH for require() resolution -->
    <param name="script-directory" value="$${script_dir}/?.lua"/>

    <!-- Add directories to LUA_CPATH for native C modules -->
    <param name="module-directory" value="/usr/local/lib/lua/5.1/?.so"/>

    <!-- XML handler: must appear before xml-handler-bindings -->
    <param name="xml-handler-script" value="xml_handler.lua"/>
    <param name="xml-handler-bindings" value="dialplan"/>

    <!-- Background daemon scripts launched at module load -->
    <param name="startup-script" value="event_daemon.lua"/>

    <!-- Event hook -->
    <hook event="CUSTOM" subclass="conference::maintenance" script="catch-event.lua"/>

  </settings>
</configuration>
```

--------------------------------

### Build FreeSWITCH from Source

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/foundations/getting-started.mdx

Clone the FreeSWITCH repository, generate build scripts, configure modules, compile, and install binaries and sound files.

```bash
git clone https://github.com/signalwire/freeswitch.git
cd freeswitch

# Generate the configure script and the module build list
./bootstrap.sh -j

# Optionally edit modules.conf to select which modules compile, then configure
./configure

# Compile and install the binaries
make
make install

# Install the sound files: prompts and music on hold
make cd-sounds-install cd-moh-install
```

--------------------------------

### Using the `say` dialplan application

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/say-modules.mdx

Examples of how to use the `say` dialplan application to speak numbers, currency, dates, and times. Ensure the correct module and language are specified.

```xml
<action application="say" data="en NUMBER PRONOUNCED 12345"/>
<action application="say" data="en CURRENCY PRONOUNCED 19.99"/>
<action application="say" data="en CURRENT_DATE_TIME PRONOUNCED 0"/>
<action application="say" data="de NUMBER COUNTED MASCULINE 1"/>
```

--------------------------------

### Configure xml_rpc.conf.xml

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/xml-interfaces/mod_xml_rpc.mdx

Example configuration for `xml_rpc.conf.xml`, setting the HTTP port and authentication parameters.

```xml
<configuration name="xml_rpc.conf" description="XML RPC">
  <settings>
    <!-- The port where you want to run the http service (default 8080) -->
    <param name="http-port" value="8080"/>
    <!-- if all 3 of the following params exist all http traffic will require auth -->
    <param name="auth-realm" value="freeswitch"/>
    <param name="auth-user" value="freeswitch"/>
    <param name="auth-pass" value="works"/>

    <!-- regex pattern to match against commands called against this service.
         If a command with arguments matches, it will be logged at INFO level -->
    <!--<param name="commands-to-log" value=""/> -->

  </settings>
</configuration>
```

--------------------------------

### Pickup Endpoint Prefix Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/dialplan/dptools-reference.mdx

Example of using the 'pickup' endpoint prefix to register a call into a named pickup group.

```freeswitch
pickup/sales
```

--------------------------------

### Group Endpoint Prefix Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/dialplan/dptools-reference.mdx

Example of using the 'group' endpoint prefix to dial all members of a directory group simultaneously.

```freeswitch
group/support@example.com
```

--------------------------------

### Inline Originate with Asterisk Dialplan

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/dialplans/mod_dialplan_asterisk.mdx

This example shows how to initiate a call using the 'originate' command and direct it to use the Asterisk dialplan engine. The 'asterisk' keyword specifies the dialplan engine, and 'default' is the context to be used.

```bash
originate sofia/internal/1000@pbx.example.com &park() asterisk default
```

--------------------------------

### Loopback Endpoint Prefix Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/dialplan/dptools-reference.mdx

Example of using the 'loopback' endpoint prefix to re-enter the dialplan at a specific extension and context.

```freeswitch
loopback/1001/default
```

--------------------------------

### Directory Application with Specific Domain, Dialplan, and Context

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/applications/mod_directory.mdx

This example shows how to use the directory application to search within a specific domain ('example.com'), using an alternate dialplan ('XML') and context ('sales').

```xml
<!-- Search within a specific context using an alternate dialplan -->
<action application="directory" data="default example.com XML sales"/>
```

--------------------------------

### Sofia Gateway Endpoint Prefix Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/dialplan/dptools-reference.mdx

Example of using the 'sofia/gateway' endpoint prefix to dial a number through a named gateway.

```freeswitch
sofia/gateway/mycarrier/15551234567
```

--------------------------------

### Install OpenLDAP Development Libraries (Debian/Ubuntu)

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/xml-interfaces/mod_ldap.mdx

Install the OpenLDAP client development libraries before building mod_ldap on Debian/Ubuntu systems.

```bash
apt-get install libldap2-dev
```

--------------------------------

### SignalWire Configuration File Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/integration/signalwire.mdx

This XML snippet shows the default structure and commented-out parameters for the signalwire.conf.xml configuration file. Uncomment and modify parameters to override compiled-in defaults.

```xml
<configuration name="signalwire.conf" description="SignalWire">
  <settings>
    <!-- on/off -->
    <!--<param name="kslog" value="on"/>-->
    <!--<param name="blade-bootstrap" value="blade://switchblade:2100"/>-->
    <!--<param name="adoption-service" value="https://adopt.signalwire.com/adoption"/>-->
    <!--<param name="stun-server" value="stun.freeswitch.org"/>-->
    <!--<param name="ssl-verify" value="true"/>-->
    <!--<authentication></authentication>-->

    <!-- override dialplan context for calls on connector -->
    <!--<param name="override-context" value="signalwire"/>-->
  </settings>
</configuration>

```

--------------------------------

### mod_v8 Configuration with Hooks and Modules

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/integration/scripting.mdx

Example configuration for mod_v8, demonstrating script caching, hook definitions for events, and loading native V8 modules.

```xml
<configuration name="v8.conf" description="Google V8 JavaScript Plug-Ins">
  <settings>
    <param name="script-caching" value="enabled"/>
    <param name="cache-expires-sec" value="3600"/>
    <param name="startup-script" value="startup1.js"/>
    <param name="xml-handler-script" value="directory.js"/>
    <param name="xml-handler-bindings" value="directory"/>
    <hook event="CUSTOM" subclass="sofia::register" script="catch-event.js"/>
    <hook event="CHANNEL_HANGUP" script="hangup-event.js"/>
  </settings>
  <modules>
    <load module="mod_v8_skel"/>
  </modules>
</configuration>
```

--------------------------------

### Example SMPP Gateway Configuration

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/event-handlers/mod_smpp.mdx

This configuration defines a named SMPP gateway named 'example.com' with specific connection parameters for an SMPP server. Changes to this file require a FreeSWITCH restart.

```xml
<configuration name="smpp.conf" description="SMPP client and server Gateway">
  <gateways>
    <gateway name="example.com">
      <params>
        <param name="host" value="example.com"/>
        <param name="port" value="2775"/>
        <param name="debug" value="1"/>
        <param name="profile" value="default"/>
        <param name="system_id" value="username"/>
        <param name="password" value="password"/>
        <param name="system_type" value="remote_smpp"/>
      </params>
    </gateway>
  </gateways>
</configuration>
```

--------------------------------

### HTTAPI Configuration File Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/integration/xml-curl.mdx

This is a sample configuration file for mod_httapi, defining global settings, profiles, and permissions for HTTP-driven call control.

```xml
<configuration name="httapi.conf" description="HT-TAPI Hypertext Telephony API">
  <settings>
    <param name="debug" value="false"/>
    <param name="file-cache-ttl" value="300"/>
    <param name="file-not-found-expires" value="300"/>
  </settings>
  <profiles>
    <profile name="default">
      <conference>
        <param name="default-profile" value="default"/>
      </conference>
      <dial>
        <param name="context" value="default"/>
        <param name="dialplan" value="XML"/>
      </dial>
      <permissions>
        <permission name="set-params" value="true"/>
        <permission name="execute-apps" value="true">
          <application-list default="deny">
            <application name="info"/>
            <application name="hangup"/>
          </application-list>
        </permission>
        <permission name="dial" value="true"/>
        <permission name="conference" value="true"/>
      </permissions>
      <params>
        <param name="gateway-url" value="http://example.com/httapi"/>
      </params>
    </profile>
  </profiles>
</configuration>
```

--------------------------------

### Error Endpoint Prefix Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/dialplan/dptools-reference.mdx

Example of using the 'error' endpoint prefix to immediately return a specific Q.850 hangup cause.

```freeswitch
error/USER_BUSY
```

--------------------------------

### H.323 Configuration Example

Source: https://github.com/signalwire/freeswitch-docs/blob/main/docs/module-reference/endpoints/mod_h323.mdx

This XML snippet demonstrates a typical configuration for the H.323 module, including global settings and listener definitions.

```xml
<configuration name="h323.conf" description="H323 Endpoints">
  <settings>
    <param name="trace-level" value="10"/>
    <param name="context" value="default"/>
    <param name="dialplan" value="XML"/>
    <param name="codec-prefs" value="PCMA,PCMU,GSM,G729"/>
    <param name="use-rtp-timer" value="true"/>
    <param name="rtp-timer-name" value="soft"/>
    <!-- <param name="ptime-override-value" value="20"/> -->
    <param name="gk-address" value=""/>
    <param name="gk-identifer" value=""/>
    <param name="gk-interface" value=""/>
    <param name="gk-retry" value="30"/>
    <param name="faststart" value="true"/>
    <param name="h245tunneling" value="true"/>
    <param name="h245insetup" value="true"/>
    <param name="jitter-size" value="60"/>
    <param name="progress-indication" value="8"/>
    <param name="alerting-indication" value="8"/>
    <param name="endpoint-name" value="fs"/>
    <param name="fax-old-asn" value="true"/>
  </settings>
  <listeners>
    <listener name="default">
      <param name="h323-ip" value="$${local_ip_v4}"/>
      <param name="h323-port" value="1720"/>
    </listener>
  </listeners>
</configuration>
```