Skip to main content

Get Chat

Retrieves detailed information about a specific Microsoft Teams chat by its ID.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If ContinueOnError property is true, no error is caught when the project is executed even if Catch node is used.

Input​

  • Client Id - The client ID from the Connect node. Optional if using direct credentials.
  • Chat Id - The unique identifier of the chat to retrieve (required).

Output​

  • Chat - Chat object containing:
    • Id - Unique identifier
    • Topic - Chat topic/title
    • ChatType - Type (oneOnOne, group, meeting)
    • CreatedDateTime - When chat was created
    • WebUrl - Link to chat in Teams
    • Additional chat metadata

Options​

  • Credentials - OAuth2 credentials JSON (optional if using Client ID). Allows direct authentication without Connect node.

Examples​

Get Chat Details​

Retrieve information about a specific chat:

chat_id = "19:meeting_abc123..."

// Get Chat node
// Output: chat object

console.log("Chat Topic: " + chat.Topic)
console.log("Type: " + chat.ChatType)
console.log("Created: " + chat.CreatedDateTime)
console.log("URL: " + chat.WebUrl)

Get Chat from List​

Find specific chat and get full details:

// List Chats node
chats = message.chats.value

// Find chat by topic
my_chat = chats.find(c =>
    c.Topic && c.Topic.includes("Project")
)

// Get full details
chat_id = my_chat.Id
// Get Chat node
chat = message.chat

Check Chat Type Before Messaging​

Verify chat type before sending message:

chat_id = "19:meeting_abc123..."

// Get Chat node
chat = message.chat

// Check if group chat
if (chat.ChatType === "group") {
    // Send Message node
    // Send to group chat
} else {
    // Handle one-on-one chat differently
}

Tips for Effective Use​

  • Verify chat type: Check ChatType before operations
  • Get participants: Use GetChatMembers for member list
  • Cache info: Store chat data to reduce API calls
  • Handle null topic: One-on-one chats may not have topic

Common Errors and Solutions​

"Chat Id cannot be empty"​

Cause: No chat ID provided.

Solution: Get chat ID from ListChats first.

Chat Not Found​

Cause: Chat doesn't exist or user doesn't have access.

Solution: Use ListChats to find valid chat IDs.