[go: up one dir, main page]

Skip to content
Kesava Krishnan Madavan edited this page May 29, 2024 · 38 revisions

Theme=Light, Style=Color, By Cisco=True, Orientation=Horizontal

Introduction to Webex SDK

The Webex Web SDK is a toolkit that consists of a series of JavaScript libraries. It's designed to help developers integrate Webex features such as messaging, calls, and meetings into their own web applications or websites. The SDK acts as an intermediary, interacting seamlessly with Webex backend services, while providing developers with intuitive interfaces to integrate into their applications.

Messaging

Imagine being able to send and receive messages in both one-on-one chats and group spaces. With the Webex Web SDK, you can. Plus, you can create new spaces, add or remove people from these spaces, and even incorporate markdown in your messages to better format and highlight your text.

Ready to set up a personalized messaging platform inside your app? Our Messaging document is your map, guiding you through all the APIs and details you need to know!

Calling

The SDK takes communication a step further by enabling you to initiate and receive both audio and video calls. It's not just about starting and ending calls. You have control over a range of features including dialing, answering, hanging up, holding, and resuming calls. For a more interactive experience, you can also share your screen and record calls.

Feel free to explore the calling features by rolling up your sleeves and getting hands-on with our Kitchen Sink app. It's your playground to discover and learn!

Here's a Vidcast that can help you get started with our Kitchen Sink app.

Looking to dive into the nitty-gritty of all our available APIs? Just hop over to our Web Calling SDK!

Meetings

The SDK brings the power of Webex meetings to your application. You can start, and join Webex meetings directly from your app. But it goes beyond just facilitating meetings. You can manage participants in your meetings, share your screen for a more collaborative experience, connect to the Cisco Collab Devices such as DX80 or Desk Pro, and even record your meetings to refer back to later or share with those who couldn't attend.

Ready to dive in and explore the world of meetings? Our Meeting Kitchen Sink app is the perfect playground for you! It's designed to help you learn how to build a fully functional app. So go ahead, give it a whirl, and discover all the amazing features it has to offer!

Looking for detailed information? Look no further! Just click here and dive into our comprehensive guide!

Teams, People, Rooms, Membership

With the Webex Web SDK, managing teams becomes a breeze. A team here refers to groups of people across multiple spaces. You can control various aspects of these spaces, from the messages and files within them to the people that make up the team. You can also create, update, and delete rooms, and manage room memberships with ease.

Details of all the APIs for these features can be found under the Messaging document.

Webhooks

The SDK also supports webhooks. Webhooks are a powerful tool that allows your app to receive real-time notifications when a user's data changes. You can create, list, update, and delete webhooks as needed, ensuring your app always has the most up-to-date information. For instance, if you want to know whenever a new message is posted in a chat room, you can set up a webhook.

When a new message is posted, Webex's system will send a signal to a URL you've chosen (the target URL). This signal includes information about the event like details of the new message and the room it's in.

Your app can then use this information to do something, like storing the message, sending out notifications, or updating the user interface. You can set up webhooks for different events and have your app respond to each in real-time without having to keep checking for updates.

Please find detailed information on features and APIs here.

Devices and Credentials

The Devices and Credentials features of the Webex Web SDK are designed to help developers manage devices and their associated credentials.

Devices

This feature allows you to manage the different devices associated with a user’s Webex account. You can list the registered devices, register new devices, remove devices, and even update the settings of the devices.

To play around with the available features in the SDK, we recommend checking webex.devicemanager object in the browser console after initializing the webex object on the Meetings samples page.

Credentials

Credentials are essential for authenticating the user and securing communication. The Webex Web SDK provides simple methods to generate and manage these credentials.

For instance, you can generate guest tokens, which are short-lived tokens for guest users. You can also list the credentials of the current user. This can be useful to manage access and privileges for different users and devices.

To play around with the available features in the SDK, we recommend checking webex.credentials object in the browser console after initializing the webex object on the Meetings samples page.

Please find detailed information on features and APIs here.

In essence, the Webex Web SDK is a very powerful tool that enables developers to incorporate and make use of Webex's capabilities within their applications, providing a streamlined communication and collaboration experience.


Browser support

The Webex Web SDK works best on recent versions of Google Chrome, Mozilla Firefox, Safari, and Chromium-based Microsoft Edge. However, some features may not work on Safari due to browser restrictions. Always make sure to test your app in the environments you'll be using. And, you'll need to have JavaScript enabled in the browser for the SDK to work.

License

All contents are licensed under the Cisco EULA. Read our License Agreement here.

Clone this wiki locally