openapi

package
v0.22.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 23, 2022 License: MIT Imports: 6 Imported by: 0

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.27.1
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://insights.twilio.com

Class Method HTTP request Description
ConferencesApi FetchConference Get /v1/Conferences/{ConferenceSid}
ConferencesApi ListConference Get /v1/Conferences
ConferencesParticipantsApi FetchConferenceParticipant Get /v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}
ConferencesParticipantsApi ListConferenceParticipant Get /v1/Conferences/{ConferenceSid}/Participants
VideoRoomsApi FetchVideoRoomSummary Get /v1/Video/Rooms/{RoomSid}
VideoRoomsApi ListVideoRoomSummary Get /v1/Video/Rooms
VideoRoomsParticipantsApi FetchVideoParticipantSummary Get /v1/Video/Rooms/{RoomSid}/Participants/{ParticipantSid}
VideoRoomsParticipantsApi ListVideoParticipantSummary Get /v1/Video/Rooms/{RoomSid}/Participants
VoiceApi FetchCall Get /v1/Voice/{Sid}
VoiceEventsApi ListEvent Get /v1/Voice/{CallSid}/Events
VoiceMetricsApi ListMetric Get /v1/Voice/{CallSid}/Metrics
VoiceSettingsApi FetchAccountSettings Get /v1/Voice/Settings
VoiceSettingsApi UpdateAccountSettings Post /v1/Voice/Settings
VoiceSummariesApi ListCallSummaries Get /v1/Voice/Summaries
VoiceSummaryApi FetchSummary Get /v1/Voice/{CallSid}/Summary

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService added in v0.11.0 

type ApiService struct {
	// contains filtered or unexported fields
}

func NewApiService added in v0.11.0 

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient added in v0.11.0 

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) FetchAccountSettings added in v0.19.0 

func (c *ApiService) FetchAccountSettings(params *FetchAccountSettingsParams) (*InsightsV1AccountSettings, error)

func (*ApiService) FetchCall added in v0.11.0 

func (c *ApiService) FetchCall(Sid string) (*InsightsV1Call, error)

func (*ApiService) FetchConference added in v0.20.1 

func (c *ApiService) FetchConference(ConferenceSid string) (*InsightsV1Conference, error)

Fetch a specific Conference.

func (*ApiService) FetchConferenceParticipant added in v0.20.1 

func (c *ApiService) FetchConferenceParticipant(ConferenceSid string, ParticipantSid string, params *FetchConferenceParticipantParams) (*InsightsV1ConferenceParticipant, error)

Fetch a specific Conference Participant Summary.

func (*ApiService) FetchSummary added in v0.11.0 

func (c *ApiService) FetchSummary(CallSid string, params *FetchSummaryParams) (*InsightsV1Summary, error)

func (*ApiService) FetchVideoParticipantSummary added in v0.11.0 

func (c *ApiService) FetchVideoParticipantSummary(RoomSid string, ParticipantSid string) (*InsightsV1VideoParticipantSummary, error)

Get Video Log Analyzer data for a Room Participant.

func (*ApiService) FetchVideoRoomSummary added in v0.11.0 

func (c *ApiService) FetchVideoRoomSummary(RoomSid string) (*InsightsV1VideoRoomSummary, error)

Get Video Log Analyzer data for a Room.

func (*ApiService) ListCallSummaries added in v0.14.0 

func (c *ApiService) ListCallSummaries(params *ListCallSummariesParams) ([]InsightsV1CallSummaries, error)

Lists CallSummaries records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListConference added in v0.20.1 

func (c *ApiService) ListConference(params *ListConferenceParams) ([]InsightsV1Conference, error)

Lists Conference records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListConferenceParticipant added in v0.20.1 

func (c *ApiService) ListConferenceParticipant(ConferenceSid string, params *ListConferenceParticipantParams) ([]InsightsV1ConferenceParticipant, error)

Lists ConferenceParticipant records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListEvent added in v0.11.0 

func (c *ApiService) ListEvent(CallSid string, params *ListEventParams) ([]InsightsV1Event, error)

Lists Event records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListMetric added in v0.11.0 

func (c *ApiService) ListMetric(CallSid string, params *ListMetricParams) ([]InsightsV1Metric, error)

Lists Metric records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListVideoParticipantSummary added in v0.11.0 

func (c *ApiService) ListVideoParticipantSummary(RoomSid string, params *ListVideoParticipantSummaryParams) ([]InsightsV1VideoParticipantSummary, error)

Lists VideoParticipantSummary records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListVideoRoomSummary added in v0.11.0 

func (c *ApiService) ListVideoRoomSummary(params *ListVideoRoomSummaryParams) ([]InsightsV1VideoRoomSummary, error)

Lists VideoRoomSummary records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageCallSummaries added in v0.14.0 

func (c *ApiService) PageCallSummaries(params *ListCallSummariesParams, pageToken, pageNumber string) (*ListCallSummariesResponse, error)

Retrieve a single page of CallSummaries records from the API. Request is executed immediately.

func (*ApiService) PageConference added in v0.20.1 

func (c *ApiService) PageConference(params *ListConferenceParams, pageToken, pageNumber string) (*ListConferenceResponse, error)

Retrieve a single page of Conference records from the API. Request is executed immediately.

