Create a DID and assign it to an account or IVR application

Incoming calls reach the switch from a DID provider or a customer’s gateway. This tutorial adds one number, makes sure only the provider can deliver calls to it, and connects it to the account that should ring or to an IVR application such as a calling card. Allow about 20 minutes.

The example uses the DID 12125550100 delivered by Example DID Provider from the gateway 198.51.100.20, assigned to the account 1001.

Before you start

• You have Administrator access and the DID pool is enabled for your customer.
• You know the number as the provider sends it in the INVITE, including any technical prefix, and the IP address the calls come from.
• The account that should receive the calls exists and its device registers, or the IVR application exists. See Quickstart: retail.

Step 1: Add the DID provider as a vendor

The provider’s gateway must be known to the switch so that the DID can be pinned to it.

1. Open Vendors → Vendors and click Add Vendor. Enter Vendor Name: Example DID Provider, its Base Currency, and click Save & Close.
2. Click Connections in the row, then Add Connection. Enter Connection Name: Example DID Provider inbound and Destination: 198.51.100.20. Click Save & Close.

Result: the vendor has a connection with the provider’s IP. The connection does not need termination routes: it only identifies the source of incoming calls.

Step 2: Create the DID

1. Open DIDs & IVR Apps → DID Pool and click Add.
2. Keep Type at Number and enter DID: 12125550100. This is the canonical number used in CDRs and billing; choose the format your accounts should dial to reach the number.
3. Leave the field. Incoming DID/CLD in the Authentication Rules table is filled with the same number. Change it to the exact number the provider sends when it differs, for example +12125550100 or 0012125550100.
4. In the rule select Vendor Example DID Provider and Connection Example DID Provider inbound.
5. Add a CLI Translation Rule such as s/^0/+1/ if the provider sends caller numbers in a local format and your accounts should see E.164.
6. Click Save.

Screenshot "admin-panel/did-pool" has not been generated yet — see scripts/screenshots/screens.yml.

Caution

A rule with Vendor and Connection set to Any accepts calls to the number from any IP on the internet and the list marks the DID with a warning icon. Always select the provider’s connection. When the provider sends the number in two formats, add two rules with the same vendor.

Result: the DID is listed with Assigned to empty and no warning icon.

Step 3: Assign the number

1. Open the DID and click Assigned to.
2. Select Acct. 1001 to ring the account’s registered device, or IVR and the application that should answer, for example a Calling Card or Play Prompt application.
3. Select a Selling Charging Group if the account pays a monthly fee or a per-minute price for incoming calls. See DID pool for charging groups.
4. Click Save & Close.

Result: the list shows Assigned to Acct. 1001 or IVR .

Step 4: Check the account’s incoming routing

Calls to a DID assigned to an account are delivered through the account’s routing group.

1. Open Vendors → Routing Groups and open the group of the account.
2. On On-Net Routing set Use Connection to [ Default ] so that the call is delivered to the registered device through the built-in registrar. With [ Disabled ] the switch routes the incoming call like an outgoing one, through the vendor entries of the group.
3. Click Save & Close.
4. Open the account, then Actions → Services → Incoming Routing, and check that the DID is not redirected elsewhere; Follow Me and voicemail settings on the account apply after the device does not answer.

Result: incoming calls to the DID ring the registered device; unanswered calls follow the account’s voicemail timeout.

Step 5: Test it

1. Call 12125550100 from an outside phone.
2. Open Reports → DIDs Call Records. The call is listed with the DID, Charge is Applied to Acct. 1001 and the charge of the selling group.
3. Open Reports → Call Records (CDRs) for the account to see the incoming leg with its duration.

If the call is rejected with 404, the number the provider sends does not match Incoming DID/CLD; open Tools & Debugs → SIP Logs Viewer, find the INVITE and copy the request URI into the rule. If it is rejected with 403, the source IP is not the connection you selected.

Result: the DID receives calls and the charges appear in the DID reports.

What’s next

• DID pool: ranges, delegation to resellers and upload of many numbers.
• Set up a calling card product: a DID answered by an IVR application.
• Call forwarding and Follow Me: what happens when the device does not answer.
• Charging groups: fees for incoming numbers.