Teams API Client

Teams has a number of areas that your application has access to via its API. These are all available via the app.api object. Here is a short summary of the different areas:

Area	Description
conversations	Gives your application the ability to perform activities on conversations (send, update, delete messages, etc.), or create conversations (like 1:1 chat with a user)
meetings	Gives your application access to meeting details and participant information via get_by_id and get_participant
teams	Gives your application access to team or channel details

An instance of the API client is passed to handlers that can be used to fetch details:

Example

In this example, we use the API client to fetch the members in a conversation. The api object is passed to the activity handler in this case.

@app.on_message
async def handle_message(ctx: ActivityContext[MessageActivity]):
    members = await ctx.api.conversations.members.get(ctx.activity.conversation.id)

Proactive API

It's also possible to access the API client from outside a handler via the app instance. Here we have the same example as above, but we're access the API client via the app instance.

members = await app.api.conversations.members.get("...")

Meetings Example

In this example, we use the API client to get a specific meeting participant's details, such as their role (e.g. Organizer) and whether they are currently in the meeting. Provide the user's AAD Object ID to specify which participant to look up. The meetingId and tenantId are available from the activity's channel data.

note

To retrieve all members of a meeting, use the conversations API as shown in the example above, since meetings are also conversations.

@app.on_activity("meetingStart")
async def handle_meeting_start(ctx: ActivityContext):
    meeting_id = ctx.activity.channel_data.meeting.id
    tenant_id = ctx.activity.channel_data.tenant.id
    user_id = ctx.activity.from_.aad_object_id

    if meeting_id and tenant_id and user_id:
        participant = await ctx.api.meetings.get_participant(meeting_id, user_id, tenant_id)
        # participant.meeting.role — "Organizer", "Presenter", "Attendee"
        # participant.meeting.in_meeting — True/False

Visit Meeting Events to learn more about meeting events.