func (*ApiService) PageConferenceParticipant added in v0.20.1 

func (c *ApiService) PageConferenceParticipant(ConferenceSid string, params *ListConferenceParticipantParams, pageToken, pageNumber string) (*ListConferenceParticipantResponse, error)

Retrieve a single page of ConferenceParticipant records from the API. Request is executed immediately.

func (*ApiService) PageEvent added in v0.13.0 

func (c *ApiService) PageEvent(CallSid string, params *ListEventParams, pageToken, pageNumber string) (*ListEventResponse, error)

Retrieve a single page of Event records from the API. Request is executed immediately.

func (*ApiService) PageMetric added in v0.13.0 

func (c *ApiService) PageMetric(CallSid string, params *ListMetricParams, pageToken, pageNumber string) (*ListMetricResponse, error)

Retrieve a single page of Metric records from the API. Request is executed immediately.

func (*ApiService) PageVideoParticipantSummary added in v0.13.0 

func (c *ApiService) PageVideoParticipantSummary(RoomSid string, params *ListVideoParticipantSummaryParams, pageToken, pageNumber string) (*ListVideoParticipantSummaryResponse, error)

Retrieve a single page of VideoParticipantSummary records from the API. Request is executed immediately.

func (*ApiService) PageVideoRoomSummary added in v0.13.0 

func (c *ApiService) PageVideoRoomSummary(params *ListVideoRoomSummaryParams, pageToken, pageNumber string) (*ListVideoRoomSummaryResponse, error)

Retrieve a single page of VideoRoomSummary records from the API. Request is executed immediately.

func (*ApiService) StreamCallSummaries added in v0.14.0 

func (c *ApiService) StreamCallSummaries(params *ListCallSummariesParams) (chan InsightsV1CallSummaries, error)

Streams CallSummaries records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamConference added in v0.20.1 

func (c *ApiService) StreamConference(params *ListConferenceParams) (chan InsightsV1Conference, error)

Streams Conference records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamConferenceParticipant added in v0.20.1 

func (c *ApiService) StreamConferenceParticipant(ConferenceSid string, params *ListConferenceParticipantParams) (chan InsightsV1ConferenceParticipant, error)

Streams ConferenceParticipant records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamEvent added in v0.13.0 

func (c *ApiService) StreamEvent(CallSid string, params *ListEventParams) (chan InsightsV1Event, error)

Streams Event records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamMetric added in v0.13.0 

func (c *ApiService) StreamMetric(CallSid string, params *ListMetricParams) (chan InsightsV1Metric, error)

Streams Metric records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamVideoParticipantSummary added in v0.13.0 

func (c *ApiService) StreamVideoParticipantSummary(RoomSid string, params *ListVideoParticipantSummaryParams) (chan InsightsV1VideoParticipantSummary, error)

Streams VideoParticipantSummary records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamVideoRoomSummary added in v0.13.0 

func (c *ApiService) StreamVideoRoomSummary(params *ListVideoRoomSummaryParams) (chan InsightsV1VideoRoomSummary, error)

Streams VideoRoomSummary records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateAccountSettings added in v0.19.0 

func (c *ApiService) UpdateAccountSettings(params *UpdateAccountSettingsParams) (*InsightsV1AccountSettings, error)

type FetchAccountSettingsParams added in v0.19.0 

type FetchAccountSettingsParams struct {
	//
	SubaccountSid *string `json:"SubaccountSid,omitempty"`
}

Optional parameters for the method 'FetchAccountSettings'

func (*FetchAccountSettingsParams) SetSubaccountSid added in v0.19.0 

func (params *FetchAccountSettingsParams) SetSubaccountSid(SubaccountSid string) *FetchAccountSettingsParams

type FetchConferenceParticipantParams added in v0.20.1 

type FetchConferenceParticipantParams struct {
	// Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc.
	Events *string `json:"Events,omitempty"`
	// Object. Contains participant call quality metrics.
	Metrics *string `json:"Metrics,omitempty"`
}

Optional parameters for the method 'FetchConferenceParticipant'

func (*FetchConferenceParticipantParams) SetEvents added in v0.20.1 

func (params *FetchConferenceParticipantParams) SetEvents(Events string) *FetchConferenceParticipantParams

func (*FetchConferenceParticipantParams) SetMetrics added in v0.20.1 

func (params *FetchConferenceParticipantParams) SetMetrics(Metrics string) *FetchConferenceParticipantParams

type FetchSummaryParams 

type FetchSummaryParams struct {
	//
	ProcessingState *string `json:"ProcessingState,omitempty"`
}

Optional parameters for the method 'FetchSummary'

func (*FetchSummaryParams) SetProcessingState 

func (params *FetchSummaryParams) SetProcessingState(ProcessingState string) *FetchSummaryParams

type InsightsV1AccountSettings added in v0.19.0 

type InsightsV1AccountSettings struct {
	AccountSid       *string `json:"account_sid,omitempty"`
	AdvancedFeatures *bool   `json:"advanced_features,omitempty"`
	Url              *string `json:"url,omitempty"`
	VoiceTrace       *bool   `json:"voice_trace,omitempty"`
}

InsightsV1AccountSettings struct for InsightsV1AccountSettings

type InsightsV1Call 

