models

Documentation

Index

• type Application
• type Call
• type CallEventRequest
• type CallPlayRequest
• type CallRequest
• type CallResponse
• type CallSpeakRequest
• type CallUpdateRequest
• type Callback
• type DialActionUrlCallback
• type DialAttr
• type DialConferenceAttr
• type DialNumberAttr
• type DialRecordAttr
• type DialSipAttr
• type GatherAttr
• type HeartBeatPrivRequest
• type InternalRateRoute
• type NumberAPIResponse
• type OriginationRate
• type PhoneNumberInfo
• type RatingRoutingResponse
• type RecordCallback
• type RecordJob
• type RequestError
  • func (r *RequestError) BadCallerID() bool
  • func (r *RequestError) Error() string
  • func (r *RequestError) NestedDialElement() bool
  • func (r *RequestError) PaymentRequired() bool
  • func (r *RequestError) RatingRoutingMissing() bool
• type SipLocation
• type TerminationRate

Types

type Application

type Application struct {
	Name                 string `json:"AppName"`
	InboundURL           string `json:"Url"`
	InboundMethod        string `json:"Method"`
	FallbackMethod       string `json:"FallbackMethod"`
	FallbackUrl          string `json:"FallbackUrl"`
	StatusCallback       string `json:"StatusCallback"`
	StatusCallbackMethod string `json:"StatusCallbackMethod"`
	StatusCallbackEvent  string `json:"StatusCallbackEvent"`
}

type Call

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

type CallEventRequest

type CallEventRequest struct {
	SendDigits     string `json:"digits"`
	DigitsReceived string `json:"digitsReceived"`
	Leg            string `json:"leg"`
}

type CallPlayRequest

type CallPlayRequest struct {
	Urls   string `json:"urls"`
	Length int    `json:"length"`
	Legs   string `json:"legs"`
	Loop   int    `json:"loop"`
	Mix    bool   `json:"mix"`
}

type CallRequest

type CallRequest struct {
	AsyncAmdStatusCallbackMethod       string  `json:"AsyncAmdStatusCallbackMethod"`
	AsyncAmdStatusCallback             string  `json:"AsyncAmdStatusCallback"`
	AsyncAmd                           string  `json:"AsyncAmd"`
	MachineDetectionSilenceTimeout     string  `json:"MachineDetectionSilenceTimeout"`
	MachineDetectionSpeechEndThreshold string  `json:"MachineDetectionSpeechEndThreshold"`
	MachineDetectionSpeechThreshold    string  `json:"MachineDetectionSpeechThreshold"`
	MachineDetectionTimeout            string  `json:"MachineDetectionTimeout"`
	MachineDetection                   string  `json:"MachineDetection"`
	SipAuthPassword                    string  `json:"SipAuthPassword"`
	SipAuthUsername                    string  `json:"SipAuthUsername"`
	LoopPlay                           string  `json:"loop_play" example:"3"`
	Timeout                            string  `json:"Timeout"`
	From                               string  `json:"From" example:"15677654321"`
	To                                 string  `json:"To" example:"15677654321"`
	CallerName                         string  `json:"caller_name" example:"Tiniyo"`
	CallerId                           string  `json:"CallerId"`
	Byoc                               string  `json:"Byoc"`
	CallReason                         string  `json:"CallReason"`
	Trim                               string  `json:"Trim"`
	RecordingStatusCallbackEvent       string  `json:"RecordingStatusCallbackEvent"`
	RecordingTrack                     string  `json:"RecordingTrack"`
	RecordingChannels                  string  `json:"RecordingChannels"`
	ParentCallSid                      string  `json:"parent_call_sid"`
	AccountSid                         string  `json:"AccountSid"`
	Record                             string  `json:"Record"`
	SendDigits                         string  `json:"SendDigits"`
	Play                               string  `json:"play" example:"https://tiniyo.s3.amazonaws.com/MissionImpossible.mp3"`
	Speak                              string  `json:"speak" example:"Hello Dear, Thanks for using our service"`
	ApplicationSid                     string  `json:"ApplicationSid" example:"your tiniyo application id"`
	TinyML                             string  `json:"TinyML" example:"<Response><Say>Hello World</Say>"`
	Url                                string  `json:"Url" example:"https://raw.githubusercontent.com/tiniyo/public/master/answer.xml"`
	Method                             string  `json:"Method" example:"GET"`
	FallbackMethod                     string  `json:"FallbackMethod"`
	FallbackUrl                        string  `json:"FallbackUrl"`
	StatusCallback                     string  `json:"StatusCallback"`
	StatusCallbackMethod               string  `json:"StatusCallbackMethod"`
	StatusCallbackEvent                string  `json:"StatusCallbackEvent"`
	RecordingStatusCallback            string  `json:"RecordingStatusCallback"`
	RecordingStatusCallbackMethod      string  `json:"RecordingStatusCallbackMethod"`
	Rate                               float64 `json:"rate"`
	Pulse                              int64   `json:"pulse"`
	MaxDuration                        int64   `json:"max_duration"`
	DestType                           string  `json:"DestType"`
	SrcType                            string  `json:"SrcType"`
	VendorAuthID                       string  `json:"ParentAuthId"`
	SipPilotNumber                     string  `json:"SipPilotNumber"`
	Sid                                string  `json:"Sid"`
	Bridge                             string  `json:"Bridge"`
	Host                               string  `json:"Host"`
	SrcDirection                       string  `json:"SrcDirection"`
	IsCallerId                         string  `json:"IsCallerId"`
	SipTrunk                           string  `json:"SipTrunk"`
	FromRemovePrefix                   string  `json:"FromRemovePrefix"`
	DialAttr
	DialRecordAttr
	Callback
	RecordCallback
	CallResponse
	DialSipAttr
	DialNumberAttr
	GatherAttr
	DialConferenceAttr
}

