[Master] - PROD-210: Add INVITE format to strip + (2600hz#6512)

* PROD-210: Add new convert to strip +

- Add to_strip_plus and is_strip_plus to knm_converters abstraction

- Add to_strip_plus stub to th knm_regex_converter

* add strip_plus to schema objects with INVITE Format and their docs.

* - Add strip_plus converter case to trunkstore

- Add strip_plus converter case to ecallmgr

- Add strip_plus converter case to kapps_call_command

- Add strip_plus converter to kz_directory_endpoints

- Add strip_plus converter to kz_endpoints

- Remove extraneous comment from regex_converter

* - Adds migration script to change invite_format on devices, resources, and trunks

* Add converter migration docs

* update swagger spec

* update OAS3 spec

* fix formatting/whitespace issue

* remove debug artifact to appease The Great Dialyzer!

* add missing doc for migration command

* make fmt

* - add doc to doc index

- remove unused defines

Co-authored-by: John White <john2600hz.com>

applications/crossbar/doc/connectivity.md

@@ -56,7 +56,7 @@ Key | Description | Type | Default | Required | Support Level
 `servers.[].options.hunt_account_id` | When using local resources, use this account instead of the account making the call (useful for resellers) | `string()` |   | `false` |  
 `servers.[].options.hunt_non_reconcilable` | Whether to allow routing to continue on a non-reconcilable TO number | `boolean()` | `false` | `false` |  
 `servers.[].options.ignore_early_media` |   | `boolean()` |   | `false` |  
-`servers.[].options.inbound_format` | Determines how the INVITE is sent to the server | `string('e164' | 'npan' | '1npan' | 'username')` | `npan` | `false` |  
+`servers.[].options.inbound_format` | Determines how the INVITE is sent to the server | `string('e164' | 'npan' | '1npan' | 'username' | 'strip_plus')` | `npan` | `false` |  
 `servers.[].options.ip` | IP (sip) address for this device | `string()` |   | `false` |  
 `servers.[].options.media_handling` | Determine whether the switch should be in the media path or not | `string('process' | 'bypass')` | `bypass` | `false` |  
 `servers.[].options.port` | Port to send SIP traffic for the remote device | `integer()` |   | `false` |  

applications/crossbar/doc/devices.md

@@ -74,7 +74,7 @@ Key | Description | Type | Default | Required | Support Level
 `sip.expire_seconds` | The time, in seconds, sent to the provisioner for the registration period that the device should be configured with. | `integer()` | `300` | `false` | `supported`
 `sip.forward` | Forward IP to use | `string()` |   | `false` |  
 `sip.ignore_completed_elsewhere` | When set to false the phone should not consider ring group calls answered elsewhere as missed | `boolean()` |   | `false` |  
-`sip.invite_format` | The SIP request URI invite format | `string('username' | 'npan' | '1npan' | 'e164' | 'route' | 'contact')` | `contact` | `false` | `supported`
+`sip.invite_format` | The SIP request URI invite format | `string('username' | 'npan' | '1npan' | 'e164' | 'route' | 'strip_plus' | 'contact')` | `contact` | `false` | `supported`
 `sip.ip` | IP address for this device | `string()` |   | `false` | `supported`
 `sip.method` | Method of authentication | `string('password' | 'ip')` | `password` | `false` | `supported`
 `sip.number` | The number used if the invite format is 1npan, npan, or e164 (if not set the dialed number is used) | `string()` |   | `false` |  

applications/crossbar/doc/ref/connectivity.md

@@ -56,7 +56,7 @@ Key | Description | Type | Default | Required | Support Level
 `servers.[].options.hunt_account_id` | When using local resources, use this account instead of the account making the call (useful for resellers) | `string()` |   | `false` |  
 `servers.[].options.hunt_non_reconcilable` | Whether to allow routing to continue on a non-reconcilable TO number | `boolean()` | `false` | `false` |  
 `servers.[].options.ignore_early_media` |   | `boolean()` |   | `false` |  
-`servers.[].options.inbound_format` | Determines how the INVITE is sent to the server | `string('e164' | 'npan' | '1npan' | 'username')` | `npan` | `false` |  
+`servers.[].options.inbound_format` | Determines how the INVITE is sent to the server | `string('e164' | 'npan' | '1npan' | 'username' | 'strip_plus')` | `npan` | `false` |  
 `servers.[].options.ip` | IP (sip) address for this device | `string()` |   | `false` |  
 `servers.[].options.media_handling` | Determine whether the switch should be in the media path or not | `string('process' | 'bypass')` | `bypass` | `false` |  
 `servers.[].options.port` | Port to send SIP traffic for the remote device | `integer()` |   | `false` |  

applications/crossbar/doc/ref/devices.md

@@ -71,7 +71,7 @@ Key | Description | Type | Default | Required | Support Level
 `sip.expire_seconds` | The time, in seconds, sent to the provisioner for the registration period that the device should be configured with. | `integer()` | `300` | `false` | `supported`
 `sip.forward` | Forward IP to use | `string()` |   | `false` |  
 `sip.ignore_completed_elsewhere` | When set to false the phone should not consider ring group calls answered elsewhere as missed | `boolean()` |   | `false` |  
-`sip.invite_format` | The SIP request URI invite format | `string('username' | 'npan' | '1npan' | 'e164' | 'route' | 'contact')` | `contact` | `false` | `supported`
+`sip.invite_format` | The SIP request URI invite format | `string('username' | 'npan' | '1npan' | 'e164' | 'route' | 'strip_plus' | 'contact')` | `contact` | `false` | `supported`
 `sip.ip` | IP address for this device | `string()` |   | `false` | `supported`
 `sip.method` | Method of authentication | `string('password' | 'ip')` | `password` | `false` | `supported`
 `sip.number` | The number used if the invite format is 1npan, npan, or e164 (if not set the dialed number is used) | `string()` |   | `false` |  

applications/crossbar/doc/ref/resources.md

@@ -48,7 +48,7 @@ Key | Description | Type | Default | Required | Support Level
 `gateways.[].force_port` | Allow request only from this port | `boolean()` | `false` | `false` |  
 `gateways.[].format_from_uri` | When set to true requests to this resource gateway will have a reformatted SIP From Header | `boolean()` |   | `false` |  
 `gateways.[].from_uri_realm` | When formatting SIP From on outbound requests this can be used to override the realm | `string()` |   | `false` |  
-`gateways.[].invite_format` | The format of the DID needed by the underlying hardware/gateway | `string('route' | 'username' | 'e164' | 'npan' | '1npan')` | `route` | `false` |  
+`gateways.[].invite_format` | The format of the DID needed by the underlying hardware/gateway | `string('route' | 'username' | 'e164' | 'npan' | '1npan' | 'strip_plus')` | `route` | `false` |  
 `gateways.[].invite_parameters.dynamic.[]` |   | `string()|string()|string('zone')|object()` |   |   |  
 `gateways.[].invite_parameters.dynamic` | A list of properties that, if found on the inbound call, should be added as an INVITE parameter | `array()` |   | `false` |  
 `gateways.[].invite_parameters.static.[]` |   | `string()` |   | `false` |  

applications/crossbar/doc/resources.md

@@ -64,7 +64,7 @@ Key | Description | Type | Default | Required | Support Level
 `gateways.[].force_port` | Allow request only from this port | `boolean()` | `false` | `false` |  
 `gateways.[].format_from_uri` | When set to true requests to this resource gateway will have a reformatted SIP From Header | `boolean()` |   | `false` |  
 `gateways.[].from_uri_realm` | When formatting SIP From on outbound requests this can be used to override the realm | `string()` |   | `false` |  
-`gateways.[].invite_format` | The format of the DID needed by the underlying hardware/gateway | `string('route' | 'username' | 'e164' | 'npan' | '1npan')` | `route` | `false` |  
+`gateways.[].invite_format` | The format of the DID needed by the underlying hardware/gateway | `string('route' | 'username' | 'e164' | 'npan' | '1npan' | 'strip_plus')` | `route` | `false` |  
 `gateways.[].invite_parameters.dynamic.[]` |   | `string()|string()|string('zone')|object()` |   |   |  
 `gateways.[].invite_parameters.dynamic` | A list of properties that, if found on the inbound call, should be added as an INVITE parameter | `array()` |   | `false` |  
 `gateways.[].invite_parameters.static.[]` |   | `string()` |   | `false` |  

applications/crossbar/priv/api/descriptions.system_config.json

@@ -512,7 +512,7 @@
     "number_manager.bandwidth2.site_id": "number_manager.bandwidth2 site id",
     "number_manager.carrier_modules": "carrier modules to perform number search & ordering from",
     "number_manager.classifiers": "regular expressions & billing names for numbers",
-    "number_manager.converters": "suffix for the KNM module to use for E164, NPAN and 1NPAN normalization of numbers",
+    "number_manager.converters": "suffix for the KNM module to use for E164, NPAN, 1NPAN and strip_plus normalization of numbers",
     "number_manager.dash_e911.auth_password": "number_manager.dash_e911 auth password",
     "number_manager.dash_e911.auth_username": "number_manager.dash_e911 auth username",
     "number_manager.dash_e911.debug": "number_manager.dash_e911 debug",

applications/crossbar/priv/api/swagger.json

@@ -5408,7 +5408,8 @@
                                             "e164",
                                             "npan",
                                             "1npan",
-                                            "username"
+                                            "username",
+                                            "strip_plus"
                                         ],
                                         "type": "string"
                                     },
