switchvox.users.phones.getList
From SwitchvoxExtendAPI
Contents |
Description
Get a list of all phones.
In the context of this API, "phones" refers to non-Digium manufactured phones. Previous to Switchvox version 5.5, and the production of Digium phones, other manufacturers phones (Polycom, Snom, etc...) were used with Switchvox. APIs for configuring Digium phones can be found in the switchvox.digiumPhones.* and switchvox.users.digiumPhones.* namespaces.
Arguments
- See the Constructing Requests page to learn how to use arguments in requests.
| Name | Required | Type | Default | Description |
| account_id | required | integer | The account_id that belongs to this phone |
Example Requests & Responses
- Please see the API Request and Response Format section for more information on various request encodings.
Example One
Request
<request method="switchvox.users.phones.getList"> <parameters> <account_id>1101</account_id> </parameters> </request>
Response
<response method="switchvox.users.phones.getList"> <result> <phones> <phone phone_config_id="39"> </phones> </result> </response>
Error Codes
- See the Error Code Formatting section to see the xml structure when an error is returned.
- See the Generic Error Codes section to see a list of general fault codes that may be returned.
This method doesn't throw any method specific faults.