type CallResponse

type CallResponse struct {
	DateUpdated     interface{} `json:"date_updated,omitempty"`
	PriceUnit       string      `json:"price_unit,omitempty"`
	ParentCallSid   interface{} `json:"parent_call_sid,omitempty"`
	CallerName      interface{} `json:"caller_name,omitempty"`
	Duration        interface{} `json:"duration,omitempty"`
	From            string      `json:"from,omitempty"`
	To              string      `json:"to,omitempty"`
	Annotation      interface{} `json:"annotation,omitempty"`
	AnsweredBy      interface{} `json:"answered_by,omitempty"`
	Sid             string      `json:"sid,omitempty"`
	QueueTime       string      `json:"queue_time,omitempty"`
	Price           interface{} `json:"price,omitempty"`
	APIVersion      string      `json:"api_version,omitempty"`
	Status          string      `json:"status,omitempty"`
	Direction       string      `json:"direction,omitempty"`
	StartTime       interface{} `json:"start_time,omitempty"`
	DateCreated     interface{} `json:"date_created,omitempty"`
	FromFormatted   string      `json:"from_formatted,omitempty"`
	GroupSid        interface{} `json:"group_sid,omitempty"`
	TrunkSid        interface{} `json:"trunk_sid,omitempty"`
	ForwardedFrom   interface{} `json:"forwarded_from,omitempty"`
	URI             string      `json:"uri,omitempty"`
	AccountSid      string      `json:"account_sid,omitempty"`
	EndTime         interface{} `json:"end_time,omitempty"`
	ToFormatted     string      `json:"to_formatted,omitempty"`
	PhoneNumberSid  string      `json:"phone_number_sid,omitempty"`
	SubresourceUris struct {
		Notifications     string `json:"notifications,omitempty"`
		Recordings        string `json:"recordings,omitempty"`
		Payments          string `json:"payments,omitempty"`
		Feedback          string `json:"feedback,omitempty"`
		Events            string `json:"events,omitempty"`
		FeedbackSummaries string `json:"feedback_summaries,omitempty"`
	} `json:"subresource_uris,omitempty"`
}

type CallSpeakRequest

type CallSpeakRequest struct {
	Text     string `json:"text"`
	Voice    string `json:"voice"`
	Language string `json:"language"`
	Legs     string `json:"legs"`
	Loop     bool   `json:"loop"`
	Mix      bool   `json:"mix"`
}

