List channel messages

GET

https://cessy.ai/api/rest/tenant-id/app-id/channels/:channelId/messages

GET

/api/rest/tenant-id/app-id/channels/:channelId/messages

1 const url = 'https://cessy.ai/api/rest/tenant-id/app-id/channels/channelId/messages';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "messages": [
3     {
4       "id": "msg_8f3a2b7c",
5       "senderId": "user_12345",
6       "content": "Hey team, the deployment is scheduled for 3 PM today.",
7       "timestamp": "2024-06-10T14:45:00Z",
8       "attachments": [
9         {
10           "type": "image",
11           "url": "https://cdn.example.com/images/deployment-plan.png"
12         }
13       ],
14       "readBy": [
15         "user_12345",
16         "user_67890"
17       ]
18     }
19   ],
20   "hasMore": true,
21   "expired": true
22 }

Authentication

AuthorizationBearer

Tenant/app API key or OAuth/JWT bearer token.

Path parameters

channelIdstringRequired

Channel id.

Headers

X-CES-Workspace-IDstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"

Optional Workspace runtime selector header. If supplied with workspaceId, both values must match.

Query parameters

agentIdstringOptional

Optional agent participant id filter within this app.

limitintegerOptional1-200Defaults to 50

Maximum number of messages to return.

beforestringOptional

Exclusive message id cursor for backward pagination.

workspaceIdstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"

Optional Workspace runtime selector for preview or validation calls. If supplied with X-CES-Workspace-ID, both values must match.

Response

Channel message page

messageslist of maps from strings to any

hasMoreboolean

expiredboolean

True when the before cursor was too old to serve precisely.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error