The GetCommunicationHistory() command returns a list of communication history (i.e. e-mails sent) that satisfy the given filter parameters.
|
| Parameter | Type | Max Length | Required | Description |
|---|---|---|---|---|
| apiToken | string | 20 | Y | Your API security token configured in Field View. |
| projectID | integer | Y | The unique ID of the project. | |
| emailTo | string | 20 | Y | Filters the returned results where the email 'to' contains the supplied string. |
| emailSubject | string | 20 | Y | Filters the returned results where the email 'subject' contains the supplied string. |
| notSent | boolean | Y | If false, all communication history is returned. If true, only the communication history that failed to get sent is returned. | |
| dateFrom | DateTime | The date sent from communication history results to retrieve. | ||
| dateTo | DateTime | The date sent to communication history results to retrieve. | ||
|
Note: Date range must be 3 months or less.
|
||||
| Field | Type | Description |
|---|---|---|
| CommunicationHistoryInformation | CommunicationHistoryInformation | Communication history list information structure. |
<CommunicationHistoryResponse>
<Status>
SUCCESS
<Message>Success.</Message>
</Status>
<CommunicationHistoryInformation>
<SubscriptionID></SubscriptionID>
<ProjectID></ProjectID>
<ProjectName></ProjectName>
<To></To>
<Subject></Subject>
<CC></CC>
<Body></Body>
<Sent></Sent>
<Date></Date>
</CommunicationHistoryInformation>
</CommunicationHistoryResponse>