Show / Hide Table of Contents

Chat.ReadWrite

Allows an app to read and write 1 on 1 or group chats threads, on behalf of the signed-in user.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
Beta D DELETE /chats/{chat-id}/pinnedMessages/{pinnedChatMessageInfoId}
V1 D GET /chats
V1 D GET /chats/{chat-id}
V1 D GET /chats/{chat-id}/members
V1 D GET /chats/{chat-id}/members/{membership-id}
V1 D GET /chats/{chat-id}/messages
Beta D GET /chats/{chat-id}/operations
Beta D GET /chats/{chat-id}/operations/{operation-id}
Beta D GET /chats/{chat-id}/pinnedMessages
V1 D GET /chats/{id}/members
V1 D GET /chats/{id}/members/{id}
V1 D GET /me/chats
V1 D GET /me/chats/{chat-id}
V1 D GET /me/chats/{chat-id}/messages
V1 D GET /teams/{id}/channels/{id}/members/{id}
V1 D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}
V1 D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/hostedContents
V1 D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/hostedContents/{hosted-content-id}
V1 D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies/{reply-id}
V1 D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies/{reply-id}/hostedContents
V1 D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies/{reply-id}/hostedContents/{hosted-content-id}
V1 D GET /users/{user-id | user-principal-name}/chats
V1 D GET /users/{user-id | user-principal-name}/chats/{chat-id}
V1 D GET /users/{user-id | user-principal-name}/chats/{chat-id}/members
Beta D GET /users/{user-id | user-principal-name}/chats/{chat-id}/members/{membership-id}
V1 D GET /users/{user-id | user-principal-name}/chats/{chat-id}/messages
V1 D GET /users/{user-id} | user-principal-name/chats/{chat-id}/members/{membership-id}
V1 D PATCH /chats/{chat-id}
V1 D POST /chats
Beta D POST /chats/{chat-id}/markChatReadForUser
Beta D POST /chats/{chat-id}/markChatUnreadForUser
V1 D POST /chats/{chat-id}/members
V1 D POST /chats/{chat-id}/messages
Beta D POST /chats/{chat-Id}/pinnedMessages
Beta D POST /chats/{chatsId}/hideForUser
Beta D POST /chats/{chatsId}/unhideForUser
V1 D POST /teams/{team-id}/channels/{channel-id}/messages

Delegate Permission

Id 9ff7295e-131b-4d94-90e1-69fde507ac11
Consent Type User
Display String Read and write user chat messages
Description Allows an app to read and write 1 on 1 or group chats threads, on behalf of the signed-in user.

Resources

channel

Property Type Description
description String Optional textual description for the channel.
displayName String Channel name as it will appear to the user in Microsoft Teams.
id String The channel's unique identifier. Read-only.
isFavoriteByDefault Boolean Indicates whether the channel should automatically be marked 'favorite' for all members of the team. Can only be set programmatically with Create team. Default: false.
email String The email address for sending messages to the channel. Read-only.
webUrl String A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.
membershipType channelMembershipType The type of the channel. Can be set during creation and can't be changed. Possible values are: standard - Channel inherits the list of members of the parent team; private - Channel can have members that are a subset of all the members on the parent team.
createdDateTime dateTimeOffset Read only. Timestamp at which the channel was created.

chat

Property Type Description
chatType chatType Specifies the type of chat. Possible values are: group, oneOnOne, meeting, unknownFutureValue.
createdDateTime dateTimeOffset Date and time at which the chat was created. Read-only.
id String The chat's unique identifier. Read-only.
lastUpdatedDateTime dateTimeOffset Date and time at which the chat was renamed or list of members were last changed. Read-only.
onlineMeetingInfo teamworkOnlineMeetingInfo Represents details about an online meeting. If the chat isn't associated with an online meeting, the property is empty. Read-only.
tenantId String The identifier of the tenant in which the chat was created. Read-only.
topic String (Optional) Subject or topic for the chat. Only available for group chats.
webUrl String The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.

chatMessage

