Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

API Changelog

This page lists recent and upcoming changes to the Webex Teams API. Contact Webex Developer Support with any questions.

October 21, 2020

Warning
  • The List People API will soon enforce a maximum value for the max query parameter. Currently, requests made for more than 1000 events will return a varying number of results. After November 10, 2020, requesting more than 1000 people will return an HTTP 400 error.

October 13, 2020

New
  • The new Workspaces API will replace the Places API, which will be deprecated on March 31, 2021. In addition to what the Places API provided, the new Workspaces API allows developers to assign a type and a capacity for a workspace. For more information on workspaces, see the blog post Workspaces in Control Hub— What’s in it for you?.

October 5, 2020

Breaking Change
  • We are going to make changes to the file uploads via the /messages files attribute. File uploads, not using the multipart/form-data content type, must be specified with the correct file extensions. For example .jpg .doc etc. Files types will be cross checked against an allow list and we may refuse upload of certain file types with a 422 error. For the list of allowed file types please check the /messages API reference.

September 29, 2020

New
  • Users who interact with buttons and cards in a Space Widget will now see the buttons and cards rendered in the widget as well. Developers who write apps that send cards can now use the data URI to embed images directly into the body of the message request instead of specifying html url references.

    Read More

September 14, 2020

Warning
  • Admin users have the capability to filter the /people endpoint using the orgId to get a list of all users. The list response contains the user status for each person in the list. As a performance improvement, this user status will be removed from the default response. The info can be retrieved by using the query filter showAllTypes=true if the person's status information is required. Queries executed for specific users and queries done by regular users will not experience any change.

September 11, 2020

Warning
  • We may return a new status code 428 when trying to download files for users with Extended Security Pack when the files cannot be scanned for malware. The 428 code indicates that the file is unscannable, which is often true for encrypted files. API users will be able to force a file download with the parameter allow=unscannable.

September 11, 2020

Warning
  • We are making changes to the markdown rendering mechanism for improved performance and extensibility. While we have tested the most common scenarios users may experience differences in how their markup is shown in spaces after the rollout. If you experience such issues, please contact support at devsupport@cisco.com or join the #webex4devs space for support.

September 10, 2020

New
  • Our initial release of the RESTful meetings APIs were focused primarily on scheduling, and the List Meetings API responded only with scheduled meetings objects, or meetings that have a meetingType of meetingSeries or scheduledMeeting. Theses APIs will now also return meeting objects that have a meetingType of meeting, which represents an instance of a meeting that is happening or has happened in the past. When using the state query parameter on the List Meetings API, you may now use the states inProgress, ended, missed, or expired in addition to the previously working values active, and scheduled.

    This will allow developers to create apps that discover meetings that have happened, meetings that have been missed, etc.

    The /recordings will now accept a meetingId as a search parameter allowing developers to access the recording for a meeting that has ended.

September 10, 2020

Major
  • We introduced a new message updated event, covering when a message in a space is edited. Previously, message edits showed as message creation events with an updated timestamp field. To make it easier for developers and CASB vendors to identify messages updated, the right event type - "updated" - is now used. Previous message edits will not be reclassified, i.e. the "updated" field will be present for messages from September 10th forward.

September 4, 2020

New

August 10, 2020

New
  • Memberships now includes a roomType response property, which specifies the type of space (direct 1:1 or group) the membership is associated with.

August 10, 2020

New
  • You can now update the visibility of direct 1:1 spaces in the Webex Teams clients via the API. Memberships now includes the isRoomHidden parameter to specify whether a 1:1 space is hidden or visible in the clients. To change the visibility of a 1:1 space, use the Update a Membership endpoint. Compliance officers can update the visibility of memberships for any user in an organization.

August 4, 2020

Major
  • The List Events API will soon enforce a maximum value for the max query parameter. Currently, requests made for more than 1000 events will return a varying number of results. After August 17, 2020, requesting more than 1000 events will return an HTTP 400 error.

August 4, 2020

Major
  • The List Rooms API will soon enforce a maximum value for the max query parameter. Currently, requests made for more than 1000 rooms (spaces) will return a varying number of results. After September 4, 2020, requesting more than 1000 rooms will return an HTTP 400 error.

June 16, 2020

New
  • You can now use Webex Calling call control features with a new API: Call Controls. For more information about working with Webex Calling calls, see the Webex Calling Guide.

June 12, 2020

New
  • The Licenses API now provides more information about Webex Meetings licenses, including the site URL, subscription ID, and site link status.

May 28, 2020

New

May 20, 2020

New

May 12, 2020

New
  • The Webex REST API has a new host name: webexapis.com. The new host name works just like the old one. All API resources and endpoints from api.ciscospark.com are now available at the new host name. Read more about the change in our blog: Introducing the new webexapis.com.

April 27, 2020

New
  • The Rooms API now includes an ownerId response property, which provides the ID of the organization which owns the room. For more information about room ownership, see Webex Teams Data in the Compliance Guide.

February 14, 2020

New

December 10, 2019

New

October 21, 2019

New
  • Webex Devices and Places may now be managed via two new API endpoints: Devices and Places. For more information about working with devices and places, see the xAPI Guide.

October 21, 2019

