Call Tracker Management¶
These are the endpoints to manage your pool's call trackers.
Warning
Updating and flagging should only be done on a call tracking within a manual pool.
Create Call Tracker¶
Manual pools will automatically create "Available" call trackers. After, these call trackers can be updated to an "Active" status, and set to track one of your phone numbers using the update call tracker endpoint.
Note
Call trackers will inherit the is_dni, is_recorded, and is_prompted properties of the pool it is tied to.
Get Call Tracker¶
Endpoint: GET https://s.api.orb.ee/dni-manager/accounts/:account_id/pools/:pool_id/call_trackers/:call_tracker_id
The get call tracker endpoint can be used to read the information of one of the pool's call trackers.
Parameters¶
This endpoint does not take a json body form.
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 call tracker |
| original_number | string | The phone number you own |
| original_number_id | string | A unique ID assigned to your phone number |
| description | string | A description of where this call tracker will be used |
| tracking_number | string | The number that should be used in place of your phone number for tracking data |
| pool_id | string | A unique ID assigned to the pool |
| status | string | The current state of the call tracker |
| created_at | string | Timestamp of when the call tracker was created |
| dropped_at | string | Timestamp of when the call tracker was flagged |
| updated_at | string | Timestamp of when the call tracker was last updated |
List Call Trackers¶
Endpoint: GET https://s.api.orb.ee/dni-manager/accounts/:account_id/pools/:pool_id/call_trackers
The list call trackers endpoint can be used to read the information of all call trackers tied to the pool.
Parameters¶
This endpoint does not take a json body form.
Response¶
This endpoint will provide an array of the get call tracker responses.
Update Call Tracker¶
Endpoint: PUT https://s.api.orb.ee/dni-manager/accounts/:account_id/pools/:pool_id/call_trackers/:call_tracker_id
The update call tracker endpoint can be used to update a call tracker's information. This endpoint will also update its status to "Active" and it'll start tracking the pool's phone number.
Parameters¶
The response will be a json body with the following key value pairs:
| Variable | Value | Required? | Description | Example |
|---|---|---|---|---|
| description | string | yes | A description of where this call tracker will be used | DoNotReplace/GoogleMyBusiness |
Note
For manual pools, we follow the rule that a permanent number should be given the prefix "DoNotReplace/" in the description, followed by where or what it is going to be used to track. Typically, we also choose to omit any spaces in this description.
Response¶
This endpoint will provide the same response as the get call tracker endpoint.
Flag Call Tracker¶
Endpoint: PUT https://s.api.orb.ee/dni-manager/accounts/:account_id/pools/:pool_id/call_trackers/:call_tracker_id/flag
The flag call tracker endpoint can be used to update the call tracker to a "Flagged" status and put it on a timeline.
Warning
If the call tracker's timeline expires and is then deleted, the pool will still fill up by creating another call tracker. Just make sure to update the pool's size accordingly, before using this endpoint.
Parameters¶
This endpoint does not take any keys in its json body form.
Response¶
This endpoint will provide the same response as the get call tracker endpoint.