<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Video - Go

Installation

go get github.com/team-telnyx/telnyx-go

Setup

import (
  "context"
  "fmt"
  "os"

  "github.com/team-telnyx/telnyx-go"
  "github.com/team-telnyx/telnyx-go/option"
)

client := telnyx.NewClient(
  option.WithAPIKey(os.Getenv("TELNYX_API_KEY")),
)

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

import "errors"

result, err := client.Messages.Send(ctx, params)
if err != nil {
  var apiErr *telnyx.Error
  if errors.As(err, &apiErr) {
    switch apiErr.StatusCode {
    case 422:
      fmt.Println("Validation error — check required fields and formats")
    case 429:
      // Rate limited — wait and retry with exponential backoff
      fmt.Println("Rate limited, retrying...")
    default:
      fmt.Printf("API error %d: %s\n", apiErr.StatusCode, apiErr.Error())
    }
  } else {
    fmt.Println("Network error — check connectivity and retry")
  }
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

View a list of room compositions.

GET /room_compositions

	page, err := client.RoomCompositions.List(context.Background(), telnyx.RoomCompositionListParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)

Returns: completedat (date-time), createdat (date-time), downloadurl (string), durationsecs (integer), endedat (date-time), format (enum: mp4), id (uuid), recordtype (string), resolution (string), roomid (uuid), sessionid (uuid), sizemb (float), startedat (date-time), status (enum: completed, enqueued, processing), updatedat (date-time), userid (uuid), videolayout (object), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer)

Create a room composition.

Asynchronously create a room composition.

POST /room_compositions

Optional: format (string), resolution (string), sessionid (uuid), videolayout (object), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer)

	roomComposition, err := client.RoomCompositions.New(context.Background(), telnyx.RoomCompositionNewParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", roomComposition.Data)

Returns: completedat (date-time), createdat (date-time), downloadurl (string), durationsecs (integer), endedat (date-time), format (enum: mp4), id (uuid), recordtype (string), resolution (string), roomid (uuid), sessionid (uuid), sizemb (float), startedat (date-time), status (enum: completed, enqueued, processing), updatedat (date-time), userid (uuid), videolayout (object), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer)

View a room composition.

GET /roomcompositions/{roomcomposition_id}

	roomComposition, err := client.RoomCompositions.Get(context.Background(), "5219b3af-87c6-4c08-9b58-5a533d893e21")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", roomComposition.Data)

Returns: completedat (date-time), createdat (date-time), downloadurl (string), durationsecs (integer), endedat (date-time), format (enum: mp4), id (uuid), recordtype (string), resolution (string), roomid (uuid), sessionid (uuid), sizemb (float), startedat (date-time), status (enum: completed, enqueued, processing), updatedat (date-time), userid (uuid), videolayout (object), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer)

Delete a room composition.

Synchronously delete a room composition.

DELETE /roomcompositions/{roomcomposition_id}

	err := client.RoomCompositions.Delete(context.Background(), "5219b3af-87c6-4c08-9b58-5a533d893e21")
	if err != nil {
		log.Fatal(err)
	}

View a list of room participants.

GET /room_participants

	page, err := client.RoomParticipants.List(context.Background(), telnyx.RoomParticipantListParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)

Returns: context (string), id (uuid), joinedat (date-time), leftat (date-time), recordtype (string), sessionid (uuid), updated_at (date-time)

View a room participant.

GET /roomparticipants/{roomparticipant_id}

	roomParticipant, err := client.RoomParticipants.Get(context.Background(), "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", roomParticipant.Data)

Returns: context (string), id (uuid), joinedat (date-time), leftat (date-time), recordtype (string), sessionid (uuid), updated_at (date-time)

View a list of room recordings.

GET /room_recordings

	page, err := client.RoomRecordings.List(context.Background(), telnyx.RoomRecordingListParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)

Returns: codec (string), completedat (date-time), createdat (date-time), downloadurl (string), durationsecs (integer), endedat (date-time), id (uuid), participantid (uuid), recordtype (string), roomid (uuid), sessionid (uuid), sizemb (float), startedat (date-time), status (enum: completed, processing), type (enum: audio, video), updatedat (date-time)

Delete several room recordings in a bulk.

DELETE /room_recordings

	response, err := client.RoomRecordings.DeleteBulk(context.Background(), telnyx.RoomRecordingDeleteBulkParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)

Returns: room_recordings (integer)

View a room recording.

GET /roomrecordings/{roomrecording_id}

	roomRecording, err := client.RoomRecordings.Get(context.Background(), "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", roomRecording.Data)

Returns: codec (string), completedat (date-time), createdat (date-time), downloadurl (string), durationsecs (integer), endedat (date-time), id (uuid), participantid (uuid), recordtype (string), roomid (uuid), sessionid (uuid), sizemb (float), startedat (date-time), status (enum: completed, processing), type (enum: audio, video), updatedat (date-time)

Delete a room recording.

Synchronously delete a Room Recording.