type CallUpdateRequest

type CallUpdateRequest struct {
	Sid                  string `json:"Sid,omitempty"`
	Url                  string `json:"Url"`
	Method               string `json:"Method" example:"GET"`
	FallbackMethod       string `json:"FallbackMethod"`       // `json:"FallbackMethod"`
	FallbackUrl          string `json:"FallbackUrl"`          // `json:"FallbackUrl"`
	StatusCallback       string `json:"StatusCallback"`       // `json:"StatusCallback"`
	StatusCallbackMethod string `json:"StatusCallbackMethod"` // `json:"StatusCallbackMethod"`
	Status               string `json:"Status"`               // `json:"StatusCallback"`
}

type Callback

type Callback struct {
	Called           string `json:"Called,omitempty" form:"Called" query:"Called" freeswitch:"Caller-Destination-Number"`
	Direction        string `json:"Direction,omitempty" form:"Direction" query:"Direction" freeswitch:"Variable_direction"`
	Timestamp        string `json:"Timestamp,omitempty" form:"Timestamp" query:"Timestamp" freeswitch:"Event-Date-GMT"`
	CallSid          string `json:"CallSid,omitempty" form:"CallSid" query:"CallSid" freeswitch:"Variable_call_sid"`
	To               string `json:"To,omitempty" form:"To" query:"To" freeswitch:"Variable_sip_req_user"`
	AccountSid       string `json:"AccountSid,omitempty" form:"AccountSid" query:"AccountSid" freeswitch:"Variable_tiniyo_accid"`
	Caller           string `json:"Caller,omitempty" form:"Caller" query:"Caller" freeswitch:"Caller-ANI"`
	From             string `json:"From,omitempty" form:"From" query:"From" freeswitch:"Variable_sip_from_user"`
	ParentCallSid    string `json:"ParentCallSid,omitempty" form:"ParentCallSid" query:"ParentCallSid" freeswitch:"Variable_parent_call_sid"`
	CallStatus       string `json:"CallStatus,omitempty" form:"CallStatus" query:"CallStatus" freeswitch:"Hangup-Cause"`
	CallDuration     string `json:"CallDuration,omitempty" form:"CallDuration" query:"CallDuration" freeswitch:"Variable_billsec"`
	ToState          string `json:"ToState,omitempty" form:"ToState" query:"ToState"`
	CallerCountry    string `json:"CallerCountry,omitempty" form:"CallerCountry" query:"CallerCountry" `
	CallbackSource   string `json:"CallbackSource,omitempty" form:"CallbackSource" query:"CallbackSource"`
	SipResponseCode  string `json:"SipResponseCode,omitempty" form:"SipResponseCode" query:"SipResponseCode"`
	CallerState      string `json:"CallerState,omitempty" form:"CallerState" query:"CallerState"`
	ToZip            string `json:"ToZip,omitempty" form:"ToZip" query:"ToZip"`
	SequenceNumber   string `json:"SequenceNumber,omitempty" form:"SequenceNumber" query:"SequenceNumber"`
	CallerZip        string `json:"CallerZip,omitempty" form:"CallerZip" query:"CallerZip"`
	ToCountry        string `json:"ToCountry,omitempty" form:"ToCountry" query:"ToCountry"`
	CalledZip        string `json:"CalledZip,omitempty" form:"CalledZip" query:"CalledZip"`
	ApiVersion       string `json:"ApiVersion,omitempty" form:"ApiVersion" query:"ApiVersion"`
	CalledCity       string `json:"CalledCity,omitempty" form:"CalledCity" query:"CalledCity"`
	CalledCountry    string `json:"CalledCountry,omitempty" form:"CalledCountry" query:"CalledCountry"`
	CallerCity       string `json:"CallerCity,omitempty" form:"CallerCity" query:"CallerCity"`
	ToCity           string `json:"ToCity,omitempty" form:"ToCity" query:"ToCity"`
	FromCountry      string `json:"FromCountry,omitempty" form:"FromCountry" query:"FromCountry"`
	FromCity         string `json:"FromCity,omitempty" form:"FromCity" query:"FromCity"`
	CalledState      string `json:"CalledState,omitempty" form:"CalledState" query:"CalledState"`
	FromZip          string `json:"FromZip,omitempty" form:"FromZip" query:"FromZip"`
	FromState        string `json:"FromState,omitempty" form:"FromState" query:"FromState"`
	InitiationTime   string `json:"InitiationTime,omitempty" form:"InitiationTime" query:"InitiationTime"`
	AnswerTime       string `json:"AnswerTime,omitempty" form:"AnswerTime" query:"AnswerTime"`
	RingTime         string `json:"RingTime,omitempty" form:"RingTime" query:"RingTime"`
	HangupTime       string `json:"HangupTime,omitempty" form:"HangupTime" query:"HangupTime"`
	Digits           string `json:"Digits,omitempty" form:"Digits" query:"Digits"`
	DtmfInputType    string `json:"DtmfInputType,omitempty" form:"DtmfInputType" query:"DtmfInputType"`
	DialCallStatus   string `json:"DialCallStatus,omitempty"`
	DialCallSid      string `json:"DialCallSid,omitempty"`
	DialCallDuration string `json:"DialCallDuration,omitempty"`
	RecordingUrl     string `json:"RecordingUrl,omitempty" form:"RecordingUrl" query:"RecordingUrl" freeswitch:"Variable_tiniyo_recording_file"`
	PriceUnit        string `json:"price_unit,omitempty"`
}

