Skip to main content
About the Resource Center

External trunk settings

There are three types of external trunks: BYOC Carrier and BYOC PBX (for BYOC Cloud), and Premises External SIP (for BYOC Premises). When you configure an external trunk, you configure the basic settings described in the  Create a trunk under BYOC Cloud and Create a trunk under BYOC Premises articles. Depending on your needs, you may also configure some of the more advanced settings. This reference describes all the settings that you find on the Create/Edit External Trunk page.

Note: While most of these settings apply to all types of external trunks, some settings apply only to certain types of trunks. Those settings that are trunk type specific are noted in the description.
SettingDescription
External Trunk NameUse this box to assign the external trunk a descriptive name. This name identifies this trunk when you need to select an external trunk on the various telephony configuration pages in Genesys Cloud.

Type

 

Use this list to select the type of external trunk that you want to create. There are three choices:

  • BYOC Carrier
  • BYOC PBX
  • Premises External SIP

For more information on creating trunks, see Create a trunk under BYOC Cloud and Create a trunk under BYOC Premises.

Type

 

BYOC Carrier and BYOC PBX only

When you select one of the BYOC trunks, you see a second Type list.

  • If you select the BYOC Carrier trunk, you need to select the type of carrier you want to use. You can select either Generic BYOC Carrier or Verizon BYOC Carrier 
  • If you select the BYOC PBX trunk, you need to select the type of PBX you want to use. you can select Generic BYOC PBX.

Managed By

 

Use this switch to specify who is authorized to manage the External Trunk configuration going forward. The default setting is Everyone, which includes telephony admins and the provider. However, you can select the Provider Only option to limit control to just the provider.

Trunk State

 

Use this switch to change the operational state of the external trunk.

The default setting is In-Service.

Protocol

 

Use this list to choose the trunk transport protocol variant.

There are three choices for the trunk transport protocol:

  • UDP
  • TCP 
  • TLS 

In most cases, you select UDP as the Protocol.

Listen Port

 

Premises External SIP only

Use this box to specify the trunk transport listen port.

Common values for this setting in Genesys Cloud are 5061 for TLS and 5060 for UDP and TCP.

Inbound 

SettingDescription

Number Plan Site

Use this setting to identify the site with the number plan that you want to use.

To improve inbound call handling, Genesys Cloud allows you to identify the site with the number plan that you want to use. The site that you select controls which number plan is used, both for transforms on inbound calls and for subsequent outbound transfers for calls that never flow through another site.

Inbound SIP Termination Identifier

 

BYOC Carrier and BYOC PBX

Use this box to specify your termination identifier. Genesys Cloud requires that a unique identifier exists in the INVITE to associate inbound calls with the appropriate Genesys Cloud organization’s resources.

By default you can use the FQDN or the TGRP method for formatting your SIP INVITES.

To make it easy to understand how to format inbound INVITES, the user interface provides dynamic help. When you begin typing an identifier in the Inbound SIP Termination Identifier box, the Inbound Request-URI Reference panel appears. This panel provides you with invite formatting examples that include your termination identifier and the address of your Genesys Cloud organization’s region.

  • If you select Generic BYOC Carrier, the Inbound SIP Termination Identifier is a static configuration that should be populated with a regionally unique identifier. This identifier will be used to direct traffic from external Carriers to the organization.
  • If you select Verizon BYOC Carrier, the Inbound SIP Termination Identifier is a static configuration that should be populated with a regionally unique identifier. This identifier will be used to direct traffic from Verizon to the organization.
  • If you select Generic BYOC PBX, the Inbound SIP Termination Identifier is a static configuration that should be populated with a regionally unique identifier. This identifier will be used to direct traffic from third-party PBXs to the organization.

Inbound SIP Termination Header

BYOC Carrier and BYOC PBX

Use this box to specify the name of the SIP header the carrier will populate with the inbound SIP termination identifier value on inbound calls. You only use this setting when none of the standard identification methods are supported by your carrier. 

  • If you select Generic BYOC Carrier, the Inbound SIP Termination Header is a custom field that contains the Termination Identifier value for inbound calls to Genesys Cloud.
  • If you select Verizon BYOC Carrier, the Inbound SIP Termination Header is by default set to X-VZ-CSP-Customer-Identifier.
  • If you select Generic BYOC PBX, the Inbound SIP Termination Header is a custom field that contains the Termination Identifier value for inbound calls to Genesys Cloud.

DNIS Replacement Routing

BYOC Carrier and BYOC PBX

If your carrier’s requirements prevent you from using either the FQDN or the TGRP method for formatting your SIP INVITES, you can enable DNIS Replacement Routing. You can then format your SIP INVITES using the DNIS method. The same dynamic help is available.

