Ms Teams @ Mentions in adaptive cards

[vbvbvb]

There were already couple of posts with this  topic but without definitive answers.

According to recently published documentation: https://docs.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-format?t...

To include a mention in an Adaptive Card your app needs to include the following elements

• <at>username</at> in the supported adaptive card elements
• The mention object inside of an msteams property in the card content, which includes the Teams user id of the user being mentioned

And a bit vague code with following example how to add that:

"msteams": {
"entities": [
{
"type": "mention",
"text": "<at>John Doe</at>",
"mentioned": {
"id": "29:123124124124",
"name": "John Doe"
}

Many 3rd party websites are full with information about that ID value - some say it should be Teams user ID (or Azure AD orgID - same thing), but this example format doesn't look like this - i have tried various version with full OrdID,  without "-", etc ,even using pure JSON from this article example - all lead to Flow simply failing. 

It seems need to have very Teams specific context like that 'id':

"id": "29:1GcS4EyB_oSI8A88XmWBN7NJFyMqe3QGnJdgLfFGkJnVelzRGos0bPbpsfJjcbAD22bmKc4GMbrY2g4JDrrA8vM06X1-cHHle4zOE6U4ttcc",

"objectId": "9d3e08f9-a7ae-43aa-a4d3-de3f319a8a9c",

"givenName": "Larry",

"surname": "Brown",

"email": "Larry.Brown@fabrikam.com",

"userPrincipalName": "labrown@fabrikam.com"

Any idea how to retrieve that from the team? Some Graph query maybe?

Is there's anything else required for "Post your own adaptive card as Flow bot to a channel" to simply process this mentions ? And also, how to make it multi-user if this is possible?

[vbvbvb · Accepted solution]

Managed to self-resolve it , instead of trying to get that "29:" Teams ID bot ID context, using "8:orgid" instead:

"type": "mention",
"text": "<at>John Doe</at>",
"mentioned":
{
"id": "8:orgid:{org-ID-of-the-user}",
"name": "John Doe",
}

[alrez]

Hi,

Its great that you were able to solve your issue here. It looks like graph was doing some interesting transforming of the data which made it a little unintuitive. 

Regards,

Alex

-------

Community Support Team _ Alex Rezac
If this post helps, then please consider Accept it as the solution to help the other members find it more quickly.

[vbvbvb]

 I think main issue here that all @ metnions in adaptive cards documentation only says 29:xxxxxxxxxx ID in Bot Framework context. I posted GitHub query on that documentation page and got reply with screenshot saying that 29:xxxxx ID is obtainable via Bot Builder etc. But for Flow this is not very intuitive indeed to use that - would make so much sense to make <at> work like they do in the Flow bot messages without jumping via hoops of determining orgID etc.

For example, I want to have @ mentions in the adaptive card dynamically generated  - with <at>User1</at>,<at>User2</at>, etc it's quite simple to make Flow read this from SPO list for example, but when i need to make dynamically generated list of users to mention in form of string which looks like this: {"type":"mention","text":"<at>User1</at>","mentioned":{"id":"8:orgid:1234etc","name":"User1",}},{"type":"mention","text":"<at>User2</at>","mentioned":{"id":"8:orgid:5678etc","name":"User2",}}, - and then still have to match all these users with <at>User1</at>, <at>User 2</at> - it's is such overengineering to be honest..

[Anonymous]

Hey vbvbvb,

Could you help with an example on how to get the orgid and org-ID-of-the-user in your example?

"id": "8:orgid:{org-ID-of-the-user}"

Also, should I always use "8:" at the front?

Thanks!

[vbvbvb]

Hi @Anonymous ,

OrgID or objectID can be obtained via multiple ways - get Azure AD user, via Graph query , etc.  As example:

Get-ADUser -Identity user -Properties * > look for objectGUID

8:orgid: always has to be there, followed by user object ID (orgID), for example:

"id": "8:orgid:e1418d64-096c-4cb0-b903-ebb66562d99d"

I managed to automate that via Flow too via HTTP request to Azure AD action using Graph query :

https://graph.microsoft.com/v1.0/users?$filter=mail eq 'jon.doe@contoso.com'&$select=id

Output would be like this and you just have to use Pase JSON to get dynamic value for orgID to use (for example write to SPO list of something to use later in @metnions .

{

  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users(id)",

  "value": [

    {

      "id": "e1418d64-096c-4cb0-b903-ebb66562d99d"

    }

  ]

[Anonymous]

Hi vbvbvb,

Thanks for the quick response! I have tested it out in a simple card with just text and it seems to be working.

I'm having trouble integrating this into my actual adaptive card that looks abit like this below.

I read that the msteams entities part of the code should be placed after the $schema.

Could you help to take a look to see where it should be included?

{
    "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
    "type": "AdaptiveCard",
    "version": "1.0",
    "body": [
        {
            "type": "TextBlock",
            "text": "Mention_Test",
            "weight": "Bolder",
            "size": "Medium"
        },
        {
            "type": "ColumnSet",
            "columns": [
                {
                    "type": "Column",
                    "width": "stretch",
                    "items": [
                        {
                            "type": "TextBlock",
                            "spacing": "None",
                            "text": "Created 1234",
                            "isSubtle": true,
                            "wrap": true
                        }
                    ]
                }
            ]
        },
        {
            "type": "TextBlock",
            "text": "<at>testing</at>",
            "size": "Medium",
            "wrap": true
        },
    "msteams": {
      "entities": [
        {
          "type": "mention",
          "text": "<at>testing</at>",
          "mentioned": {
            "id": "8:orgid:baae7aa8-035a-zzzz-yyyy-xxxx",
            "name": "test123"
          }
        }
      ]
    }
  ]
}

[Expiscornovus]

Hi @Anonymous,

I think you need to correct two things in your json. Try and use version 1.2 of the schema. They added mentioned support in that one:

https://docs.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-format?tabs=adaptive-md%2Cconnector-html

Also the name of the user was different in the mentioned section. So I changed that too.

Here is a new code snippet:

{
    "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
    "type": "AdaptiveCard",
    "version": "1.2",
    "body": [
        {
            "type": "TextBlock",
            "id": "MentionTextBlock",
            "text": "Mention_Test",
            "weight": "Bolder",
            "size": "Medium"
        },
        {
            "type": "ColumnSet",
            "id": "MentionColumnSet",
            "columns": [
                {
                    "type": "Column",
                    "id": "MentionColumn",
                    "width": "stretch",
                    "items": [
                        {
                            "type": "TextBlock",
                            "id": "MentionTextBlock2",
                            "spacing": "None",
                            "text": "<at>Testing</at>",
                            "isSubtle": true,
                            "wrap": true
                        }
                    ]
                }
            ]
        }
    ],
    "msteams": {
        "entities": [
            {
                "type": "mention",
                "text": "<at>Testing</at>",
                "mentioned": {
                    "id": "8:orgid:yourid",
                    "name": "Testing"
                }
            }
        ]
    }
}

[AlexBal]

Is the OrgID constant for every user in a org?

[Expiscornovus]

Hi @AlexBal,

Like mentioned by @vbvbvb it's the user object ID. So it will be different for every user.

[vbvbvb]

Indeed, @AlexBal , it would be different for every user, but constant throughout  the tenant.  

[cdn4lf]

@vbvbvb 

I'm having a problem having a dynamic username for the mention.  Have you come up with a way to do this?  The solution I am using appears to break in Android, but works successfully everywhere else.

[vbvbvb]

@cdn4lf  works fine in Adaptive cards in Android and visually still in iOS, but using that method with OrgID slightly break card design and this bug is get worked on already. If in you case you just get blank card in Android when @ mentions are used, you have issue in card JSON. Try to reduce card code it to bare minimum, ensure you are using  adaptive card version 1.2+ etc.

[cdn4lf]

@vbvbvb here is the link to my other post /question. Would you be able to assist with correcting the issue?

https://powerusers.microsoft.com/t5/Building-Flows/Teams-Adaptive-Card-Mentions/m-p/650918#M87114

[vbvbvb]

I think you have to be sure that both mention TextBlock and msteams part have "Name, Surname" identical to that in 'name':

"items": [
                        {
                            "type": "TextBlock",
                            "id": "MentionTextBlock2",
                            "spacing": "None",
                            "isSubtle": true,
                            "wrap": true,
                            "text": "Dear <at>{$root.Name} {$root.Surname}</at>,"
                        }

"msteams": {
        "entities": [
            {
                "type": "mention",
                "text": "<at>{$root.Name} {$root.Surname}</at>",
                "mentioned": {
                    "id": "8:orgid:{$root.id}",
                    "name": "{$root.Name} {$root.Surname}"
                }
            }
        ]
    },

[cdn4lf]

@vbvbvb 

When I attempt to use your suggestion I get an invalid json error when attempting to launch the flow.

The request failed. Error code: 'MissingOrInvalidBotAdaptiveCardRequest'. Error Message: 'The specified Teams flowbot adaptive card request is missing or invalid. The tracking Id is '23fc4d80-7b06-4261-9073-0232d4c77de1'.'.

When I switch it back to <at>username</at>, everything works.  What it appears to be is that the Android version of Teams isn't reading the mention the same way, when part of an adaptive card, and is falling back to the static name of the mention instead of the dynamic code.

[vbvbvb]

Probably you would have to change the way how Name, Surname is populated. Can't you use HTTP to Azure AD query or Get O365 user action and use returned DisplayName value to use in mentions?

[cdn4lf]

@vbvbvb  I am using the 0365 connector to get the employee information from AD.  From there, I am get their unique ID as well as their display name/surname/given name.

The problem is that Android is falling back to the default text and not properly reading the information.  Apparently this could be due to issues with the developer preview.

From what I understand, the <at>name</at> is a placeholder and references the mention entity below.  The name within that mention entity is what is supposed to appear, but doesn't due to the issues with the developer preview.

Using the mention token called within Power Automate also doesn't work within the new card editor, as it simply passes the information then fails.

[Hellder]

Considering my complete lack of knowledge, I had a hard time using the orgid method. If it can be of any help, I added this to the adaptive card and it worked perfectly fine for what I needed.

{

  "type": "TextBlock",

  "text": "<at>youradress@mail.com</at>",

}

[ianwuk]

@Hellder Can you please share how you added that to your card and the complete syntax please?  I also want to achieve this.