openapi

package
v1.10.0 Latest Latest
Warning

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

 Go to latest Published: Jul 13, 2023 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.46.0
  • 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}
VoiceAnnotationApi FetchAnnotation Get /v1/Voice/{CallSid}/Annotation
VoiceAnnotationApi UpdateAnnotation Post /v1/Voice/{CallSid}/Annotation
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)

Get the Voice Insights Settings.

func (*ApiService) FetchAnnotation added in v0.23.0 

func (c *ApiService) FetchAnnotation(CallSid string) (*InsightsV1Annotation, error)

Get the Annotation for a specific Call.

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)

Get a specific Conference Summary.

func (*ApiService) FetchConferenceParticipant added in v0.20.1 

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

Get a specific Conference Participant Summary for a Conference.

func (*ApiService) FetchSummary added in v0.11.0 

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

Get a specific Call Summary.

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, chan 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, chan 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, chan 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, chan 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, chan 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, chan 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, chan 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)

Update a specific Voice Insights Setting.

func (*ApiService) UpdateAnnotation added in v0.23.0 

func (c *ApiService) UpdateAnnotation(CallSid string, params *UpdateAnnotationParams) (*InsightsV1Annotation, error)

Update an Annotation for a specific Call.

type FetchAccountSettingsParams added in v0.19.0 

