Messages

Available methods

All available methods for resource Message.

HTTP method	Endpoint	Description
[badge-blue GET]	/messages	Get information about all messages
[badge-blue GET]	/messages/{message_id}	Get information about an message

Actions

Action methods for send message to customer.

HTTP method	Endpoint	Description
[badge-green POST]	/messages/actions/send-message	Send message to an customer.

Get all messages

Get information about messages as a list.
[badge-blue GET] /messages

Query string

Parameter name	Type	Description	Mandatory (Yes/No)
count	integer	The number of records to return. Default value is 100.	No
offset	integer	The number of records from a collection to skip. Default value is 0.	No
sort_field	string	One of the query string parameters for sorting. Response is sorted by the specified field.	No
sort_direction	string	Direction of sorting the response list. Possible values are: ASC / DESC	No
customer_id	string	The unique ID of the customer	No
contact	string	Email of phone number that was used as a contact in message	No
communication_channel_id	string	The unique id of the communication channel. Possible values are: 1 - email / 2- SMS / 4 - PUSH notification (Apple or Google)/ 5 - internal system notification	No
send_time_from	string	Start date and time of the time interval YYYY-MM-DD HH:MM:SS	No
send_time_to	string	End date and time of the time interval YYYY-MM-DD HH:MM:SS	No

Response

Parameter name	Type	Description
messages	Message[]	List of all messages
total_items	integer	Count of all found messages

Get an message

Get information about a specific message
[badge-blue GET] /messages/{message_id}

Path parameters

Parameter name	Type	Description
message_id	string	The unique id of the message

Response

Send message

Send message (email, SMS or PUSH notification) to customer
[badge-green POST] /messages/actions/send-message

Request

Parameter name	Type	Description	Mandatory (Yes/No)
message	Message	Message that will be send to customer	Yes

Response