@@ -5858,6 +5859,7 @@
                                 "1npan",
                                 "e164",
                                 "route",
+                                "strip_plus",
                                 "contact"
                             ],
                             "type": "string"
@@ -13948,6 +13950,7 @@
                         "npan",
                         "1npan",
                         "route",
+                        "strip_plus",
                         "loopback",
                         "contact"
                     ],
@@ -26461,6 +26464,7 @@
                         "npan",
                         "1npan",
                         "route",
+                        "strip_plus",
                         "loopback",
                         "contact"
                     ],
@@ -31499,7 +31503,8 @@
                                     "username",
                                     "e164",
                                     "npan",
-                                    "1npan"
+                                    "1npan",
+                                    "strip_plus"
                                 ],
                                 "type": "string"
                             },
@@ -37147,7 +37152,7 @@
                     "default": [
                         "regex"
                     ],
-                    "description": "suffix for the KNM module to use for E164, NPAN and 1NPAN normalization of numbers",
+                    "description": "suffix for the KNM module to use for E164, NPAN, 1NPAN and strip_plus normalization of numbers",
                     "items": {
                         "type": "string"
                     },
@@ -39587,6 +39592,7 @@
                                             "e164",
                                             "npan",
                                             "1npan",
+                                            "strip_plus",
                                             "username"
                                         ],
                                         "type": "string"