type InsightsV1Call struct {
	Links *map[string]interface{} `json:"links,omitempty"`
	Sid   *string                 `json:"sid,omitempty"`
	Url   *string                 `json:"url,omitempty"`
}

InsightsV1Call struct for InsightsV1Call

type InsightsV1CallSummaries added in v0.14.0 

type InsightsV1CallSummaries struct {
	AccountSid      *string                 `json:"account_sid,omitempty"`
	Attributes      *map[string]interface{} `json:"attributes,omitempty"`
	CallSid         *string                 `json:"call_sid,omitempty"`
	CallState       *string                 `json:"call_state,omitempty"`
	CallType        *string                 `json:"call_type,omitempty"`
	CarrierEdge     *map[string]interface{} `json:"carrier_edge,omitempty"`
	ClientEdge      *map[string]interface{} `json:"client_edge,omitempty"`
	ConnectDuration *int                    `json:"connect_duration,omitempty"`
	CreatedTime     *time.Time              `json:"created_time,omitempty"`
	Duration        *int                    `json:"duration,omitempty"`
	EndTime         *time.Time              `json:"end_time,omitempty"`
	From            *map[string]interface{} `json:"from,omitempty"`
	ProcessingState *string                 `json:"processing_state,omitempty"`
	Properties      *map[string]interface{} `json:"properties,omitempty"`
	SdkEdge         *map[string]interface{} `json:"sdk_edge,omitempty"`
	SipEdge         *map[string]interface{} `json:"sip_edge,omitempty"`
	StartTime       *time.Time              `json:"start_time,omitempty"`
	Tags            *[]string               `json:"tags,omitempty"`
	To              *map[string]interface{} `json:"to,omitempty"`
	Trust           *map[string]interface{} `json:"trust,omitempty"`
	Url             *string                 `json:"url,omitempty"`
}

InsightsV1CallSummaries struct for InsightsV1CallSummaries

type InsightsV1Conference added in v0.20.1 

