TAtalkjs
Messages

List messages in a conversation

Lists messages in a specific conversation.

get/v1/{appId}/conversations/{conversationId}/messages

Request

Path parameters

appIdstring required
Example:abcd1234

A unique identifier of your TalkJS app. You can find your app ID on the Settings page of your dashboard.

conversationIdstring required
Example:0123456789abcdef

A unique identifier of a conversation.

Query parameters

startingAfterstring
Example:c10

An optional object ID that identifies a place in the record list, to allow you to paginate through a list of results.

By default, all records are sorted in descending order based on their createdAt property, which is a timestamp of a record's insertion date.

limitinteger
Example:25

An optional parameter to specify the number of results that should be returned.

Response

Messages listed successfully.

Example response

{
  "data": [
    {
      "id": "msg_123ABcdefghiJKlmNOpqRS",
      "type": "UserMessage",
      "origin": "web",
      "location": [
        51.44442681184582,
        5.4733118103642395
      ],
      "text": "Hi, how are you?",
      "custom": {
        "priority": "high"
      },
      "attachment": {
        "dimensions": {
          "height": 1125,
          "width": 516
        },
        "size": 51552,
        "url": "https://example.com/attachment.jpg"
      },
      "conversationId": "0123456789",
      "createdAt": 1697711905431,
      "senderId": "alice",
      "editedAt": 1629972494633,
      "referencedMessageId": "msg_012ABcdefghiJKlmNOpqRS",
      "readBy": [
        "zayneb"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.