New
  • You can now use the xAPI to programmatically invoke commands on and query the status of devices that run Webex RoomOS software. Check out the xAPI Guide and xAPI API Reference to get started.

October 1, 2019

New
  • Full administrators for an organization can now list Webex Control Hub Admin Audit Events. See this article for more information about the types of events that are available.

August 6, 2019

New
  • Your apps can now provide a web-like user interface with actionable buttons, input text boxes, dropdowns, checkboxes, images, and more right within Webex Teams spaces by including Cards when creating a message. Check out the announcement on the blog to learn more.

July 19, 2019

Major
  • The sipAddress property currently returned via the Get Room Details endpoint is now deprecated. After September 30, 2019, this property will no longer return the SIP address for the space. Instead, use the Get Room Meeting Details endpoint to retrieve the space's SIP address along with more detailed meeting information such as PSTN numbers and the meeting URL.

June 13, 2019

New
  • You can now retrieve extended meeting details for a space (room). Use the new Get Room Meeting Details action to see the meeting details for the space such as the SIP address, Webex Meetings URL, and PSTN dial-in numbers.

May 2, 2019

New
  • People now includes additional status values: "call", "meeting", and "presenting". See this article for more information about the different status options in Webex Teams.

May 1, 2019

April 11, 2019

  • Memberships will soon include two new response properties: roomType, which will specify the type of space (direct 1:1 or group) the membership is associated with, and isRoomHidden, which will specify whether or not a 1:1 space is hidden in the Webex Teams clients for the participant.

March 15, 2019

Breaking Change
  • Beginning April 27, 2019, the Webex platform will require that API clients use the Transport Layer Security (TLS) 1.2 protocol. To align with industry best practices for transport security, the TLS 1.1 encryption protocol will be disabled on all endpoints. See this blog post for more information.

January 30, 2019

New
  • The People API now includes a phoneNumbers response property, which will provide the phone numbers associated with the person. This read-only property will only be returned for people within the same organization.

December 20, 2018

  • Currently, compliance officers can only see membership Events for spaces owned by their organization. Soon, compliance officers will have access to membership events for all spaces which include members of their organization, regardless of the space's owner.

December 19, 2018

New
  • Compliance officers can now delete messages in 1:1 spaces that were sent by an external user. Previously, messages in 1:1 spaces from an external user could only be monitored.

December 18, 2018

New
  • You can now retrieve messages in a 1:1 space without first knowing the roomId of the conversation. Use the new List Direct Messages action with the other party's person ID or email to retrieve messages from the 1:1 space.

September 18, 2018

New
  • A new type of application is now available! Guest Issuer apps may now be created to let guest users collaborate with your organization’s paid users. See our Guest Issuer documentation for more information about Guest Issuer apps.

September 6, 2018

Warning
  • The Memberships API will no longer return memberships and will instead return a 404 Not Found for team spaces (rooms) which are archived.

September 5, 2018

New

August 30, 2018

  • The People API will soon include a new phoneNumbers field, which will provide the phone numbers associated with the person. This read-only field will be returned for people within the same organization.

July 31, 2018

New
  • Group mentions in messages are now included in Messages API response details. A new response parameter, mentionedGroups, will be present if a group is @mentioned in a message.

July 31, 2018

New

July 20, 2018

  • The Messages API will soon accept group mentions, such as @all, when creating new messages. Check back for more information within the coming weeks.

July 5, 2018

New
  • The Messages API no longer rejects new messages which contain an @mention for an email address that is not associated with a Webex Teams user. The message will contain the display name, if provided, or the email address in plain text instead of the @mention.

June 15, 2018

  • Two new roles will soon be available via the Roles API: User Admin and Device Admin. These roles may be assigned or unassigned to users with the People API.

June 15, 2018

Warning
  • The Messages API currently accepts values for both the text and markdown parameters when sending a message. After July 15, 2018, this API will return an error if a new message contains values for both parameters. Use only one parameter for the message body. Markdown content will be automatically transformed to plain-text for API clients which support only plain-text messages.

June 15, 2018

Major
  • The following scopes have been deprecated and will no longer work after August 15, 2018: spark-admin:events_read, spark-admin:memberships_read, spark-admin:memberships_write, spark-admin:messages_read, spark-admin:messages_write, spark-admin:rooms_read, spark-admin:teams_read, spark-admin:team_memberships_read, and spark-admin:team_memberships_write. They are no longer available for testing via Test Mode in the Webex Teams API Reference, or with your portal token, if you are an Organization Administrator. These scopes have been replaced by spark-compliance scopes for use by designated Compliance Officers. See this guide for more information about compliance scopes.

April 16, 2018

Warning
  • The Messages API currently accepts @mentions in 1:1 messages. After May 26, 2018, this API will return an error if a message sent to a 1:1 space contains an @mention.

April 10, 2018

New
  • All licenses for Hybrid Services which are available for an organization, both enabled and disabled, will now be returned via the Licenses API. Hybrid Services licenses may now be assigned to users before a particular service is activated.

February 8, 2018

Breaking Change
  • Beginning March 17, 2018, the Cisco Spark platform will require API clients to use TLS 1.1 or higher. The TLS 1.0 encryption protocol will be disabled on all endpoints to align with industry best practices for transport security. See this blog post for more information.