Account Management¶
These are the endpoints to manage your Voice Management account.
Create Account¶
Endpoint: POST https://s.api.orb.ee/call_tracking/accounts
The create account endpoint can be used to enable call-tracking for your account. This is required if you want to create any type of pool.
Parameters¶
The table below shows all parameters that can be set through the endpoint's json body form:
| Variable | Value | Required? | Description | Example |
|---|---|---|---|---|
| account_token | string | yes | Your Orbee Account ID | e39f85a2-64c0-4f01-91e4-4f8466e6bd4c |
Response¶
The response will be a json body with the following key value pairs:
| Key | Value | Description |
|---|---|---|
| id | integer | A unique ID assigned to the account |
| is_active | boolean | Determines if the account has call-tracking enabled |
| account_token | string | Your Orbee Account ID |
| created_at | string | Timestamp of when the account was created with Orbee |
| updated_at | string | Timestamp of when the account was last updated |
Update Account¶
Endpoint: PUT https://s.api.orb.ee/call_tracking/accounts/:id
The update account endpoint can be used to enable or disable call-tracking on your account.
Parameters¶
The table below shows all parameters that can be set through the endpoint's json body form:
| Variable | Value | Required? | Description | Example |
|---|---|---|---|---|
| is_active | boolean | yes | True for enabling. False for disabling | false |
Response¶
This endpoint has no response body.
Last update:
2023-04-13