calls

package
v0.25.0 Latest Latest
Warning

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

 Go to latest Published: Dec 20, 2022 License: Apache-2.0 Imports: 8 Imported by: 2

Documentation

Overview

Package calls contains auto-generated files. DO NOT MODIFY

Package calls contains auto-generated files. DO NOT MODIFY

Package calls contains auto-generated files. DO NOT MODIFY

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CallsPage 

type CallsPage struct {
	CurrentPage *CallsPageResponse
	Error       error
	// contains filtered or unexported fields
}

CallsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageCallResponse or error that is returned from the api call(s)

type CallsPageOptions 

type CallsPageOptions struct {
	PageSize      *int
	Page          *int
	PageToken     *string
	To            *string
	From          *string
	ParentCallSid *string
	Status        *string
	StartTime     *string
	EndTime       *string
}

CallsPageOptions defines the query options for the api operation

type CallsPageResponse 

type CallsPageResponse struct {
	Calls           []PageCallResponse `json:"calls"`
	End             int                `json:"end"`
	FirstPageURI    string             `json:"first_page_uri"`
	NextPageURI     *string            `json:"next_page_uri,omitempty"`
	Page            int                `json:"page"`
	PageSize        int                `json:"page_size"`
	PreviousPageURI *string            `json:"previous_page_uri,omitempty"`
	Start           int                `json:"start"`
	URI             string             `json:"uri"`
}

CallsPageResponse defines the response fields for the calls page

type CallsPaginator 

type CallsPaginator struct {
	Page  *CallsPage
	Calls []PageCallResponse
	// contains filtered or unexported fields
}

CallsPaginator defines the fields for makings paginated api calls Calls is an array of calls that have been returned from all of the page calls

func (*CallsPaginator) CurrentPage 

func (p *CallsPaginator) CurrentPage() *CallsPageResponse

CurrentPage retrieves the results for the current page

func (*CallsPaginator) Error 

func (p *CallsPaginator) Error() error

Error retrieves the error returned from the page

func (*CallsPaginator) Next 

func (p *CallsPaginator) Next() bool

Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (*CallsPaginator) NextWithContext 

func (p *CallsPaginator) NextWithContext(context context.Context) bool

NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate

type Client 

type Client struct {
	FeedbackSummaries *feedback_summaries.Client
	FeedbackSummary   func(string) *feedback_summary.Client
	// contains filtered or unexported fields
}

Client for managing call resources See https://www.twilio.com/docs/voice/api/call-resource for more details

func New 

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the calls client

func (Client) Create 

func (c Client) Create(input *CreateCallInput) (*CreateCallResponse, error)

Create creates a new call resource See https://www.twilio.com/docs/voice/api/call-resource#create-a-call-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext 

func (c Client) CreateWithContext(context context.Context, input *CreateCallInput) (*CreateCallResponse, error)

CreateWithContext creates a new call resource See https://www.twilio.com/docs/voice/api/call-resource#create-a-call-resource for more details

func (*Client) NewCallsPaginator 

func (c *Client) NewCallsPaginator() *CallsPaginator

NewCallsPaginator creates a new instance of the paginator for Page.

func (*Client) NewCallsPaginatorWithOptions 

func (c *Client) NewCallsPaginatorWithOptions(options *CallsPageOptions) *CallsPaginator

NewCallsPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page 

func (c Client) Page(options *CallsPageOptions) (*CallsPageResponse, error)

Page retrieves a page of calls See https://www.twilio.com/docs/voice/api/call-resource#read-multiple-call-resources for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) PageWithContext 

func (c Client) PageWithContext(context context.Context, options *CallsPageOptions) (*CallsPageResponse, error)

PageWithContext retrieves a page of calls See https://www.twilio.com/docs/voice/api/call-resource#read-multiple-call-resources for more details

type ClientProperties 

type ClientProperties struct {
	AccountSid string
}

ClientProperties are the properties required to manage the calls resources

type CreateCallInput 