type DialActionUrlCallback

type DialActionUrlCallback struct {
}

type DialAttr

type DialAttr struct {
	DialAnswerOnBridge string `json:"DialAnswerOnBridge"`
	DialCallerId       string `json:"DialCallerId"`
	DialHangupOnStar   string `json:"DialHangupOnStar"`
	DialAction         string `json:"DialAction"`
	DialMethod         string `json:"DialMethod"`
	DialRingTone       string `json:"DialRingTone"`
	DialTimeLimit      string `json:"DialTimeLimit"`
	DialTimeout        string `json:"DialTimeout"`
}

type DialConferenceAttr

type DialConferenceAttr struct {
	DialConferenceMuted                         string `json:"DialConferenceMuted"`
	DialConferenceBeep                          string `json:"DialConferenceBeep"`
	DialConferenceStartConferenceOnEnter        string `json:"DialConferenceStartConferenceOnEnter"`
	DialConferenceEndConferenceOnExit           string `json:"DialConferenceEndConferenceOnExit"`
	DialConferenceParticipantLabel              string `json:"DialConferenceParticipantLabel"`
	DialConferenceStatusCallbackEvent           string `json:"DialConferenceStatusCallbackEvent"`
	DialConferenceStatusCallback                string `json:"DialConferenceStatusCallback"`
	DialConferenceStatusCallbackMethod          string `json:"DialConferenceStatusCallbackMethod"`
	DialConferenceJitterBufferSize              string `json:"DialConferenceJitterBufferSize"`
	DialConferenceWaitUrl                       string `json:"DialConferenceWaitUrl"`
	DialConferenceWaitMethod                    string `json:"DialConferenceWaitMethod"`
	DialConferenceMaxParticipants               string `json:"DialConferenceMaxParticipants"`
	DialConferenceRecord                        string `json:"DialConferenceRecord"`
	DialConferenceRegion                        string `json:"DialConferenceRegion"`
	DialConferenceTrim                          string `json:"DialConferenceTrim"`
	DialConferenceCoach                         string `json:"DialConferenceCoach"`
	DialConferenceRecordingStatusCallback       string `json:"DialConferenceRecordingStatusCallback"`
	DialConferenceRecordingStatusCallbackEvent  string `json:"DialConferenceRecordingStatusCallbackEvent"`
	DialConferenceRecordingStatusCallbackMethod string `json:"DialConferenceRecordingStatusCallbackMethod"`
}

type DialNumberAttr