applications/crossbar/priv/couchdb/schemas/connectivity.json

@@ -232,7 +232,8 @@
                                     "e164",
                                     "npan",
                                     "1npan",
-                                    "username"
+                                    "username",
+                                    "strip_plus"
                                 ],
                                 "type": "string"
                             },

applications/crossbar/priv/couchdb/schemas/devices.json

@@ -373,6 +373,7 @@
                         "1npan",
                         "e164",
                         "route",
+                        "strip_plus",
                         "contact"
                     ],
                     "support_level": "supported",

applications/crossbar/priv/couchdb/schemas/kapi.dialplan.bridge_endpoint.json

@@ -43,6 +43,7 @@
                 "npan",
                 "1npan",
                 "route",
+                "strip_plus",
                 "loopback",
                 "contact"
             ],

applications/crossbar/priv/couchdb/schemas/kapi.route.resp_route.json

@@ -48,6 +48,7 @@
                 "npan",
                 "1npan",
                 "route",
+                "strip_plus",
                 "loopback",
                 "contact"
             ],

applications/crossbar/priv/couchdb/schemas/resources.json

@@ -232,7 +232,8 @@
                             "username",
                             "e164",
                             "npan",
-                            "1npan"
+                            "1npan",
+                            "strip_plus"
                         ],
                         "type": "string"
                     },

applications/crossbar/priv/couchdb/schemas/system_config.number_manager.json

@@ -66,7 +66,7 @@
             "default": [
                 "regex"
             ],
-            "description": "suffix for the KNM module to use for E164, NPAN and 1NPAN normalization of numbers",
+            "description": "suffix for the KNM module to use for E164, NPAN, 1NPAN and strip_plus normalization of numbers",
             "items": {
                 "type": "string"
             },

applications/crossbar/priv/couchdb/schemas/trunkstore.json

@@ -245,6 +245,7 @@
                                     "e164",
                                     "npan",
                                     "1npan",
+                                    "strip_plus",
                                     "username"
                                 ],
                                 "type": "string"

applications/crossbar/priv/oas3/oas3-schemas.yml

@@ -4285,6 +4285,7 @@
                   - npan
                   - 1npan
                   - username
+                  - strip_plus
                 'type': string
               'ip':
                 'description': IP (sip) address for this device
@@ -4651,6 +4652,7 @@
             - 1npan
             - e164
             - route
+            - strip_plus
             - contact
           'type': string
           'x-support_level': supported
@@ -8104,6 +8106,7 @@
               - e164
               - npan
               - 1npan
+              - strip_plus
             'type': string
           'invite_parameters':
             'additionalProperties': false
@@ -12468,7 +12471,7 @@
       'default':
         - regex
       'description': |-
