Personal tools

switchvox.users.fax.getFile

From SwitchvoxExtendAPI

Jump to: navigation, search

Contents

Description

Returns the link to the fax PDF file for the specified message sequence number.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.
Name Required Type Default Description
account_id required The account ID of the extension.
message_id required The message ID.
folder required The name of the fax folder the message exists in. Possible values: Fax, Fax.Drafts, Fax.Outbox and Fax.Sent.

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.users.fax.getFile">
    <parameters>
        <account_id>1101</account_id>
        <message_id>1</message_id>
        <folder>INBOX</folder>
    </parameters>
</request>

Response

<response method="switchvox.users.fax.getFile">
  <result>
    <download link="http://10.10.10/voicemail/messages/100/cache/Fax/1/display.pdf" />
  </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
66939 Missing the account_id parameter.
11014 Invalid account_id (%1). Account_ids may only contain digits.
84711 That account_id is invalid.
64125 Invalid Folder (%1)
64127 Please provide at least one message ID
64128 Invalid message ID (%1)
27168 Your account is not permitted to run this action.
Retrieved from "http://developers.digium.com/switchvox/wiki/index.php/Switchvox.users.fax.getFile"