Data Export Quick SMS
This service allows export of data for SMS campaigns. It works similarly to Data Export Quick for Email Campaigns. The reports are generated immediately using the #filter provided.
There are a variety of reports available, but only one is fully described below, as they all use the same format of parameters and return values.
Each method generates a CSV file which can then be downloaded. The columns in the CSV will be similar, but some additional columns will be available for particular report types, such as click-through URL or conversion revenue.
sent
string data_export_quick_sms.sent( array filter )
Generates the chosen report, based upon the filter provided.
Parameters
filter
Associative array, containing at least one of the keys detailed below:
Key | Type | Description |
---|---|---|
sms_id | int | Identifier for the SMS from which to export data |
timestamp | string | Only export data from after this DateTime (yyyy-mm-dd hh:mm:ss), maximum age 1 month |
Return Values
Returns the file download key.
The method will only return once the file has been successfully generated, or return an error. There is no need to check for export creation status as there is with some other export services.
The file can downloaded by using the following URL:
https://<server>/download/file/key/<key>
Where:
Placeholder | Value |
---|---|
server | Hostname of your server |
key | The file download key returned |
delivered
Uses the same format of parameters and return values as #sent.
undelivered
Uses the same format of parameters and return values as #sent.
clicks
Uses the same format of parameters and return values as #sent.
totalClicks
Uses the same format of parameters and return values as #sent.
replies
Uses the same format of parameters and return values as #sent.
unsubscribes
Uses the same format of parameters and return values as #sent.
Service
data_export_quick_sms
Methods