What is Messaging

Use the Messaging module to send, retrieve, and manage messages and conversations within the Scalar Messaging Platform. Messages support text and files (image and pdf).


Base URL	https://messaging.api.eu1.scalar.zf.com
Audience	Integrators from customer organizations
Supported Versions	V1

Why use Messaging

Messaging APIs are used by an integrator of an organization for sending, retrieving, and managing conversations and messages within the Scalar Messaging Platform. This includes support for text and file-based messaging using multipart/form-data.

Use Cases

Use case I: Get contact list

Using this API, an integrator can retrieve the complete contact list for his organization .

Use case II: Get all conversations

Using this API, an integrator can retrieve all the existing conversations listed in his organization.

Use case III: Conversation messages

This API returns messages from multiple conversations with optional filtering by conversation IDs, time range, and chat type. Org-scoped endpoint supporting up to 100 conversations per request. Supports cursor-based pagination for efficient message retrieval. This API can be used by an integrator to:

Retrieve messages and their statuses from an organization for a conversation.
Retrieve messages and their statuses within a selected interval for a conversation.

Use case IV: Get attachment details

This API returns the actual attachment type and attachment file from a message id that an integrator requests from any conversation. The integrator can use this for any document management system integrator as per his organization’s need.

Use case V: Send messages

SCALAR enables you to send messages or replies to an existing message (text, image, or pdf) to in an existing conversation via an Integrator service. The integrator will send these messages on behalf of a user from customer’s organization to meet any of their business case such as .

Backoffice to Backoffice user communication
Backoffice to Driver communication
Sending documents from a 3rd party doc management system via our messaging platform
Sending schedules to driver by integrating scheduler with messaging Note: This API is to be used for backoffice users primarily and not for drivers.
Integrator needs to pass sender Id, recipient id and message information he is intending to share via this API.

Use case VI: Get participants only from a group conversation

Retrieve the list of people in a group chat. This is only for group conversations, since one‑to‑one chats already show both participants. This endpoint is specifically designed for group conversations that can have many participants requiring pagination. This feature is available only with SCALAR PRO package.

Use case VII: Mark a message as seen/read

Mark a message as ‘read’ for a specific person, just like when someone opens a message in a chat app. The system updates the message’s status automatically.

Use case VIII: Mark a message as treated

Mark a message as delivered and handled by the person who received it. It works only if group chat is turned on for your organization.