type DialNumberAttr struct {
	DialNumberMethod               string `json:"DialNumberMethod"`
	DialNumberSendDigits           string `json:"DialNumberSendDigits"`
	DialNumberStatusCallbackEvent  string `json:"DialNumberStatusCallbackEvent"`
	DialNumberStatusCallback       string `json:"DialNumberStatusCallback"`
	DialNumberStatusCallbackMethod string `json:"DialNumberStatusCallbackMethod"`
	DialNumberUrl                  string `json:"DialNumberUrl"`
	DialNumberByoc                 string `json:"DialNumberByoc"`
}

type DialRecordAttr

type DialRecordAttr struct {
	RecordTimeout            string `json:"RecordTimeout"`
	RecordFinishOnKey        string `json:"RecordFinishOnKey"`
	RecordMaxLength          string `json:"RecordMaxLength"`
	RecordPlayBeep           string `json:"RecordPlayBeep"`
	RecordAction             string `json:"RecordAction"`
	RecordMethod             string `json:"RecordMethod"`
	RecordStorageUrl         string `json:"RecordStorageUrl"`
	RecordStorageUrlMethod   string `json:"RecordStorageUrlMethod"`
	RecordTranscribe         string `json:"RecordTranscribe"`
	RecordTranscribeCallback string `json:"RecordTranscribeCallback"`
}

type DialSipAttr

type DialSipAttr struct {
	DialSipMethod               string `json:"DialSipMethod"`
	DialSipPassword             string `json:"DialSipPassword"`
	DialSipStatusCallbackEvent  string `json:"DialSipStatusCallbackEvent"`
	DialSipStatusCallback       string `json:"DialSipStatusCallback"`
	DialSipStatusCallbackMethod string `json:"DialSipStatusCallbackMethod"`
	DialSipUrl                  string `json:"DialSipUrl"`
	DialSipUsername             string `json:"DialSipUsername"`
}

type GatherAttr

type GatherAttr struct {
	GatherFinishOnKey         string `json:"GatherFinishOnKey"`
	GatherTimeout             string `json:"GatherTimeout"`
	GatherAction              string `json:"GatherAction"`
	GatherMethod              string `json:"GatherMethod"`
	GatherNumDigit            string `json:"GatherNumDigit"`
	GatherActionOnEmptyResult string `json:"GatherActionOnEmptyResult"`
	GatherEnhanced            string `json:"GatherEnhanced"`
}

type HeartBeatPrivRequest

type HeartBeatPrivRequest struct {
	AccountID string  `json:"accountid"`
	CallID    string  `json:"callid"`
	Rate      float64 `json:"rate"`
	Pulse     int64   `json:"pulse"`
	Duration  int64   `json:"duration"`
}

type InternalRateRoute

type InternalRateRoute struct {
	PulseRate            float64
	Pulse                int64
	RoutingGatewayString string
	RoutingUserAuthToken string
	SipPilotNumber       string
	TrunkPrefix          string
	RemovePrefix         string /**/
	FromRemovePrefix     string
}

type NumberAPIResponse

type NumberAPIResponse struct {
	AppResponse PhoneNumberInfo `json:"message"`
}

type OriginationRate

type OriginationRate struct {
	Rate         float32 `json:"rate_per_minute"`
	InitialPulse int64   `json:"initial_pulse"`
	SubPulse     int64   `json:"sub_pulse"`
}

type PhoneNumberInfo

type PhoneNumberInfo struct {
	PhoneNumber  string      `json:"phone_number"`
	Rate         float64     `json:"rps"`
	AuthID       string      `json:"acc_id"`
	VendorAuthID string      `json:"parent_act_id"`
	InitPulse    int64       `json:"initial_pulse"`
	SubPulse     int64       `json:"sub_pulse"`
	Application  Application `json:"application"`
	Host         string      `json:"host"`
}

type RatingRoutingResponse

type RatingRoutingResponse struct {
	Orig OriginationRate    `json:"origination"`
	Term []*TerminationRate `json:"termination"`
}

type RecordCallback

