Add Number to Number Pool

post https://api.telmetrics.com/v3/api/numberpools/{id}/numbers

Adds Numbers to Number Pool.

Responses

Response body

object

int64 | null

The id of the number pool.

match_period

int32 | null

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

quantity

int32 | null

How many numbers the pool should contain.

created_datetime

date-time | null

Created Date

modified_datetime

date-time | null

Modified Date

top_up_with_tollfree

boolean | null

Flag to indicate if no more numbers are found for a specific request, the rest of the numbers for the number pool can be toll free.

numbers

array of objects | null

The numbers in a number pool.

numbers

object

int64 | null

The unique identifier of the number.

phone_number

string | null

The phone number.

attribution

object

The number pool attribution model.

string | null

The unique identifier of the attribution model.

type

string | null

The attribution type.

name

string | null

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

group_id

int64 | null

The id of the group the number pool is attached to.

status

string | null

The status of the number pool.

phone_number_request

object

number_type

string | null

The number type.

Supported options: Standard, Digital, International. Default: Standard.

match_type

string | null

The type of numbers to find.

North America: LocalToNumber, LocalToCity, Tollfree, Hybrid, CustomerOwned.

International: Tollfree, Geographic, National

local_to_number

string | null

The number to base the local to number lookup on.
Only supported for North America.

state

string | null

The state to find numbers in.
Only supported for North America.

city

string | null

The city to find numbers in.
Supported in North America LocalToCity and International Geographic requests.

iso_country

string | null

The ISO 3166 Alpha 2 Code. Required and only supported for International Requests.

region

string | null

The region to find numbers in.

number_match_filter

string | null

The region to find numbers in.
Supported for North America only.

owner_address_details

object

area_code

string | null

The area code to find numbers in for an International Geographic request.

features

object

stop_call

object

call_verify

object

call_record

object

whisper

object

call_tag_rules

array of uuids | null

call_tag_rules

replacement_configuration

object

The number replacement configuration for the tracking sources.

numbers_to_replace

array of strings | null

The numbers to replace on the webpage.

numbers_to_replace

tracking_sources

array of objects | null

The tracking sources.

tracking_sources

object

name

string | null

The name of the tracking source.

referrer_domain

string | null

Referrer domain.

url_triggers

array of strings | null

The url triggers to start the number replacement.

url_triggers

page_variable_triggers

array of strings | null

The page variable triggers to start the number replacement.

page_variable_triggers

track_organic

boolean | null

Option to track organic users visiting the site from an organic google search.

url_trigger_operator

string | null

The URL trigger operator.
Supported options: OR (default), AND.

OR - If any URL triggers/values match, the numbers will be replaced.

AND - If all URL triggers/values match, the numbers will be replaced.

page_trigger_operator

string | null

The page trigger operator.
Supported options: OR (default), AND.

OR - If any page triggers/values match, the numbers will be replaced.

AND - If all page triggers/values match, the numbers will be replaced.

replace_all_numbers

boolean | null

Option to replace all numbers on the page.

sms_routes

object

route_type

string | null

route

object

call_routes

object

route_type

string | null

notification_file

string | null

notification_text

string | null

route

object

routes

array of objects | null

routes

object

int32 | null

The route id.

termination_number

string | null

default

boolean | null

Flag to indicate the default route if nothing else is selected

Supported options: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

route_key

string | null

The route key of the route.

Supported options: default for the default route or 2-9 for time of day routing.

name

string | null

The name of the route.

key_press

int32 | null

The key press.

zip_code

string | null

geo_route

string | null

type

string | null

The type of the time of day route.

start_time

string | null

The start time of the time of day route.

Format: HHMM (24 hour)

end_time

string | null

The end time of the time of day route.

Format: HHMM (24 hour)

days

array of strings | null

The weekdays of which the number should be routed to for the Daily type.

Supported options: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

days

start_day

string | null

The start day of the time of day routing for the Range type.

Supported options: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

end_day

string | null

The end day of the time of day routing for the Range type.

Supported options: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

ring_count

int32 | null

ordinal

int32 | null

features

object

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.telmetrics.com/v3/api/numberpools/id/numbers \
3
     --header 'Authorization: Bearer ' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/*+json'

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success

400Bad request. Please check your payload.

401Unauthorized. Please check your token or request.

404The item you are requesting was not found.

500Server Error