Consist Send Message API Documentation
Overview
A request to send a message is an API POST request to a URL with an arguments object. The request is sent to the GLASSIX servers.
Authorization
Please consult with the implementer at Consist or with the sales person to determine if permission is relevant.
Authorization works by passing a token in the request header as follows:
Authorization: Bearer <your_token>
You can use Postman for testing purposes and pass the token as shown above.
During the authorization process, the system will validate that the token matches the customer account. If it does not match, the system will respond with a "401: Unauthorized error".
Notes
- The messages you want to send must first be confirmed with the Consist support team at Consist.Glassix@glassix.support. Only after confirmation should the messages be sent.
- The approved message must be added to Prepared Responses in the Galaxy settings of that department.
- The department ID must be changed to the API key of the Glassix department to which you want to send the message.
- Ensure with the support team that the department has the option to send a non_ticket message.
Request Parameters
Mandatory parameters are highlighted in red. Selectable parameters are highlighted in orange.
| Parameter | Data Type | Explanation | Notes |
|---|---|---|---|
title | String | You must choose to use a body or a title. One of them is mandatory. | |
body | String | The message you confirmed with Consist's support team. | You must choose to use a body or title. |
from | String | The phone number from which the message is sent. | Starts with 972. |
to | String | The phone number to which the message is sent. | Starts with 972. |
protocolType | String | The type of protocol: SMS or WhatsApp. | One of them must be chosen. |
params | Array of Objects | Additional parameters. Example: [{"customerName": "Nati"}] | |
files | Array of Objects | A file you would like to send in the message. |
Example Request Body
{
"title": "Test Message",
"body": "Hello, this is a test message.",
"from": "972501234567",
"to": "972509876543",
"protocolType": "WhatsApp",
"params": [{ "customerName": "Nati" }],
"files": []
}
For any assistance or additional information, please reach out to the Consist support team at Consist.Glassix@glassix.support.