- Webex Teams Api Login
- Webex Teams Api Python
- Webex Teams Api Testing
- Webex Personal Room Vs Meeting
- Webex Teams Api Rate Limit
- Webex Teams Api Python
- Webex Quick User Guide
Webex Teams enables continuous teamwork with video meetings, group messaging, file sharing, and white boarding. Always available. Cisco secure. With the Webex Teams connector, you can send and receive messages, manage files, and manage spaces and teams.
This connector is available in the following products and regions:
Webex-api-emulator: an Emulator for (some of) the Webex REST APIs. The primary goal of the emulator is to help facilitate the creation of Webex Teams (formerly Cisco Spark) chat bots. Can use either Webex Meetings OAuth or Webex Teams OAuth mechanisms. Postman collection - Webex Meetings XML API.json - import this Postman collection which contains select scripted API request samples. Webex environments. Full site - For full admin access and complete features, a production Webex instance is best. Some samples require site. Cisco Webex is a cloud-based platform for video conferencing, online meetings, and screen shares. Cisco Webex Teams is a cloud-based collaboration platform focused on team collaboration. Many of the Webex Team services was originally developed by the Cisco Sparks Team, which Cisco acquired a few years back.
- WebEx API - DevNet300-835 CLAUTOIn this video, I describe the process of building a web app on Cisco's WebEx API. I also talk about the design process and h.
- Teams are groups of people with a set of rooms that are visible to all members of that team. This API is used to manage the teams themselves. Teams are created and deleted with this API. You can also update a team to change its name, for example. To manage people in a team see the Team Memberships API. To manage team rooms see the Rooms API.
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions |
| Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet |
| Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet |
| Connector Metadata | |
|---|---|
| Publisher | Cisco |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add Member to Space | Add a member to an existing space |
| Add Member to Team | Add a member to a team |
| Create Space | Create space or team space |
| Get Message Details | Shows details for a message, by message ID. |
| Get Messages | Get a list of recent messages for a space |
| Get My Own Details | Lookup your own details |
| Get People | Lookup details and presence information for people in your organization |
| Get Space Details | Return details of a given space |
| Get Spaces List | This action retrieves a list of spaces |
| Send a Message | Send a message to webex teams |
Add Member to Space
Add a member to an existing space
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| isModerator | True | boolean | Is moderator? | |
Email | personEmail | string | Email address | |
| personId | string | Person ID of the new member | ||
Space | roomId | True | string | Select a space |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| created | date-time | created | |
id | id | string | id |
| isModerator | boolean | isModerator | |
isMonitor | isMonitor | boolean | isMonitor |
| personDisplayName | string | personDisplayName | |
personEmail | personEmail | string | personEmail |
| personId | string | personId | |
personOrgId | personOrgId | string | personOrgId |
| roomId | string | roomId |
Add Member to Team
Add a member to a team
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| isModerator | True | boolean | Is Moderator? | |
Email | personEmail | string | Email address | |
| personId | string | Person ID of the new member | ||
Team | teamId | True | string | Select a team |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| created | date-time | created | |
id | id | string | id |
| isModerator | boolean | isModerator | |
personDisplayName | personDisplayName | string | personDisplayName |
| personEmail | string | personEmail | |
personId | personId | string | personId |
| personOrgId | string | personOrgId | |
teamId | teamId | string | teamId |
Create Space
Create space or team space
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| teamId | string | Optionally select a team | ||
Title | title | True | string | Space Title |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| created | date-time | created | |
creatorId | creatorId | string | creatorId |
| id | string | id | |
isLocked | isLocked | boolean | isLocked |
| lastActivity | date-time | lastActivity | |
title | title | string | title |
| type | string | type |
Get Message Details
Shows details for a message, by message ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| messageId | True | string | The message ID |
Returns
Webex Teams Api Login
| Name | Path | Type | Description |
|---|---|---|---|
created | created | string | created |
| files | array of string | files | |
id | id | string | id |
| markdown | string | markdown | |
mentionedGroups | mentionedGroups | array of string | mentionedGroups |
| mentionedPeople | array of string | mentionedPeople | |
personEmail | personEmail | string | personEmail |
| personId | string | personId | |
roomId | roomId | string | roomId |
| roomType | string | roomType | |
text | text | string | text |
| toPersonEmail | string | toPersonEmail | |
toPersonId | toPersonId | string | toPersonId |
Get Messages
Webex Teams Api Python
Get a list of recent messages for a space
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| roomId | True | string | List messages in a space for a given space ID | |
Mentioned People | mentionedPeople | string | List messages where the caller is mentioned by specifying 'me' or the caller personId. | |
| beforeMessage | string | List messages sent before a message, by ID. | ||
Before | before | string | List messages sent before a date and time, in ISO8601 format. | |
| max | integer | Limit the maximum number of messages in the response. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
items | items | array of object | items |
| items.created | date-time | created | |
id | items.id | string | id |
| items.personEmail | string | personEmail | |
personId | items.personId | string | personId |
| items.roomId | string | roomId | |
roomType | items.roomType | string | roomType |
| items.text | string | text |
Get My Own Details
Lookup your own details
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| avatar | string | avatar | |
created | created | string | created |
| displayName | string | displayName | |
emails | emails | array of string | emails |
| firstName | string | firstName | |
id | id | string | id |
| lastActivity | string | lastActivity | |
lastName | lastName | string | lastName |
| nickName | string | nickName | |
orgId | orgId | string | orgId |
| phoneNumbers | array of object | phoneNumbers | |
type | phoneNumbers.type | string | type |
| phoneNumbers.value | string | value | |
status | status | string | status |
| type | string | type |
Get People
Lookup details and presence information for people in your organization
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| id | string | List people by ID. Accepts up to 85 person IDs separated by commas. | ||
Email | string | List people with this email address |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| items | array of object | items | |
avatar | items.avatar | string | avatar |
| items.created | string | created | |
displayName | items.displayName | string | displayName |
| items.emails | array of string | emails | |
firstName | items.firstName | string | firstName |
| items.id | string | id | |
lastActivity | items.lastActivity | string | lastActivity |
| items.lastName | string | lastName | |
nickName | items.nickName | string | nickName |
| items.orgId | string | orgId | |
phoneNumbers | items.phoneNumbers | array of object | phoneNumbers |
| items.phoneNumbers.type | string | type | |
value | items.phoneNumbers.value | string | value |
| items.status | string | status | |
type | items.type | string | type |
| notFoundIds | array of string | notFoundIds |
Get Space Details
Return details of a given space
Webex Teams Api Testing
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| roomId | True | string | Select a space |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
created | created | date-time | created |
| creatorId | string | creatorId | |
id | id | string | id |
| isLocked | boolean | isLocked | |
lastActivity | lastActivity | date-time | lastActivity |
| title | string | title | |
type | type | string | type |
Get Spaces List
This action retrieves a list of spaces
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| max | integer | Maximum number of spaces to return Tajima serial connection distance. | ||
Type of space | type | string | (group) only include group spaces, (direct) only include 1 to 1 spaces, returns all if not specified | |
| sortBy | string | (id) the space id, (lastactivity) the last activity timestamp, (created) space creation date |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
items | items | array of object | items |
| items.created | date-time | created | |
creatorId | items.creatorId | string | creatorId |
| items.id | string | id | |
isLocked | items.isLocked | boolean | isLocked |
| items.lastActivity | date-time | lastActivity | |
title | items.title | string | title |
| items.type | string | type |
Send a Message
Send a message to webex teams
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| files | string | Attach files to this message | ||
Text | markdown | string | Message, in markdown format | |
| roomId | string | Select a recipient space | ||
text | text | string | Message Text, in plain text, used for clients that do not support markdown | |
| toPersonEmail | string | The email address of the recipient when sending a private 1:1 message | ||
Person ID | toPersonId | string | The ID of the recipient when sending a 1:1 message |
Webex Personal Room Vs Meeting
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| created | date-time | created | |
id | id | string | id |
| personEmail | string | personEmail | |
personId | personId | string | personId |
| roomId | string | roomId | |
roomType | roomType | string | roomType |
| text | string | text | |
toPersonEmail | toPersonEmail | string | toPersonEmail |
Triggers
| When a membership is created | Someone joined a room that you're in or you've been added to a new room |
| When a membership is deleted | Someone left or was kicked out of a room that you're in, or you left or were removed from a room; only triggers for group rooms, not 1-to-1 rooms |
| When a membership is updated | Someone's membership was updated in a room that you're in; primarily used to detect moderator changes |
| When a message is created | New message posted into a room that you're in |
| When a message is deleted | A message was deleted from a room that you're in |
| When a space is created | A new space was created by you or one of your integrations |
| When a space is updated | A space that you're in was updated; primarily used to detect when a space becomes Locked or Unlocked |
When a membership is created
Someone joined a room that you're in or you've been added to a new room
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| data.created | string | created | |
| data.id | string | id | |
| data.isModerator | boolean | isModerator | |
isMonitor | data.isMonitor | boolean | isMonitor |
| data.personDisplayName | string | personDisplayName | |
personEmail | data.personEmail | string | personEmail |
| data.personId | string | personId | |
personOrgId | data.personOrgId | string | personOrgId |
| data.roomId | string | spaceId |
When a membership is deleted
Someone left or was kicked out of a room that you're in, or you left or were removed from a room; only triggers for group rooms, not 1-to-1 rooms
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| data.created | string | created | |
id | data.id | string | id |
| data.isModerator | boolean | isModerator | |
isMonitor | data.isMonitor | boolean | isMonitor |
| data.personDisplayName | string | personDisplayName | |
personEmail | data.personEmail | string | personEmail |
| data.personId | string | personId | |
personOrgId | data.personOrgId | string | personOrgId |
| data.roomId | string | spaceId |
When a membership is updated
Someone's membership was updated in a room that you're in; primarily used to detect moderator changes
Returns
Webex Teams Api Rate Limit
| Name | Path | Type | Description |
|---|---|---|---|
| data.created | string | created | |
id | data.id | string | id |
| data.isModerator | boolean | isModerator | |
isMonitor | data.isMonitor | boolean | isMonitor |
| data.personDisplayName | string | personDisplayName | |
personEmail | data.personEmail | string | personEmail |
| data.personId | string | personId | |
personOrgId | data.personOrgId | string | personOrgId |
| data.roomId | string | spaceId |
When a message is created
New message posted into a room that you're in
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| data.created | string | created | |
id | data.id | string | id |
| data.personEmail | string | personEmail | |
personId | data.personId | string | personId |
| data.roomId | string | spaceId |
When a message is deleted
A message was deleted from a room that you're in
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| data.created | string | created | |
id | data.id | string | id |
| data.personEmail | string | personEmail | |
personId | data.personId | string | personId |
| data.roomId | string | spaceId |
When a space is created
A new space was created by you or one of your integrations
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| data.created | string | created | |
creatorId | data.creatorId | string | creatorId |
| data.id | string | id | |
isLocked | data.isLocked | boolean | isLocked |
| data.lastActivity | string | lastActivity | |
teamId | data.teamId | string | teamId |
| data.title | string | title | |
type | data.type | string | type |
When a space is updated
Webex Teams Api Python
A space that you're in was updated; primarily used to detect when a space becomes Locked or Unlocked
Webex Quick User Guide
Returns
| Name | Path | Type | Description |
|---|---|---|---|
| data.created | string | created | |
creatorId | data.creatorId | string | creatorId |
| data.id | string | id | |
isLocked | data.isLocked | boolean | isLocked |
| data.lastActivity | string | lastActivity | |
teamId | data.teamId | string | teamId |
| data.title | string | title | |
type | data.type | string | type |
How do I get information on the Webex APIs?
What does API stand for?
Where can I find API documentation?
What is the API developer site?
API is an acronym for Application Programming Interface.
- For information on Webex Developer XML API, see: https://developer.cisco.com/site/webex-developer/develop-test/xml-api/overview/
- For information on Webex Developer URL API, see: https://developer.cisco.com/site/webex-developer/develop-test/url-api/overview/
- For information on Webex Developer REST API, see: https://developer.webex.com/docs/api/getting-started