Skip to main content

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:

AreaDescription
conversationsGives your application the ability to perform activities on conversations (send, update, delete messages, etc.), or create conversations (like 1:1 chat with a user)
meetingsGives your application access to meeting details
teamsGives 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("...")