type FetchAccountSettingsParams struct {
	// The unique SID identifier of the Subaccount.
	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 {
	// The Processing State of this Call Summary. One of `complete`, `partial` or `all`.
	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 {
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// A boolean flag indicating whether Advanced Features for Voice Insights are enabled.
	AdvancedFeatures *bool `json:"advanced_features,omitempty"`
	// A boolean flag indicating whether Voice Trace is enabled.
	VoiceTrace *bool `json:"voice_trace,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

InsightsV1AccountSettings struct for InsightsV1AccountSettings

type InsightsV1Annotation added in v0.23.0 

type InsightsV1Annotation struct {
	// The unique SID identifier of the Call.
	CallSid *string `json:"call_sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid        *string `json:"account_sid,omitempty"`
	AnsweredBy        *string `json:"answered_by,omitempty"`
	ConnectivityIssue *string `json:"connectivity_issue,omitempty"`
	// Specifies if the call had any subjective quality issues. Possible values are one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, or `static_noise`.
	QualityIssues *[]string `json:"quality_issues,omitempty"`
	// Specifies if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.
	Spam *bool `json:"spam,omitempty"`
	// Specifies the Call Score, if available. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
	CallScore *int `json:"call_score,omitempty"`
	// Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments.
	Comment *string `json:"comment,omitempty"`
	// Incident or support ticket associated with this call. The `incident` property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
	Incident *string `json:"incident,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

InsightsV1Annotation struct for InsightsV1Annotation

type InsightsV1Call 

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

InsightsV1Call struct for InsightsV1Call

type InsightsV1CallSummaries added in v0.14.0 

type InsightsV1CallSummaries struct {
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique SID identifier of the Call.
	CallSid         *string `json:"call_sid,omitempty"`
	AnsweredBy      *string `json:"answered_by,omitempty"`
	CallType        *string `json:"call_type,omitempty"`
	CallState       *string `json:"call_state,omitempty"`
	ProcessingState *string `json:"processing_state,omitempty"`
	// The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS
	CreatedTime *time.Time `json:"created_time,omitempty"`
	// The time at which the Call was started, given in ISO 8601 format.
	StartTime *time.Time `json:"start_time,omitempty"`
	// The time at which the Call was ended, given in ISO 8601 format.
	EndTime *time.Time `json:"end_time,omitempty"`
	// Duration between when the call was initiated and the call was ended
	Duration *int `json:"duration,omitempty"`
	// Duration between when the call was answered and when it ended
	ConnectDuration *int `json:"connect_duration,omitempty"`
	// The calling party.
	From *interface{} `json:"from,omitempty"`
	// The called party.
	To *interface{} `json:"to,omitempty"`
	// Contains metrics and properties for the Twilio media gateway of a PSTN call.
	CarrierEdge *interface{} `json:"carrier_edge,omitempty"`
	// Contains metrics and properties for the Twilio media gateway of a Client call.
	ClientEdge *interface{} `json:"client_edge,omitempty"`
	// Contains metrics and properties for the SDK sensor library for Client calls.
	SdkEdge *interface{} `json:"sdk_edge,omitempty"`
	// Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
	SipEdge *interface{} `json:"sip_edge,omitempty"`
	// Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
	Tags *[]string `json:"tags,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
	// Attributes capturing call-flow-specific details.
	Attributes *interface{} `json:"attributes,omitempty"`
	// Contains edge-agnostic call-level details.
	Properties *interface{} `json:"properties,omitempty"`
	// Contains trusted communications details including Branded Call and verified caller ID.
	Trust      *interface{} `json:"trust,omitempty"`
	Annotation *interface{} `json:"annotation,omitempty"`
}

InsightsV1CallSummaries struct for InsightsV1CallSummaries

type InsightsV1Conference added in v0.20.1 

type InsightsV1Conference struct {
	// The unique SID identifier of the Conference.
	ConferenceSid *string `json:"conference_sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// Custom label for the conference resource, up to 64 characters.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// Conference creation date and time in ISO 8601 format.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// Timestamp in ISO 8601 format when the conference started. Conferences do not start until at least two participants join, at least one of whom has startConferenceOnEnter=true.
	StartTime *time.Time `json:"start_time,omitempty"`
	// Conference end date and time in ISO 8601 format.
	EndTime *time.Time `json:"end_time,omitempty"`
	// Conference duration in seconds.
	DurationSeconds *int `json:"duration_seconds,omitempty"`
	// Duration of the between conference start event and conference end event in seconds.
	ConnectDurationSeconds *int    `json:"connect_duration_seconds,omitempty"`
	Status                 *string `json:"status,omitempty"`
	// Maximum number of concurrent participants as specified by the configuration.
	MaxParticipants *int `json:"max_participants,omitempty"`
	// Actual maximum number of concurrent participants in the conference.
	MaxConcurrentParticipants *int `json:"max_concurrent_participants,omitempty"`
	// Unique conference participants based on caller ID.
	UniqueParticipants *int    `json:"unique_participants,omitempty"`
	EndReason          *string `json:"end_reason,omitempty"`
	// Call SID of the participant whose actions ended the conference.
	EndedBy              *string `json:"ended_by,omitempty"`
	MixerRegion          *string `json:"mixer_region,omitempty"`
	MixerRegionRequested *string `json:"mixer_region_requested,omitempty"`
	// Boolean. Indicates whether recording was enabled at the conference mixer.
	RecordingEnabled *bool `json:"recording_enabled,omitempty"`
	// Potential issues detected by Twilio during the conference.
	DetectedIssues *interface{} `json:"detected_issues,omitempty"`
	// Tags for detected conference conditions and participant behaviors which may be of interest.
	Tags *[]string `json:"tags,omitempty"`
	// Object. Contains details about conference tags including severity.
	TagInfo         *interface{} `json:"tag_info,omitempty"`
	ProcessingState *string      `json:"processing_state,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
	// Contains a dictionary of URL links to nested resources of this Conference.
	Links *map[string]interface{} `json:"links,omitempty"`
}

InsightsV1Conference struct for InsightsV1Conference

type InsightsV1ConferenceParticipant added in v0.20.1 

type InsightsV1ConferenceParticipant struct {
	// SID for this participant.
	ParticipantSid *string `json:"participant_sid,omitempty"`
	// The user-specified label of this participant.
	Label *string `json:"label,omitempty"`
	// The unique SID identifier of the Conference.
	ConferenceSid *string `json:"conference_sid,omitempty"`
	// Unique SID identifier of the call that generated the Participant resource.
	CallSid *string `json:"call_sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid    *string `json:"account_sid,omitempty"`
	CallDirection *string `json:"call_direction,omitempty"`
	// Caller ID of the calling party.
	From *string `json:"from,omitempty"`
	// Called party.
	To         *string `json:"to,omitempty"`
	CallStatus *string `json:"call_status,omitempty"`
	// ISO alpha-2 country code of the participant based on caller ID or called number.
	CountryCode *string `json:"country_code,omitempty"`
	// Boolean. Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true.
	IsModerator *bool `json:"is_moderator,omitempty"`
	// ISO 8601 timestamp of participant join event.
	JoinTime *time.Time `json:"join_time,omitempty"`
	// ISO 8601 timestamp of participant leave event.
	LeaveTime *time.Time `json:"leave_time,omitempty"`
	// Participant durations in seconds.
	DurationSeconds *int `json:"duration_seconds,omitempty"`
	// Add Participant API only. Estimated time in queue at call creation.
	OutboundQueueLength *int `json:"outbound_queue_length,omitempty"`
	// Add Participant API only. Actual time in queue in seconds.
	OutboundTimeInQueue *int    `json:"outbound_time_in_queue,omitempty"`
	JitterBufferSize    *string `json:"jitter_buffer_size,omitempty"`
	// Boolean. Indicated whether participant was a coach.
	IsCoach *bool `json:"is_coach,omitempty"`
	// Call SIDs coached by this participant.
	CoachedParticipants *[]string `json:"coached_participants,omitempty"`
	ParticipantRegion   *string   `json:"participant_region,omitempty"`
	ConferenceRegion    *string   `json:"conference_region,omitempty"`
	CallType            *string   `json:"call_type,omitempty"`
	ProcessingState     *string   `json:"processing_state,omitempty"`
	// Participant properties and metadata.
	Properties *interface{} `json:"properties,omitempty"`
	// Object containing information of actions taken by participants. Contains a dictionary of URL links to nested resources of this Conference Participant.
	Events *interface{} `json:"events,omitempty"`
	// Object. Contains participant call quality metrics.
	Metrics *interface{} `json:"metrics,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 {
	// Event time.
	Timestamp *string `json:"timestamp,omitempty"`
	// The unique SID identifier of the Call.
	CallSid *string `json:"call_sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	Edge       *string `json:"edge,omitempty"`
	// Event group.
	Group *string `json:"group,omitempty"`
	Level *string `json:"level,omitempty"`
	// Event name.
	Name *string `json:"name,omitempty"`
	// Represents the connection between Twilio and our immediate carrier partners. The events here describe the call lifecycle as reported by Twilio's carrier media gateways.
	CarrierEdge *interface{} `json:"carrier_edge,omitempty"`
	// Represents the Twilio media gateway for SIP interface and SIP trunking calls. The events here describe the call lifecycle as reported by Twilio's public media gateways.
	SipEdge *interface{} `json:"sip_edge,omitempty"`
	// Represents the Voice SDK running locally in the browser or in the Android/iOS application. The events here are emitted by the Voice SDK in response to certain call progress events, network changes, or call quality conditions.
	SdkEdge *interface{} `json:"sdk_edge,omitempty"`
	// Represents the Twilio media gateway for Client calls. The events here describe the call lifecycle as reported by Twilio's Voice SDK media gateways.
	ClientEdge *interface{} `json:"client_edge,omitempty"`
}

InsightsV1Event struct for InsightsV1Event

type InsightsV1Metric added in v0.14.0 

type InsightsV1Metric struct {
	// Timestamp of metric sample. Samples are taken every 10 seconds and contain the metrics for the previous 10 seconds.
	Timestamp *string `json:"timestamp,omitempty"`
	// The unique SID identifier of the Call.
	CallSid *string `json:"call_sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	Edge       *string `json:"edge,omitempty"`
	Direction  *string `json:"direction,omitempty"`
	// Contains metrics and properties for the Twilio media gateway of a PSTN call.
	CarrierEdge *interface{} `json:"carrier_edge,omitempty"`
	// Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
	SipEdge *interface{} `json:"sip_edge,omitempty"`
	// Contains metrics and properties for the SDK sensor library for Client calls.
	SdkEdge *interface{} `json:"sdk_edge,omitempty"`
	// Contains metrics and properties for the Twilio media gateway of a Client call.
	ClientEdge *interface{} `json:"client_edge,omitempty"`
}

InsightsV1Metric struct for InsightsV1Metric

type InsightsV1Summary added in v0.14.0 

type InsightsV1Summary struct {
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique SID identifier of the Call.
	CallSid         *string `json:"call_sid,omitempty"`
	CallType        *string `json:"call_type,omitempty"`
	CallState       *string `json:"call_state,omitempty"`
	AnsweredBy      *string `json:"answered_by,omitempty"`
	ProcessingState *string `json:"processing_state,omitempty"`
	// The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS
	CreatedTime *time.Time `json:"created_time,omitempty"`
	// The time at which the Call was started, given in ISO 8601 format.
	StartTime *time.Time `json:"start_time,omitempty"`
	// The time at which the Call was ended, given in ISO 8601 format.
	EndTime *time.Time `json:"end_time,omitempty"`
	// Duration between when the call was initiated and the call was ended
	Duration *int `json:"duration,omitempty"`
	// Duration between when the call was answered and when it ended
	ConnectDuration *int `json:"connect_duration,omitempty"`
	// The calling party.
	From *interface{} `json:"from,omitempty"`
	// The called party.
	To *interface{} `json:"to,omitempty"`
	// Contains metrics and properties for the Twilio media gateway of a PSTN call.
	CarrierEdge *interface{} `json:"carrier_edge,omitempty"`
	// Contains metrics and properties for the Twilio media gateway of a Client call.
	ClientEdge *interface{} `json:"client_edge,omitempty"`
	// Contains metrics and properties for the SDK sensor library for Client calls.
	SdkEdge *interface{} `json:"sdk_edge,omitempty"`
	// Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
	SipEdge *interface{} `json:"sip_edge,omitempty"`
	// Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
	Tags *[]string `json:"tags,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
	// Attributes capturing call-flow-specific details.
	Attributes *interface{} `json:"attributes,omitempty"`
	// Contains edge-agnostic call-level details.
	Properties *interface{} `json:"properties,omitempty"`
	// Contains trusted communications details including Branded Call and verified caller ID.
	Trust *interface{} `json:"trust,omitempty"`
	// Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API.
	Annotation *interface{} `json:"annotation,omitempty"`
}

InsightsV1Summary struct for InsightsV1Summary

type InsightsV1VideoParticipantSummary added in v0.14.0 

type InsightsV1VideoParticipantSummary struct {
	// Unique identifier for the participant.
	ParticipantSid *string `json:"participant_sid,omitempty"`
	// The application-defined string that uniquely identifies the participant within a Room.
	ParticipantIdentity *string `json:"participant_identity,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"`
	// Amount of time in seconds the participant was in the room.
	DurationSec *int64 `json:"duration_sec,omitempty"`
	// Account SID associated with the room.
	AccountSid *string `json:"account_sid,omitempty"`
	// Unique identifier for the room.
	RoomSid *string `json:"room_sid,omitempty"`
	Status  *string `json:"status,omitempty"`
	// Codecs detected from the participant. Can be `VP8`, `H264`, or `VP9`.
	Codecs *[]string `json:"codecs,omitempty"`
	// Reason the participant left the room. See [the list of possible values here](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#end_reason).
	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"`
	MediaRegion  *string `json:"media_region,omitempty"`
	// Object containing information about the participant's data from the room. See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#properties) for more information.
	Properties   *interface{} `json:"properties,omitempty"`
	EdgeLocation *string      `json:"edge_location,omitempty"`
	// Object containing information about the SDK name and version. See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#publisher_info) for more information.
	PublisherInfo *interface{} `json:"publisher_info,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"`
	// Unique identifier for the room.
	RoomSid *string `json:"room_sid,omitempty"`
	// Room friendly name.
	RoomName *string `json:"room_name,omitempty"`
	// Creation time of the room.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// End time for the room.
	EndTime    *time.Time `json:"end_time,omitempty"`
	RoomType   *string    `json:"room_type,omitempty"`
	RoomStatus *string    `json:"room_status,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"`
	CreatedMethod        *string `json:"created_method,omitempty"`
	EndReason            *string `json:"end_reason,omitempty"`
	// Max number of total participants allowed by the application settings.
	MaxParticipants *int `json:"max_participants,omitempty"`
	// Number of participants. May include duplicate identities for participants who left and rejoined.
	UniqueParticipants *int `json:"unique_participants,omitempty"`
	// Unique number of participant identities.
	UniqueParticipantIdentities *int `json:"unique_participant_identities,omitempty"`
	// Actual number of concurrent participants.
	ConcurrentParticipants *int `json:"concurrent_participants,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"`
	// Codecs used by participants in the room. Can be `VP8`, `H264`, or `VP9`.
	Codecs      *[]string `json:"codecs,omitempty"`
	MediaRegion *string   `json:"media_region,omitempty"`
	// Total room duration from create time to end time.
	DurationSec *int64 `json:"duration_sec,omitempty"`
	// Combined amount of participant time in the room.
	TotalParticipantDurationSec *int64 `json:"total_participant_duration_sec,omitempty"`
	// Combined amount of recorded seconds for participants in the room.
	TotalRecordingDurationSec *int64  `json:"total_recording_duration_sec,omitempty"`
	ProcessingState           *string `json:"processing_state,omitempty"`
	// Boolean indicating if recording is enabled for the room.
	RecordingEnabled *bool   `json:"recording_enabled,omitempty"`
	EdgeLocation     *string `json:"edge_location,omitempty"`
	// URL for the room resource.
	Url *string `json:"url,omitempty"`
	// Room subresources.
	Links *map[string]interface{} `json:"links,omitempty"`
}

InsightsV1VideoRoomSummary struct for InsightsV1VideoRoomSummary

type ListCallSummariesParams added in v0.14.0 

type ListCallSummariesParams struct {
	// A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
	From *string `json:"From,omitempty"`
	// A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
	To *string `json:"To,omitempty"`
	// An origination carrier.
	FromCarrier *string `json:"FromCarrier,omitempty"`
	// A destination carrier.
	ToCarrier *string `json:"ToCarrier,omitempty"`
	// A source country code based on phone number in From.
	FromCountryCode *string `json:"FromCountryCode,omitempty"`
	// A destination country code. Based on phone number in To.
	ToCountryCode *string `json:"ToCountryCode,omitempty"`
	// A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.
	Branded *bool `json:"Branded,omitempty"`
	// A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.
	VerifiedCaller *bool `json:"VerifiedCaller,omitempty"`
	// A boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).
	HasTag *bool `json:"HasTag,omitempty"`
	// A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.
	StartTime *string `json:"StartTime,omitempty"`
	// An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.
	EndTime *string `json:"EndTime,omitempty"`
	// A Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`.
	CallType *string `json:"CallType,omitempty"`
	// A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.
	CallState *string `json:"CallState,omitempty"`
	// A Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.
	Direction *string `json:"Direction,omitempty"`
	// A Processing State of the Call Summaries. One of `completed`, `partial` or `all`.
	ProcessingState *string `json:"ProcessingState,omitempty"`
	// A Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`.
	SortBy *string `json:"SortBy,omitempty"`
	// A unique SID identifier of a Subaccount.
	Subaccount *string `json:"Subaccount,omitempty"`
	// A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
	AbnormalSession *bool `json:"AbnormalSession,omitempty"`
	// An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.
	AnsweredBy *string `json:"AnsweredBy,omitempty"`
	// A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
	ConnectivityIssue *string `json:"ConnectivityIssue,omitempty"`
	// A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
	QualityIssue *string `json:"QualityIssue,omitempty"`
	// A boolean flag indicating spam calls.
	Spam *bool `json:"Spam,omitempty"`
	// A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
	CallScore *string `json:"CallScore,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) SetAnsweredBy added in v1.5.0 

func (params *ListCallSummariesParams) SetAnsweredBy(AnsweredBy string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetBranded added in v0.14.0 

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

func (*ListCallSummariesParams) SetCallScore added in v1.8.0 

func (params *ListCallSummariesParams) SetCallScore(CallScore string) *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) SetConnectivityIssue added in v1.8.0 

func (params *ListCallSummariesParams) SetConnectivityIssue(ConnectivityIssue 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) SetQualityIssue added in v1.8.0 

func (params *ListCallSummariesParams) SetQualityIssue(QualityIssue string) *ListCallSummariesParams

func (*ListCallSummariesParams) SetSortBy added in v0.14.0 

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

func (*ListCallSummariesParams) SetSpam added in v1.7.1 

func (params *ListCallSummariesParams) SetSpam(Spam bool) *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          ListCallSummariesResponseMeta `json:"meta,omitempty"`
}

ListCallSummariesResponse struct for ListCallSummariesResponse

type ListCallSummariesResponseMeta added in v1.0.0 

type ListCallSummariesResponseMeta struct {
	FirstPageUrl    string  `json:"first_page_url,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"`
	Key             string  `json:"key,omitempty"`
}

ListCallSummariesResponseMeta struct for ListCallSummariesResponseMeta

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 {
	Participants []InsightsV1ConferenceParticipant `json:"participants,omitempty"`
	Meta         ListCallSummariesResponseMeta     `json:"meta,omitempty"`
}

ListConferenceParticipantResponse struct for ListConferenceParticipantResponse

type ListConferenceResponse added in v0.20.1 

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

ListConferenceResponse struct for ListConferenceResponse

type ListEventParams 

type ListEventParams struct {
	// The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
	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   ListCallSummariesResponseMeta `json:"meta,omitempty"`
}

ListEventResponse struct for ListEventResponse

type ListMetricParams 

type ListMetricParams struct {
	// The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
	Edge *string `json:"Edge,omitempty"`
	// The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.
	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 {
	Metrics []InsightsV1Metric            `json:"metrics,omitempty"`
	Meta    ListCallSummariesResponseMeta `json:"meta,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 {
	Participants []InsightsV1VideoParticipantSummary `json:"participants,omitempty"`
	Meta         ListCallSummariesResponseMeta       `json:"meta,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 {
	Rooms []InsightsV1VideoRoomSummary  `json:"rooms,omitempty"`
	Meta  ListCallSummariesResponseMeta `json:"meta,omitempty"`
}

ListVideoRoomSummaryResponse struct for ListVideoRoomSummaryResponse

type UpdateAccountSettingsParams added in v0.19.0 

type UpdateAccountSettingsParams struct {
	// A boolean flag to enable Advanced Features for Voice Insights.
	AdvancedFeatures *bool `json:"AdvancedFeatures,omitempty"`
	// A boolean flag to enable Voice Trace.
	VoiceTrace *bool `json:"VoiceTrace,omitempty"`
	// The unique SID identifier of the Subaccount.
	SubaccountSid *string `json:"SubaccountSid,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

type UpdateAnnotationParams added in v0.23.0 

type UpdateAnnotationParams struct {
	//
	AnsweredBy *string `json:"AnsweredBy,omitempty"`
	//
	ConnectivityIssue *string `json:"ConnectivityIssue,omitempty"`
	// Specify if the call had any subjective quality issues. Possible values, one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. Use comma separated values to indicate multiple quality issues for the same call.
	QualityIssues *string `json:"QualityIssues,omitempty"`
	// A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use `true` if the call was a spam call.
	Spam *bool `json:"Spam,omitempty"`
	// Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
	CallScore *int `json:"CallScore,omitempty"`
	// Specify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`.
	Comment *string `json:"Comment,omitempty"`
	// Associate this call with an incident or support ticket. The `incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
	Incident *string `json:"Incident,omitempty"`
}

Optional parameters for the method 'UpdateAnnotation'

func (*UpdateAnnotationParams) SetAnsweredBy added in v0.23.0 

func (params *UpdateAnnotationParams) SetAnsweredBy(AnsweredBy string) *UpdateAnnotationParams

func (*UpdateAnnotationParams) SetCallScore added in v0.23.0 

func (params *UpdateAnnotationParams) SetCallScore(CallScore int) *UpdateAnnotationParams

func (*UpdateAnnotationParams) SetComment added in v0.23.0 

func (params *UpdateAnnotationParams) SetComment(Comment string) *UpdateAnnotationParams

func (*UpdateAnnotationParams) SetConnectivityIssue added in v0.23.0 

func (params *UpdateAnnotationParams) SetConnectivityIssue(ConnectivityIssue string) *UpdateAnnotationParams

func (*UpdateAnnotationParams) SetIncident added in v0.23.0 

func (params *UpdateAnnotationParams) SetIncident(Incident string) *UpdateAnnotationParams

func (*UpdateAnnotationParams) SetQualityIssues added in v0.23.0 

func (params *UpdateAnnotationParams) SetQualityIssues(QualityIssues string) *UpdateAnnotationParams

func (*UpdateAnnotationParams) SetSpam added in v0.23.0 

func (params *UpdateAnnotationParams) SetSpam(Spam bool) *UpdateAnnotationParams

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.