chats

Get chat by link

Changed on

Returns chat/channel information by its public link or dialog with user by username

get/chats/{chatLink}

Request

  • Base URL
    https://botapi.tamtam.chat
  • URL
    https://botapi.tamtam.chat/chats/{chatLink}
  • Auth
    API key in query parameter access_token

Path parameters

chatLinkstring required

Public chat link or username

Response

Chat information

chat_idinteger required

Chats identifier

type'dialog' | 'chat' | 'channel' required

Type of chat. Dialog (one-on-one), chat or channel

status'active' | 'removed' | 'left' | 'closed' | 'suspended' required

Chat status for current bot

titlestring nullable required

Visible title of chat. Can be null for dialogs

last_event_timeinteger required

Time of last event occurred in chat

participants_countinteger required

Number of people in chat. Always 2 for dialog chat type

owner_idinteger nullable

Identifier of chat owner. Visible only for chat admins

participantsobject nullable

Participants in chat with time of last activity. Can be null when you request list of chats. Visible for chat admins only

is_publicboolean required

Is current chat publicly available. Always false for dialogs

linkstring nullable

Link on chat

descriptionstring nullable required

Chat description

messages_countinteger nullable

Messages count in chat. Only for group chats and channels. Not available for dialogs

chat_message_idstring nullable

Identifier of message that contains chat button initialized chat

Changes

    • info

      added highlighted discriminator mapping keys to the /////////// response property for the response status

    • info

      added highlighted discriminator mapping keys to the //////////////// response property for the response status

    • info

      removed code discriminator mapping keys from the /////////// response property for the response status

    • info

      removed code discriminator mapping keys from the //////////////// response property for the response status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property /////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status