+49 69 83008980 service@xqueue.com
Benötigen Sie Hilfe?

Im Maileon Help-Center finden Sie umfassende Dokumentationen zu unserem System.

Beliebte Suchanfragen: Importe | Rest-API | Integrationen | SMS

Get Replies

Returns a page of manual or automated replies.

GET https://api.maileon.com/1.0/reports/replies
GET https://api.maileon.com/1.0/reports/replies/count

Attributes

Parameter Default Description
from_date If provided, only the replies after or equal (including) the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds after January 1, 1970 00:00:00
to_date If provided, only the replies before (excluding) the given date will be returned./  The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00
mailing_id Multivalued parameter to filter the replies by mailings. Each value must correspond to a mailing id.
ids Multivalued parameter to filter the results by contacts. Each value must correspond to a contact id.
emails Multivalued parameter to filter the results by email addresses.
eids Multivalued parameter to filter the results by external ids. Each value must correspond to a contacts external id
type

Filter parameter that specifies the category of the event or message.
Possible values are:

  • unknown – Unclassified or unrecognized type

  • unsubscribe – Request to be removed from a mailing list

  • receipt_confirmation – Read or delivery receipt confirmation

  • out_of_office_vacation – Automatic out-of-office or vacation reply

  • spam – Spam complaint or spam-related message

exclude_anonymous_replies true Supported values: true / false. If set to true, the replies that cannot be mapped to contacts because of permission types or because unsubscriptions are omitted in the results
standard_field Multivalued parameter to query the value of a standard contact field.
custom_field Multivalued parameter to query the value of a custom contact field.
page_index 1 The index of the result page. The index must be greater or equal to 1.
page_size 100 The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Reply

Parameter Default Description
type

Possible values are:

  • unknown – Unclassified or unrecognized type

  • unsubscribe – Request to be removed from a mailing list

  • receipt_confirmation – Read or delivery receipt confirmation

  • out_of_office_vacation – Automatic out-of-office or vacation reply

  • spam – Spam complaint or spam-related message

Example

GET https://api.maileon.com/1.0/reports/replies
Authorization: Basic XXXXXXXXXXXXXXX
Accept: application/vnd.maileon.api+xml; charset=utf-8
Status: 200 OK
Content-Type: application/vnd.maileon.api+xml
Link: ...
X-Pages: ...
X-Items: ...
<replies>
    <reply>
        <contact>
            <id>12345</id>
            <email>max.mustermann@xqueue.com</email>
            <permissionStatus>available</permissionStatus>
            <permissionType>doi+</permissionType>
            <created>2014-02-10 17:08:10.0</created>
            <updated>2024-06-10 05:22:52.0</updated>
            <external_id nil="true"/>
            <standard_fields/>
            <custom_fields/>
        </contact>
        <timestamp>2023-12-19 12:51:11</timestamp>
        <mailing_id>12064</mailing_id>
        <msg_id nil="true"/>
        <type>out_of_office_vacation</type>
    </reply>
...
</replies>
Inhaltsverzeichnis