命名空间：microsoft.graph
在指定的聊天中固定 聊天消息。 此 API 无法创建新聊天;必须使用 列表聊天 方法检索现有聊天的 ID，然后才能固定聊天消息。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
✅ |
✅ |
✅ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派（工作或学校帐户） |
ChatMessage.Send |
Chat.ReadWrite |
| 委派（个人 Microsoft 帐户） |
不支持。 |
不支持。 |
| 应用程序 |
Chat.ReadWrite.All |
不可用。 |
HTTP 请求
POST /chats/{chat-Id}/pinnedMessages
| 名称 |
说明 |
| Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type |
application/json. 必需。 |
请求正文
在请求正文中，提供要固定的聊天消息的 ID。
响应
如果成功，此方法在 201 Created 响应正文中返回响应代码和 pinnedChatMessageInfo 对象。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/pinnedMessages
Content-Type: application/json
Content-length: 63
{
"message@odata.bind":"https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new PinnedChatMessageInfo
{
AdditionalData = new Dictionary<string, object>
{
{
"message@odata.bind" , "https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832"
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Chats["{chat-id}"].PinnedMessages.PostAsync(requestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewPinnedChatMessageInfo()
additionalData := map[string]interface{}{
"message@odata.bind" : "https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832",
}
requestBody.SetAdditionalData(additionalData)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
pinnedMessages, err := graphClient.Chats().ByChatId("chat-id").PinnedMessages().Post(context.Background(), requestBody, nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
PinnedChatMessageInfo pinnedChatMessageInfo = new PinnedChatMessageInfo();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("message@odata.bind", "https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832");
pinnedChatMessageInfo.setAdditionalData(additionalData);
PinnedChatMessageInfo result = graphClient.chats().byChatId("{chat-id}").pinnedMessages().post(pinnedChatMessageInfo);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
const pinnedChatMessageInfo = {
'message@odata.bind':'https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832'
};
await client.api('/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/pinnedMessages')
.post(pinnedChatMessageInfo);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\PinnedChatMessageInfo;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new PinnedChatMessageInfo();
$additionalData = [
'message@odata.bind' => 'https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832',
];
$requestBody->setAdditionalData($additionalData);
$result = $graphServiceClient->chats()->byChatId('chat-id')->pinnedMessages()->post($requestBody)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
Import-Module Microsoft.Graph.Teams
$params = @{
"message@odata.bind" = "https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832"
}
New-MgChatPinnedMessage -ChatId $chatId -BodyParameter $params
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.pinned_chat_message_info import PinnedChatMessageInfo
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PinnedChatMessageInfo(
additional_data = {
"message@odata_bind" : "https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832",
}
)
result = await graph_client.chats.by_chat_id('chat-id').pinned_messages.post(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
注意：为了提高可读性，可能缩短了此处显示的响应对象。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.pinnedChatMessageInfo",
"id": "1616964509832"
}
相关内容