rooms

Rooms

The Rooms module provides functionality to interact with the Webex Rooms API, allowing you to create, retrieve, update, and delete Webex spaces (rooms).

Overview

Rooms (also called spaces) in Webex are virtual meeting places where people can message, share content, and meet. This module allows you to:

1. Create new rooms
2. Retrieve room details
3. List rooms with various filters
4. Update room properties
5. Delete rooms

Installation

This module is part of the Webex Go SDK. To use it, import the SDK and the rooms package:

import (
    "github.com/WebexCommunity/webex-go-sdk/v2"
    "github.com/WebexCommunity/webex-go-sdk/v2/rooms"
)

Usage

Initializing the Client

client, err := webex.NewClient(accessToken, nil)
if err != nil {
    log.Fatalf("Error creating client: %v", err)
}

// Access the rooms client
roomsClient := client.Rooms()

Creating a Room

To create a new room:

room := &rooms.Room{
    Title: "My New Room",
    // Optional: Specify the team this room belongs to
    TeamID: "TEAM_ID",
}

createdRoom, err := client.Rooms().Create(room)
if err != nil {
    log.Fatalf("Error creating room: %v", err)
}

fmt.Printf("Room created: ID=%s, Title=%s\n", createdRoom.ID, createdRoom.Title)

Retrieving a Room

To get details about a specific room:

roomDetails, err := client.Rooms().Get("ROOM_ID")
if err != nil {
    log.Fatalf("Error getting room: %v", err)
}

fmt.Printf("Room: %s (Type: %s)\n", roomDetails.Title, roomDetails.Type)
fmt.Printf("Created: %v\n", roomDetails.Created)

Listing Rooms

To retrieve a list of rooms:

options := &rooms.ListOptions{
    Max: 10, // Optional: limit to 10 rooms
}

page, err := client.Rooms().List(options)
if err != nil {
    log.Fatalf("Error listing rooms: %v", err)
}

fmt.Printf("Found %d rooms:\n", len(page.Items))
for i, room := range page.Items {
    fmt.Printf("%d. %s (ID: %s)\n", i+1, room.Title, room.ID)
}

You can use additional filters when listing rooms:

options := &rooms.ListOptions{
    TeamID: "TEAM_ID", // Filter rooms by team
    Type:   "group",   // Filter by type (direct or group)
    SortBy: "lastactivity", // Sort by last activity
    Max:    50,             // Limit to 50 rooms
}

Updating a Room

To update a room's properties:

updateRoom := &rooms.Room{
    Title:    "Updated Room Title",
    IsLocked: true, // Lock the room
}

updatedRoom, err := client.Rooms().Update("ROOM_ID", updateRoom)
if err != nil {
    log.Fatalf("Error updating room: %v", err)
}

fmt.Printf("Room updated: %s (Locked: %t)\n", updatedRoom.Title, updatedRoom.IsLocked)

Deleting a Room

To delete a room:

err = client.Rooms().Delete("ROOM_ID")
if err != nil {
    log.Fatalf("Error deleting room: %v", err)
}

fmt.Println("Room deleted successfully")

Data Structures

Room Structure

The Room structure contains the following fields:

There's also a RoomWithReadStatus structure that includes additional fields:

ListOptions

When listing rooms, you can use the following filter options:

Room Types

Webex has two types of rooms:

• Direct (1:1): Private spaces automatically created when you message someone directly
• Group: Spaces that can include multiple people, have titles, and can be moderated

Complete Example

Here's a complete example that demonstrates the major operations with rooms:

package main

import (
    "fmt"
    "log"
    "os"

    "github.com/WebexCommunity/webex-go-sdk/v2"
    "github.com/WebexCommunity/webex-go-sdk/v2/rooms"
)

func main() {
    // Get access token from environment
    accessToken := os.Getenv("WEBEX_ACCESS_TOKEN")
    if accessToken == "" {
        log.Fatal("WEBEX_ACCESS_TOKEN environment variable is required")
    }

    // Create client
    client, err := webex.NewClient(accessToken, nil)
    if err != nil {
        log.Fatalf("Error creating client: %v", err)
    }

    // Create a room
    room := &rooms.Room{
        Title: "Go SDK Room Example",
    }

    createdRoom, err := client.Rooms().Create(room)
    if err != nil {
        log.Fatalf("Error creating room: %v", err)
    }
    fmt.Printf("Room created: ID=%s, Title=%s\n", createdRoom.ID, createdRoom.Title)

    // Get room details
    roomDetails, err := client.Rooms().Get(createdRoom.ID)
    if err != nil {
        log.Fatalf("Error getting room: %v", err)
    }
    fmt.Printf("\nRoom details:\n")
    fmt.Printf("  ID: %s\n", roomDetails.ID)
    fmt.Printf("  Title: %s\n", roomDetails.Title)
    fmt.Printf("  Type: %s\n", roomDetails.Type)
    fmt.Printf("  IsLocked: %t\n", roomDetails.IsLocked)
    fmt.Printf("  CreatorID: %s\n", roomDetails.CreatorID)
    fmt.Printf("  Created: %v\n", roomDetails.Created)

    // List rooms
    options := &rooms.ListOptions{
        Max: 10,
    }

    page, err := client.Rooms().List(options)
    if err != nil {
        log.Fatalf("Error listing rooms: %v", err)
    }

    fmt.Printf("\nFound %d rooms:\n", len(page.Items))
    for i, r := range page.Items {
        fmt.Printf("%d. %s (ID: %s)\n", i+1, r.Title, r.ID)
    }

    // Update the room
    updateRoom := &rooms.Room{
        Title: "Go SDK Room Example (Updated)",
    }

    updatedRoom, err := client.Rooms().Update(createdRoom.ID, updateRoom)
    if err != nil {
        log.Fatalf("Error updating room: %v", err)
    }
    fmt.Printf("\nRoom updated: ID=%s, New Title=%s\n", updatedRoom.ID, updatedRoom.Title)

    // Delete the room
    fmt.Printf("\nDeleting room %s...\n", createdRoom.ID)
    err = client.Rooms().Delete(createdRoom.ID)
    if err != nil {
        log.Fatalf("Error deleting room: %v", err)
    }
    fmt.Println("Room deleted successfully")
}

Error Handling

All methods return structured errors from the webexsdk package. Use the convenience functions to check error types:

room, err := client.Rooms().Get("ROOM_ID")
if err != nil {
    switch {
    case webexsdk.IsNotFound(err):
        log.Println("Room not found")
    case webexsdk.IsAuthError(err):
        log.Println("Invalid or expired access token")
    case webexsdk.IsRateLimited(err):
        log.Println("Rate limited — SDK retries automatically")
    default:
        log.Printf("Error: %v", err)
    }
}

See webexsdk/Readme.md for the full error type reference.

Related Resources

• Webex Rooms API Documentation