Get message metadata

Retrieve metadata for a specific message by its unique ID.

Request

POST: https://[Base URL](/platform-chat-api/base-url)/v4/channel-type/message/metadata/list

Rate limit: 100 requests per second.

Authentication: All server API requests require signature verification. See API request signing.

Request body

Content type: application/json

Parameter	Type	Required	Description
messageUID	String	Yes	Unique message ID. Obtainable via message routing.
page	Number	No	Page number. Returns up to 300 metadata entries per page by default.

Request example

HTTP

POST /v4/channel-type/message/metadata/list HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1585127132438
Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/json

{"messageUID":"BRGM-DEN2-01E4-BN66","page":1}

Response

Property	Type	Description
code	Number	Status code. 0 indicates success.
result.metadata	Object	Metadata content as JSON key-value pairs. Each value contains the metadata value and an updatedAt timestamp.

Response example

HTTP

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "code": 0,
    "result": {
        "metadata": {
            "status": {
                "value": "read",
                "updatedAt": 1742457600000
            }
        }
    }
}