12 KiB
\MeetAPI
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| GetMeetHealth | Get /v1/meet/health | Reports whether the office can mint join tokens. |
| GetMeetSession | Get /v1/meet/session | What this caller may open a room in |
| MeetCall | Get /v1/meet/call | Where a room's call happens |
| MeetRecordRead | Get /v1/meet/record | What is being recorded in a room, and where the file goes |
| MeetRecordStart | Post /v1/meet/record | Start recording a room, or return the recording already running |
| MeetRecordStop | Delete /v1/meet/record | Stop a room's recording |
| PostMeetGettoken | Post /v1/meet/getToken | Mint a join token for one video room |
GetMeetHealth
MeetMeetHealth GetMeetHealth(ctx).Execute()
Reports whether the office can mint join tokens.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MeetAPI.GetMeetHealth(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MeetAPI.GetMeetHealth``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetMeetHealth`: MeetMeetHealth
fmt.Fprintf(os.Stdout, "Response from `MeetAPI.GetMeetHealth`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetMeetHealthRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetMeetSession
GetMeetSession(ctx).Execute()
What this caller may open a room in
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.MeetAPI.GetMeetSession(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MeetAPI.GetMeetSession``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetMeetSessionRequest struct via the builder pattern
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MeetCall
MeetVenue MeetCall(ctx).Space(space).Channel(channel).Execute()
Where a room's call happens
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
space := "space_example" // string | Space is the space uuid holding the channel, as GET /v1/team/channels reports it. It is the segment the caller's membership is checked against.
channel := "channel_example" // string | Channel is the channel's own id within that space, as GET /v1/team/channels reports it. It is opaque here: meet keeps no channels and cannot say whether one exists, only whether this caller may be seated in the space holding it.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MeetAPI.MeetCall(context.Background()).Space(space).Channel(channel).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MeetAPI.MeetCall``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `MeetCall`: MeetVenue
fmt.Fprintf(os.Stdout, "Response from `MeetAPI.MeetCall`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiMeetCallRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| space | string | Space is the space uuid holding the channel, as GET /v1/team/channels reports it. It is the segment the caller's membership is checked against. | |
| channel | string | Channel is the channel's own id within that space, as GET /v1/team/channels reports it. It is opaque here: meet keeps no channels and cannot say whether one exists, only whether this caller may be seated in the space holding it. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MeetRecordRead
MeetRecording MeetRecordRead(ctx).Room(room).Execute()
What is being recorded in a room, and where the file goes
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
room := "room_example" // string | Room is the LiveKit room, named the way the office client names one (`<space>_<name>_<id>`). Its leading segment is what binds the room to a tenant, and it is the segment the caller's membership is checked against.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MeetAPI.MeetRecordRead(context.Background()).Room(room).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MeetAPI.MeetRecordRead``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `MeetRecordRead`: MeetRecording
fmt.Fprintf(os.Stdout, "Response from `MeetAPI.MeetRecordRead`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiMeetRecordReadRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| room | string | Room is the LiveKit room, named the way the office client names one (`<space><name><id>`). Its leading segment is what binds the room to a tenant, and it is the segment the caller's membership is checked against. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MeetRecordStart
MeetRecording MeetRecordStart(ctx).MeetRecordIn(meetRecordIn).Execute()
Start recording a room, or return the recording already running
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
meetRecordIn := *openapiclient.NewMeetRecordIn("Room_example") // MeetRecordIn |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MeetAPI.MeetRecordStart(context.Background()).MeetRecordIn(meetRecordIn).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MeetAPI.MeetRecordStart``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `MeetRecordStart`: MeetRecording
fmt.Fprintf(os.Stdout, "Response from `MeetAPI.MeetRecordStart`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiMeetRecordStartRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| meetRecordIn | MeetRecordIn |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MeetRecordStop
MeetRecording MeetRecordStop(ctx).Room(room).Execute()
Stop a room's recording
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
room := "room_example" // string | Room is the LiveKit room, named the way the office client names one (`<space>_<name>_<id>`). Its leading segment is what binds the room to a tenant, and it is the segment the caller's membership is checked against.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.MeetAPI.MeetRecordStop(context.Background()).Room(room).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MeetAPI.MeetRecordStop``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `MeetRecordStop`: MeetRecording
fmt.Fprintf(os.Stdout, "Response from `MeetAPI.MeetRecordStop`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiMeetRecordStopRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| room | string | Room is the LiveKit room, named the way the office client names one (`<space><name><id>`). Its leading segment is what binds the room to a tenant, and it is the segment the caller's membership is checked against. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostMeetGettoken
PostMeetGettoken(ctx).Execute()
Mint a join token for one video room
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.MeetAPI.PostMeetGettoken(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `MeetAPI.PostMeetGettoken``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiPostMeetGettokenRequest struct via the builder pattern
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]