Create Numbers

Creates tracking numbers for a group. Tracking numbers are the core resource for call attribution - each number can be configured with a destination (termination number), call routing behavior, and a set of features that control how calls are handled, recorded, and verified.

Features objects - when to use which:

There are two places features can be configured: at the number level (features) and at the route level (call_routes.route.features / call_routes.routes[].features). Where you place a feature depends on your routing type.

Basic routing (route_type: "Basic"):

  • features (number-level): Configure stop_call, call_verify, scheduled_call_verify, and call_tag_rules here. These apply uniformly to the number regardless of routing.
  • call_routes.route.features (route-level): Configure call_record and whisper here. These are specific to how the single route handles the call.

Advanced routing (route_type: "KeyPress", "Geo", "ZipCode"):

  • features (number-level): Configure stop_call, call_verify, scheduled_call_verify, and call_tag_rules here. These act as defaults across all routes.
  • call_routes.routes[].features (route-level): Configure call_record and whisper per route. This allows different recording or whisper behavior depending on which route handles the call - for example, enabling recording on a daytime route but not an after-hours route.

General guidance:

  • Number-level features apply call-agnostically - they fire regardless of which route is matched.
  • Route-level features take precedence over number-level features for calls handled by that route.
  • If you only need uniform behavior across all routes, prefer setting features at the number level and omitting them at the route level.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The unique integer ID of the group under which this number will be created.

Body Params

The request payload for creating a new tracking number.

string | null

A unique name to identify the number for reporting purposes.

string | null

A custom id that can be set.

boolean | null

A custom id that can be set.

string | null

Custom text field 1.

string | null

Custom text field 2.

string | null

Custom text field 3.

string | null

Custom text field 4.

string | null

Custom text field 5.

string | null

Custom text field 6.

string | null

Custom text field 7.

string | null

Custom text field 8.

string | null

Custom text field 9.

string | null

Custom text field 10.

string | null

Custom text field 11.

string | null

Custom text field 12.

string | null

Custom text field 13.

string | null

Custom text field 14.

string | null

Custom text field 15.

string | null

Custom text field 16.

string | null

Custom text field 17.

string | null

Custom text field 18.

string | null

Custom text field 19.

string | null

Custom text field 20.

phone_number_request
object
features
object

Number-level features are evaluated on every inbound call before routing occurs.

  • features.stop_call - Prevents the call from completing. Use this for credit control or to temporarily suspend call routing for a number.


  • features.call_verify - Requires the caller to press a key before the call connects. Use this to reduce spam and robocalls.


  • features.scheduled_call_verify - Same as call_verify, but only active during configured time ranges. Use this to apply the key-press challenge after hours without disrupting the experience for legitimate callers during business hours.


  • features.call_tag_rules - Applies call tagging rules to every inbound call on this number.


For call_record and whisper, where you configure them depends on the route type:

  • Basic - Configure at call_routes.route.features.call_record and call_routes.route.features.whisper.


  • Geo, ZipCode - Configure per route at call_routes.routes[].features.call_record and call_routes.routes[].features.whisper. This allows different recording or whisper behavior on each route.


  • FollowMe, TimeOfDay - Configure at features.call_record and features.whisper. These route types do not support per-route feature configuration.

replacement_configuration
object

The number replacement configuration for the tracking sources.

sms_routes
object
call_routes
object
attribution_mapping
object
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json