What is an API Router?

Example: You can use an API Router to send a call to a different destination based on the caller's account status, support tier, or whether a representative is currently available.

Creating an API Router

                  

1. Assigned Account: Select the account this API router belongs to. This field only appears if you have not already selected an account from the main dropdown at the top right of the page.
2. Label: Enter a name used for internal identification (e.g., “CRM API Routing”).
   
3. Extension Number: Assign any 3-5 digit extension number that the system will use to identify this API router for call routing purposes.

4. Select “Add” in the lower-right to create the API router.

5. Once the API Router is created, you’ll be redirected to a page where you can further customize it (refer to Step 4 in the Management section below).

Note: An API Router can be created without an extension, but it will not be functional until an extension is assigned.

Managing an Existing API Router

1. From the left navigation menu, go to: "UC Admin" → "Call Flow" → "API Routers"

            

3. From the list of existing API routers, select the name of the router you wish to edit to open it's settings.

4. You'll have access to several configuration tabs:

1. General
   
1. Update the Label, Description, and Notes
   
2. Edit the Extension Number and Dialing Address (unique number that can be dialed from anywhere in the platform by any phone or extension)
2. Advanced
   
1. Define the Custom API URL – this is the external endpoint the system will query to determine routing behavior
   
2. Set Custom Headers with a Header Name and Header Value
   
3. Specify a Default Destination to route calls in case of an API failure or timeout
   
4. Apply CDR Tags  (label calls for easier sorting and reporting) or trigger a Webhook (for real-time integration with external systems)
3. Destinations
   
1. Select “+ Add Destination” to configure possible routing endpoints
   
2. Edit or delete existing destinations as needed
   
3. Each destination can be labeled and configured with its own routing target
   
   
   
   
   
   
   
4. Dependency Tree
   
1. View a visual representation of how this API Router is connected to other components in the overall call flow
   
2. Helpful for troubleshooting and understanding system dependencies
   

Be sure to click “Update” at the bottom of the screen to save your changes before navigating away.