Get all messages
Get information about messages as a list.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
The unique ID of the customer. GET /customers
Email of phone number that was used as a contact in message.
The unique ID of the communication channel. List of values is available in resource GET /communication-channels.
Start of the time interval for filtering by send time. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.
End of the time interval for filtering by send time. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"messages": [
{
"message_id": "8fd73167342d06899c4c015320",
"status": 1,
"message_template_id": "8bed991c68a470e7aaeffbf048",
"customer_id": "8ea2591121e636086a4a9c0992",
"contact": "happy_customer@crmcarecloud.com",
"title": "Newsletter no. 30",
"send_time": "2015-01-05 11:24:12",
"opened_time": "2015-01-05 13:24:12",
"mail_client_user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.11.0",
"mail_client_language": "cs,sk;q=0.8,en-US;q=0.5,en;q=0.3",
"communication_channel_id": 1,
"attachments": [
{
"upload_method": "url",
"file_data": "https://upload.wikimedia.org/wikipedia/commons/c/ca/1x1.png",
"cache_for": 20
}
],
"last_change": "2015-01-05 11:24:12"
}
],
"total_items": 1
}
}