Unit Structure
Base Attributes
| Attribute | Type | Example |
|---|---|---|
|
id The ID of the unit |
Integer | 1 |
|
record_id The record ID of the unit |
String | unit_6dSJJZlmiGc2qnDi |
|
name The name of the unit |
String | Acme Inc |
|
identifier The identifier |
String | acme |
|
type The type of unit |
String | direct |
|
disposition Should unanswered calls be shown in logs? |
Integer | 1 |
|
call_recording_retention_days How many days should call recordings be kept for, leave blank for unlimited |
Integer | 14 |
|
statistics.last_call The last call either made or received by the unit |
Hash | {} |
|
statistics.extension_count The number of extensions the unit has |
Integer | 1 |
|
statistics.incoming_number_count The number of incoming numbers the unit has |
Integer | 2 |
|
statistics.internal_number_count The number of internal numbers the unit has |
Integer | 4 |
|
statistics.incoming_numbers An array of incoming numbers the unit has |
Array | [] |
Extended Attributes
| Attribute | Type | Example |
|---|---|---|
|
created_at The time the unit was created |
Time | |
|
updated_at The time the unit was updated |
Time | |
|
price_for_unit The amount to charge for this unit (if different to price plan) |
Float | 1.25 |
|
price_for_reseller The amount to charge the reseller for this unit (if different to price plan) |
Float | 5.25 |
|
daily_call_cost_usage The daily call costs for this unit
|
Decimal | 0.182 |
|
customer_reference This unit's customer reference |
String | 1000003 |
|
daily_call_cost_limit The total cost of calls per day |
Float | 1.0 |
|
call_rate_limit The call rate limit |
Float | 0.06 |
|
call_connect_limit The call connect limit |
Float | 0.1 |
|
withhold_by_default Withold all numbers by default |
Integer | 0 |
|
enabled Whether this unit is enabled or not |
Integer | 1 |
|
free_minutes The number of free minutes available (if overriding a price plan) |
Integer | 200 |
|
free_minutes_available The number of free minutes available |
Integer | 0 |
|
account_type The type of account |
String | credit |
|
credit_limit The credit limit |
Float | 100.0 |
|
balance The current balance |
Float | 44.39 |
|
remaining_credit The total amount of credit remaining |
Float | 55.61 |
|
credit_warning Whether or not a credit warning should be displayed |
Integer | 0 |
|
invoice_day The day this unit will usually have an invoice generated |
Integer | 10 |
|
renewal_type The type of renewal schedule this unit uses (daily or monthly) |
String | daily |
|
update_required Are changes pending application for this unit |
Boolean | false |
Expansions
Expansions are embedded structures of other objects that are related to the structure that you're viewing. Which expansions are returned by a specific action are shown on that action's documentation however some actions allow you to choose which expansions are returned.
| Attribute | Type | Example |
|---|---|---|
|
price_plan The price plan for the unit |
Hash | Price plan structure |
|
reseller The reseller that this unit belongs to
|
Hash | Reseller structure |
|
container The container that the unit is assigned to
|
Hash | Container structure |