From 750b534360506ba749064426336a45f69332f640 Mon Sep 17 00:00:00 2001 From: hey-august Date: Wed, 10 Jan 2024 19:46:39 -0500 Subject: [PATCH 1/2] Initiating filename standardization effort with IVR.mdx. --- docs/FreeSWITCH-Explained/{IVR_13173361.mdx => IVR.mdx} | 0 docs/FreeSWITCH-Explained/Introduction/Call-Legs_7143972.mdx | 2 +- .../Meta-Pages/XML-Meta-Page_16352177.mdx | 4 ++-- 3 files changed, 3 insertions(+), 3 deletions(-) rename docs/FreeSWITCH-Explained/{IVR_13173361.mdx => IVR.mdx} (100%) diff --git a/docs/FreeSWITCH-Explained/IVR_13173361.mdx b/docs/FreeSWITCH-Explained/IVR.mdx similarity index 100% rename from docs/FreeSWITCH-Explained/IVR_13173361.mdx rename to docs/FreeSWITCH-Explained/IVR.mdx diff --git a/docs/FreeSWITCH-Explained/Introduction/Call-Legs_7143972.mdx b/docs/FreeSWITCH-Explained/Introduction/Call-Legs_7143972.mdx index 0df99492..772f11b3 100644 --- a/docs/FreeSWITCH-Explained/Introduction/Call-Legs_7143972.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/Call-Legs_7143972.mdx @@ -77,7 +77,7 @@ In this scenario, when someone is checking their voicemail, the caller is the _o Examples for **one legged calls**: -* [IVR](../IVR_13173361.mdx#about) +* [IVR](../IVR.mdx#about) * [voicemail](../Modules/mod-voicemail/Voicemail_13174041.mdx#--) * [conference](../Modules/mod_conference_3965534.mdx#list) diff --git a/docs/FreeSWITCH-Explained/Meta-Pages/XML-Meta-Page_16352177.mdx b/docs/FreeSWITCH-Explained/Meta-Pages/XML-Meta-Page_16352177.mdx index fca0176b..680ba20d 100644 --- a/docs/FreeSWITCH-Explained/Meta-Pages/XML-Meta-Page_16352177.mdx +++ b/docs/FreeSWITCH-Explained/Meta-Pages/XML-Meta-Page_16352177.mdx @@ -129,7 +129,7 @@ [Outbound Conference Calls](../Conference/Outbound-Conference-Calls_5046359.mdx#about) – possibly stays on its own page -[IVR](../IVR_13173361.mdx#about) +[IVR](../IVR.mdx#about) ## Core Configuration @@ -409,7 +409,7 @@ This section needs to find a place. But the concept of a channel is important. I * [PHP ESL](../Client-and-Developer-Interfaces/PHP-ESL/index.mdx#-ivrd-) – has XML showing the use of socket * [PHP Example - Mod XML curl](../Client-and-Developer-Interfaces/PHP-ESL/PHP-Examples/PHP-Example---Mod-XML-curl_7144621.mdx#php-example-) – prototype implementation for serving XML to XML\_CURL * [PHP Example - Wakeup call](../Client-and-Developer-Interfaces/PHP-ESL/PHP-Examples/PHP-Example---Wakeup-call_7144610.mdx#about) – has more XML ... as a side note, the XML examples show javascripts :| -* [IVR](../IVR_13173361.mdx#about) – more IVR XML config +* [IVR](../IVR.mdx#about) – more IVR XML config * [RTCP](../Signalling/RTCP_13173472.mdx#--) – has XML config for RTCP * [RTMP Configuration Files](../Signalling/RTMP-Configuration-Files_13173533.mdx#context) – has RTMP config in XML * [Troubleshooting Debugging](../Troubleshooting-Debugging/index.mdx#about) – console config XML here From aa194d73dd0711a6837dd47e254f7a0657c5359a Mon Sep 17 00:00:00 2001 From: hey-august Date: Thu, 11 Jan 2024 11:52:00 -0500 Subject: [PATCH 2/2] Standardizing filenames in top level of /FreeSWITCH-Explained/ and top level of /FreeSWITCH-Explained/Introduction/ --- .../api_on_media_16352809.mdx | 2 +- .../hangup_after_bridge_16352708.mdx | 2 +- .../playback_terminators_16353264.mdx | 10 +- .../1048948.mdx | 2 +- .../Creating-New-Modules/9634354.mdx | 4 +- .../Dialplan/Channel-States_7144639.mdx | 4 +- .../Dialplan/Channel-Variables_16352493.mdx | 2 +- .../x__Channel-Variables_1048892.mdx | 2 +- .../Variables-Master-List_16352570.mdx | 12 +- .../Dialplan/XML-Dialplan/index.mdx | 2 +- .../Directory/XML-User-Directory/index.mdx | 2 +- .../{15139379.mdx => Event-Types.mdx} | 0 docs/FreeSWITCH-Explained/Index_1048632.mdx | 115 ------------------ .../Interoperability/Softphones/index.mdx | 2 +- .../Introduction/Audio-Formats_15696302.mdx | 18 --- .../{Call-Legs_7143972.mdx => Call-Legs.mdx} | 18 --- .../Introduction/Debian+10+Buster.mdx | 1 - .../{Endpoints_15696294.mdx => Endpoints.mdx} | 2 +- .../Event-System/Event-List_7143557.mdx | 2 +- .../Event-System/Events_32178330.mdx | 4 +- .../Introduction/Event-System/index.mdx | 2 +- ...CH-API_30867723.mdx => FreeSWITCH-API.mdx} | 2 +- .../{Glossary_13173966.mdx => Glossary.mdx} | 6 +- .../Introduction-to-Dialplan_15696304.mdx | 18 --- .../Introduction.mdx} | 22 ++-- .../{Licensing_13173286.mdx => Licensing.mdx} | 0 ...l_1048888.mdx => Life-Cycle-of-a-Call.mdx} | 0 .../Running-FreeSWITCH_15696307.mdx | 18 --- ...Understanding-the-Configuration-Files.mdx} | 0 .../Introduction/Variables/index.mdx | 6 +- .../Introduction/index.mdx | 22 ++-- .../Meta-Pages/Filename-Standardization.mdx | 28 +++++ .../FreeSWITCH-Legacy-Context-Review.mdx | 27 +++- .../Meta-Pages/XML-Meta-Page_16352177.mdx | 4 +- .../Modules/mod-dptools/6586414.mdx | 2 +- .../Modules/mod-dptools/6586646.mdx | 4 +- .../Modules/mod-dptools/6586692.mdx | 2 +- .../Modules/mod-dptools/6586776.mdx | 8 +- .../Modules/mod-dptools/6587017.mdx | 2 +- .../Modules/mod-dptools/6587061.mdx | 2 +- .../Modules/mod_commands_1966741.mdx | 30 ++--- .../Modules/mod_erlang_event_1048926.mdx | 10 +- .../Modules/mod_event_socket_1048924.mdx | 6 +- ...tor_9633841.mdx => Verto-Communicator.mdx} | 6 - provisioning/nginx/redirects.map | 16 +-- 45 files changed, 146 insertions(+), 303 deletions(-) rename docs/FreeSWITCH-Explained/{15139379.mdx => Event-Types.mdx} (100%) delete mode 100644 docs/FreeSWITCH-Explained/Index_1048632.mdx delete mode 100644 docs/FreeSWITCH-Explained/Introduction/Audio-Formats_15696302.mdx rename docs/FreeSWITCH-Explained/Introduction/{Call-Legs_7143972.mdx => Call-Legs.mdx} (91%) delete mode 100644 docs/FreeSWITCH-Explained/Introduction/Debian+10+Buster.mdx rename docs/FreeSWITCH-Explained/Introduction/{Endpoints_15696294.mdx => Endpoints.mdx} (91%) rename docs/FreeSWITCH-Explained/Introduction/{FreeSWITCH-API_30867723.mdx => FreeSWITCH-API.mdx} (91%) rename docs/FreeSWITCH-Explained/Introduction/{Glossary_13173966.mdx => Glossary.mdx} (99%) delete mode 100644 docs/FreeSWITCH-Explained/Introduction/Introduction-to-Dialplan_15696304.mdx rename docs/FreeSWITCH-Explained/{1048601.mdx => Introduction/Introduction.mdx} (94%) rename docs/FreeSWITCH-Explained/Introduction/{Licensing_13173286.mdx => Licensing.mdx} (100%) rename docs/FreeSWITCH-Explained/Introduction/{Life-Cycle-of-a-Call_1048888.mdx => Life-Cycle-of-a-Call.mdx} (100%) delete mode 100644 docs/FreeSWITCH-Explained/Introduction/Running-FreeSWITCH_15696307.mdx rename docs/FreeSWITCH-Explained/Introduction/{Understanding-the-Configuration-Files_15696295.mdx => Understanding-the-Configuration-Files.mdx} (100%) create mode 100644 docs/FreeSWITCH-Explained/Meta-Pages/Filename-Standardization.mdx rename docs/FreeSWITCH-Explained/{Verto-Communicator_9633841.mdx => Verto-Communicator.mdx} (83%) diff --git a/docs/Channel-Variables-Catalog/api_on_media_16352809.mdx b/docs/Channel-Variables-Catalog/api_on_media_16352809.mdx index b009163e..15abaab5 100644 --- a/docs/Channel-Variables-Catalog/api_on_media_16352809.mdx +++ b/docs/Channel-Variables-Catalog/api_on_media_16352809.mdx @@ -5,7 +5,7 @@ ## api_on_media -string Execute a [FreeSWITCH API](../FreeSWITCH-Explained/Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) command when the far end sends media, i.e. ringing or 183/SDP. +string Execute a [FreeSWITCH API](../FreeSWITCH-Explained/Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) command when the far end sends media, i.e. ringing or 183/SDP. The command is executed only on channels that are not already answered. Just use `export` or `export` with `nolocal:` prefix to make sure it is executed when b-leg answers. diff --git a/docs/Channel-Variables-Catalog/hangup_after_bridge_16352708.mdx b/docs/Channel-Variables-Catalog/hangup_after_bridge_16352708.mdx index af56cf57..9ebe6072 100644 --- a/docs/Channel-Variables-Catalog/hangup_after_bridge_16352708.mdx +++ b/docs/Channel-Variables-Catalog/hangup_after_bridge_16352708.mdx @@ -3,7 +3,7 @@ Created by Ryan Harris, last modified by Attila Gulyas on 2020.08.04 -boolean Controls what happens to a calling (A) party when in a [bridge state](../FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call_1048888.mdx#0-about), and the called (B) party hangs up. If `true` the [dialplan](../FreeSWITCH-Explained/Dialplan/index.mdx#0-about) will stop processing, and the A leg will be terminated when the B leg terminates. If `false` (default) the dialplan continues to be processed after the B leg terminates. This is checked after [park\_after\_bridge](../FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx#park_after_bridge) and [transfer\_after\_bridge](../FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx#transfer_after_bridge). +boolean Controls what happens to a calling (A) party when in a [bridge state](../FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call.mdx#0-about), and the called (B) party hangs up. If `true` the [dialplan](../FreeSWITCH-Explained/Dialplan/index.mdx#0-about) will stop processing, and the A leg will be terminated when the B leg terminates. If `false` (default) the dialplan continues to be processed after the B leg terminates. This is checked after [park\_after\_bridge](../FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx#park_after_bridge) and [transfer\_after\_bridge](../FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx#transfer_after_bridge). The default value is `false` diff --git a/docs/Channel-Variables-Catalog/playback_terminators_16353264.mdx b/docs/Channel-Variables-Catalog/playback_terminators_16353264.mdx index 27c917b0..7f807d90 100644 --- a/docs/Channel-Variables-Catalog/playback_terminators_16353264.mdx +++ b/docs/Channel-Variables-Catalog/playback_terminators_16353264.mdx @@ -9,7 +9,7 @@ dtmf digit ## 0\. About -Allows you to set which [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) tones will terminate +Allows you to set which [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) tones will terminate * playback (see [mod\_dptools:playback](../FreeSWITCH-Explained/Modules/mod-dptools/6586776.mdx#0-about) or [mod\_dptools:play\_and\_detect\_speech](../FreeSWITCH-Explained/Modules/mod_dptools_1970333.mdx#-c) for example), or * recording (see `uuid_record` in [mod\_commands](../FreeSWITCH-Explained/Modules/mod_commands_1966741.mdx#--) (i.e., the FreeSWITCH API commands), [mod\_dptools:record](../FreeSWITCH-Explained/Modules/mod-dptools/6587041.mdx#0-about), and [mod\_dptools:record\_session](../FreeSWITCH-Explained/Modules/mod-dptools/6587110.mdx#about)). @@ -24,14 +24,14 @@ The default terminator is `*` (star). playback_terminators=123456789*0# | any | none ``` -* `none` \- undefines the terminator digit, meaning no [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) tone will interrupt playback -* `any` \- any [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) will interrupt playback +* `none` \- undefines the terminator digit, meaning no [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) tone will interrupt playback +* `any` \- any [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) will interrupt playback Digits not specified as terminators will be collected, but won't interrupt playback. ## 2\. Modifiers -* `+` (plus) - includes the following terminator digit along with the other [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) digits in the returned string +* `+` (plus) - includes the following terminator digit along with the other [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) digits in the returned string * `x` (letter ex) - includes the following terminator digit in the returned string and also returns `SWITCH_STATUS_RESTART` See last example below on what these modifiers do. @@ -46,7 +46,7 @@ Make either `*` (star) or `#` (bar/pound/square) interrupt the subsequent playba ``` -If [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) 9 is dialed during playback, it will interrupt playback and return the digit 9 along with any other dialed digits; if `*` is dialed it will only interrupt playback without being included in the [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) string returned: +If [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) 9 is dialed during playback, it will interrupt playback and return the digit 9 along with any other dialed digits; if `*` is dialed it will only interrupt playback without being included in the [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) string returned: ```xml diff --git a/docs/FreeSWITCH-Explained/Client-and-Developer-Interfaces/1048948.mdx b/docs/FreeSWITCH-Explained/Client-and-Developer-Interfaces/1048948.mdx index fc335de8..4004f924 100644 --- a/docs/FreeSWITCH-Explained/Client-and-Developer-Interfaces/1048948.mdx +++ b/docs/FreeSWITCH-Explained/Client-and-Developer-Interfaces/1048948.mdx @@ -181,7 +181,7 @@ REGISTRATIONS 0 ### 4.1 FreeSWITCH API -While connected, the user can issue any command in the [FreeSWITCH API](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) (which are all the commands exposed in the [enabled modules](../Configuration/Configuring-FreeSWITCH/index.mdx#modulesconfxml) and [mod\_commands](../Modules/mod_commands_1966741.mdx#--)). +While connected, the user can issue any command in the [FreeSWITCH API](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) (which are all the commands exposed in the [enabled modules](../Configuration/Configuring-FreeSWITCH/index.mdx#modulesconfxml) and [mod\_commands](../Modules/mod_commands_1966741.mdx#--)). See the `console` commands for example, exposed by [mod\_console](../Modules/mod_console_1048950.mdx#about) . diff --git a/docs/FreeSWITCH-Explained/Community/Contributing-Code/Creating-New-Modules/9634354.mdx b/docs/FreeSWITCH-Explained/Community/Contributing-Code/Creating-New-Modules/9634354.mdx index 56f49d70..79882ee3 100644 --- a/docs/FreeSWITCH-Explained/Community/Contributing-Code/Creating-New-Modules/9634354.mdx +++ b/docs/FreeSWITCH-Explained/Community/Contributing-Code/Creating-New-Modules/9634354.mdx @@ -47,7 +47,7 @@ An **endpoint module** deals a lot with **sessions**_._ ## 2\. Sessions -A FreeSWITCH **session** is equivalent to a **[call-leg](../../../Introduction/Call-Legs_7143972.mdx#0-about)** when the **session**is managed by [mod\_sofia](../../../Modules/mod_sofia_1048707.mdx#about). +A FreeSWITCH **session** is equivalent to a **[call-leg](../../../Introduction/Call-Legs.mdx#0-about)** when the **session**is managed by [mod\_sofia](../../../Modules/mod_sofia_1048707.mdx#about). A **session**contains a **channel** and **private data**_._ @@ -148,7 +148,7 @@ First follow the [New Module Checklist](./index.mdx#new-module-checklist). [Earl ## 5\. Handling calls from within your module -See [Life Cycle of a Call](../../../Introduction/Life-Cycle-of-a-Call_1048888.mdx#0-about). +See [Life Cycle of a Call](../../../Introduction/Life-Cycle-of-a-Call.mdx#0-about). ### 5.1 Common tasks to both incoming and outgoing calls diff --git a/docs/FreeSWITCH-Explained/Dialplan/Channel-States_7144639.mdx b/docs/FreeSWITCH-Explained/Dialplan/Channel-States_7144639.mdx index 3708f3eb..574de465 100644 --- a/docs/FreeSWITCH-Explained/Dialplan/Channel-States_7144639.mdx +++ b/docs/FreeSWITCH-Explained/Dialplan/Channel-States_7144639.mdx @@ -281,7 +281,7 @@ Shell got {event,["26c739fc-8d49-43ee-9c9e-129e81236cd2", | CS\_CONSUME\_MEDIA | 7 | Channel is consuming all media and dropping it. | | CS\_HIBERNATE | 8 | Channel is in a sleep state. | | CS\_RESET | 9 | Channel is in a reset state. | -| CS\_HANGUP | 10 | Channel is flagged for hangup and ready to end. Media will now end, and no further call routing will occur.The hangup state either transfers the call back to the routing state, if there is a name–value pair that requests it, or else it will hang up the call.TODO The above two sentences contradict each other on the routing part. The second sentence was moved her from [Life Cycle of a Call](../Introduction/Life-Cycle-of-a-Call_1048888.mdx#0-about) (before it got moved to [Call States](./Call-States_32178212.mdx#0-about)). | +| CS\_HANGUP | 10 | Channel is flagged for hangup and ready to end. Media will now end, and no further call routing will occur.The hangup state either transfers the call back to the routing state, if there is a name–value pair that requests it, or else it will hang up the call.TODO The above two sentences contradict each other on the routing part. The second sentence was moved her from [Life Cycle of a Call](../Introduction/Life-Cycle-of-a-Call.mdx#0-about) (before it got moved to [Call States](./Call-States_32178212.mdx#0-about)). | | CS\_REPORTING | 11 | The channel is already hung up, media is already down, and now it's time to do any sort of reporting processes such as CDR logging. | | CS\_DESTROY | 12 | Channel is ready to be destroyed and out of the state machine. Memory pools are returned to the core and utilized memory from the channel is freed. | | CS\_NONE | 13 | TODO What does this do? In [the source](https://github.com/signalwire/freeswitch/blob/b337e77258079212aaf2f46ea42c4be0ffade28d/src/switch%5Fcore%5Fstate%5Fmachine.c#L668), it simply calls C's abort(). | @@ -293,7 +293,7 @@ Custom state handlers can be added to the channels either globally or on a per-c ## 3\. See Also * [Channel Variables](./Channel-Variables_16352493.mdx#about) \- specifically the `state` variable -* [Life Cycle of a Call](../Introduction/Life-Cycle-of-a-Call_1048888.mdx#0-about) +* [Life Cycle of a Call](../Introduction/Life-Cycle-of-a-Call.mdx#0-about) * [Call States](./Call-States_32178212.mdx#0-about) diff --git a/docs/FreeSWITCH-Explained/Dialplan/Channel-Variables_16352493.mdx b/docs/FreeSWITCH-Explained/Dialplan/Channel-Variables_16352493.mdx index f4ee5a15..db159108 100644 --- a/docs/FreeSWITCH-Explained/Dialplan/Channel-Variables_16352493.mdx +++ b/docs/FreeSWITCH-Explained/Dialplan/Channel-Variables_16352493.mdx @@ -241,7 +241,7 @@ Some variables, as shown from the [info app](../Modules/mod-dptools/6587023.mdx# | Channel-State | state | Current [state](./Channel-States_7144639.mdx#0-about) of the channel | | Channel-State-Number | state\_number | Integer | | Channel-Name | channel\_name | Channel name | -| Unique-ID | uuid | uuid of this channel's [call leg](../Introduction/Call-Legs_7143972.mdx#0-about) | +| Unique-ID | uuid | uuid of this channel's [call leg](../Introduction/Call-Legs.mdx#0-about) | | Call-Direction | direction | Inbound or Outbound | | Answer-State | state | \- | | Channel-Read-Codec-Name | read\_codec | the read codec variable mean the source codec | diff --git a/docs/FreeSWITCH-Explained/Dialplan/Variables-Archive/x__Channel-Variables_1048892.mdx b/docs/FreeSWITCH-Explained/Dialplan/Variables-Archive/x__Channel-Variables_1048892.mdx index 68f9d807..ba0eae68 100644 --- a/docs/FreeSWITCH-Explained/Dialplan/Variables-Archive/x__Channel-Variables_1048892.mdx +++ b/docs/FreeSWITCH-Explained/Dialplan/Variables-Archive/x__Channel-Variables_1048892.mdx @@ -470,7 +470,7 @@ Some variables, as shown from the [info app](../../Modules/mod-dptools/6587023.m | Channel-State | state | Current [state](../Channel-States_7144639.mdx#0-about) of the call | | Channel-State-Number | state\_number | Integer | | Channel-Name | channel\_name | Channel name | -| Unique-ID | uuid | uuid of this channel's [call leg](../../Introduction/Call-Legs_7143972.mdx#0-about) | +| Unique-ID | uuid | uuid of this channel's [call leg](../../Introduction/Call-Legs.mdx#0-about) | | Call-Direction | direction | Inbound or Outbound | | Answer-State | state | \- | | Channel-Read-Codec-Name | read\_codec | the read codec variable mean the source codec | diff --git a/docs/FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx b/docs/FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx index b7d90ff4..f2bcc3f5 100644 --- a/docs/FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx +++ b/docs/FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx @@ -1933,7 +1933,7 @@ dtmf digit In the `group_confirm_key` variable, you define the DTMF that the cal string -boolean Controls what happens to a calling (A) party when in a [bridge state](../Introduction/Life-Cycle-of-a-Call_1048888.mdx#0-about), and the called (B) party hangs up. If `true` the [dialplan](index.mdx#0-about) will stop processing, and the A leg will be terminated when the B leg terminates. If `false` (default) the dialplan continues to be processed after the B leg terminates. This is checked after [park\_after\_bridge](Variables-Master-List_16352570.mdx#park_after_bridge) and [transfer\_after\_bridge](Variables-Master-List_16352570.mdx#transfer_after_bridge). +boolean Controls what happens to a calling (A) party when in a [bridge state](../Introduction/Life-Cycle-of-a-Call.mdx#0-about), and the called (B) party hangs up. If `true` the [dialplan](index.mdx#0-about) will stop processing, and the A leg will be terminated when the B leg terminates. If `false` (default) the dialplan continues to be processed after the B leg terminates. This is checked after [park\_after\_bridge](Variables-Master-List_16352570.mdx#park_after_bridge) and [transfer\_after\_bridge](Variables-Master-List_16352570.mdx#transfer_after_bridge). The default value is `false` @@ -3049,7 +3049,7 @@ dtmf digit ### 0\. About -Allows you to set which [DTMF](../Introduction/Glossary_13173966.mdx#dtmf) tones will terminate +Allows you to set which [DTMF](../Introduction/Glossary.mdx#dtmf) tones will terminate * playback (see [mod\_dptools:playback](../Modules/mod_dptools_1970333.mdx#-c) or [mod\_dptools:play\_and\_detect\_speech](../Modules/mod_dptools_1970333.mdx#-c) for example), or * recording (see `uuid_record` in [mod\_commands](../Modules/mod_commands_1966741.mdx#--) (i.e., the FreeSWITCH API commands), [mod\_dptools:record](../Modules/mod_dptools_1970333.mdx#-c), and [mod\_dptools:record\_session](../Modules/mod_dptools_1970333.mdx#-c)). @@ -3064,14 +3064,14 @@ The default terminator is `*` (star). playback_terminators=123456789*0# | any | none ``` -* `none` \- undefines the terminator digit, meaning no [DTMF](../Introduction/Glossary_13173966.mdx#dtmf) tone will interrupt playback -* `any` \- any [DTMF](../Introduction/Glossary_13173966.mdx#dtmf) will interrupt playback +* `none` \- undefines the terminator digit, meaning no [DTMF](../Introduction/Glossary.mdx#dtmf) tone will interrupt playback +* `any` \- any [DTMF](../Introduction/Glossary.mdx#dtmf) will interrupt playback Digits not specified as terminators will be collected, but won't interrupt playback. ### 2\. Modifiers -* `+` (plus) - includes the following terminator digit along with the other [DTMF](../Introduction/Glossary_13173966.mdx#dtmf) digits in the returned string +* `+` (plus) - includes the following terminator digit along with the other [DTMF](../Introduction/Glossary.mdx#dtmf) digits in the returned string * `x` (letter ex) - includes the following terminator digit in the returned string and also returns `SWITCH_STATUS_RESTART` See last example below on what these modifiers do. @@ -3086,7 +3086,7 @@ Make either `*` (star) or `#` (bar/pound/square) interrupt the subsequent playba ``` -If [DTMF](../Introduction/Glossary_13173966.mdx#dtmf) 9 is dialed during playback, it will interrupt playback and return the digit 9 along with any other dialed digits; if `*` is dialed it will only interrupt playback without being included in the [DTMF](../Introduction/Glossary_13173966.mdx#dtmf) string returned: +If [DTMF](../Introduction/Glossary.mdx#dtmf) 9 is dialed during playback, it will interrupt playback and return the digit 9 along with any other dialed digits; if `*` is dialed it will only interrupt playback without being included in the [DTMF](../Introduction/Glossary.mdx#dtmf) string returned: ```xml diff --git a/docs/FreeSWITCH-Explained/Dialplan/XML-Dialplan/index.mdx b/docs/FreeSWITCH-Explained/Dialplan/XML-Dialplan/index.mdx index 5c1ae3d8..0d6187bd 100644 --- a/docs/FreeSWITCH-Explained/Dialplan/XML-Dialplan/index.mdx +++ b/docs/FreeSWITCH-Explained/Dialplan/XML-Dialplan/index.mdx @@ -311,7 +311,7 @@ Each condition is parsed using the Perl Compatible Regular Expression library. ( ##### Example 1: Capturing Digits -The next example will use a feature of PCRE to show how to route a local call to the local [Telco/PTT](../../Introduction/Glossary_13173966.mdx#telco). (Local providers often insist that local calls be stripped of their country/area/city code.) +The next example will use a feature of PCRE to show how to route a local call to the local [Telco/PTT](../../Introduction/Glossary.mdx#telco). (Local providers often insist that local calls be stripped of their country/area/city code.) In the USA, the last 7 digits of the full 11 digit phone number are the local part. So, if our PBX is located in Los Angeles, the first four digits will always be 1213 for local calls, so we can check for that: diff --git a/docs/FreeSWITCH-Explained/Directory/XML-User-Directory/index.mdx b/docs/FreeSWITCH-Explained/Directory/XML-User-Directory/index.mdx index 8ee7859b..0de38417 100644 --- a/docs/FreeSWITCH-Explained/Directory/XML-User-Directory/index.mdx +++ b/docs/FreeSWITCH-Explained/Directory/XML-User-Directory/index.mdx @@ -401,7 +401,7 @@ You can prevent a particular user from registering over SIP with the sip-forbid- ### Dial String -The dial string MUST be defined and will control the behavior of the call when a user is dialed. The dial-string parameter is used by the [user/ endpoint](../../Introduction/Endpoints_15696294.mdx#about). +The dial string MUST be defined and will control the behavior of the call when a user is dialed. The dial-string parameter is used by the [user/ endpoint](../../Introduction/Endpoints.mdx#about). Default value goes as follows: diff --git a/docs/FreeSWITCH-Explained/15139379.mdx b/docs/FreeSWITCH-Explained/Event-Types.mdx similarity index 100% rename from docs/FreeSWITCH-Explained/15139379.mdx rename to docs/FreeSWITCH-Explained/Event-Types.mdx diff --git a/docs/FreeSWITCH-Explained/Index_1048632.mdx b/docs/FreeSWITCH-Explained/Index_1048632.mdx deleted file mode 100644 index 39b34edb..00000000 --- a/docs/FreeSWITCH-Explained/Index_1048632.mdx +++ /dev/null @@ -1,115 +0,0 @@ - -# Index - - - -Label Heatmap - -* [api](https://freeswitch.org/confluence/label/FREESWITCH/api) -* [apps](https://freeswitch.org/confluence/label/FREESWITCH/apps) -* [arm](https://freeswitch.org/confluence/label/FREESWITCH/arm) -* [asr](https://freeswitch.org/confluence/label/FREESWITCH/asr) -* [bsd](https://freeswitch.org/confluence/label/FREESWITCH/bsd) -* [bugs](https://freeswitch.org/confluence/label/FREESWITCH/bugs) -* [building](https://freeswitch.org/confluence/label/FREESWITCH/building) -* [call-control](https://freeswitch.org/confluence/label/FREESWITCH/call-control) -* [cdr](https://freeswitch.org/confluence/label/FREESWITCH/cdr) -* [centos](https://freeswitch.org/confluence/label/FREESWITCH/centos) -* [certificate](https://freeswitch.org/confluence/label/FREESWITCH/certificate) -* [channel\_variable](https://freeswitch.org/confluence/label/FREESWITCH/channel%5Fvariable) -* [clients](https://freeswitch.org/confluence/label/FREESWITCH/clients) -* [clusters](https://freeswitch.org/confluence/label/FREESWITCH/clusters) -* [codecs](https://freeswitch.org/confluence/label/FREESWITCH/codecs) -* [community](https://freeswitch.org/confluence/label/FREESWITCH/community) -* [conference](https://freeswitch.org/confluence/label/FREESWITCH/conference) -* [configuration](https://freeswitch.org/confluence/label/FREESWITCH/configuration) -* [databases](https://freeswitch.org/confluence/label/FREESWITCH/databases) -* [debugging](https://freeswitch.org/confluence/label/FREESWITCH/debugging) -* [developers](https://freeswitch.org/confluence/label/FREESWITCH/developers) -* [dialplan](https://freeswitch.org/confluence/label/FREESWITCH/dialplan) -* [directory](https://freeswitch.org/confluence/label/FREESWITCH/directory) -* [docs-team](https://freeswitch.org/confluence/label/FREESWITCH/docs-team) -* [dptools](https://freeswitch.org/confluence/label/FREESWITCH/dptools) -* [dtmf](https://freeswitch.org/confluence/label/FREESWITCH/dtmf) -* [encryption](https://freeswitch.org/confluence/label/FREESWITCH/encryption) -* [endpoints](https://freeswitch.org/confluence/label/FREESWITCH/endpoints) -* [erlang](https://freeswitch.org/confluence/label/FREESWITCH/erlang) -* [esl](https://freeswitch.org/confluence/label/FREESWITCH/esl) -* [events](https://freeswitch.org/confluence/label/FREESWITCH/events) -* [examples](https://freeswitch.org/confluence/label/FREESWITCH/examples) -* [fax](https://freeswitch.org/confluence/label/FREESWITCH/fax) -* [featured](https://freeswitch.org/confluence/label/FREESWITCH/featured) -* [file\_formats](https://freeswitch.org/confluence/label/FREESWITCH/file%5Fformats) -* [global\_variable](https://freeswitch.org/confluence/label/FREESWITCH/global%5Fvariable) -* [google](https://freeswitch.org/confluence/label/FREESWITCH/google) -* [grammar](https://freeswitch.org/confluence/label/FREESWITCH/grammar) -* [gui](https://freeswitch.org/confluence/label/FREESWITCH/gui) -* [hangup](https://freeswitch.org/confluence/label/FREESWITCH/hangup) -* [high-availability](https://freeswitch.org/confluence/label/FREESWITCH/high-availability) -* [high-volume](https://freeswitch.org/confluence/label/FREESWITCH/high-volume) -* [inline](https://freeswitch.org/confluence/label/FREESWITCH/inline) -* [installation](https://freeswitch.org/confluence/label/FREESWITCH/installation) -* [interfaces](https://freeswitch.org/confluence/label/FREESWITCH/interfaces) -* [interop](https://freeswitch.org/confluence/label/FREESWITCH/interop) -* [introduction](https://freeswitch.org/confluence/label/FREESWITCH/introduction) -* [ivr](https://freeswitch.org/confluence/label/FREESWITCH/ivr) -* [java](https://freeswitch.org/confluence/label/FREESWITCH/java) -* [javascript](https://freeswitch.org/confluence/label/FREESWITCH/javascript) -* [json-rpc](https://freeswitch.org/confluence/label/FREESWITCH/json-rpc) -* [khomp](https://freeswitch.org/confluence/label/FREESWITCH/khomp) -* [learn](https://freeswitch.org/confluence/label/FREESWITCH/learn) -* [linux](https://freeswitch.org/confluence/label/FREESWITCH/linux) -* [logging](https://freeswitch.org/confluence/label/FREESWITCH/logging) -* [lua](https://freeswitch.org/confluence/label/FREESWITCH/lua) -* [media](https://freeswitch.org/confluence/label/FREESWITCH/media) -* [mod](https://freeswitch.org/confluence/label/FREESWITCH/mod) -* [mod\_event\_socket](https://freeswitch.org/confluence/label/FREESWITCH/mod%5Fevent%5Fsocket) -* [mod\_lcr](https://freeswitch.org/confluence/label/FREESWITCH/mod%5Flcr) -* [modules](https://freeswitch.org/confluence/label/FREESWITCH/modules) -* [mq](https://freeswitch.org/confluence/label/FREESWITCH/mq) -* [mrcp](https://freeswitch.org/confluence/label/FREESWITCH/mrcp) -* [multi-tenant](https://freeswitch.org/confluence/label/FREESWITCH/multi-tenant) -* [needs-documentation](https://freeswitch.org/confluence/label/FREESWITCH/needs-documentation) -* [networking](https://freeswitch.org/confluence/label/FREESWITCH/networking) -* [openzap](https://freeswitch.org/confluence/label/FREESWITCH/openzap) -* [operating-systems](https://freeswitch.org/confluence/label/FREESWITCH/operating-systems) -* [perl](https://freeswitch.org/confluence/label/FREESWITCH/perl) -* [phones](https://freeswitch.org/confluence/label/FREESWITCH/phones) -* [playback](https://freeswitch.org/confluence/label/FREESWITCH/playback) -* [presence](https://freeswitch.org/confluence/label/FREESWITCH/presence) -* [protocols](https://freeswitch.org/confluence/label/FREESWITCH/protocols) -* [providers](https://freeswitch.org/confluence/label/FREESWITCH/providers) -* [python](https://freeswitch.org/confluence/label/FREESWITCH/python) -* [record](https://freeswitch.org/confluence/label/FREESWITCH/record) -* [reference](https://freeswitch.org/confluence/label/FREESWITCH/reference) -* [release](https://freeswitch.org/confluence/label/FREESWITCH/release) -* [rpc](https://freeswitch.org/confluence/label/FREESWITCH/rpc) -* [rtp](https://freeswitch.org/confluence/label/FREESWITCH/rtp) -* [scheduler](https://freeswitch.org/confluence/label/FREESWITCH/scheduler) -* [scripts](https://freeswitch.org/confluence/label/FREESWITCH/scripts) -* [security](https://freeswitch.org/confluence/label/FREESWITCH/security) -* [sip](https://freeswitch.org/confluence/label/FREESWITCH/sip) -* [socket](https://freeswitch.org/confluence/label/FREESWITCH/socket) -* [sofia](https://freeswitch.org/confluence/label/FREESWITCH/sofia) -* [spy](https://freeswitch.org/confluence/label/FREESWITCH/spy) -* [too-short](https://freeswitch.org/confluence/label/FREESWITCH/too-short) -* [troubleshooting](https://freeswitch.org/confluence/label/FREESWITCH/troubleshooting) -* [tts](https://freeswitch.org/confluence/label/FREESWITCH/tts) -* [ubuntu](https://freeswitch.org/confluence/label/FREESWITCH/ubuntu) -* [unix](https://freeswitch.org/confluence/label/FREESWITCH/unix) -* [variables](https://freeswitch.org/confluence/label/FREESWITCH/variables) -* [verto](https://freeswitch.org/confluence/label/FREESWITCH/verto) -* [video](https://freeswitch.org/confluence/label/FREESWITCH/video) -* [virtualization](https://freeswitch.org/confluence/label/FREESWITCH/virtualization) -* [webapi](https://freeswitch.org/confluence/label/FREESWITCH/webapi) -* [webrtc](https://freeswitch.org/confluence/label/FREESWITCH/webrtc) -* [zapata](https://freeswitch.org/confluence/label/FREESWITCH/zapata) -* [zaptel](https://freeswitch.org/confluence/label/FREESWITCH/zaptel) - -## Space Index - -#### Total number of pages: 1,746 - -We can't show the Page Index because this space has more than 1,000 pages.[Learn More](https://docs.atlassian.com/confluence/docs-713/Page+Index+Macro) - - diff --git a/docs/FreeSWITCH-Explained/Interoperability/Softphones/index.mdx b/docs/FreeSWITCH-Explained/Interoperability/Softphones/index.mdx index f15641c1..6fe2cb59 100644 --- a/docs/FreeSWITCH-Explained/Interoperability/Softphones/index.mdx +++ b/docs/FreeSWITCH-Explained/Interoperability/Softphones/index.mdx @@ -48,7 +48,7 @@ Click to expand Table of Contents ## Verto Communicator -[Verto Communicator](../../Verto-Communicator_9633841.mdx#about) runs in a web browser and speaks the Verto protocol to FreeSWITCH. It implements the WebRTC specification for audio and video streaming. +[Verto Communicator](../../Verto-Communicator.mdx#about) runs in a web browser and speaks the Verto protocol to FreeSWITCH. It implements the WebRTC specification for audio and video streaming. ## [3CX Phone 1.17](http://www.3cx.com/) diff --git a/docs/FreeSWITCH-Explained/Introduction/Audio-Formats_15696302.mdx b/docs/FreeSWITCH-Explained/Introduction/Audio-Formats_15696302.mdx deleted file mode 100644 index 6a182ad1..00000000 --- a/docs/FreeSWITCH-Explained/Introduction/Audio-Formats_15696302.mdx +++ /dev/null @@ -1,18 +0,0 @@ - -# Audio Formats - - - -## About - -About text. - -Click here to expand Table of Contents - -* 1 [Heading](#heading) - -## Heading - -Text. - - diff --git a/docs/FreeSWITCH-Explained/Introduction/Call-Legs_7143972.mdx b/docs/FreeSWITCH-Explained/Introduction/Call-Legs.mdx similarity index 91% rename from docs/FreeSWITCH-Explained/Introduction/Call-Legs_7143972.mdx rename to docs/FreeSWITCH-Explained/Introduction/Call-Legs.mdx index 772f11b3..4472446b 100644 --- a/docs/FreeSWITCH-Explained/Introduction/Call-Legs_7143972.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/Call-Legs.mdx @@ -1,25 +1,7 @@ # Call Legs - ---- - -Table of Contents (click to expand) - -* [0\. About](#0-about) -* [1\. Call legs](#1-call-legs) - * [1.1 A leg vs B leg](#11-a-leg-vs-b-leg) -* [2\. Channels](#2-channels) -* [3\. Calls](#3-calls) - * [3.1 One legged calls](#31-one-legged-calls) - * [3.2 Bridged call](#32-bridged-call) - * [3.2.1 What happens when one side hangs up?](#321-what-happens-when-one-side-hangs-up) - * [3.2.2 Can legs be bridged if they use different protocols?](#322-can-legs-be-bridged-if-they-use-different-protocols) -* [4\. Channels vs Calls](#4-channels-vs-calls) -* [5\. Propagating variables from the A leg to the B leg](#5-propagating-variables-from-the-a-leg-to-the-b-leg) - ---- ## 0\. About diff --git a/docs/FreeSWITCH-Explained/Introduction/Debian+10+Buster.mdx b/docs/FreeSWITCH-Explained/Introduction/Debian+10+Buster.mdx deleted file mode 100644 index 5b10452d..00000000 --- a/docs/FreeSWITCH-Explained/Introduction/Debian+10+Buster.mdx +++ /dev/null @@ -1 +0,0 @@ -https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/Installation/Linux/Debian_67240088 diff --git a/docs/FreeSWITCH-Explained/Introduction/Endpoints_15696294.mdx b/docs/FreeSWITCH-Explained/Introduction/Endpoints.mdx similarity index 91% rename from docs/FreeSWITCH-Explained/Introduction/Endpoints_15696294.mdx rename to docs/FreeSWITCH-Explained/Introduction/Endpoints.mdx index 6499c45e..47e68f9f 100644 --- a/docs/FreeSWITCH-Explained/Introduction/Endpoints_15696294.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/Endpoints.mdx @@ -5,7 +5,7 @@ ## About -Every [call leg](./Call-Legs_7143972.mdx#0-about) (channel) is by definition a connection between FreeSWITCH and something else. That something else can be a VoIP phone, a PRI connection or even an audio device on your computer. Each type of device has their own protocol for setting up channels, negotiating [codecs](../Codecs-and-Media/index.mdx#about), sending and receiving media. In FreeSWITCH a channel itself is not tied to a specific protocol, instead it uses an Endpoint module to implement the protocol. This architecture allows us to bridge channels using different protocols. It also allows us to easily implement new protocols. +Every [call leg](./Call-Legs.mdx#0-about) (channel) is by definition a connection between FreeSWITCH and something else. That something else can be a VoIP phone, a PRI connection or even an audio device on your computer. Each type of device has their own protocol for setting up channels, negotiating [codecs](../Codecs-and-Media/index.mdx#about), sending and receiving media. In FreeSWITCH a channel itself is not tied to a specific protocol, instead it uses an Endpoint module to implement the protocol. This architecture allows us to bridge channels using different protocols. It also allows us to easily implement new protocols. You will sometimes see the term **Session**, this is a programmatic interface used by Endpoint modules to create and manage a channel. diff --git a/docs/FreeSWITCH-Explained/Introduction/Event-System/Event-List_7143557.mdx b/docs/FreeSWITCH-Explained/Introduction/Event-System/Event-List_7143557.mdx index 41cc52fb..757e09b2 100644 --- a/docs/FreeSWITCH-Explained/Introduction/Event-System/Event-List_7143557.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/Event-System/Event-List_7143557.mdx @@ -116,7 +116,7 @@ What is the relation between CHANNEL\_CALLSTATE and CHANNEL\_STATE events, and C The empty lines denote the boundaries between different events. Made a test call (that hasn't been answered, only routed by an extension), and the resulting events have been filtered in Vim using `/"Channel-State"\|"Channel-Call-State"\|^$\|CHANNEL_CALLSTATE\|CHANNEL_STATE` -The UML diagram in [Life Cycle of a Call](../Life-Cycle-of-a-Call_1048888.mdx#0-about) and the dump below should be helpful to decipher this. See [attachment](/attachments/7143557/32178221.html) for a diff between two `CHANNEL_STATE` event, one in `CS_ROUTING` and one in `CS_EXECUTE` state (there's very little difference). +The UML diagram in [Life Cycle of a Call](../Life-Cycle-of-a-Call.mdx#0-about) and the dump below should be helpful to decipher this. See [attachment](/attachments/7143557/32178221.html) for a diff between two `CHANNEL_STATE` event, one in `CS_ROUTING` and one in `CS_EXECUTE` state (there's very little difference). See also [Creating a New Endpoint: Lifecycle of a Session](../../Community/Contributing-Code/Creating-New-Modules/9634354.mdx#0-about) page! diff --git a/docs/FreeSWITCH-Explained/Introduction/Event-System/Events_32178330.mdx b/docs/FreeSWITCH-Explained/Introduction/Event-System/Events_32178330.mdx index 1ce97ed7..bc205d11 100644 --- a/docs/FreeSWITCH-Explained/Introduction/Event-System/Events_32178330.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/Event-System/Events_32178330.mdx @@ -29,7 +29,7 @@ Events are generated by * external applications * TODO What else? -and the [event system](./index.mdx#0-about) is responsible of controlling the distribution of events among (internal and external) [subscribers](../Glossary_13173966.mdx#event-socket). +and the [event system](./index.mdx#0-about) is responsible of controlling the distribution of events among (internal and external) [subscribers](../Glossary.mdx#event-socket). For a comprehensive list of events, see [Event List](./Event-List_7143557.mdx#nat). @@ -271,7 +271,7 @@ A `CUSTOM` event (i.e., where the `**Event-Name**` header's value is `CUSTOM`) i **CUSTOM** events are employed by -* most **[endpoint modules](../Endpoints_15696294.mdx#about)** (see [Creating a New Endpoint: Lifecycle of a Session](../../Community/Contributing-Code/Creating-New-Modules/9634354.mdx#0-about)), +* most **[endpoint modules](../Endpoints.mdx#about)** (see [Creating a New Endpoint: Lifecycle of a Session](../../Community/Contributing-Code/Creating-New-Modules/9634354.mdx#0-about)), for example, when a user logs into Verto, or a SIP phone tries to register * many **[dialplan applications](../../Modules/mod_dptools_1970333.mdx#-c)**, such as the [conference](../../Conference/index.mdx#about), [voicemail](../../Modules/mod-voicemail/Voicemail_13174041.mdx#--), and [call center](../../Configuration/Call-Center_7143525.mdx#about) applications, the fax management in [mod\_spandsp](../../Modules/mod_spandsp_6587021.mdx#--), and so on. The [ivr application](../../Modules/mod-dptools/6586989.mdx#about) also generates CUSTOM events, and subclasses describe entering and exiting of menus (see "Events" section in [mod\_dptools: IVR Menu](../../Modules/mod-dptools/6586989.mdx#about)). diff --git a/docs/FreeSWITCH-Explained/Introduction/Event-System/index.mdx b/docs/FreeSWITCH-Explained/Introduction/Event-System/index.mdx index 0c620b99..8973c5c9 100644 --- a/docs/FreeSWITCH-Explained/Introduction/Event-System/index.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/Event-System/index.mdx @@ -22,7 +22,7 @@ Subpages (click to expand) ## 0\. About -FreeSWITCH is event-driven; it responds to and emits events. [Events](./Events_32178330.mdx#0-about) are the result of any activity happening on the system, and are generated by the [core and modules of FreeSWITCH](../index.mdx#3-architecture), and by external sources. The event system is also what makes it possible to build [event socket](../Glossary_13173966.mdx#event-socket) applications. +FreeSWITCH is event-driven; it responds to and emits events. [Events](./Events_32178330.mdx#0-about) are the result of any activity happening on the system, and are generated by the [core and modules of FreeSWITCH](../index.mdx#3-architecture), and by external sources. The event system is also what makes it possible to build [event socket](../Glossary.mdx#event-socket) applications. You can quickly see the event system in action in [fs\_cli](../../Client-and-Developer-Interfaces/1048948.mdx#or) : diff --git a/docs/FreeSWITCH-Explained/Introduction/FreeSWITCH-API_30867723.mdx b/docs/FreeSWITCH-Explained/Introduction/FreeSWITCH-API.mdx similarity index 91% rename from docs/FreeSWITCH-Explained/Introduction/FreeSWITCH-API_30867723.mdx rename to docs/FreeSWITCH-Explained/Introduction/FreeSWITCH-API.mdx index d78d3c99..d456fafd 100644 --- a/docs/FreeSWITCH-Explained/Introduction/FreeSWITCH-API_30867723.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/FreeSWITCH-API.mdx @@ -6,7 +6,7 @@ The public FreeSWITCH API consists of all the commands that can be issued to FreeSWITCH via * its console, [fs\_cli](../Client-and-Developer-Interfaces/1048948.mdx#or), -* the [event socket interface](Glossary_13173966.mdx#event-socket), and +* the [event socket interface](Glossary.mdx#event-socket), and * scripting interfaces. The set of available commands is dependent on which modules are loaded. The authoritative set of commands for your installation is the union of the sets of commands registered by each module. diff --git a/docs/FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx b/docs/FreeSWITCH-Explained/Introduction/Glossary.mdx similarity index 99% rename from docs/FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx rename to docs/FreeSWITCH-Explained/Introduction/Glossary.mdx index c3afa28b..a7d88187 100644 --- a/docs/FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/Glossary.mdx @@ -11,7 +11,7 @@ Covered terms range from basic telephony elements like call legs and channels to --- -Table of Glossary Terms (click to expand) +Table of Glossary Terms * 1 [Call switching](#call-switching) * 2 [Call leg](#call-leg) @@ -51,13 +51,13 @@ See Wikipedia entries [telephone exchange](https://en.wikipedia.org/wiki/Telepho A **call leg** is an inbound or outbound connection between the phone switch and an external party. -See [Call Legs](./Call-Legs_7143972.mdx#0-about) page. +See [Call Legs](./Call-Legs.mdx#0-about) page. ## Channel In FreeSWITCH, a **channel** represents a _call leg_. -See [Call Legs](./Call-Legs_7143972.mdx#0-about) page. +See [Call Legs](./Call-Legs.mdx#0-about) page. ## CODEC diff --git a/docs/FreeSWITCH-Explained/Introduction/Introduction-to-Dialplan_15696304.mdx b/docs/FreeSWITCH-Explained/Introduction/Introduction-to-Dialplan_15696304.mdx deleted file mode 100644 index 0a9c0f28..00000000 --- a/docs/FreeSWITCH-Explained/Introduction/Introduction-to-Dialplan_15696304.mdx +++ /dev/null @@ -1,18 +0,0 @@ - -# Introduction to Dialplan - - - -## About - -About text. - -Click here to expand Table of Contents - -* 1 [Heading](#-freeswitch--introduction-to-dialplan-) - -## Heading - -Text. - - diff --git a/docs/FreeSWITCH-Explained/1048601.mdx b/docs/FreeSWITCH-Explained/Introduction/Introduction.mdx similarity index 94% rename from docs/FreeSWITCH-Explained/1048601.mdx rename to docs/FreeSWITCH-Explained/Introduction/Introduction.mdx index edbb146b..2ca06704 100644 --- a/docs/FreeSWITCH-Explained/1048601.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/Introduction.mdx @@ -1,3 +1,8 @@ +--- + +slug: /FreeSWITCH-Explained/Introduction/Introduction.mdx + +--- # Introduction @@ -9,19 +14,6 @@ Welcome to the community documentation wiki for FreeSWITCH, a telephony construc Because FreeSWITCH is an engine designed as a platform on which to build many different types of systems, it is inherently modular. Our motto is: "Don't glue the Lego pieces together". FreeSWITCH is a modular application, in which modules can extend the functionality, but the abstraction layer prevents inter-module dependency. The goal is to ensure that one module is not required to load another. -Click to expand Table of Contents - -* 1 [What Is FreeSWITCH™?](#what-is-freeswitch) -* 2 [Tutorials and Guides](#tutorials-and-guides--) - * 2.1 [New Users - Start Here](#new-users---start-here) -* 3 [Weekly Conference Calls](#weekly-conference-calls) -* 4 [Application Examples](#application-examples) -* 5 [FreeSWITCH™ Architecture](#freeswitch-architecture) - * 5.1 [Feature Documentation](#feature-documentation) - * 5.2 [News](#-freeswitch--dead-introduction-) - * 5.3 [Community and Support](#community-and-support) - * 5.4 [New Features](#new-features--) - * 5.5 [Home](#-freeswitch--dead-introduction-) ## What Is FreeSWITCH™? @@ -63,7 +55,7 @@ With a desire not to reinvent the wheel, we've designed FreeSWITCH to take advan ## Weekly Conference Calls -[FreeSWITCH Community page](/confluence/pages/createpage.action?spaceKey=FREESWITCH&title=Join+the+Community&linkCreation=true&fromPageId=1048601) +[FreeSWITCH Community page](/freeswitch/FreeSWITCH-Explained/Community/) ## Application Examples @@ -76,7 +68,7 @@ The following sample applications are included in the distribution: ## FreeSWITCH™ Architecture * [Core Outline of FreeSWITCH™]: This gives the basic outline of FreeSWITCH™ -* [Life Cycle of a Call into FreeSWITCH™](./Introduction/Life-Cycle-of-a-Call_1048888.mdx#0-about): The basic life cycle of a call. +* [Life Cycle of a Call into FreeSWITCH™](./Introduction/Life-Cycle-of-a-Call.mdx#0-about): The basic life cycle of a call. ### Feature Documentation diff --git a/docs/FreeSWITCH-Explained/Introduction/Licensing_13173286.mdx b/docs/FreeSWITCH-Explained/Introduction/Licensing.mdx similarity index 100% rename from docs/FreeSWITCH-Explained/Introduction/Licensing_13173286.mdx rename to docs/FreeSWITCH-Explained/Introduction/Licensing.mdx diff --git a/docs/FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call_1048888.mdx b/docs/FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call.mdx similarity index 100% rename from docs/FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call_1048888.mdx rename to docs/FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call.mdx diff --git a/docs/FreeSWITCH-Explained/Introduction/Running-FreeSWITCH_15696307.mdx b/docs/FreeSWITCH-Explained/Introduction/Running-FreeSWITCH_15696307.mdx deleted file mode 100644 index 3dffa2cd..00000000 --- a/docs/FreeSWITCH-Explained/Introduction/Running-FreeSWITCH_15696307.mdx +++ /dev/null @@ -1,18 +0,0 @@ - -# Running FreeSWITCH - - - -## About - -About text. - -Click here to expand Table of Contents - -* 1 [Heading](#heading) - -## Heading - -Text. - - diff --git a/docs/FreeSWITCH-Explained/Introduction/Understanding-the-Configuration-Files_15696295.mdx b/docs/FreeSWITCH-Explained/Introduction/Understanding-the-Configuration-Files.mdx similarity index 100% rename from docs/FreeSWITCH-Explained/Introduction/Understanding-the-Configuration-Files_15696295.mdx rename to docs/FreeSWITCH-Explained/Introduction/Understanding-the-Configuration-Files.mdx diff --git a/docs/FreeSWITCH-Explained/Introduction/Variables/index.mdx b/docs/FreeSWITCH-Explained/Introduction/Variables/index.mdx index 6496865b..9aa8b1e2 100644 --- a/docs/FreeSWITCH-Explained/Introduction/Variables/index.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/Variables/index.mdx @@ -57,7 +57,7 @@ The difference between variable names prefixed with a single $ or a double $$ ** * The `$$` (or double $) syntax is only for **[global variables](./Global-Variables_13173994.mdx#about)**. -`$${variable_name}` will be completely removed by the **[pre-processor](../Understanding-the-Configuration-Files_15696295.mdx)**, and replaced with the value of the variable. If there is no matching global variable it will just remain blank. Because this is done by the **[pre-processor](../Understanding-the-Configuration-Files_15696295.mdx)**, it is evaluated only when the configuration file is loaded into memory (either at startup or when reloading). +`$${variable_name}` will be completely removed by the **[pre-processor](../Understanding-the-Configuration-Files.mdx)**, and replaced with the value of the variable. If there is no matching global variable it will just remain blank. Because this is done by the **[pre-processor](../Understanding-the-Configuration-Files.mdx)**, it is evaluated only when the configuration file is loaded into memory (either at startup or when reloading). * The $ (or single $) syntax is not affected by the **pre-processor**, instead it's evaluated at runtime. For example, if you use it in the [dialplan](../../Dialplan/index.mdx#0-about), it will be evaluated from scratch for every call. Therefore, if you change the value of a global variable, the $ syntax will reflect the new value. @@ -110,7 +110,7 @@ freeswitch@lofa> uuid_getvar variable_name As their name implies, global variables are available to the entire FreeSWITCH system, and their values are the same for all channels. It's intended to be used for variables that don't change often. -Global variables can be created/modified in the configuration using the [set](../Understanding-the-Configuration-Files_15696295.mdx#-freeswitch--understanding-the-configuration-files-) pre-processor command (see [Understanding the Configuration Files](../Understanding-the-Configuration-Files_15696295.mdx)). You can also set a global variable using the [global\_setvar ](../../Modules/mod_commands_1966741.mdx#global_setvar)API command (see [mod\_commands](../../Modules/mod_commands_1966741.mdx#--)). +Global variables can be created/modified in the configuration using the [set](../Understanding-the-Configuration-Files.mdx#-freeswitch--understanding-the-configuration-files-) pre-processor command (see [Understanding the Configuration Files](../Understanding-the-Configuration-Files.mdx)). You can also set a global variable using the [global\_setvar ](../../Modules/mod_commands_1966741.mdx#global_setvar)API command (see [mod\_commands](../../Modules/mod_commands_1966741.mdx#--)). The FreeSWITCH core as well as individual modules have many predefined variables, some of which are set in [vars.xml](../../Configuration/Configuring-FreeSWITCH/vars.xml_7144079.mdx#about) in the [default configuration](../../Configuration/Default-Configuration_6587388.mdx#mod_vp8), others have a default value assigned by the FreeSWITCH core. @@ -118,7 +118,7 @@ See the [Global Variables](./Global-Variables_13173994.mdx#about) page for a ful ## 4\. Channel Variables -[Channel variables](../../Dialplan/Channel-Variables_16352493.mdx#about) are variables that are specific to a single channel (or a single call, to put it another way) such as [caller\_id\_number](../../../Channel-Variables-Catalog/caller_id_number_16352836.mdx#caller_id_number), etc. You can create a channel variable with the [set ](../../Modules/mod-dptools/6586661.mdx#about)pre-processor directive (see [Understanding the Configuration Files](../Understanding-the-Configuration-Files_15696295.mdx)). Because channel variables are specific to a channel, they are only available in the context of a channel such as in the [dialplan](../../Dialplan/index.mdx#0-about), or in scripts running as part of a [dialplan](../../Dialplan/index.mdx#0-about). +[Channel variables](../../Dialplan/Channel-Variables_16352493.mdx#about) are variables that are specific to a single channel (or a single call, to put it another way) such as [caller\_id\_number](../../../Channel-Variables-Catalog/caller_id_number_16352836.mdx#caller_id_number), etc. You can create a channel variable with the [set ](../../Modules/mod-dptools/6586661.mdx#about)pre-processor directive (see [Understanding the Configuration Files](../Understanding-the-Configuration-Files.mdx)). Because channel variables are specific to a channel, they are only available in the context of a channel such as in the [dialplan](../../Dialplan/index.mdx#0-about), or in scripts running as part of a [dialplan](../../Dialplan/index.mdx#0-about). ## 5\. System Defined Variables diff --git a/docs/FreeSWITCH-Explained/Introduction/index.mdx b/docs/FreeSWITCH-Explained/Introduction/index.mdx index 44b2d36f..00de5775 100644 --- a/docs/FreeSWITCH-Explained/Introduction/index.mdx +++ b/docs/FreeSWITCH-Explained/Introduction/index.mdx @@ -9,19 +9,19 @@ In this Introduction we provide a brief overview of FreeSWITCH in laymen's terms FreeSWITCH is a Software Defined Telecom Stack enabling the digital transformation from proprietary telecom switches to a versatile software implementation that runs on any commodity hardware. From a Raspberry PI to a multi-core server, FreeSWITCH can unlock the telecommunications potential of any device. Combined with our hosted cloud platform, SignalWire, FreeSWITCH can interconnect with the outside world and scale to any size. (Visit for more info) -FreeSWITCH can handle voice, video and text communications from an IP Network ([VoIP](Glossary_13173966.mdx#voip)) and the [PSTN](Glossary_13173966.mdx#pstn) (i.e., regular landlines). FreeSWITCH supports all popular [VoIP](Glossary_13173966.mdx#voip) protocols as well as interfacing with [PRIs](Glossary_13173966.mdx#pri). For a full listing of supported protocols, see the [Endpoints ](./Endpoints_15696294.mdx#about)page. +FreeSWITCH can handle voice, video and text communications from an IP Network ([VoIP](Glossary.mdx#voip)) and the [PSTN](Glossary.mdx#pstn) (i.e., regular landlines). FreeSWITCH supports all popular [VoIP](Glossary.mdx#voip) protocols as well as interfacing with [PRIs](Glossary.mdx#pri). For a full listing of supported protocols, see the [Endpoints ](./Endpoints_15696294.mdx#about)page. Some common capacities, that FreeSWITCH is used for, include -* [PBX](Glossary_13173966.mdx#pbx) (Office phone system) -* [Class 5 Softswitch](Glossary_13173966.mdx#softswitch) (Telephone carrier) +* [PBX](Glossary.mdx#pbx) (Office phone system) +* [Class 5 Softswitch](Glossary.mdx#softswitch) (Telephone carrier) * Application server such as Voicemail, conferencing, IVR -* [Softphone](Glossary_13173966.mdx#softphone) +* [Softphone](Glossary.mdx#softphone) This list is by no means comprehensive. FreeSWITCH is extremely flexible, and can be used in any way you can imagine. -The [default configuration](../Configuration/Default-Configuration_6587388.mdx#mod_vp8) showcases a full-featured [PBX](Glossary_13173966.mdx#pbx) with many applications. +The [default configuration](../Configuration/Default-Configuration_6587388.mdx#mod_vp8) showcases a full-featured [PBX](Glossary.mdx#pbx) with many applications. ### Where can I run FreeSWITCH? @@ -46,7 +46,7 @@ When designing FreeSWITCH the goal was to have the following properties: * **Extensibility** \- Allowing new features to be added easily. * **Flexibility** \- Users should be able to pick and choose which functionalities are enabled, while also allowing them to replace parts of the system with different implementations -* **Scalability** \- FreeSWITCH can be run on systems as small as an embedded [softphone](Glossary_13173966.mdx#softphone) or as big as a cluster of full-blown carrier switches. +* **Scalability** \- FreeSWITCH can be run on systems as small as an embedded [softphone](Glossary.mdx#softphone) or as big as a cluster of full-blown carrier switches. * **Stability** \- Problems with one feature should not bring down the whole system. To accomplish these goals FreeSWITCH is built using a **modular system**: @@ -62,7 +62,7 @@ The [modules](../Modules/index.mdx#about) are grouped by the type of functionali | Type | Description | | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Endpoint](./Endpoints_15696294.mdx#about) | Endpoint modules support types of communications devices such as [VoIP](Glossary_13173966.mdx#voip), [PSTN](Glossary_13173966.mdx#pstn) (i.e., regular landline), Skype, Google Talk etc. Endpoint modules are one of the most important modules in FreeSWITCH. | +| [Endpoint](./Endpoints.mdx#about) | Endpoint modules support types of communications devices such as [VoIP](Glossary.mdx#voip), [PSTN](Glossary.mdx#pstn) (i.e., regular landline), Skype, Google Talk etc. Endpoint modules are one of the most important modules in FreeSWITCH. | | Application | This is where all the action is happening! There are hundreds of application modules included in the default setup a few examples are playing a file, joining a conference, send a call to voicemail, play an IVR menu. Many of the common applications are provided by the [dptools ](../Modules/mod_dptools_1970333.mdx#-c)module. | | [Dialplan](../Dialplan/index.mdx#0-about) | A Dialplan module is responsible for routing calls, based on information such as Caller ID, Destination Number and more. The default dialplan module is the [XML Dialplan](../Dialplan/XML-Dialplan/index.mdx#about). We will cover this in detail in the [Dialplan](../Dialplan/index.mdx#0-about) section. | | [Directory](../Directory/index.mdx#about) | Provides authentication and configurations for users that can register with FreeSWITCH. The most common directory module is the [XML Directory](../Directory/XML-User-Directory/index.mdx#about). | @@ -86,11 +86,11 @@ This table provides a roadmap you can use to go through the documentation in a s | Page | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Installation](../Installation/index.mdx#about) | How to download and install FreeSWITCH | -| [Configuration](./Understanding-the-Configuration-Files_15696295.mdx) | Overview of the structure of FreeSWITCH Configuration files. | +| [Configuration](./Understanding-the-Configuration-Files.mdx) | Overview of the structure of FreeSWITCH Configuration files. | | [Running FreeSWITCH](./Running-FreeSWITCH_15696307.mdx#about) | How to run FreeSWITCH in the console or as a daemon | -| [Call Legs](./Call-Legs_7143972.mdx#0-about) | Explains an important concept required to better understand Endpoints and Dialplans | -| [Endpoints](./Endpoints_15696294.mdx#about) | Explains the endpoint concept in general, as well as a more detailed overview of the common endpoints | -| [Introduction to Dialplan](./Introduction-to-Dialplan_15696304.mdx#about) | Dialplan is one of the most complex parts of FreeSWITCH, this page distills it | +| [Call Legs](./Call-Legs.mdx#0-about) | Explains an important concept required to better understand Endpoints and Dialplans | +| [Endpoints](./Endpoints.mdx#about) | Explains the endpoint concept in general, as well as a more detailed overview of the common endpoints | +| [Introduction to Dialplan](./Introduction-to-Dialplan.mdx#about) | Dialplan is one of the most complex parts of FreeSWITCH, this page distills it | | [Directory](../Directory/index.mdx#about) | How to setup users and devices | | Logging & CDR | Setup Logging and Call Records | | [Databases](../Databases/FreeSWITCH-Databases_13173016.mdx#--) | How to configure FreeSWITCH to store channel state in a database | diff --git a/docs/FreeSWITCH-Explained/Meta-Pages/Filename-Standardization.mdx b/docs/FreeSWITCH-Explained/Meta-Pages/Filename-Standardization.mdx new file mode 100644 index 00000000..f1807042 --- /dev/null +++ b/docs/FreeSWITCH-Explained/Meta-Pages/Filename-Standardization.mdx @@ -0,0 +1,28 @@ + +# Filename Standardization + +## Updated files + +| Previous filename | Updated filename | +| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| Endpoints_15696294.mdx | [Endpoints.mdx](/FreeSWITCH-Explained/Introduction/Endpoints) | +| 1048601.mdx | [Introduction.mdx](/FreeSWITCH-Explained/Introduction/Introduction.mdx) | +| Call-Legs_7143972.mdx | [Call-Legs.mdx](/FreeSWITCH-Explained/Introduction/Call-Legs) | +| 15139379.mdx | [Event-Types.mdx](/FreeSWITCH-Explained/Event-Types) | +| FreeSWITCH-API_30867723.mdx | [FreeSWITCH-API.mdx](/FreeSWITCH-Explained/Introduction/FreeSWITCH-API) | +| Glossary_13173966.mdx | [Glossary.mdx](/FreeSWITCH-Explained/Introduction/Glossary) | +| Licensing_13173286.mdx | [Licensing.mdx](/FreeSWITCH-Explained/Introduction/Licensing) | +| Life-Cycle-of-a-Call_1048888.mdx | [Life-Cycle-of-a-Call.mdx](/FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call) | +| Verto-Communicator_9633841.mdx | [Verto-Communicator.mdx](/FreeSWITCH-Explained/Verto-Communicator) | +| Understanding-the-Configuration-Files_15696295.mdx | [Understanding-the-Configuration-Files.mdx](/FreeSWITCH-Explained/Meta-Pages/Filename-Standardization) | + +## Deleted files + +| File | Notes | +| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Debian+10+Buster.mdx | Empty file linking to the Debian Installation page. Not linked by any other pages. | +| Audio-Formats_15696302.mdx | Empty file | +| Index_1048632 | Broken label heatmap and space index resources from Confluence. List of labels has been added to [issue \#79.](https://github.com/signalwire/freeswitch-docs/issues/79) | +| Introduction-to-Dialplan_15696304.mdx | Empty file | +| Running-FreeSWITCH_15696307.mdx | Empty file | +| | | \ No newline at end of file diff --git a/docs/FreeSWITCH-Explained/Meta-Pages/FreeSWITCH-Legacy-Context-Review.mdx b/docs/FreeSWITCH-Explained/Meta-Pages/FreeSWITCH-Legacy-Context-Review.mdx index 36abc680..c3fa16a5 100644 --- a/docs/FreeSWITCH-Explained/Meta-Pages/FreeSWITCH-Legacy-Context-Review.mdx +++ b/docs/FreeSWITCH-Explained/Meta-Pages/FreeSWITCH-Legacy-Context-Review.mdx @@ -20,11 +20,13 @@ This document aims to streamline documentation content while preserving valuable | [mod_dptools: playback](../Modules/mod-dptools/6586776/#comments/#comments) | Question and answer about playing audio files using `loop_playback`. | Deleted | Added to 'See Also' section. | | [mod_dptools: bind_digit_action](../Modules/mod-dptools/6586414/#comments) | Bug report. | Left in place | Potentially Relevant | | [Connecting your Avaya and FreeSWITCH via SIP](../Auxiliary-Knowledge-and-Utilities/Connecting-your-Avaya-and-FreeSWITCH-via-SIP_13173356/#comments) | Update regarding depreciated support for SES Server. | Left in place | Potentially relevant. Document has very little content; out-of-date content may have already been cut. | -| [Call Legs](../Introduction/Call-Legs_7143972/#comments) | Correction/clarification to document content. | Left in place | Potentially relevant. Needs review for correctness. | +| [Call Legs](../Introduction/Call-Legs/#comments) | Correction/clarification to document content. | Left in place | Potentially relevant. Needs review for correctness. | | [Event List](../Introduction/Event-System/Event-List_7143557/#comments) | Perhaps a bug report? | Deleted | Comment is more than 7 years old. | -| [Fail2Ban](../Security/Fail2Ban_1049236/#comments) | Clarification/addition to document content. | Left in place | Potentially relevant | -| [Command Line Interface (fs_cli)](../Client-and-Developer-Interfaces/1048948/#comments) | Bug report with linked Jira issue and workaround. | Left in place | Old, but maybe still relevant. | +| [Fail2Ban](../Security/Fail2Ban_1049236/#comments) | Clarification/addition to document content. | Left in place | Potentially relevant | +| [Command Line Interface (fs_cli)](../Client-and-Developer-Interfaces/1048948/#comments) | Bug report with linked Jira issue and workaround. | Left in place | Old, but maybe still relevant. | | [SPA3102 HowTo](../Interoperability/Phones/Linksys/SPA3102-HowTo_1966971/#comments) | Bug report with linked Jira issue. | Deleted | Very old comment for an EOL product. | +| [Verto Communicator](../Verto-Communicator.mdx) | Question and answer. | Deleted | Doesn't seem relevant. | +| | | | | ## Needs Review @@ -69,7 +71,7 @@ Documents with comments that may still be relevant are below. Click on the drop- -### [Life Cycle of a Call](../Introduction/Life-Cycle-of-a-Call_1048888) +### [Life Cycle of a Call](../Introduction/Life-Cycle-of-a-Call)
3 comments @@ -89,7 +91,7 @@ Documents with comments that may still be relevant are below. Click on the drop-
-### [Call Legs](../Introduction/Call-Legs_7143972/) +### [Call Legs](../Introduction/Call-Legs/)
1 comment @@ -140,3 +142,18 @@ Documents with comments that may still be relevant are below. Click on the drop- > Posted by xbipin at May 19, 2015 02:37
+ +### [Verto Communicator](../Verto-Communicator.mdx) + +
+ 2 comments + +> I have my own TURN and STUN serversVerto communicator comes with configured TURN.How i can use my servers ? +> Posted by arsm at Apr 29, 2016 16:16 + +--- + +> You more than likely don't need them when talking to FreeSWITCH on the public internet. TURN will gain you very little unless you're doing peer to peer media and need to hairpin thru a TURN server. +> Posted by brian at Feb 06, 2017 09:10 + +
\ No newline at end of file diff --git a/docs/FreeSWITCH-Explained/Meta-Pages/XML-Meta-Page_16352177.mdx b/docs/FreeSWITCH-Explained/Meta-Pages/XML-Meta-Page_16352177.mdx index 680ba20d..e5101501 100644 --- a/docs/FreeSWITCH-Explained/Meta-Pages/XML-Meta-Page_16352177.mdx +++ b/docs/FreeSWITCH-Explained/Meta-Pages/XML-Meta-Page_16352177.mdx @@ -81,7 +81,7 @@ [Mumble Conference With ALSA](../Auxiliary-Knowledge-and-Utilities/Mumble-Conference-With-ALSA_13173534.mdx#about) -[Verto Communicator](../Verto-Communicator_9633841.mdx#about) +[Verto Communicator](../Verto-Communicator.mdx#about) [XML Modules Configuration](../Modules/XML-Modules-Configuration_13173211.mdx#xml-modules-configuration) @@ -342,7 +342,7 @@ This section needs to find a place. But the concept of a channel is important. I * [Shared Line Appearance](../Configuration/Shared-Line-Appearance_13174046.mdx#snom) \- more sofia XML configuration * [SBC FreeSWITCH Configuration Example 2](../Configuration/SBC-FreeSWITCH-Configuration-Example-2_13174171.mdx#about) \- an example that would be better in the prototypes section * [Outbound\_profile](../Configuration/Sofia-SIP-Stack/Outbound_profile_13174013.mdx#about) \- another discussion about outbound profiles with light information about XML config for ext-rtp-ip and ext-sip-ip -* [Verto Communicator](../Verto-Communicator_9633841.mdx#about) \- has XML config, but is specific to a module, wouldn't make sense in a dedicated XML section +* [Verto Communicator](../Verto-Communicator.mdx#about) \- has XML config, but is specific to a module, wouldn't make sense in a dedicated XML section * [Codecs and Media](../Codecs-and-Media/index.mdx#about) \- discussion about XML config for codecs * [Bypass Media Overview](../Codecs-and-Media/Bypass-Media-Overview/index.mdx#faq) \- goes into a light discussion about profile config for sofia and channel variable bypass\_media * [Call Forward Example](../Codecs-and-Media/Bypass-Media-Overview/Call-Forward-Example_6587445.mdx#about) XML example for call forwarding diff --git a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586414.mdx b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586414.mdx index 7a964c5d..30ff3bab 100644 --- a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586414.mdx +++ b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586414.mdx @@ -67,7 +67,7 @@ TODO Is this still valid? Section **3.4 Capture dialed** **digits** describes ex | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- | | <realm> | Somewhat similar to a dialplan context (see [XML Dialplan](../../Dialplan/XML-Dialplan/index.mdx#about)) or a state in a finite state machine.To clear or remove the digit bindings, use [mod\_dptools: clear\_digit\_action](./6586422.mdx#about).To switch between realms, use [mod\_dptools: digit\_action\_set\_realm](./6586771.mdx#0-about). | get\_passcode | | <binding> | A <binding> can either bea **sequence of digits to** **match** ora **[PCRE-compatible regular expression](https://www.pcre.org/)**that must start with a **\~** TODO Only assuming PCRE-compatibility because other module descriptions mention it, and [one of FreeSWITCH dependencies is the PCRE library.](https://freeswitch.org/confluence/display/FAH/FreeSWITCH+Dependencies) | 1234567\~7\\d{3} | -| <command\_string> | <command\_string> Descriptionexec:<dialplan\_app>To execute a [dialplan application](../mod_dptools_1970333.mdx#-c). This can have an optional flag 'H' which disables putting the other leg on hold during this operation. Can have an optional flag 'i' which makes the command blocking (it will execute in the thread of of the digit callback). Setting 'i' means 'H' has no effect.api:<api\_command>To issue a [FreeSWITCH API](../../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) command. | exec:execute\_extension,att\_xfer XML default,both,selfexec\[H\]:execute\_extension,start\_record XML defaultapi:hupall | +| <command\_string> | <command\_string> Descriptionexec:<dialplan\_app>To execute a [dialplan application](../mod_dptools_1970333.mdx#-c). This can have an optional flag 'H' which disables putting the other leg on hold during this operation. Can have an optional flag 'i' which makes the command blocking (it will execute in the thread of of the digit callback). Setting 'i' means 'H' has no effect.api:<api\_command>To issue a [FreeSWITCH API](../../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) command. | exec:execute\_extension,att\_xfer XML default,both,selfexec\[H\]:execute\_extension,start\_record XML defaultapi:hupall | | <value> | OPTIONAL Contains the arguments to the <command\_string> | | | <dtmf\_target\_leg> | OPTIONAL Possible values: self (the default) peer both Any other value is treated as self. | peer | | <event\_target\_leg> | OPTIONAL See <dtmf\_target\_leg> above | self | diff --git a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586646.mdx b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586646.mdx index ffde9121..a020c47a 100644 --- a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586646.mdx +++ b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586646.mdx @@ -60,9 +60,9 @@ See [Channel Variables Catalog](../../../Channel-Variables-Catalog/index.mdx#com ### 2.2 Low level method -The low level method defines its own `file_string://` [URI scheme](../../Introduction/Glossary_13173966.mdx#uri-scheme), and the examples below show how to use it exactly. +The low level method defines its own `file_string://` [URI scheme](../../Introduction/Glossary.mdx#uri-scheme), and the examples below show how to use it exactly. -When using the `file_string://` [URI scheme](../../Introduction/Glossary_13173966.mdx#uri-scheme), the delimiter is always the `!` character. +When using the `file_string://` [URI scheme](../../Introduction/Glossary.mdx#uri-scheme), the delimiter is always the `!` character. #### 2.2.1 With [mod_dptools: playback](./6586776.mdx#0-about) without the `playback_delimiter` channel variable diff --git a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586692.mdx b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586692.mdx index 1cbe1027..78ac121a 100644 --- a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586692.mdx +++ b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586692.mdx @@ -34,7 +34,7 @@ On speak-text and play-file `speak-text` and `play-file` phrase macro actions are very similar in functionality to [mod\_dptools: playback](./6586776.mdx#0-about) and [mod\_dptools: speak](./6587123.mdx#0-about) respectively, but * the former can only be used in phrase macros, and -* the latter are applications that can be used in [dialplan](../../Dialplan/index.mdx#0-about)s, [event socket applications](../../Introduction/Glossary_13173966.mdx#event-socket), etc. +* the latter are applications that can be used in [dialplan](../../Dialplan/index.mdx#0-about)s, [event socket applications](../../Introduction/Glossary.mdx#event-socket), etc. See [Speech Phrase Management](../../Configuration/Speech-Phrase-Management_9634492.mdx#0-about) for the full list of **phrase macro actions**. diff --git a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586776.mdx b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586776.mdx index 8678874a..bdde0c84 100644 --- a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586776.mdx +++ b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6586776.mdx @@ -4,7 +4,7 @@ ## 0\. About -Plays a sound file on the current [channel](../../Introduction/Call-Legs_7143972.mdx#0-about). +Plays a sound file on the current [channel](../../Introduction/Call-Legs.mdx#0-about). In order to be able to play MP3 files, [mod\_shout](../mod_shout_3965531.mdx#21-play) needs to be built and loaded. @@ -12,7 +12,7 @@ TODO Use [mod\_vlc](../mod_vlc_13173380.mdx#--) for anything else (i.e., M4A, AA Stop playback -To stop playback, use the `uuid_break` [API](../../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) command. See [mod\_commands](../mod_commands_1966741.mdx#--) for usage. +To stop playback, use the `uuid_break` [API](../../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) command. See [mod\_commands](../mod_commands_1966741.mdx#--) for usage. ## 1\. Usage @@ -35,7 +35,7 @@ To stop playback, use the `uuid_break` [API](../../Introduction/FreeSWITCH-API_3 ``` -The [playback\_terminators](../../../Channel-Variables-Catalog/playback_terminators_16353264.mdx#0-about) [channel variable](../../Dialplan/Channel-Variables_16352493.mdx#about) is set to `none` to disable stopping the playback on [DTMF](../../Introduction/Glossary_13173966.mdx#dtmf) input. (The default terminator is `*`.) +The [playback\_terminators](../../../Channel-Variables-Catalog/playback_terminators_16353264.mdx#0-about) [channel variable](../../Dialplan/Channel-Variables_16352493.mdx#about) is set to `none` to disable stopping the playback on [DTMF](../../Introduction/Glossary.mdx#dtmf) input. (The default terminator is `*`.) The terminator used is available in [playback\_terminator\_used](../../../Channel-Variables-Catalog/playback_terminator_used_16353270.mdx#playback_terminator_used). See [Channel Variables Catalog](../../../Channel-Variables-Catalog/index.mdx#comments) for more. @@ -57,7 +57,7 @@ Assuming this file was sampled at 8000 samples/second, the `@@8000` suffix will ``` -The prefix `{var1=val1,var2=val2}` defines variables that will be sent in [PLAYBACK\_START](../../Introduction/Event-System/Event-List_7143557.mdx#playback_start) and [PLAYBACK\_STOP](../../Introduction/Event-System/Event-List_7143557.mdx#playback_stop) events, thus this is especially handy when building [event socket](../../Introduction/Glossary_13173966.mdx#event-socket) applications. In the events, the variables will be named the same way as the variable names you configured (in this case, `var1` and `var2`). +The prefix `{var1=val1,var2=val2}` defines variables that will be sent in [PLAYBACK\_START](../../Introduction/Event-System/Event-List_7143557.mdx#playback_start) and [PLAYBACK\_STOP](../../Introduction/Event-System/Event-List_7143557.mdx#playback_stop) events, thus this is especially handy when building [event socket](../../Introduction/Glossary.mdx#event-socket) applications. In the events, the variables will be named the same way as the variable names you configured (in this case, `var1` and `var2`). Please note that in FreeSWITCH versions older than the commit below, variables could be set in the suffix after the filename, instead of in the prefix. So if you experience problems on older versions, you must upgrade your application to reflect these changes. diff --git a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6587017.mdx b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6587017.mdx index 2cffcd4c..55959392 100644 --- a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6587017.mdx +++ b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6587017.mdx @@ -31,7 +31,7 @@ If you use hangup after a bridge, FreeSWITCH™ overrides the cause with the cau These tips have been shared by [Bao Nguyen](https://freeswitch.org/confluence/display/~nttranbao) -### 2.1 [A leg](../../Introduction/Call-Legs_7143972.mdx#0-about) wouldn't disconnect after calling `hangup` +### 2.1 [A leg](../../Introduction/Call-Legs.mdx#0-about) wouldn't disconnect after calling `hangup` Did you see the `BYE` sent by FreeSWITCH™ towards the caller, and its 200 OK response? If yes, then it's the problem with your ITSP or the caller cell provider. diff --git a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6587061.mdx b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6587061.mdx index 73321a6e..d935534b 100644 --- a/docs/FreeSWITCH-Explained/Modules/mod-dptools/6587061.mdx +++ b/docs/FreeSWITCH-Explained/Modules/mod-dptools/6587061.mdx @@ -94,7 +94,7 @@ If your A-leg call has already been answered (e.g., with an IVR), and you want t   ``` -### 2.3 Using the [FreeSWITCH API](../../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) outside the dialplan +### 2.3 Using the [FreeSWITCH API](../../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) outside the dialplan Once a call is already up you can do it from the sched\_hangup API command from [XML-RPC](../../Configuration/FreeSWITCH-XML-RPC_13173038.mdx#--) or the [CLI](../../Client-and-Developer-Interfaces/1048948.mdx#or). diff --git a/docs/FreeSWITCH-Explained/Modules/mod_commands_1966741.mdx b/docs/FreeSWITCH-Explained/Modules/mod_commands_1966741.mdx index 908f308d..e20044c0 100644 --- a/docs/FreeSWITCH-Explained/Modules/mod_commands_1966741.mdx +++ b/docs/FreeSWITCH-Explained/Modules/mod_commands_1966741.mdx @@ -165,13 +165,13 @@ Table of Contents (click to expand) ### 0\. About -[mod\_commands](./mod_commands_1966741.mdx#--) processes the [FreeSWITCH API commands](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-). +[mod\_commands](./mod_commands_1966741.mdx#--) processes the [FreeSWITCH API commands](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-). **FreeSWITCH API** The public FreeSWITCH API consists of all the commands that can be issued to FreeSWITCH via * its console, [fs\_cli](https://freeswitch.org/confluence/pages/viewpage.action?pageId=1048948), -* the [event socket interface](../Introduction/Glossary_13173966.mdx#event-socket), and +* the [event socket interface](../Introduction/Glossary.mdx#event-socket), and * scripting interfaces. The set of available commands is dependent on which modules are loaded. The authoritative set of commands for your installation is the union of the sets of commands registered by each module. @@ -199,7 +199,7 @@ See below. #### 1.4 From the [Dialplan](../Dialplan/index.mdx#0-about) -An [API command](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) can be called from the dialplan. Example: +An [API command](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) can be called from the dialplan. Example: **Invoke API Command From Dialplan** @@ -223,7 +223,7 @@ Other examples: ``` -[API commands](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) with multiple arguments usually have the arguments separated by a space: +[API commands](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) with multiple arguments usually have the arguments separated by a space: **Multiple Arguments** @@ -233,7 +233,7 @@ Other examples: Dialplan Usage -If you are calling an [API command](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) from the dialplan make absolutely certain that there isn't already a dialplan application that gives you the functionality you are looking for. See [mod\_dptools](https://wiki.freeswitch.org/wiki/Mod%5Fdptools "Mod dptools") for a list of dialplan applications, they are quite extensive. +If you are calling an [API command](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) from the dialplan make absolutely certain that there isn't already a dialplan application that gives you the functionality you are looking for. See [mod\_dptools](https://wiki.freeswitch.org/wiki/Mod%5Fdptools "Mod dptools") for a list of dialplan applications, they are quite extensive. ### 2\. Format of returned data @@ -368,7 +368,7 @@ freeswitch> alias del reloadall #### 3.3 `bgapi` -Execute an [API command](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) in a thread. +Execute an [API command](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) in a thread. ##### 3.3.1 Syntax @@ -385,7 +385,7 @@ bgapi [ ] | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | acl | Match an IP address against an [access control list (ACL)](../Networking/3965687.mdx#-acl-). | acl <ip\_address> <acl\_name> | acl 1.2.3.4 test | | alias | Provide an alternative name (i.e., an alias) to commonly used commands on the [CLI](../Client-and-Developer-Interfaces/1048948.mdx#or) to save on some keystrokes.SubcommandDescriptionaddCreate an alias.stickyaddCreate an alias that persists across restarts.delDelete alias. | alias add <alias> <command(s)>alias stickyadd <alias> <command(s)>alias del \[<alias>\|\*\] | freeswitch> alias add reloadall reloadacl reloadxml+OKfreeswitch> alias add unreg sofia profile internal flush\_inbound\_reg+OKfreeswitch> alias stickyadd reloadall reloadacl reloadxml+OKfreeswitch> alias del reloadall+OK | -| bgapi | Execute an [API command](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) in a thread. | bgapi <command>\[ <command\_args>\] | | +| bgapi | Execute an [API command](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) in a thread. | bgapi <command>\[ <command\_args>\] | | | complete | Complete.TODO That description is not very helpful. | complete add <word>\|del \[<word>|\*\] | | | | | | | | | | | | | | @@ -476,7 +476,7 @@ CS_EXECUTE ### expand -Execute an [API command](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) with variable expansion. +Execute an [API command](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) with variable expansion. Usage: expand [uuid:<uuid> ]<cmd> <args> @@ -533,7 +533,7 @@ USAGE: fsctl Usage: fsctl api_expansion [on|off] -Toggles API expansion. With it off, no [API functions](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) can be expanded inside channel variables like ${show channels} This is a specific security mode that is not often used. +Toggles API expansion. With it off, no [API functions](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) can be expanded inside channel variables like ${show channels} This is a specific security mode that is not often used. #### calibrate_clock @@ -845,7 +845,7 @@ The B leg receives a new variable, `dialed_group`, containing the full group nam ### help -Show help for all the [API commands](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-). +Show help for all the [API commands](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-). Usage: help @@ -1113,7 +1113,7 @@ show foo as delim | * aliases – list defined command aliases -* api – list [API commands](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) exposed by loadable modules +* api – list [API commands](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) exposed by loadable modules * application – list applications exposed by loadable modules, notably mod\_dptools * bridged\_calls – deprecated, use "show calls" * calls \[count\] – list details of currently active calls; the keyword "count" eliminates the details and only prints the total count of calls @@ -1245,7 +1245,7 @@ xml_locate configuration configuration name ivr.conf ### xml_wrap -Wrap another [API command](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) in XML. +Wrap another [API command](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) in XML. Usage: xml_wrap <command> <args> @@ -1877,7 +1877,7 @@ This command directs FreeSWITCH to remove itself from the SIP signaling path if Usage: uuid_simplify <uuid> -Execute this [API command](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) to instruct FreeSWITCH™ to inspect the Leg A and Leg B network addresses. If they are both hosted by the same switch as a result of a transfer or forwarding loop across a number of FreeSWITCH™ systems the one executing this command will remove itself from the SIP and media path and restore the endpoints to their local FreeSWITCH™ to shorten the network path. This is particularly useful in large distributed FreeSWITCH™ installations. +Execute this [API command](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) to instruct FreeSWITCH™ to inspect the Leg A and Leg B network addresses. If they are both hosted by the same switch as a result of a transfer or forwarding loop across a number of FreeSWITCH™ systems the one executing this command will remove itself from the SIP and media path and restore the endpoints to their local FreeSWITCH™ to shorten the network path. This is particularly useful in large distributed FreeSWITCH™ installations. For example, suppose a call arrives at a FreeSWITCH™ box in Los Angeles, is answered, then forwarded to a FreeSWITCH™ box in London, answered there and then forwarded back to Los Angeles. The London switch could execute uuid\_simplify to tell its local switch to examine both legs of the call to determine that they could be hosted by the Los Angeles switch since both legs are local to it. Alternatively, setting sip\_auto\_simplify to true either globally in vars.xml or as part of a dailplan extension would tell FS to perform this check for each call when both legs supervise. @@ -2067,7 +2067,7 @@ userid|context|domain|group|contact|callgroup|effective_caller_id_name|effective ### sched_api -Schedule an [API call](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) in the future. +Schedule an [API call](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) in the future. **Usage** @@ -2272,7 +2272,7 @@ See also {foo, freeswitch@example} ! {bgapi, status, ""}, receive Z -> Z after 1000 -> timeout end. @@ -532,11 +532,11 @@ There are two ways to get the results: microseconds\n0 session(s) since startup\n0 session(s) 0/30\n"} ``` Note that the command's final result is tagged with `bgok` /`bgerror`. -2. In addition to a directed reply, a normal `BACKGROUND_JOB` event (see [Event List](../Introduction/Event-System/Event-List_7143557.mdx#nat)) is also fired whenever a [FreeSWITCH API](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) command is executed in the background, which you could alternately choose to receive. (See `events` in the "API" section below on how to subscribe to FreeSWITCH system events). +2. In addition to a directed reply, a normal `BACKGROUND_JOB` event (see [Event List](../Introduction/Event-System/Event-List_7143557.mdx#nat)) is also fired whenever a [FreeSWITCH API](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) command is executed in the background, which you could alternately choose to receive. (See `events` in the "API" section below on how to subscribe to FreeSWITCH system events). api vs bgapi -A [FreeSWITCH API](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) commands called with `bgapi` +A [FreeSWITCH API](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) commands called with `bgapi` * will be **executed in its own thread**, * is **non-blocking**, and @@ -1071,7 +1071,7 @@ The api is very similar to the one in [mod\_event\_socket](./mod_event_socket_10 #### api -Send a [FreeSWITCH API](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) command, a **blocking** call. +Send a [FreeSWITCH API](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) command, a **blocking** call. Usage: diff --git a/docs/FreeSWITCH-Explained/Modules/mod_event_socket_1048924.mdx b/docs/FreeSWITCH-Explained/Modules/mod_event_socket_1048924.mdx index 70fc2e20..19e44ad0 100644 --- a/docs/FreeSWITCH-Explained/Modules/mod_event_socket_1048924.mdx +++ b/docs/FreeSWITCH-Explained/Modules/mod_event_socket_1048924.mdx @@ -186,7 +186,7 @@ The following section aims at documenting all commands that can be sent. This se ### 3.1 api -Send a [FreeSWITCH API](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) command, **blocking mode**. That is, the FreeSWITCH instance won't accept any new commands until the `api` command finished execution. +Send a [FreeSWITCH API](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) command, **blocking mode**. That is, the FreeSWITCH instance won't accept any new commands until the `api` command finished execution. **Usage** @@ -204,7 +204,7 @@ api msleep 5000 ### 3.2 bgapi -Send a [FreeSWITCH API](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) command, **non-blocking mode**. This will let you execute a job in the background, and the result will be sent as an event with an indicated UUID to match the reply to the command. +Send a [FreeSWITCH API](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) command, **non-blocking mode**. This will let you execute a job in the background, and the result will be sent as an event with an indicated UUID to match the reply to the command. **Usage** @@ -817,7 +817,7 @@ sendmsg ``` -`sendmsg` is used to control the behavior of FreeSWITCH. `UUID` is mandatory, and it refers to a specific call (i.e., a channel or call leg or session; see [Call Legs](../Introduction/Call-Legs_7143972.mdx#0-about) and [Creating a New Endpoint: Lifecycle of a Session](../Community/Contributing-Code/Creating-New-Modules/9634354.mdx#0-about)). +`sendmsg` is used to control the behavior of FreeSWITCH. `UUID` is mandatory, and it refers to a specific call (i.e., a channel or call leg or session; see [Call Legs](../Introduction/Call-Legs.mdx#0-about) and [Creating a New Endpoint: Lifecycle of a Session](../Community/Contributing-Code/Creating-New-Modules/9634354.mdx#0-about)). TODO What does this line mean? "_originate a call directly to park by making an ext the ext part of the originate command &park()_" diff --git a/docs/FreeSWITCH-Explained/Verto-Communicator_9633841.mdx b/docs/FreeSWITCH-Explained/Verto-Communicator.mdx similarity index 83% rename from docs/FreeSWITCH-Explained/Verto-Communicator_9633841.mdx rename to docs/FreeSWITCH-Explained/Verto-Communicator.mdx index 6503c55d..ca9386b9 100644 --- a/docs/FreeSWITCH-Explained/Verto-Communicator_9633841.mdx +++ b/docs/FreeSWITCH-Explained/Verto-Communicator.mdx @@ -165,10 +165,4 @@ Add your language in the registerAvailableLanguageKeys function. All done. * [mod\_verto](./Modules/mod_verto_3964934.mdx#about) -### Comments: - -| I have my own TURN and STUN serversVerto communicator comes with configured TURN.How i can use my servers ? ![](/images/icons/contenttypes/comment_16.png) Posted by arsm at Apr 29, 2016 16:16 | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| You more than likely don't need them when talking to FreeSWITCH on the public internet. TURN will gain you very little unless you're doing peer to peer media and need to hairpin thru a TURN server. ![](/images/icons/contenttypes/comment_16.png) Posted by brian at Feb 06, 2017 09:10 | - diff --git a/provisioning/nginx/redirects.map b/provisioning/nginx/redirects.map index 52bcf2a8..7b3bab09 100644 --- a/provisioning/nginx/redirects.map +++ b/provisioning/nginx/redirects.map @@ -1327,8 +1327,8 @@ /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Software+Interfaces /freeswitch/FreeSWITCH-Explained/Interoperability/Software-Interfaces/; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Interoperability /freeswitch/FreeSWITCH-Explained/Interoperability/; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Audio+Formats /freeswitch/FreeSWITCH-Explained/Introduction/Audio-Formats_15696302; -/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Call+Legs /freeswitch/FreeSWITCH-Explained/Introduction/Call-Legs_7143972; -/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Endpoints /freeswitch/FreeSWITCH-Explained/Introduction/Endpoints_15696294; +/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Call+Legs /freeswitch/FreeSWITCH-Explained/Introduction/Call-Legs; +/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Endpoints /freeswitch/FreeSWITCH-Explained/Introduction/Endpoints; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Debugging+Event+Socket+Message /freeswitch/FreeSWITCH-Explained/Introduction/Event-System/Debugging-Event-Socket-Message_9634071; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/ESL+Example+Clients /freeswitch/FreeSWITCH-Explained/Introduction/Event-System/ESL-Example-Clients_27591923; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Event+Handlers /freeswitch/FreeSWITCH-Explained/Introduction/Event-System/Event-Handlers_32178263; @@ -1338,13 +1338,13 @@ /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/List+of+CUSTOM+Events /freeswitch/FreeSWITCH-Explained/Introduction/Event-System/List-of-CUSTOM-Events_15139388; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Making+Event+Socket+behave+like+the+console /freeswitch/FreeSWITCH-Explained/Introduction/Event-System/Making-Event-Socket-behave-like-the-console_10682474; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Event+System /freeswitch/FreeSWITCH-Explained/Introduction/Event-System/; -/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/FreeSWITCH+API /freeswitch/FreeSWITCH-Explained/Introduction/FreeSWITCH-API_30867723; +/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/FreeSWITCH+API /freeswitch/FreeSWITCH-Explained/Introduction/FreeSWITCH-API; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Glossary /freeswitch/FreeSWITCH-Explained/Introduction/Glossary_13173966; -/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Introduction+to+Dialplan /freeswitch/FreeSWITCH-Explained/Introduction/Introduction-to-Dialplan_15696304; -/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Licensing /freeswitch/FreeSWITCH-Explained/Introduction/Licensing_13173286; -/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Life+Cycle+of+a+Call /freeswitch/FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call_1048888; +/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Introduction+to+Dialplan /freeswitch/FreeSWITCH-Explained/Introduction/Introduction-to-Dialplan; +/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Licensing /freeswitch/FreeSWITCH-Explained/Introduction/Licensing; +/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Life+Cycle+of+a+Call /freeswitch/FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Running+FreeSWITCH /freeswitch/FreeSWITCH-Explained/Introduction/Running-FreeSWITCH_15696307; -/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Understanding+the+Configuration+Files /freeswitch/FreeSWITCH-Explained/Introduction/Understanding-the-Configuration-Files_15696295; +/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Understanding+the+Configuration+Files /freeswitch/FreeSWITCH-Explained/Introduction/Understanding-the-Configuration-Files; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Global+Variables /freeswitch/FreeSWITCH-Explained/Introduction/Variables/Global-Variables_13173994; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Variables /freeswitch/FreeSWITCH-Explained/Introduction/Variables/; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Introduction /freeswitch/FreeSWITCH-Explained/Introduction/; @@ -1709,7 +1709,7 @@ /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Test+Numbers /freeswitch/FreeSWITCH-Explained/Troubleshooting-Debugging/Test-Numbers_9634301; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Troubleshooting+Freeswitch /freeswitch/FreeSWITCH-Explained/Troubleshooting-Debugging/Troubleshooting-Freeswitch_9633933; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Troubleshooting+Debugging /freeswitch/FreeSWITCH-Explained/Troubleshooting-Debugging/; -/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Verto+Communicator /freeswitch/FreeSWITCH-Explained/Verto-Communicator_9633841; +/freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Verto+Communicator /freeswitch/FreeSWITCH-Explained/Verto-Communicator; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Billing+Solutions /freeswitch/FreeSWITCH-Explained/[DEAD/Billing-Solutions_13173290; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/Core+Outline /freeswitch/FreeSWITCH-Explained/[DEAD/Core-Outline_1048880; /freeswitch/confluence-to-docs-redirector/display/FREESWITCH/27591425 /freeswitch/FreeSWITCH-Explained/[DEAD/FAQ/27591425;