Syntax
array getAutoresponderById( string api_key, int autoresponder_id );
Parameters
api_key(string)The key required to access the API. See Getting Started for more information.
autoresponder_id(int)The ID of the Autoresponder.
Return Value
Returns an array containing a single associative array of Autoresponder details. See searchAutoresponders for a description of the values returned.
Examples
$api = new Api($url, 'YOURAPIKEY');
$autoresponder_id = 23;
$autoresponder = $api->invokeMethod('getAutoresponderById', $autoresponder_id);
$autoresponder_id = 23;
$autoresponder = $api->invokeMethod('getAutoresponderById', $autoresponder_id);
{
"id": 1,
"method": "getAutoresponderById",
"params": [
"YOURAPIKEY",
23
]
}
"id": 1,
"method": "getAutoresponderById",
"params": [
"YOURAPIKEY",
23
]
}
{
"id": 1,
"result": [
{
"id": 23,
"is_active": 1,
"event_type": "subscribe",
"creator_user_id": 0,
"creation_time": 0,
"last_modified_time": 0,
"folder_id": 102520,
"timezone": "Australia\/Brisbane",
"list_id": 43,
"creator_name": null,
"message_id": 10050,
"time_criteria_type": "immediate",
"time_criteria_timestamp": 0,
"time_criteria_offset_value": 0,
"time_criteria_offset_period": "",
"time_criteria_specific_minute": 0,
"time_criteria_specific_hour": 0
}
],
"error": null
}
"id": 1,
"result": [
{
"id": 23,
"is_active": 1,
"event_type": "subscribe",
"creator_user_id": 0,
"creation_time": 0,
"last_modified_time": 0,
"folder_id": 102520,
"timezone": "Australia\/Brisbane",
"list_id": 43,
"creator_name": null,
"message_id": 10050,
"time_criteria_type": "immediate",
"time_criteria_timestamp": 0,
"time_criteria_offset_value": 0,
"time_criteria_offset_period": "",
"time_criteria_specific_minute": 0,
"time_criteria_specific_hour": 0
}
],
"error": null
}
Error Codes
This method may return the following error code in addition to the standard error codes:
| Code | Error | Description |
|---|---|---|
309 |
Unable to Load Campaign | Autoresponder could not be found or retrieved |