type CreateCallInput struct {
	ApplicationSid                     *string   `form:"ApplicationSid,omitempty"`
	AsyncAMD                           *bool     `form:"AsyncAmd,omitempty"`
	AsyncAMDStatusCallback             *string   `form:"AsyncAmdStatusCallback,omitempty"`
	AsyncAmdStatusCallbackMethod       *string   `form:"AsyncAmdStatusCallbackMethod,omitempty"`
	Byoc                               *string   `form:"Byoc,omitempty"`
	CallReason                         *string   `form:"CallReason,omitempty"`
	CallerID                           *string   `form:"CallerId,omitempty"`
	FallbackMethod                     *string   `form:"FallbackMethod,omitempty"`
	FallbackURL                        *string   `form:"FallbackUrl,omitempty"`
	From                               string    `validate:"required" form:"From"`
	MachineDetection                   *string   `form:"MachineDetection,omitempty"`
	MachineDetectionSilenceTimeout     *int      `form:"MachineDetectionSilenceTimeout,omitempty"`
	MachineDetectionSpeechEndThreshold *int      `form:"MachineDetectionSpeechEndThreshold,omitempty"`
	MachineDetectionSpeechThreshold    *int      `form:"MachineDetectionSpeechThreshold,omitempty"`
	MachineDetectionTimeout            *int      `form:"MachineDetectionTimeout,omitempty"`
	Method                             *string   `form:"Method,omitempty"`
	Record                             *bool     `form:"Record,omitempty"`
	RecordingChannels                  *string   `form:"RecordingChannels,omitempty"`
	RecordingStatusCallback            *string   `form:"RecordingStatusCallback,omitempty"`
	RecordingStatusCallbackEvents      *[]string `form:"RecordingStatusCallbackEvent,omitempty"`
	RecordingStatusCallbackMethod      *string   `form:"RecordingStatusCallbackMethod,omitempty"`
	RecordingTrack                     *string   `form:"RecordingTrack,omitempty"`
	SendDigits                         *string   `form:"SendDigits,omitempty"`
	SipAuthPassword                    *string   `form:"SipAuthPassword,omitempty"`
	SipAuthUsername                    *string   `form:"SipAuthUsername,omitempty"`
	StatusCallback                     *string   `form:"StatusCallback,omitempty"`
	StatusCallbackEvents               *[]string `form:"StatusCallbacks,omitempty"`
	StatusCallbackMethod               *string   `form:"StatusCallbackMethod,omitempty"`
	Timeout                            *int      `form:"Timeout,omitempty"`
	To                                 string    `validate:"required" form:"To"`
	Trim                               *string   `form:"Trim,omitempty"`
	TwiML                              *string   `form:"Twiml,omitempty"`
	URL                                *string   `form:"Url,omitempty"`
}

CreateCallInput defines input fields for making a new call

type CreateCallResponse 

type CreateCallResponse struct {
	APIVersion     string             `json:"api_version"`
	AccountSid     string             `json:"account_sid"`
	AnsweredBy     *string            `json:"answered_by,omitempty"`
	CallerName     *string            `json:"caller_name,omitempty"`
	DateCreated    utils.RFC2822Time  `json:"date_created"`
	DateUpdated    *utils.RFC2822Time `json:"date_updated,omitempty"`
	Direction      string             `json:"direction"`
	Duration       string             `json:"duration"`
	EndTime        *utils.RFC2822Time `json:"end_time,omitempty"`
	ForwardedFrom  *string            `json:"forwarded_from,omitempty"`
	From           string             `json:"from"`
	FromFormatted  string             `json:"from_formatted"`
	GroupSid       *string            `json:"group_sid,omitempty"`
	ParentCallSid  *string            `json:"parent_call_sid,omitempty"`
	PhoneNumberSid string             `json:"phone_number_sid"`
	Price          *string            `json:"price,omitempty"`
	PriceUnit      *string            `json:"price_unit,omitempty"`
	QueueTime      string             `json:"queue_time"`
	Sid            string             `json:"sid"`
	StartTime      *utils.RFC2822Time `json:"start_time,omitempty"`
	Status         string             `json:"status"`
	To             string             `json:"to"`
	ToFormatted    string             `json:"to_formatted"`
	TrunkSid       *string            `json:"trunk_sid,omitempty"`
}

CreateCallResponse defines the response fields for making a new call

type PageCallResponse 

type PageCallResponse struct {
	APIVersion     string             `json:"api_version"`
	AccountSid     string             `json:"account_sid"`
	AnsweredBy     *string            `json:"answered_by,omitempty"`
	CallerName     *string            `json:"caller_name,omitempty"`
	DateCreated    utils.RFC2822Time  `json:"date_created"`
	DateUpdated    *utils.RFC2822Time `json:"date_updated,omitempty"`
	Direction      string             `json:"direction"`
	Duration       string             `json:"duration"`
	EndTime        *utils.RFC2822Time `json:"end_time,omitempty"`
	ForwardedFrom  *string            `json:"forwarded_from,omitempty"`
	From           string             `json:"from"`
	FromFormatted  string             `json:"from_formatted"`
	GroupSid       *string            `json:"group_sid,omitempty"`
	ParentCallSid  *string            `json:"parent_call_sid,omitempty"`
	PhoneNumberSid string             `json:"phone_number_sid"`
	Price          *string            `json:"price,omitempty"`
	PriceUnit      *string            `json:"price_unit,omitempty"`
	QueueTime      string             `json:"queue_time"`
	Sid            string             `json:"sid"`
	StartTime      *utils.RFC2822Time `json:"start_time,omitempty"`
	Status         string             `json:"status"`
	To             string             `json:"to"`
	ToFormatted    string             `json:"to_formatted"`
	TrunkSid       *string            `json:"trunk_sid,omitempty"`
}

Source Files

View all Source files

Directories

Path Synopsis
Package feedback_summaries contains auto-generated files.
 Package feedback_summaries contains auto-generated files.
Package feedback_summary contains auto-generated files.
 Package feedback_summary contains auto-generated 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.