Description
This method returns an export file asynchronously generated by another method call.
Arguments
| Field | Description | Field Type | Required | Example |
|---|---|---|---|---|
| file | The filepath provided within the <task_response> parameter of the utilities.getTasks method. | string | Yes | export_files/message_contacts_data_20111030_162323.xml |
Response
Simply returns the file from the path specified in the input parameters.
Response Codes
| Response Code | Response Text | Condition |
|---|---|---|
| 665 | file not found | The file path provided in the <file> parameter does not reference a file exists. |
Example Post
<methodCall>
<methodName>utilities.getFile</methodName>
<file>export_files/message_contacts_data_64311_2148426_20111110_161331.xml</file>
</methodCall>
Example Error
<methodResponse>
<item>
<methodName>utilities.getFile</methodName>
<responseCode>665</responseCode>
<responseText>file not found</responseText>
<responseData></responseData>
<responseNum>1</responseNum>
</item>
</methodResponse>