Property Type Description
id String Read-only. Unique ID of the message.
replyToId string Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)
from chatMessageFromIdentitySet Details of the sender of the chat message. Can only be set during migration.
etag string Read-only. Version number of the chat message.
messageType chatMessageType The type of chat message. The possible values are: message, chatEvent, typing, unknownFutureValue, systemEventMessage. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: systemEventMessage.
createdDateTime dateTimeOffset Timestamp of when the chat message was created.
lastModifiedDateTime dateTimeOffset Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
lastEditedDateTime dateTimeOffset Read only. Timestamp when edits to the chat message were made. Triggers an "Edited" flag in the Teams UI. If no edits are made the value is null.
deletedDateTime dateTimeOffset Read only. Timestamp at which the chat message was deleted, or null if not deleted.
subject string The subject of the chat message, in plaintext.
body itemBody Plaintext/HTML representation of the content of the chat message. Representation is specified by the contentType inside the body. The content is always in HTML if the chat message contains a chatMessageMention.
summary string Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
attachments chatMessageAttachment collection References to attached objects like files, tabs, meetings etc.
mentions chatMessageMention collection List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.
importance string The importance of the chat message. The possible values are: normal, high, urgent.
reactions chatMessageReaction collection Reactions for this chat message (for example, Like).
locale string Locale of the chat message set by the client. Always set to en-us.
policyViolation chatMessagePolicyViolation Defines the properties of a policy violation set by a data loss prevention (DLP) application.
chatId string If the message was sent in a chat, represents the identity of the chat.
channelIdentity channelIdentity If the message was sent in a channel, represents identity of the channel.
webUrl string Read-only. Link to the message in Microsoft Teams.
eventDetail eventMessageDetail Read-only. If present, represents details of an event that happened in a **c

chatMessageHostedContent

Property Type Description
id String Read-only. Represents the chat message hosted content identifier.
contentBytes Edm.Binary Write-only. When posting new chat message hosted content, represents the bytes of the payload. These are represented as a base64Encoded string.
contentType String Write-only. When posting new chat message hosted content, represents the type of content, such as image/png.

conversationMember

Property Type Description
id String Read-only. Unique ID of the user.
displayName string The display name of the user.
roles string collection The roles for that user.
visibleHistoryStartDateTime DateTimeOffset The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.

pinnedChatMessageInfo

Property Type Description
id String The ID of the chatMessage. Read-only.

team

Property Type Description
displayName string The name of the team.
description string An optional description for the team. Maximum length: 1024 characters.
classification string An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory.
specialization teamSpecialization Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case.
visibility teamVisibilityType The visibility of the group and team. Defaults to Public.
funSettings teamFunSettings Settings to configure use of Giphy, memes, and stickers in the team.
guestSettings teamGuestSettings Settings to configure whether guests can create, update, or delete channels in the team.
internalId string A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.
isArchived Boolean Whether this team is in read-only mode.
memberSettings teamMemberSettings Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team.
messagingSettings teamMessagingSettings Settings to configure messaging and mentions in the team.
webUrl string (readonly) A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.
createdDateTime dateTimeOffset Timestamp at which the team was created.

teamsApp

Property Type Description
id string The catalog app's generated app ID (different from the developer-provided ID in the Microsoft Teams zip app package.
externalId string The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
displayName string The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
distributionMethod teamsAppDistributionMethod The method of distribution for the app. Read-only.

teamsAsyncOperation

Property Type Description
id string Unique operation id.
operationType teamsAsyncOperationType Denotes which type of operation is being described.
createdDateTime DateTimeOffset Time when the operation was created.
status teamsAsyncOperationStatus Operation status.
lastActionDateTime DateTimeOffset Time when the async operation was last updated.
attemptsCount Int32 Number of times the operation was attempted before being marked successful or failed.
targetResourceId guid The ID of the object that's created or modified as result of this async operation, typically a team.
targetResourceLocation string The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths.
error operationError Any error that causes the async operation to fail.

teamworkUserIdentity

Property Type Description
displayName String Inherited from identity. Display name of the user. Optional.
id String Inherited from identity. ID of the user.
userIdentityType teamworkUserIdentityType Type of user. Possible values are: aadUser, onPremiseAadUser, anonymousGuest, federatedUser, personalMicrosoftAccountUser, skypeUser, phoneUser, unknownFutureValue and emailUser.

webhooks

In This Article
Back to top Created by merill | Submit feedback