List Devices Status
Sandbox is coming soon
Today, requests on this page run against your live account. A hosted sandbox with simulated PSTN is on the roadmap — until then, use a non-production user or callflow when experimenting.
Authorization
AuthToken X-Auth-Token<token>
Obtain via PUT /v2/user_auth (user credentials) or PUT /v2/api_auth (account API key). See Authentication.
In: header
Path Parameters
account_id*string
Vinix account identifier.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/accounts/string/devices/status"{
"data": {
"call_forward": {
"direct_calls_only": false,
"enabled": false,
"failover": false,
"ignore_early_media": true,
"keep_caller_id": true,
"number": "string",
"require_keypress": true,
"substitute": true
},
"call_recording": {
"any": {
"any": {
"enabled": true,
"format": "mp3",
"record_min_sec": 0,
"record_on_answer": true,
"record_on_bridge": true,
"record_sample_rate": 0,
"time_limit": 5,
"url": "http://example.com"
},
"offnet": {
"enabled": true,
"format": "mp3",
"record_min_sec": 0,
"record_on_answer": true,
"record_on_bridge": true,
"record_sample_rate": 0,
"time_limit": 5,
"url": "http://example.com"
},
"onnet": {
"enabled": true,
"format": "mp3",
"record_min_sec": 0,
"record_on_answer": true,
"record_on_bridge": true,
"record_sample_rate": 0,
"time_limit": 5,
"url": "http://example.com"
}
},
"inbound": {
"any": {
"enabled": true,
"format": "mp3",
"record_min_sec": 0,
"record_on_answer": true,
"record_on_bridge": true,
"record_sample_rate": 0,
"time_limit": 5,
"url": "http://example.com"
},
"offnet": {
"enabled": true,
"format": "mp3",
"record_min_sec": 0,
"record_on_answer": true,
"record_on_bridge": true,
"record_sample_rate": 0,
"time_limit": 5,
"url": "http://example.com"
},
"onnet": {
"enabled": true,
"format": "mp3",
"record_min_sec": 0,
"record_on_answer": true,
"record_on_bridge": true,
"record_sample_rate": 0,
"time_limit": 5,
"url": "http://example.com"
}
},
"outbound": {
"any": {
"enabled": true,
"format": "mp3",
"record_min_sec": 0,
"record_on_answer": true,
"record_on_bridge": true,
"record_sample_rate": 0,
"time_limit": 5,
"url": "http://example.com"
},
"offnet": {
"enabled": true,
"format": "mp3",
"record_min_sec": 0,
"record_on_answer": true,
"record_on_bridge": true,
"record_sample_rate": 0,
"time_limit": 5,
"url": "http://example.com"
},
"onnet": {
"enabled": true,
"format": "mp3",
"record_min_sec": 0,
"record_on_answer": true,
"record_on_bridge": true,
"record_sample_rate": 0,
"time_limit": 5,
"url": "http://example.com"
}
}
},
"call_restriction": {},
"call_waiting": {
"enabled": true
},
"caller_id": {
"asserted": {
"name": "string",
"number": "string",
"realm": "string"
},
"emergency": {
"name": "string",
"number": "string"
},
"external": {
"name": "string",
"number": "string"
},
"internal": {
"name": "string",
"number": "string"
}
},
"caller_id_options": {
"outbound_privacy": "full"
},
"contact_list": {},
"device_type": "string",
"dial_plan": {
"system": [
"string"
],
"property1": {
"description": "string",
"prefix": "string",
"suffix": "string"
},
"property2": {
"description": "string",
"prefix": "string",
"suffix": "string"
}
},
"do_not_disturb": {
"enabled": true
},
"enabled": true,
"exclude_from_queues": false,
"flags": [
"string"
],
"formatters": {
"property1": [
{
"direction": "inbound",
"match_invite_format": true,
"prefix": "string",
"regex": "/regex/",
"strip": true,
"suffix": "string",
"value": "string"
}
],
"property2": [
{
"direction": "inbound",
"match_invite_format": true,
"prefix": "string",
"regex": "/regex/",
"strip": true,
"suffix": "string",
"value": "string"
}
]
},
"hotdesk": {
"users": {
"property1": {},
"property2": {}
}
},
"language": "string",
"mac_address": "string",
"media": {
"audio": {},
"bypass_media": true,
"encryption": {},
"fax_option": true,
"ignore_early_media": true,
"progress_timeout": 0,
"video": {}
},
"metaflows": {
"binding_digit": "1",
"digit_timeout": 0,
"listen_on": "both",
"numbers": {
"property1": {
"children": {
"property1": {
"children": {},
"data": {},
"module": "string"
},
"property2": {
"children": {},
"data": {},
"module": "string"
}
},
"data": {},
"module": "string"
},
"property2": {
"children": {
"property1": {
"children": {},
"data": {},
"module": "string"
},
"property2": {
"children": {},
"data": {},
"module": "string"
}
},
"data": {},
"module": "string"
}
},
"patterns": {
"property1": {
"children": {
"property1": {
"children": {},
"data": {},
"module": "string"
},
"property2": {
"children": {},
"data": {},
"module": "string"
}
},
"data": {},
"module": "string"
},
"property2": {
"children": {
"property1": {
"children": {},
"data": {},
"module": "string"
},
"property2": {
"children": {},
"data": {},
"module": "string"
}
},
"data": {},
"module": "string"
}
}
},
"music_on_hold": {},
"mwi_unsolicited_updates": true,
"name": "string",
"outbound_flags": [
"string"
],
"owner_id": "stringstringstringstringstringst",
"presence_id": "string",
"provision": {
"combo_keys": {
"property1": {
"type": "parking",
"value": 1
},
"property2": {
"type": "parking",
"value": 1
}
},
"endpoint_brand": "string",
"endpoint_family": "string",
"endpoint_model": "string",
"feature_keys": {
"property1": {
"type": "parking",
"value": 1
},
"property2": {
"type": "parking",
"value": 1
}
}
},
"register_overwrite_notify": false,
"ringtones": {},
"sip": {},
"suppress_unregister_notifications": false,
"timezone": "string"
}
}{
"code": "string",
"message": "string",
"request_id": "string"
}{
"code": "string",
"message": "string",
"request_id": "string"
}