Skip to content

Pool Management

These are the endpoints to manage your pools.

Create Pool

Endpoint: POST https://s.api.orb.ee/dni_manager/accounts/:account_id/pools

The setup pool endpoint can be used to register a pool under your account.

Parameters

The table below shows all parameters that can be set through the endpoint's json body form:

Variable Value Automanaged Required? Manual Required? Description Example
original_number string yes yes One of the phone numbers you registered under your account +12223334444
area_code string yes yes The area code of the call tracker to be used 123
description string no no A description of the pool Example description
is_dni boolean yes yes Determines if the call trackers in the pool are to be used for DNI false
is_prompted boolean yes yes Determines if the call tracker has a prompt before calls begin false
is_recorded boolean yes yes Determines if the call tracker will save a recording of calls false
pool_type string yes yes Manual or automated automated
property_token string yes no Your Orbee Property ID 9296509c-d00e-456e-af3a-ba15bf54b25e
size integer yes yes The maximum amount of call trackers that are to be assigned to the pool's phone number 10
utilization double yes no The percentage of call trackers that will be active at a given moment 0.5

Note

Phone numbers should be in E.164 formatting. The phone number should also already exist under your account. Learn more.

Note

Utilization will always be ignored for manual pools.

Response

The response will be a json body with the following key value pairs:

Key Value Description
id string A unique ID assigned to the pool
original_number_id string The ID of the attached phone number
account_token string Your Orbee Account ID
area_code string The area code of the call tracker to be used
description string A description of the pool
is_dni boolean Determines if the call trackers in the pool are to be used for DNI
is_prompted boolean Determines if the call tracker has a prompt before calls begin
is_recorded boolean Determines if the call tracker will save a recording of calls
pool_type string Manual or automanaged
property_token string Your Orbee Property ID
size integer The maximum amount of call trackers that are to be assigned to the pool's phone number
utilization double The percentage of call trackers that will be active at a given moment
created_at string Timestamp of when the pool was created
updated_at string Timestamp of when the pool was last updated

Get Pool

Endpoint: GET https://s.api.orb.ee/dni_manager/accounts/:account_id/pools/:pool_id

The get pool endpoint can be used to read the information of one of the account's pools.

Parameters

This endpoint does not take a json body form.

Response

This endpoint will provide the same response as the create pool endpoint, provided a correct ID.

List Pools

Endpoint: GET https://s.api.orb.ee/dni_manager/accounts/:account_id/pools

The list pools endpoint can be used to read the information of all pools registered under your account.

Parameters

This endpoint does not take a json body form.

Response

This endpoint will provide an array of the create pool reponses.

Update Pool

Endpoint: PUT https://s.api.orb.ee/dni_manager/accounts/:account_id/pools/:pool_id

The update pool endpoint can be used to update a pool's information.

Note

We currently only support updating a pool's size, utilization, area code. Learn more about how updating these values affects the pool's management of call trackers.

Parameters

The response will be a json body with the following key value pairs:

Key Value Description
area_code string The area code of the call tracker to be used
size integer The maximum amount of call trackers that are to be assigned to the pool's phone number
utilization double The percentage of call trackers that will be active at a given moment

Response

This endpoint will provide the same response as the create pool endpoint.

Delete Pool

We do not currently support deleting a pool.

Note

Enabling/Disabling a pool will be coming soon.


Last update: 2023-04-13