Gateways

Owned by Olesya Tantsyura
Last updated: Mar 19, 2024
5 min read

1. Description

The page is intended for creating a Gateway. Displays information about Gateways in the domain.

Gateways are used to connect to the outside world. This is either SIP registration - registration to an external trunk, or SIP trunks - without registration.

It consists of the following elements:

  1. Creation tool (Fig.1(1));

  2. Search field (Fig.1(2));

  3. Refresh button (Fig.1(3));

  4. Registry (Fig.1(4));

  5. Pagination (Fig.1(5)).

Fig. 1. cpage

1.1. Creation tool

Use the Add button to create a new Gateway (Fig.1(1)). The New gateway modal window (Fig.2) opens after clicking the button. The following types of Gateway are available:

  • SIP Registration - registers to an external trunk;

  • SIP Trunking - without registration.

Fig. 2. New gateway modal window

1.1.1. SIP Registration

Select SIP Registration in the New gateway modal window and click the Create button to create a new SIP registration. The General tab opens after clicking the button.

1.1.2. SIP Trunking

Authorization of gateways without login and password consists of two steps.

The first step is to check the allowed IP addresses (from which IP and port the invite packet comes to us). If the provider can send from different IPs, then all IPs must be added to the Configuration tab. If it comes from an IP not entered in the Configuration tab, such a request will be sent with a 403 Forbidden error.

The second step is the match of the Host-Proxy pair (From-To). Only when passing through both steps, the call gets to the Inbound flow scheme, for example, the IVR flow scheme.

Select SIP Trunking in the New gateway modal window and click the Create button to create a new SIP trunking. The General tab opens after clicking the button.

When creating a SIP Trunking, the following tabs are available to fill in:

1.2. Search field

The search is performed on the Name column.

1.3. Refresh button

(Fig.1 (3)).

1.4. Registry

The registry is a list of entries of existing objects in this section, each of which consists of a set of fields:

  1. Checkbox;

  2. Name;

  3. Proxy;

  4. State;

  5. Status;

  6. Editing tool;

  7. Removal tool.

If there is no entry on the page, then an additional Add button is displayed in the register, the functionality of which duplicates the Add button in paragraph 1.1.

1.4.1. Checkbox

Fig. 3. Confirm deletion modal window

1.4.2. Name

The name of the Gateway is displayed here.

1.4.3. Proxy

The proxy is displayed here.

1.4.4. State

A switch that is responsible for enabling and disabling the Gateway by the position:

 - the Gateway is enabled;

 - the Gateway is disabled.

1.4.5. Status

There are the following statuses:

  • Success; 

  • Not registered;

  • Failed.

 

Gateways without registration always have the status Success.

1.4.6. Editing tool

1.4.7. Removal tool

Fig. 3. Confirm deletion modal window

1.5. Pagination

2. Opportunities

2.1. Create a new SIP Registration

Goal

Create a new SIP Registration

Goal

Create a new SIP Registration

Preconditions

  1. Access to the Admin application;

  2. Access to the Gateways section in the Admin application;

  3. Permission to create in the Gateways section.

Steps

 

  1. Click the Add button. The New gateway modal window opens.

  2. Select a SIP Registration.

  3. Click the Create button. The General tab opens.

  4. Enter data. The Save button becomes active.

  5. Click the Save button.

Result

Data saved. The SIP Registration is created.

2.2. Create a new SIP Trunking

Goal

Create a new SIP Trunking

Goal

Create a new SIP Trunking

Preconditions

  1. Access to the Admin application;

  2. Access to the Gateways section in the Admin application;

  3. Permission to create in the Gateways section.

Steps

 

  1. Click the Add button. The New gateway modal window opens.

  2. Select SIP Trunking.

  3. Click the Create button. The General tab opens.

  4. Enter data. The Save button becomes active.

  5. Fill in the required data in other tabs.

  6. Click the Save button.

Result

Data saved. The SIP Trunking is created.

2.3. Delete a Gateway

Goal

Delete a Gateway

Goal

Delete a Gateway

Preconditions

  1. Access to the Admin application;

  2. Access to the Gateways section in the Admin application;

  3. Permission to select and delete in the Gateways section;

  4. The presence of at least one Gateway.

Steps

 

  1. Find the Gateway you want to delete in the registry;

  2. Click on the delete button -

    . A modal window opens to confirm the deletion;

  3. Click the Delete button.

Result

The modal window closes. Gateway is deleted.

2.4. Delete several Gateways

Goal

Delete several Gateways

Goal

Delete several Gateways

Preconditions

  1. Access to the Admin application;

  2. Access to the Gateways section in the Admin application;

  3. Permission to select and delete in the Gateways section;

  4. The presence of at least one Gateway.

Steps

 

  1. Find the Gateways you want to delete in the registry. Select them using the checkbox;

  2. Click on the delete button at the top of the registry. A modal window opens to confirm the deletion.

  3. Click the Delete button.

Result

The modal window closes. Gateways are deleted.

2.5. Edit a Gateway

Goal

Edit a Gateway

Goal

Edit a Gateway

Preconditions

  1. Access to the Admin application;

  2. Access to the Gateways section in the Admin application;

  3. Permission to edit in the Gateways section;

  4. The presence of at least one Gateway.

Steps

 

  1. Find the Gateway you want to edit in the registry.

  2. Click on the edit button in the entry of this Gateway. The General tab opens.

  3. Open the tab you need.

  4. Make changes.

  5. Click the Save button.

Result

Data saved.

2.6. Enable/disable Gateway

Goal

Enable/disable Gateway

Goal

Enable/disable Gateway

Preconditions

  1. Access to the Admin application;

  2. Access to the Gateways section in the Admin application;

  3. Permission to edit in the Gateways section;

  4. The presence of at least one Gateway.

Steps

 

  1. Find the Gateway you want to enable/disable in the registry entries.

  2. Move the switch in the State column to the active/inactive position.

Result

The Gateway is enabled/disabled.