Call recording doc update (2600hz#5038)

* add description to schema and docs * document call recording matrix * update descritions * update docs * fix key
tungtv05 · Aug 6, 2018 · 3fb5b7c · 3fb5b7c
1 parent 520e61d
commit 3fb5b7c
Show file tree

Hide file tree

Showing 19 changed files with 145 additions and 78 deletions.
diff --git a/.aspell.en.pws b/.aspell.en.pws
@@ -1,4 +1,4 @@
-personal_ws-1.1 en 1111 utf-8
+personal_ws-1.1 en 1113 utf-8
 PrivateKeyInfo
 cfg
 ccv
@@ -611,6 +611,7 @@ httpclose
 param
 phonebook
 qubicle
+multicast
 Prepends
 BEARERCAPABILITY
 eaddrinuse
@@ -854,6 +855,7 @@ chmod
 Whitelabling
 smtpd
 demonitor
+Makefiles
 pymdown
 dbtext
 WORKDIR

diff --git a/applications/crossbar/doc/accounts.md b/applications/crossbar/doc/accounts.md
@@ -68,9 +68,9 @@ endpoint recording settings
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
-`inbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
-`outbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
+`any` | settings for any calls to/from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
+`inbound` | settings for inbound calls to the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
+`outbound` | settings for outbound calls from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
 
 ### call_recording.parameters
 
@@ -91,9 +91,9 @@ Key | Description | Type | Default | Required | Support Level
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
-`offnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
-`onnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
+`any` | settings for calls from any network | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
+`offnet` | settings for calls from offnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
+`onnet` | settings for calls from onnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
 
 ### call_waiting
 

diff --git a/applications/crossbar/doc/devices.md b/applications/crossbar/doc/devices.md
@@ -37,7 +37,7 @@ Key | Description | Type | Default | Required | Support Level
 `enabled` | Determines if the device is currently enabled | `boolean()` | `true` | `false` | `supported`
 `exclude_from_queues` | Do not ring this device when calling user/agent in queue | `boolean()` | `false` | `false` |
 `formatters` |   | [#/definitions/formatters](#formatters) |   | `false` |
-`hotdesk` | The hotdesk status of this device | `object()` |   | `false` |  
+`hotdesk` | The hotdesk status of this device | `object()` |   | `false` |
 `language` | The language for the device | `string()` |   | `false` | `supported`
 `mac_address` | The MAC Address of the device (if applicable) | `string()` |   | `false` | `supported`
 `media` | Configure audio/video/etc media options for this device | [#/definitions/endpoint.media](#endpointmedia) |   | `false` |
@@ -91,9 +91,9 @@ endpoint recording settings
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
-`inbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
-`outbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
+`any` | settings for any calls to/from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
+`inbound` | settings for inbound calls to the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
+`outbound` | settings for outbound calls from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
 
 ### call_recording.parameters
 
@@ -114,9 +114,9 @@ Key | Description | Type | Default | Required | Support Level
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
-`offnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
-`onnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
+`any` | settings for calls from any network | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
+`offnet` | settings for calls from offnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
+`onnet` | settings for calls from onnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
 
 ### call_waiting
 

diff --git a/applications/crossbar/doc/ref/accounts.md b/applications/crossbar/doc/ref/accounts.md
@@ -60,9 +60,9 @@ endpoint recording settings
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
-`inbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
-`outbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
+`any` | settings for any calls to/from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
+`inbound` | settings for inbound calls to the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
+`outbound` | settings for outbound calls from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
 
 ### call_recording.parameters
 
@@ -83,9 +83,9 @@ Key | Description | Type | Default | Required | Support Level
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
-`offnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
-`onnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
+`any` | settings for calls from any network | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
+`offnet` | settings for calls from offnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
+`onnet` | settings for calls from onnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
 
 ### call_waiting
 

diff --git a/applications/crossbar/doc/ref/devices.md b/applications/crossbar/doc/ref/devices.md
@@ -88,9 +88,9 @@ endpoint recording settings
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
-`inbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
-`outbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
+`any` | settings for any calls to/from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
+`inbound` | settings for inbound calls to the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
+`outbound` | settings for outbound calls from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
 
 ### call_recording.parameters
 
@@ -111,9 +111,9 @@ Key | Description | Type | Default | Required | Support Level
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
-`offnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
-`onnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
+`any` | settings for calls from any network | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
+`offnet` | settings for calls from offnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
+`onnet` | settings for calls from onnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
 
 ### call_waiting
 

diff --git a/applications/crossbar/doc/ref/users.md b/applications/crossbar/doc/ref/users.md
@@ -73,9 +73,9 @@ endpoint recording settings
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
-`inbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
-`outbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
+`any` | settings for any calls to/from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
+`inbound` | settings for inbound calls to the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
+`outbound` | settings for outbound calls from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |  
 
 ### call_recording.parameters
 
@@ -96,9 +96,9 @@ Key | Description | Type | Default | Required | Support Level
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
-`offnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
-`onnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
+`any` | settings for calls from any network | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
+`offnet` | settings for calls from offnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
+`onnet` | settings for calls from onnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |  
 
 ### call_waiting
 

diff --git a/applications/crossbar/doc/users.md b/applications/crossbar/doc/users.md
@@ -75,9 +75,9 @@ endpoint recording settings
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
-`inbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
-`outbound` |   | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
+`any` | settings for any calls to/from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
+`inbound` | settings for inbound calls to the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
+`outbound` | settings for outbound calls from the endpoint | [#/definitions/call_recording.source](#call_recordingsource) |   | `false` |
 
 ### call_recording.parameters
 
@@ -98,9 +98,9 @@ Key | Description | Type | Default | Required | Support Level
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
-`any` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
-`offnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
-`onnet` |   | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
+`any` | settings for calls from any network | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
+`offnet` | settings for calls from offnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
+`onnet` | settings for calls from onnet networks | [#/definitions/call_recording.parameters](#call_recordingparameters) |   | `false` |
 
 ### call_waiting
 

diff --git a/applications/crossbar/priv/api/swagger.json b/applications/crossbar/priv/api/swagger.json
@@ -1008,13 +1008,16 @@
             "description": "endpoint recording settings",
             "properties": {
                 "any": {
-                    "$ref": "#/definitions/call_recording.source"
+                    "$ref": "#/definitions/call_recording.source",
+                    "description": "settings for any calls to/from the endpoint"
                 },
                 "inbound": {
-                    "$ref": "#/definitions/call_recording.source"
+                    "$ref": "#/definitions/call_recording.source",
+                    "description": "settings for inbound calls to the endpoint"
                 },
                 "outbound": {
-                    "$ref": "#/definitions/call_recording.source"
+                    "$ref": "#/definitions/call_recording.source",
+                    "description": "settings for outbound calls from the endpoint"
                 }
             },
             "type": "object"
@@ -1066,13 +1069,16 @@
         "call_recording.source": {
             "properties": {
                 "any": {
-                    "$ref": "#/definitions/call_recording.parameters"
+                    "$ref": "#/definitions/call_recording.parameters",
+                    "description": "settings for calls from any network"
                 },
                 "offnet": {
-                    "$ref": "#/definitions/call_recording.parameters"
+                    "$ref": "#/definitions/call_recording.parameters",
+                    "description": "settings for calls from offnet networks"
                 },
                 "onnet": {
-                    "$ref": "#/definitions/call_recording.parameters"
+                    "$ref": "#/definitions/call_recording.parameters",
+                    "description": "settings for calls from onnet networks"
                 }
             },
             "type": "object"

diff --git a/applications/crossbar/priv/couchdb/schemas/call_recording.json b/applications/crossbar/priv/couchdb/schemas/call_recording.json
@@ -5,13 +5,16 @@
     "description": "endpoint recording settings",
     "properties": {
         "any": {
-            "$ref": "call_recording.source"
+            "$ref": "call_recording.source",
+            "description": "settings for any calls to/from the endpoint"
         },
         "inbound": {
-            "$ref": "call_recording.source"
+            "$ref": "call_recording.source",
+            "description": "settings for inbound calls to the endpoint"
         },
         "outbound": {
-            "$ref": "call_recording.source"
+            "$ref": "call_recording.source",
+            "description": "settings for outbound calls from the endpoint"
         }
     },
     "type": "object"

diff --git a/applications/crossbar/priv/couchdb/schemas/call_recording.source.json b/applications/crossbar/priv/couchdb/schemas/call_recording.source.json
@@ -4,13 +4,16 @@
     "additionalProperties": false,
     "properties": {
         "any": {
-            "$ref": "call_recording.parameters"
+            "$ref": "call_recording.parameters",
+            "description": "settings for calls from any network"
         },
         "offnet": {
-            "$ref": "call_recording.parameters"
+            "$ref": "call_recording.parameters",
+            "description": "settings for calls from offnet networks"
         },
         "onnet": {
-            "$ref": "call_recording.parameters"
+            "$ref": "call_recording.parameters",
+            "description": "settings for calls from onnet networks"
         }
     },
     "type": "object"

diff --git a/core/kazoo_endpoint/src/kz_endpoint.erl b/core/kazoo_endpoint/src/kz_endpoint.erl
@@ -395,7 +395,6 @@ merge_call_recording(K, JObj, Acc, List) ->
     Fun = fun(K1, V1) -> merge_call_recording(K1, V1, Any) end,
     kz_json:set_value(K, lists:foldl(Fun, kz_json:delete_key(<<"any">>, JObj), List), Acc).
 
-
 -spec get_account_record_call_properties(kz_term:api_object()) -> kz_json:object().
 get_account_record_call_properties(JObj) ->
     kz_json:foldl(fun(K, V, Acc) ->

diff --git a/...o_translator/src/convertors/kzt_kazoo.erl → ...o_translator/src/converters/kzt_kazoo.erl b/...o_translator/src/convertors/kzt_kazoo.erl → ...o_translator/src/converters/kzt_kazoo.erl
diff --git a/...o_translator/src/convertors/kzt_twiml.erl → ...o_translator/src/converters/kzt_twiml.erl b/...o_translator/src/convertors/kzt_twiml.erl → ...o_translator/src/converters/kzt_twiml.erl
diff --git a/...nslator/src/convertors/kzt_twiml_dial.erl → ...nslator/src/converters/kzt_twiml_dial.erl b/...nslator/src/convertors/kzt_twiml_dial.erl → ...nslator/src/converters/kzt_twiml_dial.erl
diff --git a/...anslator/src/convertors/kzt_twiml_say.erl → ...anslator/src/converters/kzt_twiml_say.erl b/...anslator/src/convertors/kzt_twiml_say.erl → ...anslator/src/converters/kzt_twiml_say.erl
diff --git a/...nslator/src/convertors/kzt_twiml_util.erl → ...nslator/src/converters/kzt_twiml_util.erl b/...nslator/src/convertors/kzt_twiml_util.erl → ...nslator/src/converters/kzt_twiml_util.erl
diff --git a/doc/internationalization/examples/number_manager/european_union.md b/doc/internationalization/examples/number_manager/european_union.md
@@ -10,7 +10,7 @@ Configuring the `system_config/number_manager` document for European Union-based
 }
 ```
 
-#### E164 Convertors
+#### E164 Converters
 
 ```json
 {

diff --git a/doc/internationalization/numbers.md b/doc/internationalization/numbers.md
@@ -143,7 +143,7 @@ If you want a literal '#', 'S', or '*', prefix it with a '\' (so '\#', '\S', and
 
 Users can dial local numbers, just as they do with the PSTN, by providing Kazoo with `dial_plan` regular expressions. These regexes will be used on the dialed numbers to correct them to properly routable numbers.
 
-It is possible to set these regexes on an account, user, or device basis. All that needs doing is adding a `dial_plan` key at the root level of the account, user, or device document. Kazoo will then apply the regexes in order, preferring the calling device's, then user's (if the calling device has an `owner_id` set), and finally the account's dialplan. Failing any of those, the system `e164_convertors` will be employed.
+It is possible to set these regexes on an account, user, or device basis. All that needs doing is adding a `dial_plan` key at the root level of the account, user, or device document. Kazoo will then apply the regexes in order, preferring the calling device's, then user's (if the calling device has an `owner_id` set), and finally the account's dialplan. Failing any of those, the system `e164_converters` will be employed.
 
 !!! warning
     It is possible that these `dial_plan` rules will interfere with extension dialing within an account. Please take common extension length into consideration when creating these `dial_plan` rules.
-Original file line number
+Diff line change
@@ Expand Up @@
     }
     ```
-    #### E164 Convertors
+    #### E164 Converters
     ```json
     {
@@ Expand Down @@