Automatic Number Assignment

Using Marketing Edge automated number assignment, a Tracking Number can be automatically selected based on the criteria you specify.

You may supply search criteria that will select and order:

A Tracking Number local to an existing advertiser's number
A Tracking Number local to a geographic region
A Toll-Free Tracking Number

Outlined below are the methods that can be used to provision a number that best suits your needs.

1. Local to Number

Using this number assignment method, you may use the following endpoint to create your number:

POST https://edgeapi.marchex.io/marketingedge/v5/api/groups/{group_id}/numbers

Remember when creating a number, it must be assigned to a Group.

The following fields are used in this request, and must be passed in your request:

Field	Value
name	a unique name to identify the number for reporting purposes
phone_number_request -> match_type	localtonumber
phone_number_request -> local_to_number	a 10 digit phone number used to locate a local phone number
phone_number_request -> number_match_filter	Optional will restrict match results to numbers matching the supplied 3 digit Area Code(NPA), or 6 digit Area Code(NPA)/Exchange(NXX)
call_routes -> route_type	Basic, KeyPress, FollowMe, ZipCode, TimeOfDay, Geo
call_routes -> route -> termination_number	advertiser phone number where calls should be forwarded to

Below is an example of how to request a number using the criteria outlined above:

POST https://edgeapi.marchex.io/marketingedge/v5/api/groups/{groups_id}/numbers

{
  "name": "ABC Company",
  "phone_number_request": {
    "match_type": "localtonumber",
    "local_to_number": "9056372046",
    "number_match_filter": "289"
  },
  "call_routes": {
    "route_type": "Basic",
    "route": {
      "termination_number": "4165551234"
    }
  }
}

A successful post will result in the creation of a tracking number:

{
    "id": 8660466,
    "name": "ABC Company 4",
    "campaign_id": 11623282,
    "status": "Active",
    "phone_number": "2898122093",
    "created_datetime": "2018-04-12T00:00:00Z",
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30474073,
            "termination_number": "4165551234"
        }
    }
}

2. Local to Geographic Area

This number assignment method will allow you to automatically select and order a number in the specified geographical area.

Using this number assignment method, use the following endpoint to create your Tracking Number:

POST https://edgeapi.marchex.io/marketingedge/v5/api/groups/{group_id)/numbers

Remember when creating a number, it must be assigned to a Group.

The following fields are used in this request, and must be passed in your request:

Field	Value
name	a unique name to identify the number for reporting purposes
phone_number_request -> match_type	localtocity
phone_number_request -> city	name of the city where you want a local number. Be aware when using this field that not all cities will map back to a local calling area
phone_number_request -> state	a two letter state/province code where you want a local number
phone_number_request -> number_match_filter	Optional will restrict match results to numbers matching the supplied 3 digit Area Code(NPA), or 6 digit Area Code(NPA)/Exchange(NXX)
call_routes -> route_type	Basic, KeyPress, FollowMe, ZipCode, TimeOfDay, Geo
call_routes -> route -> termination_number	advertiser phone number where calls should be forwarded to

Below is an example of how to request a number using the criteria outlined above:

POST https://edgeapi.marchex.io/marketingedge/v5/api/groups/{group_id}/numbers

{
  "name": "ABC Company",
  "phone_number_request": {
    "match_type": "localtocity",
    "city":"atlanta",
    "state":"ga",
    "number_match_filter": "404"
  },
  "call_routes": {
    "route_type": "Basic",
    "route": {
      "termination_number": "4043993433"
    }
  }
}

A successful post will result in the creation of a tracking number:

{
    "id": 8660467,
    "name": "ABC Company",
    "campaign_id": 11623282,
    "status": "Active",
    "phone_number": "4043411266",
    "created_datetime": "2018-04-12T00:00:00Z",
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30474074,
            "termination_number": "4043993433"
        }
    }
}

3. Toll-Free

This number assignment method will allow you to automatically select and order a Toll-Free number.

Using this number assignment method, use the following endpoint to create your Tracking Number:

POST https://edgeapi.marchex.io/marketingedge/v5/api/groups/{group_id)/numbers

Remember when creating a number, it must be assigned to a Group.

The following fields are used in this request, and must be passed in your request:

Field	Value
name	a unique name to identify the number for reporting purposes
phone_number_request -> match_type	tollfree
phone_number_request -> number_match_filter	Optional will restrict match results to numbers matching the supplied 3 digit Area Code(NPA), or 6 digit Area Code(NPA)/Exchange(NXX)
call_routes -> route_type	Basic, KeyPress, FollowMe, ZipCode, TimeOfDay, Geo
call_routes -> route -> termination_number	advertiser phone number where calls should be forwarded to

Below is an example of how to request a number using the criteria outlined above:

POST https://edgeapi.marchex.io/marketingedge/v5/api/groups/{group_id}

{
  "name": "ABC Company",
  "phone_number_request": {
    "match_type": "tollfree",
    "number_match_filter": "833"
  },
  "call_routes": {
    "route_type": "Basic",
    "route": {
      "termination_number": "4043993433"
    }
  }
}

A successful post will result in the creation of a tracking number:

{
    "id": 8660468,
    "name": "ABC Company 6",
    "group_id": 11623282,
    "status": "Active",
    "phone_number": "8332018273",
    "created_datetime": "2018-04-12T00:00:00Z",
    "sms_routes": {
        "route_type": "None"
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30474075,
            "termination_number": "4043993433"
        }
    }
}