Set Up Inbound Routes for Your Phone Number

Overview

Steps

• Create an inbound voice route
• via cURL
• via the Flowroute Python Library v3
• Set up an inbound voice route for your phone number
• via cURL
• via the Flowroute Python Library v3

Create an inbound voice route

To assign a primary or a failover inbound voice route to a phone number, you must create a record for the inbound route first. There are four voice route types: host, number, uri, or sip-reg all in lowercase. sip-reg is the default primary route type assigned to a Flowroute phone number upon purchase. For details around valid values according to route type, see body parameters section of "Create an Inbound Route".

The Flowroute API v2 provides an alternative programmatic way for you to create a new inbound voice route. For the Manage method of creating an inbound route, visit Inbound Routes > Add New Route.

In this tutorial, we will show you two methods of creating a new inbound route and assigning that route as a primary or a failover voice route to a phone number using the Flowroute API v2:

Request via cURL

1. Open a command shell session.
2. If you haven't installed cURL previously, download your specific source package here.
3. Copy the following example POST request.

curl https://api.flowroute.com/v2/routes \
-X POST -u accessKey:secretKey \
-d '{"data": {"type":"route", "attributes": {"route_type": "host", "value": "www.getouttahere.com", "alias":"new_route_5000"}}}' \ 
-H 'Content-Type':'application/vnd+api.json'

                    

4. Replace accessKey:secretKey with your API credentials.
5. In the JSON body parameters section of your cURL request right after the cURL -d flag, , make the following substitutions:
   • Replace route_type with your preferred route type. You can choose between host, uri, number, and sip-reg.
   • Replace value with the appropriate value according to your route type.
   • Replace alias with a unique alias for your new route.
6. Press Enter.

Request via Python

1. To begin, follow the Requirements and Installation sections of the library guide.
2. Open up your preferred text editor and start writing Python code.

vim routes-test.py
            

3. Import the following required libraries.

import pprint
import os
import json
from flowroutenumbersandmessaging.flowroutenumbersandmessaging_client import FlowroutenumbersandmessagingClient

            

4. Assign your Flowroute accessKey and secretKey to the following variables or set them as environment variables.

basic_auth_user_name = "YOUR_FR_ACCESS_KEY"
basic_auth_password = "YOUR_FR_SECRET_KEY"

                    

5. Next, instantiate the API Client and the routes controllers.

client = FlowroutenumbersandmessagingClient(basic_auth_user_name, basic_auth_password)
routes_controller = client.routes

                    

6. Lastly, specify your body parameters and invoke the Python library v3 search method.

print("--Create an Inbound Route")
request_body = '{ \
  "data": { \
    "type": "route", \
    "attributes": { \
      "route_type": "host", \
      "value": "www.getouttahere.com", \
      "alias": "new_route_5000" \
    } \
  } \
}'
result = routes_controller.create_an_inbound_route(request_body)
pprint.pprint(result)

                    

7. You're done coding, at least for the inbound route creation portion of this tutorial. Save the file and run it.

python routes-test.py
            

Flowroute API Create an Inbound Route Response

On success, the HTTP status code in the response header is 201 CREATED and the response body contains the newly created route object in JSON format. Make a note of the id of the inbound route in the JSON response. You will need that for the next portion.

{
  "data": {
    "attributes": {
      "alias": "new_route_5000",
      "route_type": "host",
      "value": "www.getouttahere.com"
    },
    "id": "98396",
    "links": {
      "self": "https://api.flowroute.com/routes/98396"
    },
    "type": "route"
  },
  "links": {
    "self": "https://api.flowroute.com/routes/98396"
  }
}

            

Set up an inbound voice route for your phone number

You may assign inbound routes that you have created as a primary or a failover voice route to any Flowroute number that you own.

Request via cURL

1. To assign your newly created inbound route as a voice route to your Flowroute phone number, copy the following example PATCH request.

Primary Voice Route

curl https://api.flowroute.com/v2/numbers/13474165666/relationships/primary_route -X PATCH -u accessKey:secretKey -H 'Content-Type':'application/vnd.api+json' -d '{ "data": { "type":"route", "id":"98396" } }' 

                    

Failover Voice Route

curl https://api.flowroute.com/v2/numbers/13474165666/relationships/failover_route -X PATCH -u accessKey:secretKey -H 'Content-Type':'application/vnd.api+json' -d '{ "data": { "type":"route", "id":"98396" } }' 

                    

2. Replace accessKey:secretKey with your API credentials.
3. In the path parameter section of your cURL request right after numbers, https://api.flowroute.com/v2/numbers, replace the example phone number with the id of the phone number that you want to associate with your inbound route.
4. In the JSON body parameters section of your cURL request right after the cURL -d flag, replace id with the ID of your inbound route.
5. Press Enter.