Fetch all meetings for an App

client.RealtimeKit.Meetings.Get(ctx, appID, params) (*MeetingGetResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/meetings

Returns all meetings for the given App ID.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Realtime AdminRealtime

ParametersExpand Collapse

appID string

The app identifier tag.

maxLength32

params MeetingGetParams

AccountID param.Field[string]

Path param: The account identifier tag.

maxLength32

EndTime param.Field[Time]optional

Query param: The end time range for which you want to retrieve the meetings. The time must be specified in ISO format.

formatdate-time

PageNo param.Field[float64]optional

Query param: The page number from which you want your page search results to be displayed.

minimum0

PerPage param.Field[float64]optional

Query param: Number of results per page

minimum0

Search param.Field[string]optional

Query param: The search query string. You can search using the meeting ID or title.

StartTime param.Field[Time]optional

Query param: The start time range for which you want to retrieve the meetings. The time must be specified in ISO format.

formatdate-time

ReturnsExpand Collapse

type MeetingGetResponse struct{…}

Data []MeetingGetResponseData

ID string

ID of the meeting.

formatuuid

CreatedAt Time

Timestamp the object was created at. The time is returned in ISO format.

formatdate-time

UpdatedAt Time

Timestamp the object was updated at. The time is returned in ISO format.

formatdate-time

LiveStreamOnStart booloptional

Specifies if the meeting should start getting livestreamed on start.

PersistChat booloptional

Specifies if Chat within a meeting should persist for a week.

RecordOnStart booloptional

Specifies if the meeting should start getting recorded as soon as someone joins the meeting.

SessionKeepAliveTimeInSecs float64optional

Time in seconds, for which a session remains active, after the last participant has left the meeting.

maximum600

minimum60

Status MeetingGetResponseDataStatusoptional

Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.

One of the following:

const MeetingGetResponseDataStatusActive MeetingGetResponseDataStatus = "ACTIVE"

const MeetingGetResponseDataStatusInactive MeetingGetResponseDataStatus = "INACTIVE"

SummarizeOnEnd booloptional

Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.

Title stringoptional

Title of the meeting.

Paging MeetingGetResponsePaging

EndOffset float64

StartOffset float64

TotalCount float64

minimum0

Success bool

Fetch all meetings for an App

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/realtime_kit"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  meeting, err := client.RealtimeKit.Meetings.Get(
    context.TODO(),
    "app_id",
    realtime_kit.MeetingGetParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", meeting.Data)
}

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "live_stream_on_start": true,
      "persist_chat": true,
      "record_on_start": true,
      "session_keep_alive_time_in_secs": 60,
      "status": "ACTIVE",
      "summarize_on_end": true,
      "title": "title"
    }
  ],
  "paging": {
    "end_offset": 30,
    "start_offset": 1,
    "total_count": 30
  },
  "success": true
}

Returns Examples

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "live_stream_on_start": true,
      "persist_chat": true,
      "record_on_start": true,
      "session_keep_alive_time_in_secs": 60,
      "status": "ACTIVE",
      "summarize_on_end": true,
      "title": "title"
    }
  ],
  "paging": {
    "end_offset": 30,
    "start_offset": 1,
    "total_count": 30
  },
  "success": true
}