type RecordCallback struct {
	RecordEventTimestamp string `json:"Timestamp,omitempty" form:"Timestamp" query:"Timestamp" freeswitch:"Event-Date-GMT"`
	RecordingSource      string `json:"RecordingSource,omitempty" form:"RecordingSource" query:"RecordingSource"`
	RecordingTrack       string `json:"RecordingTrack,omitempty" form:"RecordingTrack" query:"RecordingTrack"`
	RecordingSid         string `json:"RecordingSid,omitempty" form:"RecordingSid" query:"RecordingSid"`
	RecordingUrl         string `json:"RecordingUrl,omitempty" form:"RecordingUrl" query:"RecordingUrl" freeswitch:"Record-File-Path"`
	RecordingStatus      string `json:"RecordingStatus,omitempty" form:"RecordingStatus" query:"RecordingStatus"`
	RecordingChannels    string `json:"RecordingChannels,omitempty" form:"RecordingChannels" query:"RecordingChannels"`
	ErrorCode            string `json:"ErrorCode,omitempty" form:"ErrorCode" query:"ErrorCode"`
	RecordCallSid        string `json:"CallSid,omitempty" form:"CallSid" query:"CallSid"`
	RecordingStartTime   string `json:"RecordingStartTime,omitempty" form:"RecordingStartTime" query:"RecordingStartTime"`
	RecordAccountSid     string `json:"AccountSid,omitempty" form:"AccountSid" query:"AccountSid"`
	RecordingDuration    string `json:"RecordingDuration,omitempty" form:"RecordingDuration" query:"RecordingDuration" freeswitch:"Variable_record_seconds"`
}

type RecordJob

type RecordJob struct {
	Args struct {
		FileName string `json:"file_name"`
		FilePath string `json:"file_path"`
		JobID    int64  `json:"job_id"`
	} `json:"args"`
	ID   string `json:"id"`
	Name string `json:"name"`
	T    int64  `json:"t"`
}

type RequestError

type RequestError struct {
	StatusCode int
	Err        error
}

func (*RequestError) BadCallerID

func (r *RequestError) BadCallerID() bool

func (*RequestError) Error

func (r *RequestError) Error() string

func (*RequestError) NestedDialElement

func (r *RequestError) NestedDialElement() bool

func (*RequestError) PaymentRequired

func (r *RequestError) PaymentRequired() bool

func (*RequestError) RatingRoutingMissing

func (r *RequestError) RatingRoutingMissing() bool

type SipLocation

type SipLocation struct {
	ID           string    `json:"id"`
	Ruid         string    `json:"ruid"`
	Username     string    `json:"username"`
	Domain       string    `json:"domain"`
	Contact      string    `json:"contact"`
	Received     string    `json:"received"`
	Path         string    `json:"path"`
	Expires      time.Time `json:"expires"`
	Q            string    `json:"q"`
	Callid       string    `json:"callid"`
	Cseq         string    `json:"cseq"`
	LastModified time.Time `json:"last_modified"`
	Flags        string    `json:"flags"`
	Cflags       string    `json:"cflags"`
	UserAgent    string    `json:"user_agent"`
	Socket       string    `json:"socket"`
	Methods      string    `json:"methods"`
	Instance     string    `json:"instance"`
	RegID        string    `json:"reg_id"`
	ServerID     string    `json:"server_id"`
	ConnectionID string    `json:"connection_id"`
	Keepalive    string    `json:"keepalive"`
	Partition    string    `json:"partition"`
}

type TerminationRate

type TerminationRate struct {
	Rate             float32 `json:"rate_per_minute"`
	InitialPulse     int64   `json:"initial_pulse"`
	SubPulse         int64   `json:"sub_pulse"`
	PrimaryIP        string  `json:"primary_ip"`
	FailoverIP       string  `json:"secondary_ip"`
	Prefix           string  `json:"match_prefix"`
	Priority         int64   `json:"priority"`
	TrunkPrefix      string  `json:"trunk_prefix"`
	RemovePrefix     string  `json:"remove_prefix"`
	SipPilotNumber   string  `json:"sip_pilot_number"`
	FromRemovePrefix string  `json:"from_remove_prefix"`
	Username         string  `json:"username"`
	Password         string  `json:"password"`
}