Skip to content

Phone Number Management

These are the endpoints to manage your registered phone numbers.

Create Phone Number

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

The create phone number endpoint can be used to register a phone number you own under your account. This number can then be linked to a new pool.

Parameters

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

Variable Value Required? Description Example
phone_number string yes Your phone number +12223334444
description string yes A description of what service the phone number goes to Service - Desktop/Mobile
property_token string no Your Orbee Property ID d2984a75-f3f0-4c12-83fa-1a7fed404200

Note

Phone numbers should be in E.164 formatting.

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 phone number
account_token string Your Orbee Account ID
phone_number string The phone number you own
description string A description of what service the phone number goes to
created_at string Timestamp of when the phone number was created with Orbee
updated_at string Timestamp of when the phone number was last updated
property_token string Your Orbee Property ID

Get Phone Number

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

The get phone number endpoint can be used to read the information of one of the account's phone numbers.

Parameters

This endpoint does not take a json body form.

Response

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

List Phone Numbers

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

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

Parameters

This endpoint does not take a json body form.

Response

This endpoint will provide an array of the create phone number responses.

Update Phone Number

Endpoint: PUT https://s.api.orb.ee/dni_manager/accounts/:account_id/phone_numbers:phone_number_id

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

Warning

We advise you only use this to update the phone number's description. Updating the number can affect how a related automanage pool assigns call trackers.

Parameters

This endpoint takes all parameters that the create phone number endpoint takes.

Response

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

Delete Phone Number

Endpoint: DELETE https://s.api.orb.ee/dni_manager/accounts/:account_id/phone_numbers:phone_number_id

The delete phone number endpoint will delete the phone number from your account.

Warning

Phone numbers cannot be deleted, unless they are not in use by a pool.

Parameters

This endpoint does not take a json body form.

Response

This endpoint does not have a response body.


Last update: 2023-04-13