Service Agent

Get list of talk messages that mention the calling agent

Changed on

Returns the talk messages in which the calling agent is mentioned, newest first. A mention is written in the message text as [@display name](mention:<agent-id>); the server records it when the message is created. Only messages created after this feature was deployed are listed; earlier messages are not indexed. Messages in chats the agent cannot access (a direct or group chat the agent is not a participant of), deleted messages and messages of deleted chats are not returned. The mention of the author by the author is not recorded, and at most 50 distinct agents are recorded for one message.

get/service_agents/talk_mentions

Request

Query parameters

page_sizeinteger
Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

Response

A list of talk messages that mention the calling agent.

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "owner_type": "agent",
      "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
      "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
      "parent_id": "a7b8c9d0-e1f2-3a4b-5c6d-7e8f9a0b1c2d",
      "type": "normal",
      "text": "Hello team, any updates on the project?",
      "medias": [
        {
          "type": "file",
          "address": {
            "type": "tel",
            "target": "+14155551234",
            "target_name": "John Smith",
            "name": "Main Office",
            "detail": "Primary contact number"
          },
          "agent_id": "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f",
          "file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "link_url": "https://example.com/document.pdf"
        }
      ],
      "metadata": {
        "reactions": [
          {
            "emoji": "👍",
            "owner_type": "agent",
            "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
            "tm_create": "2026-01-15T09:30:00.000000Z"
          }
        ]
      },
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-16T14:20:00.000000Z",
      "tm_delete": "2026-01-17T18:45:00.000000Z"
    }
  ]
}

Changes