Personal tools

switchvox.status.telephonyCards.getList

From SwitchvoxExtendAPI

Jump to: navigation, search

Contents

Description

Returns a list of all hardware devices.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.
Name Required Type Default Description
sort_field optional name The field on which to sort the returned hardware devices. Possible values are: name, id, channel and group.
sort_order optional DESC The order in which to sort returned hardware devices. Possible values: ASC and DESC.

Example Requests & Responses

Please see the API Request and Response Format section for more information on various request encodings.

Example One

Request

<?xml version="1.0"?>
<request method="switchvox.status.telephonyCards.getList">
  <parameters>
    <sort_field>id</sort_field>
    <sort_order>ASC</sort_order>
  </parameters>
</request>

Response

<response method="switchvox.status.telephonyCards.getList">
  <result>
    <devices total_items="3">
      <device id="1" name="Device 1" channel="111" group="Group 1" signalling="FXS Kewlstart" state="No Alarm" />
      <device id="2" name="Device 2" channel="222" group="Group 2" signalling="FXS Kewlstart" state="No Alarm" />
    </devices>
  </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.
Code Description
12016 Invalid sort field
12017 Invalid sort order
Retrieved from "http://developers.digium.com/switchvox/wiki/index.php/Switchvox.status.telephonyCards.getList"