POST

Chat.Messages

Return one message by id, or list messages for a customer.

Permissions

User must be logged in with a valid bearer token.
Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

Runs the Chat.Messages function and returns JSON.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
Send parameters as POST body fields exactly as documented.

Required Parameters

No body parameters are required for this function.

Optional Parameters

Name	Type	Sample	What it gives
`message_id` post	int	`3283713`	Message id for reading one message. You may also send id or email_id.
`customer_id` post	int	`123`	Customer id for listing customer messages. You may also send contactus_id or cust_id.
`page` post	int	`1`	Page number.
`limit` post	int	`25`	Optional caller-side max. Values above 25 are capped; backend currently returns 25 per page.
`sort` post	string	`date_desc`	Sort hint for the UI. Default order is newest message first.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Chat.Messages",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "message_id": "3283713"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Chat.Messages",
    "url_domain": "https:\/\/{domain}\/app\/Chat.Messages"
}

Endpoint

POST /app/Chat.Messages
POST https://{user}.bull36.com/app/Chat.Messages
POST https://{domain}/app/Chat.Messages

Sample Output

{
    "success": 1,
    "data": {
        "id": 3283713,
        "customer_id": 123,
        "message": "Hello"
    }
}

Count Only

Use the matching count route with the same filters when the UI only needs total rows for paging.

{
    "url": "\/app\/Chat.Messages",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Chat.Messages",
    "url_domain": "https:\/\/{domain}\/app\/Chat.Messages",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "message_id": "3283713"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "total": "Total messages in the conversation.",
        "count": "Messages returned in this page.",
        "total_pages": "Pages available at backend page size."
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('message_id', '3283713');

const res = await fetch('https://{domain}/app/Chat.Messages', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data.count);

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
// Fill body fields from the Sample Request JSON above.
const res = await fetch('/app/Chat.Messages', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Missing required parameter: message_id or customer_id"
}