-        suffix for the KNM module to use for E164, NPAN and 1NPAN normalization of numbers
+        suffix for the KNM module to use for E164, NPAN, 1NPAN and strip_plus normalization of numbers
       'items':
         'type': string
       'type': array
@@ -14452,6 +14455,7 @@
                   - e164
                   - npan
                   - 1npan
+                  - strip_plus
                   - username
                 'type': string
               'media_handling':

applications/ecallmgr/src/ecallmgr_util.erl

@@ -955,6 +955,12 @@ build_freetdm_channel(#bridge_endpoint{invite_format = <<"1npan">>
                                       ,channel_selection=ChannelSelection
                                       }) ->
     {'ok', <<"freetdm/", Span/binary, "/", ChannelSelection/binary, "/", (knm_converters:to_1npan(Number))/binary>>};
+build_freetdm_channel(#bridge_endpoint{invite_format = <<"strip_plus">>
+                                      ,number=Number
+                                      ,span=Span
+                                      ,channel_selection=ChannelSelection
+                                      }) ->
+    {'ok', <<"freetdm/", Span/binary, "/", ChannelSelection/binary, "/", (knm_converters:to_strip_plus(Number))/binary>>};
 build_freetdm_channel(#bridge_endpoint{number=Number
                                       ,span=Span
                                       ,channel_selection=ChannelSelection
@@ -1142,6 +1148,8 @@ maybe_format_user(Contact, #bridge_endpoint{invite_format = <<"npan">>, number=N
     re:replace(Contact, "^[^\@]+", knm_converters:to_npan(Number), [{'return', 'binary'}]);
 maybe_format_user(Contact, #bridge_endpoint{invite_format = <<"1npan">>, number=Number}) ->
     re:replace(Contact, "^[^\@]+", knm_converters:to_1npan(Number), [{'return', 'binary'}]);
+maybe_format_user(Contact, #bridge_endpoint{invite_format = <<"strip_plus">>, number=Number}) ->
+    re:replace(Contact, "^[^\@]+", knm_converters:to_strip_plus(Number), [{'return', 'binary'}]);
 maybe_format_user(Contact, _) -> Contact.
 
 -spec maybe_set_interface(kz_term:ne_binary(), bridge_endpoint()) -> kz_term:ne_binary().

applications/trunkstore/src/ts_util.erl

@@ -259,18 +259,11 @@ invite_format(<<"e164">>, To) ->
     [{<<"Invite-Format">>, <<"e164">>}
     ,{<<"To-DID">>, knm_converters:normalize(To)}
     ];
-invite_format(<<"e164_without_plus">>, To) ->
-    case knm_converters:normalize(To) of
-        <<$+, PluslessDID/binary>> ->
-            lager:info("while processing 'e164_without_plus' flag, DID ~s converted to E.164 with truncated '+': ~s",[To, PluslessDID]),
-            [{<<"Invite-Format">>, <<"e164">>}
-            ,{<<"To-DID">>, PluslessDID}
-            ];
-        AsIsDID ->
-            [{<<"Invite-Format">>, <<"e164">>}
-            ,{<<"To-DID">>, AsIsDID}
-            ]
-    end;
+invite_format(<<"e164_without_plus">>=Format, To) ->
+    lager:debug("~p: changing legacy format ~p to strip_plus", [?MODULE, Format]),
+    [{<<"Invite-Format">>, <<"strip_plus">>}
+    ,{<<"To-DID">>, knm_converters:to_strip_plus(To)}
+    ];
 invite_format(<<"1npanxxxxxx">>, To) ->
     [{<<"Invite-Format">>, <<"1npan">>}
     ,{<<"To-DID">>, knm_converters:to_1npan(To)}
@@ -287,6 +280,10 @@ invite_format(<<"npan">>, To) ->
     [{<<"Invite-Format">>, <<"npan">>}
     ,{<<"To-DID">>, knm_converters:to_npan(To)}
     ];
+invite_format(<<"strip_plus">>, To) ->
+    [{<<"Invite-Format">>, <<"strip_plus">>}
+    ,{<<"To-DID">>, knm_converters:to_strip_plus(To)}
+    ];
 invite_format(_, _) ->
     [{<<"Invite-Format">>, <<"username">>}].
 

core/kazoo_amqp/src/api/kapi_dialplan.hrl

@@ -16,6 +16,7 @@
                               ,<<"route">>, <<"loopback">>
                               ,<<"contact">>
                               ,<<"endpoint">>, <<"forward">>
+                              ,<<"strip_plus">>
                               ]
                              }).