Es tut uns leid, aber diese Seite wurde leider noch nicht übersetzt. Doch keine Sorge, das Emarsys Lokalisierungsteam arbeitet eifrig daran, unsere gesamte Dokumentation in Ihrer Sprache bereitzustellen.
Returns a list of email campaign launch data for specified contacts, can also be restricted to specified timeframe (optional).
Endpoint
POST https://api.emarsys.net/api/v2/contact/getcontacthistory
Parameters
Required parameters
| Name | Type | Description | Comments |
|---|---|---|---|
| contacts | array | Integer array which contains the contact IDs to include |
Optional parameters
| Name | Type | Description | Comments |
|---|---|---|---|
| startDate | date | Used to filter emails by the date the launch was initiated | |
| endDate | date | Used to filter emails by the date the launch completed |
Requests Example
{
"startDate": "2014-11-05",
"endDate": "2014-11-05",
"contacts": [176415518, 749678081]
}
Result Example
{
"replyCode": 0,
"replyText": "OK",
"data":
[
{
"emailId": 100017517,
"contactId": "749678081",
"launch_date": "2014-11-05 09:42:00",
"delivery_status": "launched",
"bounce_status": "soft"
},
{
"emailId": 100017517,
"contactId": "176415518",
"launch_date": "2014-11-05 09:42:00",
"delivery_status": "launched",
"bounce_status": "soft"
}
]
}
Resulting Data Structure
{
"emailId": "integer",
"contactId": "integer",
"launch_date": "date",
"delivery_status": "string",
"bounce_status": "string"
}
Where delivery_status can have the following values:
- scheduled – The campaign is scheduled and the launch list is generated.
- canceled – The contact is canceled. The reason can be a missing email address, wrong syntax, no HTML data, or a personalization error.
- prepared – The campaign is generated and the launch is starting soon.
- launched – The campaign is launched for the contact.
Errors
| HTTP Code | Reply Code | Message | Description |
|---|---|---|---|
| 400 | 10001 | Missing parameter: contacts | contacts is a required parameter. |
| 400 | 10001 | Contacts must be an integer array | contacts must be a comma-separated list of contact IDs. |
| 400 | 10001 | Invalid data format for startDate/endDate. Date expected | Wrong date format. |
| 400 | 10001 | Max. number of contacts: 1000 |