Carrier Documentation

Authentication

You must sign into the dashboard to use Somleng. The first time you sign in you will be required to setup two factor authentication (2FA). We recommend you use Authy , Google Authenticator or your password manager to setup 2FA.

Carrier Settings

Here you will find general settings for the carrier.

From the settings page you'll see your company's name, country, logo and Carrier API Key.

You can update the name of your company, country and company logo. The logo and name of your company is used to provide custom branding for your dashboard.

You can also configure webhooks by specifying a webhook URL. Once a Webhook URL has been configured you'll see Webhook signing secret on the settings page. You'll need the signing secret when verifying webhooks .

To update your carrier settings:

1. Sign in to the Dashboard and from the side-navigation, click Carrier Settings.
2. Click the icon to edit your settings.
3. Fill out the form, specifying your company name, country and logo. You can optionally configure webhooks by specifying a webhook URL.
4. Choose Update Carrier Settings.

Accounts

Accounts are used by carriers, carrier customers and BYOC users to send/receive calls and SMS via Somleng's implementation of Twilio's REST API.

Typically a carrier would create an account for each of their customers. BYOC users might create an account for each project or just create one account for their usage.

There are two types of accounts. Carrier managed and customer managed.

To create an account via the Dashboard:

1. Sign in to the Dashboard and from the side-navigation, click Accounts.
2. Click the icon to create a new account.
3. Fill out the form, specifying a name for the account and optionally the owner's name and email address to create a customer account.
4. Choose Create Account.

Inbound SIP Trunks

Inbound SIP Trunks are used to configure inbound dialing to Somleng (aka Direct Inbound Dialing). When you create an Inbound SIP Trunk you specify the source IP address from which SIP invite is sent from. Somleng uses this information to determine the carrier, account and how to handle the call.

Once you have setup your inbound SIP trunk, you can then send SIP to any of the following endpoints. We recommend that you use sip.somleng.org for high-availability.

To create an inbound SIP trunk via the Dashboard:

1. Sign in to the Dashboard and from the side-navigation, click Inbound SIP Trunks.
2. Click the icon to create a new inbound SIP trunk.
3. Fill out the form, specifying a friendly name for the inbound SIP trunk and the source IP address.
4. Choose Create Inbound SIP Trunk.

Outbound SIP Trunks

Outbound SIP Trunks are used to configure outbound dialing from Somleng. When you create an Outbound SIP Trunk you specify the destination host to send outbound calls. You can specify your host as either a fully qualified domain name (FQDN) or IP address. The outbound SIP trunk configuration determines the dial string that will be used to send calls to your SIP server.

SIP and RTP from Somleng sent through a NAT Gateway from the IP address below. You should allow this IP address on your firewall. You may also need to setup Symmetric Latching on your device.

To create an outbound SIP trunk via the Dashboard:

1. Sign in to the Dashboard and from the side-navigation, click Outbound SIP Trunks.
2. Click the icon to create a new outbound SIP trunk.
3. Fill out the form, specifying a friendly name for the outbound SIP trunk and the host. You can also optionally configure a numeric dial string prefix, add a plus prefix or configure a trunk prefix.
4. Choose Create Outbound SIP Trunk.

Phone Numbers

Phone Numbers represent direct inbound dialing (DID) numbers. A phone number can be either an E.164 formatted phone number or a short code. When you create a phone number you can optionally assign it to an account.

Once provisioned and assigned to an account, phone numbers can be configured with a Voice URL which returns TwiML for controlling the call. This can either be done by the carrier or by the account owner (for customer managed accounts).

To create a phone number via the Dashboard:

1. Sign in to the Dashboard and from the side-navigation, click Phone Numbers.
2. Click the icon to create a new phone number.
3. Fill out the form, specifying the phone number or short code, and optionally assign it to an account.
4. Choose Create Phone number.

Once the phone number has been created you can configure it. To configure a phone number via the Dashboard:

1. From the Phone Numbers page, find the phone number you want to configure.
2. From the gear icon select Configure.
3. Fill out the form specifying a Voice URL and optionally a Status Callback URL. The Voice URL should return valid TwiML and will be executed when an inbound call is received by Somleng.
4. Choose Update Configuration.

Import Phone Numbers

In order to bulk import phone numbers, you can upload a CSV file from the Dashboard.

1. From the Phone Numbers page, click the upload button .
2. Select the CSV file of phone numbers to import.
3. Choose Upload.

Sample CSV Data

									Number,Enabled
									1234,false
									85512345678,true
								

Users

Carrier owners can invite their colleagues to the dashboard.

To invite a user to the Dashboard:

1. Sign in to the Dashboard and from the side-navigation, click Users.
2. Click the icon to invite a new user.
3. Fill out the form, specifying the user's name, email and role.
4. Choose Send an invitation.

The user will receive an email inviting them to the dashboard. Users with the owner role can manage other users, update their role and reset their 2FA.