VOvoipbin
Service Agent

Get a list of the pins of the calling agent

Changed on

Returns the chats and messages that the calling agent has pinned, newest first. Only the agent's own pins are returned. A pin is listed only while the agent can still see its target: the chat is not deleted, and in a direct or group chat the agent is still a participant (the pin reappears when the agent joins again). A pinned message that was deleted is not listed. A pin of a message carries the pinned message in message in this list; the responses of POST and DELETE do not include it.

get/service_agents/talk_pins

Request

Query parameters

target_type'chat' | 'message'

What a pin points to.

Example:message

Return only the pins of this target type.

chat_idstring uuid
Example:9a2b5c7d-1e3f-4a6b-8c9d-0e1f2a3b4c5d

Return only the pins of this chat (the pinned chat itself and the pinned messages of the chat). The ID is returned from GET /service_agents/talk_chats.

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 the pins of 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": "6f1c1a52-8d3b-4c1e-9a5e-0b7f2d9a1c10",
      "target_type": "message",
      "target_id": "0d4b7a3e-2f5c-4b8e-8a21-9c3e6f1d7a42",
      "chat_id": "9a2b5c7d-1e3f-4a6b-8c9d-0e1f2a3b4c5d",
      "message": {
        "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"
      },
      "tm_create": "2026-11-02T09:15:30.123456Z"
    }
  ]
}

Changes