Get all messages

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/messages

Get information about messages as a list.

Query Params

count

integer

≥ 1

Defaults to 100

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.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

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.

sort_direction

string

Direction of sorting the response list.

customer_id

string

The unique ID of the customer.

contact

string

Email of phone number that was used as a contact in message.

communication_channel_id

string

The unique ID of the communication channel. List of values is available in resource GET /communication-channels.

send_time_from

string

Start date and time of the time interval. YYYY-MM-DD HH:MM:SS

send_time_to

string

End date and time of the time interval. YYYY-MM-DD HH:MM:SS

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

messages

array of objects

List of all messages.

messages

object

message_id

string

The unique ID of the message.

status

integer

The status ID of the message.
Possible values are: 0 - message was not send / 1 - message was send successfully / -1 - message was not received (it was returned) / -2 - message was not received (soft bounce) / 2 - an error occurred while sending / 4 - customer has no agreements (GDPR)

1 -1 -2 2 4

message_template_id

string

required

The unique ID of the message_template.

customer_id

string

required

The unique ID of the card holder.

contact

string

Email address or phone number of customer in case of send message to different contact than customer has in database.

title

string

Subject of the email message/ Title of notification message / Preview of the text message . Mandatory only in case of email template.

send_time

string

Date and time when message was send from server to recipient. (YYYY-MM-DD HH:MM:SS)

opened_time

string

Date and time when message was opened by recipient. (YYYY-MM-DD HH:MM:SS)

mail_client_user_agent

string

User agent of the mail client application where message was opened.

mail_client_language

string

Language of the mail client application where message was opened.

communication_channel_id

integer

required

The unique ID of the communication channel. Possible values are: 1 - email / 2- SMS / 4 - PUSH notification (Apple or Google)/ 5 - internal system notification

1 2 4 5

message_data

array of objects

Message data could contains array of customized parameters. They may have influence on message display or add values to message.

message_data

object

parameter_name

string

required

Name of the parameter.

value

string

required

Value of the parameter.

attachments

array of objects

List of the attachments for the message. A single attachment has a size limit of 1 MB. File type restrictions: .jpg, .jpeg, .png, .gif, and .pdf.

attachments

object

upload_method

string

required

Method how to upload attachment file.

url base64

file_data

string

required

File data to upload. It could URL address of the file or BASE64 encoded file.

cache_for

integer

CareCloud can cache the attachment for a certain amount of minutes. If the cache parameter is not set, the attachment is not cached, and it's deleted after the message is sent.

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

total_items

integer

The number of all found messages.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/messages?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
34
}
1
{
2
  "data": {
3
    "messages": [
4
      {
5
        "message_id": "8fd73167342d06899c4c015320",
6
        "status": 1,
7
        "message_template_id": "8bed991c68a470e7aaeffbf048",
8
        "customer_id": "8ea2591121e636086a4a9c0992",
9
        "contact": "happy_customer@crmcarecloud.com",
10
        "title": "Newsletter no. 30",
11
        "send_time": "2015-01-05 11:24:12",
12
        "opened_time": "2015-01-05 13:24:12",
13
        "mail_client_user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.11.0",
14
        "mail_client_language": "cs,sk;q=0.8,en-US;q=0.5,en;q=0.3",
15
        "communication_channel_id": 1,
16
        "message_data": [
17
          {
18
            "parameter_name": null,
19
            "value": null
20
          }
21
        ],
22
        "attachments": [
23
          {
24
            "upload_method": "url",
25
            "file_data": "https://upload.wikimedia.org/wikipedia/commons/c/ca/1x1.png",

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.