set_chat_photo()

Client.set_chat_photo()

Set a new chat photo or video (H.264/MPEG-4 AVC video, max 5 seconds).

The photo and video arguments are mutually exclusive. Pass either one as named argument (see examples below).

You must be an administrator in the chat for this to work and must have the appropriate admin rights.

Parameters

  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat.

  • photo (str | BinaryIO, optional) – New chat photo. You can pass a Photo file_id (in pair with a valid file_ref), a file path to upload a new photo from your local machine or a binary file-like object with its attribute “.name” set for in-memory uploads.

  • video (str | BinaryIO, optional) – New chat video. You can pass a Video file_id (in pair with a valid file_ref), a file path to upload a new video from your local machine or a binary file-like object with its attribute “.name” set for in-memory uploads.

  • file_ref (str, optional) – A valid file reference obtained by a recently fetched media message. To be used in combination with a file_id in case a file reference is needed.

Returns

bool – True on success.

Raises

ValueError – if a chat_id belongs to user.

Example

# Set chat photo using a local file
app.set_chat_photo(chat_id, photo="photo.jpg")

# Set chat photo using an exiting Photo file_id
app.set_chat_photo(chat_id, photo=photo.file_id, file_ref=photo.file_ref)


# Set chat video using a local file
app.set_chat_photo(chat_id, video="video.mp4")

# Set chat photo using an exiting Video file_id
app.set_chat_photo(chat_id, video=video.file_id, file_ref=video.file_ref)