For more information, see Configure SIP routing for a BYOC Cloud trunk.

Outbound

SettingDescription

Outbound SIP Termination FQDN

 

Use this box to specify the FQDN portion of the outbound INVITE Request-URI.*

Outbound SIP TGRP Attribute

 

Use this box to specify the TGRP parameter of the outbound INVITE Request-URI.*

TGRP Context-ID 

 

If you specify an Outbound SIP TGRP Attribute, you must use this box to specify the trunk context parameter of the Request-URI.*

Outbound SIP DNIS

 

Use this box to specify the DNIS value for the outbound call attempt.*

* To make it easy to understand how to format outbound INVITES, the user interface provides dynamic help. When you begin typing an identifier in one of the outbound SIP boxes, the Outbound Request-URI Reference panel appears. This panel provides you with invite formatting examples that include your termination identifier.

For more information, see Configure SIP routing for a BYOC Cloud trunk.

SIP Servers or Proxies

 

Use the controls in this section to create a list of SIP servers or intermediate proxies to which all outgoing requests should be sent regardless of the destination address in the request. You can also add a port number.

If do not specify a port number, the inbound listen port is used by default.

Note: IP addresses added to the Outbound SIP Servers or Proxies section are placed automatically on the SIP Access Control Allow list.

BYOC Carrier and BYOC PBX

When you add multiple SIP servers or intermediate proxies, Genesys Cloud randomly selects a server from the list for each outbound call.


Premises External SIP 

When adding multiple SIP servers or intermediate proxies, use the arrows to put the highest priority server at the top of the list. For outbound calls, Genesys Cloud attempts to use the server at the top of the list first but will cycle thru the list until it finds an available server.

Digest Authentication

 

Use this switch to enable or disable Digest Authentication. When enabled, digest authentication provides extra layer of security to the process of granting outbound requests.

When you enable digest authentication, you specify a set of credentials (the associated realm, a user name, and a password) that will be used when outbound requests are challenged by digest authentication.

The default setting is Disabled.

Realm

 

Use this box to specify the domain name of the SIP realm that authenticates outbound requests.

User Name

 

Use this box to specify the user name to use to authenticate the call.

Password

 

Use this box to specify the password to use to authenticate the call.

By default the password is masked, but you can select the Show Password check box to see the password in plain-text.

Calling

SettingDescription
Caller AddressUse this box to specify the telephone number that you want to appear in the caller ID information for outbound calls. Enter this number in E.164 format, which includes the plus sign (+) and the country code.
Caller NameUse this box to specify the name that you want to appear in the caller ID information for outbound calls. 
Prioritized Caller SelectionUse this list to add and prioritize the locations from which Genesys Cloud can pull caller ID information For more information, see Use the Prioritized Caller Selection feature to configure caller ID information.
Suppress User NameUse this list specify how you want to handle Caller ID and Caller name when the call source is User DID. For more information, see Use the Prioritized Caller Selection feature to configure caller ID information.

Availability

SettingDescription
AvailabilityPremises External SIP only

Use this switch to enable or disable the ability to send availability requests.

The default setting is Disabled.

Interval

 

Premises External SIP only

Use this box to enter the time interval in seconds before the availability request should be sent.

Registration

SettingDescription
RegistrationPremises External SIP only

Use this switch to enable or disable registration.

The default setting is Disabled.

Expiration Interval

 

Premises External SIP only

Use this box to specify the number of seconds to wait before the registration expires.

Address of Record

 

Premises External SIP only

Use one of these options to specify the URI or the user portion of the registration. (The user portion is combined with the Edge Interface IP.)

By default Genesys Cloud automatically generates the address of record from the Edge network interface. However, you can enter a custom address.

SIP Access Control

SettingDescription

Use Source Address

 

Premises External SIP only

Use this switch to determine whether ACL matching uses the SIP messaging source address (Yes) or the VIA header originating address (No).

The default setting is Yes.

Allow the Following Addresses

 

Use the controls in this section to enter and build a list of IP or CIDR addresses to which you want to allow SIP access.

Always Deny the Following Addresses

 

Premises External SIP only

Use the controls n this section to enter and build a list of IP or CIDR addresses to which you want to deny SIP access.

Allow All

 

Premises External SIP only

Select this check box if you want to allow access to any IP or CIDR address.

Note: Allowing all addresses is a security risk.

PBX Passthrough

 

Use this switch to enable or disable PBX Passthrough. Enabling the PBX passthrough feature allows your PBX to pass calls intended for the PSTN directly through Genesys Cloud.

For more information, see Configure PBX passthrough for a BYOC trunk.