Update Number Pool

Updates a Number Pool.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The Number Pool Id.

Body Params

The Telmetrics.NumberService.Domain.Models.Numbers.NumberPoolUpdateRequestModel Number Pool model.

string | null

A unique name to identify the NUmber Pool for reporting purposes.

int32 | null

How many minutes to hold a session open to await a phone call.

string | null

The status of the number pool.

phone_number_request
object
sms_routes
object
call_routes
object
numbers
array of objects | null

The numbers in a number pool.

numbers
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.

attribution
object

The number pool attribution model.

replacement_configuration
object

The number replacement configuration for the tracking sources.

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.

date-time | null

The start time of study.

date-time | null

The end time of the time of study.

date-time | null

The start time of the time of study.

date-time | null

The end time of the time of study.

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