Get MSTeams teams
GET/projects/{projectId}/entities/{entityId}/assistants/{assistantId}/msTeamsTeams
Base URL: https://api.tinkermode.com
Get a list of teams the assistant has joined. In MSTeams, there are teams and channels within each team. During installation to a team, users specify only the team, and our bot can be used in all channels of that team. This API returns all channels for each team. This endpoint is available only when the chatPlatform of the specified assistant is MSTeams.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain the key of a user or service account with permissions to read assistant instances, or a project API key.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
entityId | string | Yes | Entity ID (unique within project) | |
assistantId | integer | Yes | The unique ID for a specific assistant. |
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
team | string | No | You can filter by the id of the team if you want |
Responses
200 Successfully retrieved the list of rooms.
Content type: application/json
A Microsoft Teams team associated with an Assistant instance.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
channels | array<object> | Yes | |||||||||||||||||
| |||||||||||||||||||
id | string | Yes | read-only (server-generated) | The unique identifier for the Team. | |||||||||||||||
name | string | Yes | read-only (server-generated) | The name of the Team. | |||||||||||||||
401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 The client doesn't have the permission to access the specified assistant or the chatPlatform of the specified assistant is not MSTeams.
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |