Personal tools

switchvox.extensions.getVoicemailInfo

From SwitchvoxExtendAPI

Jump to: navigation, search

Contents

Description

Gets the voicemail/fax disk usage information for every phone extension.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.
Name Required Type Default Description
sort_field optional extension The field on which to sort the voicemail information. Possible values are: extension, extension_type, first_name, last_name, account_id, num_messages, disk_space, quota_class and quota_used.
sort_order optional ASC The order in which to sort returned phones. Possible values: ASC and DESC.
items_per_page optional 50 Number of extensions to return per page.
page_number optional 1 The page number of extension results to return.

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.extensions.getVoicemailInfo">
    <parameters>
        <sort_field>extension</sort_field>
        <sort_order>ASC</sort_order>
        <items_per_page>50</items_per_page>
        <page_number>1</page_number>
    </parameters>
</request>

Response

<response method="switchvox.extensions.getVoicemailInfo">
  <result>
    <extensions page_number="1" total_pages="1" items_per_page="50" total_items="2" max_disk_space="40842101">
      <extension number="100" type="sip" first_name="Jon" last_name="Doe" account_id="1101" num_voicemail="5" num_fax="3" total_num_messages="8" used_vm_bytes="308154" used_bytes_fax="1254583" used_bytes="1562737" quota_used="0" quota_class="" />
      <extension number="101" type="sip" first_name="Jane" last_name="Doe" account_id="1102" num_voicemail="84" num_fax="15" total_num_messages="99" used_vm_bytes="8545337" used_bytes_fax="6276344" used_bytes="14821681" quota_used="0" quota_class="" />
    </extensions>
  </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
12018 items_per_page may only contain digits
12019 page_number may only contain digits
Retrieved from "http://developers.digium.com/switchvox/wiki/index.php/Switchvox.extensions.getVoicemailInfo"