type InsightsV1Conference struct {
	// Account SID.
	AccountSid *string `json:"account_sid,omitempty"`
	// Conference SID.
	ConferenceSid *string `json:"conference_sid,omitempty"`
	// Duration of the conference in seconds.
	ConnectDurationSeconds *int `json:"connect_duration_seconds,omitempty"`
	// Conference creation date/time.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// Potential issues detected during the conference.
	DetectedIssues *map[string]interface{} `json:"detected_issues,omitempty"`
	// Conference duration in seconds.
	DurationSeconds *int `json:"duration_seconds,omitempty"`
	// Conference end reason.
	EndReason *string `json:"end_reason,omitempty"`
	// Conference end date/time.
	EndTime *time.Time `json:"end_time,omitempty"`
	// Call SID that ended the conference.
	EndedBy *string `json:"ended_by,omitempty"`
	// Custom label for the conference.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// Nested resource URLs.
	Links *map[string]interface{} `json:"links,omitempty"`
	// Actual maximum concurrent participants.
	MaxConcurrentParticipants *int `json:"max_concurrent_participants,omitempty"`
	// Max participants specified in config.
	MaxParticipants *int `json:"max_participants,omitempty"`
	// Region where the conference was mixed.
	MixerRegion *string `json:"mixer_region,omitempty"`
	// Configuration-requested conference mixer region.
	MixerRegionRequested *string `json:"mixer_region_requested,omitempty"`
	// Processing state for the Conference Summary resource.
	ProcessingState *string `json:"processing_state,omitempty"`
	// Boolean. Indicates whether recording was enabled.
	RecordingEnabled *bool `json:"recording_enabled,omitempty"`
	// Timestamp in ISO 8601 format when the conference started.
	StartTime *time.Time `json:"start_time,omitempty"`
	// Status of conference
	Status *string `json:"status,omitempty"`
	// Object. Contains details about conference tags.
	TagInfo *map[string]interface{} `json:"tag_info,omitempty"`
	// Tags for detected conference conditions and participant behaviors.
	Tags *[]string `json:"tags,omitempty"`
	// Unique conference participants.
	UniqueParticipants *int `json:"unique_participants,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

InsightsV1Conference struct for InsightsV1Conference

type InsightsV1ConferenceParticipant added in v0.20.1 

type InsightsV1ConferenceParticipant struct {
	// Account SID.
	AccountSid *string `json:"account_sid,omitempty"`
	// Call direction of the participant.
	CallDirection *string `json:"call_direction,omitempty"`
	// Unique SID identifier of the call.
	CallSid *string `json:"call_sid,omitempty"`
	// Call status of the call that generated the participant.
	CallStatus *string `json:"call_status,omitempty"`
	// The Call Type of this Conference Participant.
	CallType *string `json:"call_type,omitempty"`
	// Call SIDs coached by this participant.
	CoachedParticipants *[]string `json:"coached_participants,omitempty"`
	// The Conference Region of this Conference Participant.
	ConferenceRegion *string `json:"conference_region,omitempty"`
	// Conference SID.
	ConferenceSid *string `json:"conference_sid,omitempty"`
	// ISO alpha-2 country code of the participant.
	CountryCode *string `json:"country_code,omitempty"`
	// Participant durations in seconds.
	DurationSeconds *int `json:"duration_seconds,omitempty"`
	// Object containing information of actions taken by participants. Nested resource URLs.
	Events *map[string]interface{} `json:"events,omitempty"`
	// Caller ID of the calling party.
	From *string `json:"from,omitempty"`
	// Boolean. Indicated whether participant was a coach.
	IsCoach *bool `json:"is_coach,omitempty"`
	// Boolean. Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true.
	IsModerator *bool `json:"is_moderator,omitempty"`
	// The Jitter Buffer Size of this Conference Participant.
	JitterBufferSize *string `json:"jitter_buffer_size,omitempty"`
	// ISO 8601 timestamp of participant join event.
	JoinTime *time.Time `json:"join_time,omitempty"`
	// The user-specified label of this participant.
	Label *string `json:"label,omitempty"`
	// ISO 8601 timestamp of participant leave event.
	LeaveTime *time.Time `json:"leave_time,omitempty"`
	// Object. Contains participant quality metrics.
	Metrics *map[string]interface{} `json:"metrics,omitempty"`
	// Estimated time in queue at call creation.
	OutboundQueueLength *int `json:"outbound_queue_length,omitempty"`
	// Actual time in queue (seconds).
	OutboundTimeInQueue *int `json:"outbound_time_in_queue,omitempty"`
	// Twilio region where the participant media originates.
	ParticipantRegion *string `json:"participant_region,omitempty"`
	// SID for this participant.
	ParticipantSid *string `json:"participant_sid,omitempty"`
	// Processing state of the Participant Summary.
	ProcessingState *string `json:"processing_state,omitempty"`
	// Participant properties and metadata.
	Properties *map[string]interface{} `json:"properties,omitempty"`
	// Called party.
	To *string `json:"to,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

InsightsV1ConferenceParticipant struct for InsightsV1ConferenceParticipant

type InsightsV1Event added in v0.14.0 

type InsightsV1Event struct {
	AccountSid  *string                 `json:"account_sid,omitempty"`
	CallSid     *string                 `json:"call_sid,omitempty"`
	CarrierEdge *map[string]interface{} `json:"carrier_edge,omitempty"`
	ClientEdge  *map[string]interface{} `json:"client_edge,omitempty"`
	Edge        *string                 `json:"edge,omitempty"`
	Group       *string                 `json:"group,omitempty"`
	Level       *string                 `json:"level,omitempty"`
	Name        *string                 `json:"name,omitempty"`
	SdkEdge     *map[string]interface{} `json:"sdk_edge,omitempty"`
	SipEdge     *map[string]interface{} `json:"sip_edge,omitempty"`
	Timestamp   *string                 `json:"timestamp,omitempty"`
}

InsightsV1Event struct for InsightsV1Event

type InsightsV1Metric added in v0.14.0 

type InsightsV1Metric struct {
	AccountSid  *string                 `json:"account_sid,omitempty"`
	CallSid     *string                 `json:"call_sid,omitempty"`
	CarrierEdge *map[string]interface{} `json:"carrier_edge,omitempty"`
	ClientEdge  *map[string]interface{} `json:"client_edge,omitempty"`
	Direction   *string                 `json:"direction,omitempty"`
	Edge        *string                 `json:"edge,omitempty"`
	SdkEdge     *map[string]interface{} `json:"sdk_edge,omitempty"`
	SipEdge     *map[string]interface{} `json:"sip_edge,omitempty"`
	Timestamp   *string                 `json:"timestamp,omitempty"`
}

InsightsV1Metric struct for InsightsV1Metric

type InsightsV1Summary added in v0.14.0 

type InsightsV1Summary struct {
	AccountSid      *string                 `json:"account_sid,omitempty"`
	Attributes      *map[string]interface{} `json:"attributes,omitempty"`
	CallSid         *string                 `json:"call_sid,omitempty"`
	CallState       *string                 `json:"call_state,omitempty"`
	CallType        *string                 `json:"call_type,omitempty"`
	CarrierEdge     *map[string]interface{} `json:"carrier_edge,omitempty"`
	ClientEdge      *map[string]interface{} `json:"client_edge,omitempty"`
	ConnectDuration *int                    `json:"connect_duration,omitempty"`
	CreatedTime     *time.Time              `json:"created_time,omitempty"`
	Duration        *int                    `json:"duration,omitempty"`
	EndTime         *time.Time              `json:"end_time,omitempty"`
	From            *map[string]interface{} `json:"from,omitempty"`
	ProcessingState *string                 `json:"processing_state,omitempty"`
	Properties      *map[string]interface{} `json:"properties,omitempty"`
	SdkEdge         *map[string]interface{} `json:"sdk_edge,omitempty"`
	SipEdge         *map[string]interface{} `json:"sip_edge,omitempty"`
	StartTime       *time.Time              `json:"start_time,omitempty"`
	Tags            *[]string               `json:"tags,omitempty"`
	To              *map[string]interface{} `json:"to,omitempty"`
	Trust           *map[string]interface{} `json:"trust,omitempty"`
	Url             *string                 `json:"url,omitempty"`
}

InsightsV1Summary struct for InsightsV1Summary

type InsightsV1VideoParticipantSummary added in v0.14.0 

type InsightsV1VideoParticipantSummary struct {
	// Account SID associated with the room.
	AccountSid *string `json:"account_sid,omitempty"`
	// Codecs detected from the participant.
	Codecs *[]string `json:"codecs,omitempty"`
	// Amount of time in seconds the participant was in the room.
	DurationSec *int `json:"duration_sec,omitempty"`
	// Name of the edge location the participant connected to.
	EdgeLocation *string `json:"edge_location,omitempty"`
	// Reason the participant left the room.
	EndReason *string `json:"end_reason,omitempty"`
	// Errors encountered by the participant.
	ErrorCode *int `json:"error_code,omitempty"`
	// Twilio error code dictionary link.
	ErrorCodeUrl *string `json:"error_code_url,omitempty"`
	// When the participant joined the room.
	JoinTime *time.Time `json:"join_time,omitempty"`
	// When the participant left the room
	LeaveTime *time.Time `json:"leave_time,omitempty"`
	// Twilio media region the participant connected to.
	MediaRegion *string `json:"media_region,omitempty"`
	// The application-defined string that uniquely identifies the participant within a Room.
	ParticipantIdentity *string `json:"participant_identity,omitempty"`
	// Unique identifier for the participant.
	ParticipantSid *string `json:"participant_sid,omitempty"`
	// Object containing information about the participant's data from the room.
	Properties *map[string]interface{} `json:"properties,omitempty"`
	// Object containing information about the SDK name and version.
	PublisherInfo *map[string]interface{} `json:"publisher_info,omitempty"`
	// Unique identifier for the room.
	RoomSid *string `json:"room_sid,omitempty"`
	// Status of the room.
	Status *string `json:"status,omitempty"`
	// URL of the participant resource.
	Url *string `json:"url,omitempty"`
}

InsightsV1VideoParticipantSummary struct for InsightsV1VideoParticipantSummary

type InsightsV1VideoRoomSummary 

type InsightsV1VideoRoomSummary struct {
	// Account SID associated with this room.
	AccountSid *string `json:"account_sid,omitempty"`
	// Codecs used by participants in the room.
	Codecs *[]string `json:"codecs,omitempty"`
	// Actual number of concurrent participants.
	ConcurrentParticipants *int `json:"concurrent_participants,omitempty"`
	// Creation time of the room.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// How the room was created.
	CreatedMethod *string `json:"created_method,omitempty"`
	// Total room duration from create time to end time.
	DurationSec *int `json:"duration_sec,omitempty"`
	// Edge location of Twilio media servers for the room.
	EdgeLocation *string `json:"edge_location,omitempty"`
	// Reason the room ended.
	EndReason *string `json:"end_reason,omitempty"`
	// End time for the room.
	EndTime *time.Time `json:"end_time,omitempty"`
	// Room subresources.
	Links *map[string]interface{} `json:"links,omitempty"`
	// Maximum number of participants allowed in the room at the same time allowed by the application settings.
	MaxConcurrentParticipants *int `json:"max_concurrent_participants,omitempty"`
	// Max number of total participants allowed by the application settings.
	MaxParticipants *int `json:"max_participants,omitempty"`
	// Region of Twilio media servers for the room.
	MediaRegion *string `json:"media_region,omitempty"`
	// Video Log Analyzer resource state. Will be either `in-progress` or `complete`.
	ProcessingState *string `json:"processing_state,omitempty"`
	// Boolean indicating if recording is enabled for the room.
	RecordingEnabled *bool `json:"recording_enabled,omitempty"`
	// room friendly name.
	RoomName *string `json:"room_name,omitempty"`
	// Unique identifier for the room.
	RoomSid *string `json:"room_sid,omitempty"`
	// Status of the room.
	RoomStatus *string `json:"room_status,omitempty"`
	// Type of room.
	RoomType *string `json:"room_type,omitempty"`
	// Webhook provided for status callbacks.
	StatusCallback *string `json:"status_callback,omitempty"`
	// HTTP method provided for status callback URL.
	StatusCallbackMethod *string `json:"status_callback_method,omitempty"`
	// Combined amount of participant time in the room.
	TotalParticipantDurationSec *int `json:"total_participant_duration_sec,omitempty"`
	// Combined amount of recorded seconds for participants in the room.
	TotalRecordingDurationSec *int `json:"total_recording_duration_sec,omitempty"`
	// Unique number of participant identities.
	UniqueParticipantIdentities *int `json:"unique_participant_identities,omitempty"`
	// Number of participants. May include duplicate identities for participants who left and rejoined.
	UniqueParticipants *int `json:"unique_participants,omitempty"`
	// URL for the room resource.
	Url *string `json:"url,omitempty"`
}

InsightsV1VideoRoomSummary struct for InsightsV1VideoRoomSummary

type ListCallSummariesParams added in v0.14.0 

type ListCallSummariesParams struct {
	//
	From *string `json:"From,omitempty"`
	//
	To *string `json:"To,omitempty"`
	//
	FromCarrier *string `json:"FromCarrier,omitempty"`
	//
	ToCarrier *string `json:"ToCarrier,omitempty"`
	//
	FromCountryCode *string `json:"FromCountryCode,omitempty"`
	//
	ToCountryCode *string `json:"ToCountryCode,omitempty"`
	//
	Branded *bool `json:"Branded,omitempty"`
	//
	VerifiedCaller *bool `json:"VerifiedCaller,omitempty"`
	//
	HasTag *bool `json:"HasTag,omitempty"`
	//
	StartTime *string `json:"StartTime,omitempty"`
	//
	EndTime *string `json:"EndTime,omitempty"`
	//
	CallType *string `json:"CallType,omitempty"`
	//
	CallState *string `json:"CallState,omitempty"`
	//
	Direction *string `json:"Direction,omitempty"`
	//
	ProcessingState *string `json:"ProcessingState,omitempty"`
	//
	SortBy *string `json:"SortBy,omitempty"`
	//
	Subaccount *string `json:"Subaccount,omitempty"`
	//
	AbnormalSession *bool `json:"AbnormalSession,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListCallSummaries'

func (*ListCallSummariesParams) SetAbnormalSession added in v0.14.1 

func (params *ListCallSummariesParams) SetAbnormalSession(AbnormalSession bool) *ListCallSummariesParams

func (*ListCallSummariesParams) SetBranded added in v0.14.0 

func (params *ListCallSummariesParams) SetBranded(Branded bool) *ListCallSummariesParams

func (*ListCallSummariesParams) SetCallState added in v0.14.0 

func (params *ListCallSummariesParams) SetCallState(CallState string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetCallType added in v0.14.0 

func (params *ListCallSummariesParams) SetCallType(CallType string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetDirection added in v0.14.0 

func (params *ListCallSummariesParams) SetDirection(Direction string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetEndTime added in v0.14.0 

func (params *ListCallSummariesParams) SetEndTime(EndTime string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetFrom added in v0.14.0 

func (params *ListCallSummariesParams) SetFrom(From string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetFromCarrier added in v0.14.0 

func (params *ListCallSummariesParams) SetFromCarrier(FromCarrier string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetFromCountryCode added in v0.14.0 

func (params *ListCallSummariesParams) SetFromCountryCode(FromCountryCode string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetHasTag added in v0.14.0 

func (params *ListCallSummariesParams) SetHasTag(HasTag bool) *ListCallSummariesParams

func (*ListCallSummariesParams) SetLimit added in v0.14.0 

func (params *ListCallSummariesParams) SetLimit(Limit int) *ListCallSummariesParams

func (*ListCallSummariesParams) SetPageSize added in v0.14.0 

func (params *ListCallSummariesParams) SetPageSize(PageSize int) *ListCallSummariesParams

func (*ListCallSummariesParams) SetProcessingState added in v0.14.0 

func (params *ListCallSummariesParams) SetProcessingState(ProcessingState string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetSortBy added in v0.14.0 

func (params *ListCallSummariesParams) SetSortBy(SortBy string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetStartTime added in v0.14.0 

func (params *ListCallSummariesParams) SetStartTime(StartTime string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetSubaccount added in v0.14.0 

func (params *ListCallSummariesParams) SetSubaccount(Subaccount string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetTo added in v0.14.0 

func (params *ListCallSummariesParams) SetTo(To string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetToCarrier added in v0.14.0 

func (params *ListCallSummariesParams) SetToCarrier(ToCarrier string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetToCountryCode added in v0.14.0 

func (params *ListCallSummariesParams) SetToCountryCode(ToCountryCode string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetVerifiedCaller added in v0.14.0 

func (params *ListCallSummariesParams) SetVerifiedCaller(VerifiedCaller bool) *ListCallSummariesParams

type ListCallSummariesResponse added in v0.14.0 

type ListCallSummariesResponse struct {
	CallSummaries []InsightsV1CallSummaries  `json:"call_summaries,omitempty"`
	Meta          ListConferenceResponseMeta `json:"meta,omitempty"`
}

ListCallSummariesResponse struct for ListCallSummariesResponse

type ListConferenceParams added in v0.20.1 

type ListConferenceParams struct {
	// The SID of the conference.
	ConferenceSid *string `json:"ConferenceSid,omitempty"`
	// Custom label for the conference resource, up to 64 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Conference status.
	Status *string `json:"Status,omitempty"`
	// Conferences created after the provided timestamp specified in ISO 8601 format
	CreatedAfter *string `json:"CreatedAfter,omitempty"`
	// Conferences created before the provided timestamp specified in ISO 8601 format.
	CreatedBefore *string `json:"CreatedBefore,omitempty"`
	// Twilio region where the conference media was mixed.
	MixerRegion *string `json:"MixerRegion,omitempty"`
	// Tags applied by Twilio for common potential configuration, quality, or performance issues.
	Tags *string `json:"Tags,omitempty"`
	// Account SID for the subaccount whose resources you wish to retrieve.
	Subaccount *string `json:"Subaccount,omitempty"`
	// Potential configuration, behavior, or performance issues detected during the conference.
	DetectedIssues *string `json:"DetectedIssues,omitempty"`
	// Conference end reason; e.g. last participant left, modified by API, etc.
	EndReason *string `json:"EndReason,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListConference'

func (*ListConferenceParams) SetConferenceSid added in v0.20.1 

func (params *ListConferenceParams) SetConferenceSid(ConferenceSid string) *ListConferenceParams

func (*ListConferenceParams) SetCreatedAfter added in v0.20.1 

func (params *ListConferenceParams) SetCreatedAfter(CreatedAfter string) *ListConferenceParams

func (*ListConferenceParams) SetCreatedBefore added in v0.20.1 

func (params *ListConferenceParams) SetCreatedBefore(CreatedBefore string) *ListConferenceParams

func (*ListConferenceParams) SetDetectedIssues added in v0.20.1 

func (params *ListConferenceParams) SetDetectedIssues(DetectedIssues string) *ListConferenceParams

func (*ListConferenceParams) SetEndReason added in v0.20.1 

func (params *ListConferenceParams) SetEndReason(EndReason string) *ListConferenceParams

func (*ListConferenceParams) SetFriendlyName added in v0.20.1 

func (params *ListConferenceParams) SetFriendlyName(FriendlyName string) *ListConferenceParams

func (*ListConferenceParams) SetLimit added in v0.20.1 

func (params *ListConferenceParams) SetLimit(Limit int) *ListConferenceParams

func (*ListConferenceParams) SetMixerRegion added in v0.20.1 

func (params *ListConferenceParams) SetMixerRegion(MixerRegion string) *ListConferenceParams

func (*ListConferenceParams) SetPageSize added in v0.20.1 

func (params *ListConferenceParams) SetPageSize(PageSize int) *ListConferenceParams

func (*ListConferenceParams) SetStatus added in v0.20.1 

func (params *ListConferenceParams) SetStatus(Status string) *ListConferenceParams

func (*ListConferenceParams) SetSubaccount added in v0.20.1 

func (params *ListConferenceParams) SetSubaccount(Subaccount string) *ListConferenceParams

func (*ListConferenceParams) SetTags added in v0.20.1 

func (params *ListConferenceParams) SetTags(Tags string) *ListConferenceParams

type ListConferenceParticipantParams added in v0.20.1 

type ListConferenceParticipantParams struct {
	// The unique SID identifier of the Participant.
	ParticipantSid *string `json:"ParticipantSid,omitempty"`
	// User-specified label for a participant.
	Label *string `json:"Label,omitempty"`
	// Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc.
	Events *string `json:"Events,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListConferenceParticipant'

func (*ListConferenceParticipantParams) SetEvents added in v0.20.1 

func (params *ListConferenceParticipantParams) SetEvents(Events string) *ListConferenceParticipantParams

func (*ListConferenceParticipantParams) SetLabel added in v0.20.1 

func (params *ListConferenceParticipantParams) SetLabel(Label string) *ListConferenceParticipantParams

func (*ListConferenceParticipantParams) SetLimit added in v0.20.1 

func (params *ListConferenceParticipantParams) SetLimit(Limit int) *ListConferenceParticipantParams

func (*ListConferenceParticipantParams) SetPageSize added in v0.20.1 

func (params *ListConferenceParticipantParams) SetPageSize(PageSize int) *ListConferenceParticipantParams

func (*ListConferenceParticipantParams) SetParticipantSid added in v0.20.1 

func (params *ListConferenceParticipantParams) SetParticipantSid(ParticipantSid string) *ListConferenceParticipantParams

type ListConferenceParticipantResponse added in v0.20.1 

type ListConferenceParticipantResponse struct {
	Meta         ListConferenceResponseMeta        `json:"meta,omitempty"`
	Participants []InsightsV1ConferenceParticipant `json:"participants,omitempty"`
}

ListConferenceParticipantResponse struct for ListConferenceParticipantResponse

type ListConferenceResponse added in v0.20.1 

type ListConferenceResponse struct {
	Conferences []InsightsV1Conference     `json:"conferences,omitempty"`
	Meta        ListConferenceResponseMeta `json:"meta,omitempty"`
}

ListConferenceResponse struct for ListConferenceResponse

type ListConferenceResponseMeta added in v0.20.1 

type ListConferenceResponseMeta struct {
	FirstPageUrl    string `json:"first_page_url,omitempty"`
	Key             string `json:"key,omitempty"`
	NextPageUrl     string `json:"next_page_url,omitempty"`
	Page            int    `json:"page,omitempty"`
	PageSize        int    `json:"page_size,omitempty"`
	PreviousPageUrl string `json:"previous_page_url,omitempty"`
	Url             string `json:"url,omitempty"`
}

ListConferenceResponseMeta struct for ListConferenceResponseMeta

type ListEventParams 

type ListEventParams struct {
	//
	Edge *string `json:"Edge,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListEvent'

func (*ListEventParams) SetEdge 

func (params *ListEventParams) SetEdge(Edge string) *ListEventParams

func (*ListEventParams) SetLimit added in v0.13.0 

func (params *ListEventParams) SetLimit(Limit int) *ListEventParams

func (*ListEventParams) SetPageSize 

func (params *ListEventParams) SetPageSize(PageSize int) *ListEventParams

type ListEventResponse 

type ListEventResponse struct {
	Events []InsightsV1Event          `json:"events,omitempty"`
	Meta   ListConferenceResponseMeta `json:"meta,omitempty"`
}

ListEventResponse struct for ListEventResponse

type ListMetricParams 

type ListMetricParams struct {
	//
	Edge *string `json:"Edge,omitempty"`
	//
	Direction *string `json:"Direction,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListMetric'

func (*ListMetricParams) SetDirection 

func (params *ListMetricParams) SetDirection(Direction string) *ListMetricParams

func (*ListMetricParams) SetEdge 

func (params *ListMetricParams) SetEdge(Edge string) *ListMetricParams

func (*ListMetricParams) SetLimit added in v0.13.0 

func (params *ListMetricParams) SetLimit(Limit int) *ListMetricParams

func (*ListMetricParams) SetPageSize 

func (params *ListMetricParams) SetPageSize(PageSize int) *ListMetricParams

type ListMetricResponse 

type ListMetricResponse struct {
	Meta    ListConferenceResponseMeta `json:"meta,omitempty"`
	Metrics []InsightsV1Metric         `json:"metrics,omitempty"`
}

ListMetricResponse struct for ListMetricResponse

type ListVideoParticipantSummaryParams 

type ListVideoParticipantSummaryParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListVideoParticipantSummary'

func (*ListVideoParticipantSummaryParams) SetLimit added in v0.13.0 

func (params *ListVideoParticipantSummaryParams) SetLimit(Limit int) *ListVideoParticipantSummaryParams

func (*ListVideoParticipantSummaryParams) SetPageSize 

func (params *ListVideoParticipantSummaryParams) SetPageSize(PageSize int) *ListVideoParticipantSummaryParams

type ListVideoParticipantSummaryResponse 

type ListVideoParticipantSummaryResponse struct {
	Meta         ListConferenceResponseMeta          `json:"meta,omitempty"`
	Participants []InsightsV1VideoParticipantSummary `json:"participants,omitempty"`
}

ListVideoParticipantSummaryResponse struct for ListVideoParticipantSummaryResponse

type ListVideoRoomSummaryParams 

type ListVideoRoomSummaryParams struct {
	// Type of room. Can be `go`, `peer_to_peer`, `group`, or `group_small`.
	RoomType *[]string `json:"RoomType,omitempty"`
	// Codecs used by participants in the room. Can be `VP8`, `H264`, or `VP9`.
	Codec *[]string `json:"Codec,omitempty"`
	// Room friendly name.
	RoomName *string `json:"RoomName,omitempty"`
	// Only read rooms that started on or after this ISO 8601 timestamp.
	CreatedAfter *time.Time `json:"CreatedAfter,omitempty"`
	// Only read rooms that started before this ISO 8601 timestamp.
	CreatedBefore *time.Time `json:"CreatedBefore,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListVideoRoomSummary'

func (*ListVideoRoomSummaryParams) SetCodec 

func (params *ListVideoRoomSummaryParams) SetCodec(Codec []string) *ListVideoRoomSummaryParams

func (*ListVideoRoomSummaryParams) SetCreatedAfter 

func (params *ListVideoRoomSummaryParams) SetCreatedAfter(CreatedAfter time.Time) *ListVideoRoomSummaryParams

func (*ListVideoRoomSummaryParams) SetCreatedBefore 

func (params *ListVideoRoomSummaryParams) SetCreatedBefore(CreatedBefore time.Time) *ListVideoRoomSummaryParams

func (*ListVideoRoomSummaryParams) SetLimit added in v0.13.0 

func (params *ListVideoRoomSummaryParams) SetLimit(Limit int) *ListVideoRoomSummaryParams

func (*ListVideoRoomSummaryParams) SetPageSize 

func (params *ListVideoRoomSummaryParams) SetPageSize(PageSize int) *ListVideoRoomSummaryParams

func (*ListVideoRoomSummaryParams) SetRoomName 

func (params *ListVideoRoomSummaryParams) SetRoomName(RoomName string) *ListVideoRoomSummaryParams

func (*ListVideoRoomSummaryParams) SetRoomType 

func (params *ListVideoRoomSummaryParams) SetRoomType(RoomType []string) *ListVideoRoomSummaryParams

type ListVideoRoomSummaryResponse 

type ListVideoRoomSummaryResponse struct {
	Meta  ListConferenceResponseMeta   `json:"meta,omitempty"`
	Rooms []InsightsV1VideoRoomSummary `json:"rooms,omitempty"`
}

ListVideoRoomSummaryResponse struct for ListVideoRoomSummaryResponse

type UpdateAccountSettingsParams added in v0.19.0 

type UpdateAccountSettingsParams struct {
	//
	AdvancedFeatures *bool `json:"AdvancedFeatures,omitempty"`
	//
	SubaccountSid *string `json:"SubaccountSid,omitempty"`
	//
	VoiceTrace *bool `json:"VoiceTrace,omitempty"`
}

Optional parameters for the method 'UpdateAccountSettings'

func (*UpdateAccountSettingsParams) SetAdvancedFeatures added in v0.19.0 

func (params *UpdateAccountSettingsParams) SetAdvancedFeatures(AdvancedFeatures bool) *UpdateAccountSettingsParams

func (*UpdateAccountSettingsParams) SetSubaccountSid added in v0.19.0 

func (params *UpdateAccountSettingsParams) SetSubaccountSid(SubaccountSid string) *UpdateAccountSettingsParams

func (*UpdateAccountSettingsParams) SetVoiceTrace added in v0.19.0 

func (params *UpdateAccountSettingsParams) SetVoiceTrace(VoiceTrace bool) *UpdateAccountSettingsParams

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.