DELETE /roomrecordings/{roomrecording_id}

	err := client.RoomRecordings.Delete(context.Background(), "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
	if err != nil {
		log.Fatal(err)
	}

View a list of room sessions.

GET /room_sessions

	page, err := client.Rooms.Sessions.List0(context.Background(), telnyx.RoomSessionList0Params{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)

Returns: active (boolean), createdat (date-time), endedat (date-time), id (uuid), participants (array[object]), recordtype (string), roomid (uuid), updated_at (date-time)

View a room session.

GET /roomsessions/{roomsession_id}

	session, err := client.Rooms.Sessions.Get(
		context.Background(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomSessionGetParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", session.Data)

Returns: active (boolean), createdat (date-time), endedat (date-time), id (uuid), participants (array[object]), recordtype (string), roomid (uuid), updated_at (date-time)

End a room session.

Note: this will also kick all participants currently present in the room

POST /roomsessions/{roomsession_id}/actions/end

	response, err := client.Rooms.Sessions.Actions.End(context.Background(), "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)

Returns: result (string)

Kick participants from a room session.

POST /roomsessions/{roomsession_id}/actions/kick

Optional: exclude (array[string]), participants (object)

	response, err := client.Rooms.Sessions.Actions.Kick(
		context.Background(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomSessionActionKickParams{
			ActionsParticipantsRequest: telnyx.ActionsParticipantsRequestParam{},
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)

Returns: result (string)

Mute participants in room session.

POST /roomsessions/{roomsession_id}/actions/mute

Optional: exclude (array[string]), participants (object)

	response, err := client.Rooms.Sessions.Actions.Mute(
		context.Background(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomSessionActionMuteParams{
			ActionsParticipantsRequest: telnyx.ActionsParticipantsRequestParam{},
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)

Returns: result (string)

Unmute participants in room session.

POST /roomsessions/{roomsession_id}/actions/unmute

Optional: exclude (array[string]), participants (object)

	response, err := client.Rooms.Sessions.Actions.Unmute(
		context.Background(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomSessionActionUnmuteParams{
			ActionsParticipantsRequest: telnyx.ActionsParticipantsRequestParam{},
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)

Returns: result (string)

View a list of room participants.

GET /roomsessions/{roomsession_id}/participants

	page, err := client.Rooms.Sessions.GetParticipants(
		context.Background(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomSessionGetParticipantsParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)

Returns: context (string), id (uuid), joinedat (date-time), leftat (date-time), recordtype (string), sessionid (uuid), updated_at (date-time)

View a list of rooms.

GET /rooms

	page, err := client.Rooms.List(context.Background(), telnyx.RoomListParams{})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)

Returns: activesessionid (uuid), createdat (date-time), enablerecording (boolean), id (uuid), maxparticipants (integer), recordtype (string), sessions (array[object]), uniquename (string), updatedat (date-time), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer)

Create a room.

Synchronously create a Room.

POST /rooms

Optional: enablerecording (boolean), maxparticipants (integer), uniquename (string), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer)

	room, err := client.Rooms.New(context.Background(), telnyx.RoomNewParams{
		UniqueName: "my-meeting-room",
		MaxParticipants: 10,
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", room.Data)

Returns: activesessionid (uuid), createdat (date-time), enablerecording (boolean), id (uuid), maxparticipants (integer), recordtype (string), sessions (array[object]), uniquename (string), updatedat (date-time), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer)

View a room.

GET /rooms/{room_id}

	room, err := client.Rooms.Get(
		context.Background(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomGetParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", room.Data)

Returns: activesessionid (uuid), createdat (date-time), enablerecording (boolean), id (uuid), maxparticipants (integer), recordtype (string), sessions (array[object]), uniquename (string), updatedat (date-time), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer)

Update a room.

Synchronously update a Room.

PATCH /rooms/{room_id}

Optional: enablerecording (boolean), maxparticipants (integer), uniquename (string), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeoutsecs (integer)

	room, err := client.Rooms.Update(
		context.Background(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomUpdateParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", room.Data)

Returns: activesessionid (uuid), createdat (date-time), enablerecording (boolean), id (uuid), maxparticipants (integer), recordtype (string), sessions (array[object]), uniquename (string), updatedat (date-time), webhookeventfailoverurl (uri), webhookeventurl (uri), webhooktimeout_secs (integer)

Delete a room.

Synchronously delete a Room. Participants from that room will be kicked out, they won't be able to join that room anymore, and you won't be charged anymore for that room.

DELETE /rooms/{room_id}

	err := client.Rooms.Delete(context.Background(), "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")
	if err != nil {
		log.Fatal(err)
	}

Create Client Token to join a room.

Synchronously create an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after tokenttlsecs, a Refresh Token is also provided to refresh a Client Token, the Refresh Token expires after refreshtokenttl_secs.

POST /rooms/{roomid}/actions/generatejoinclienttoken

Optional: refreshtokenttlsecs (integer), tokenttl_secs (integer)

	response, err := client.Rooms.Actions.GenerateJoinClientToken(
		context.Background(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomActionGenerateJoinClientTokenParams{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)

Returns: refreshtoken (string), refreshtokenexpiresat (date-time), token (string), tokenexpiresat (date-time)

Refresh Client Token to join a room.

Synchronously refresh an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after tokenttlsecs.

POST /rooms/{roomid}/actions/refreshclienttoken — Required: refreshtoken

Optional: tokenttlsecs (integer)

	response, err := client.Rooms.Actions.RefreshClientToken(
		context.Background(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomActionRefreshClientTokenParams{
			RefreshToken: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ",
		},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", response.Data)

Returns: token (string), tokenexpiresat (date-time)

View a list of room sessions.

GET /rooms/{room_id}/sessions

	page, err := client.Rooms.Sessions.List1(
		context.Background(),
		"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
		telnyx.RoomSessionList1Params{},
	)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", page)

Returns: active (boolean), createdat (date-time), endedat (date-time), id (uuid), participants (array[object]), recordtype (string), roomid (uuid), updated_at (date-time)