openapi

package
v1.7.2 Latest Latest
Warning

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

 Go to latest Published: Jun 1, 2023 License: MIT Imports: 6 Imported by: 1

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.43.2
  • 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://trunking.twilio.com

Class Method HTTP request Description
TrunksApi CreateTrunk Post /v1/Trunks
TrunksApi DeleteTrunk Delete /v1/Trunks/{Sid}
TrunksApi FetchTrunk Get /v1/Trunks/{Sid}
TrunksApi ListTrunk Get /v1/Trunks
TrunksApi UpdateTrunk Post /v1/Trunks/{Sid}
TrunksCredentialListsApi CreateCredentialList Post /v1/Trunks/{TrunkSid}/CredentialLists
TrunksCredentialListsApi DeleteCredentialList Delete /v1/Trunks/{TrunkSid}/CredentialLists/{Sid}
TrunksCredentialListsApi FetchCredentialList Get /v1/Trunks/{TrunkSid}/CredentialLists/{Sid}
TrunksCredentialListsApi ListCredentialList Get /v1/Trunks/{TrunkSid}/CredentialLists
TrunksIpAccessControlListsApi CreateIpAccessControlList Post /v1/Trunks/{TrunkSid}/IpAccessControlLists
TrunksIpAccessControlListsApi DeleteIpAccessControlList Delete /v1/Trunks/{TrunkSid}/IpAccessControlLists/{Sid}
TrunksIpAccessControlListsApi FetchIpAccessControlList Get /v1/Trunks/{TrunkSid}/IpAccessControlLists/{Sid}
TrunksIpAccessControlListsApi ListIpAccessControlList Get /v1/Trunks/{TrunkSid}/IpAccessControlLists
TrunksOriginationUrlsApi CreateOriginationUrl Post /v1/Trunks/{TrunkSid}/OriginationUrls
TrunksOriginationUrlsApi DeleteOriginationUrl Delete /v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}
TrunksOriginationUrlsApi FetchOriginationUrl Get /v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}
TrunksOriginationUrlsApi ListOriginationUrl Get /v1/Trunks/{TrunkSid}/OriginationUrls
TrunksOriginationUrlsApi UpdateOriginationUrl Post /v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}
TrunksPhoneNumbersApi CreatePhoneNumber Post /v1/Trunks/{TrunkSid}/PhoneNumbers
TrunksPhoneNumbersApi DeletePhoneNumber Delete /v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid}
TrunksPhoneNumbersApi FetchPhoneNumber Get /v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid}
TrunksPhoneNumbersApi ListPhoneNumber Get /v1/Trunks/{TrunkSid}/PhoneNumbers
TrunksRecordingApi FetchRecording Get /v1/Trunks/{TrunkSid}/Recording
TrunksRecordingApi UpdateRecording Post /v1/Trunks/{TrunkSid}/Recording

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) CreateCredentialList added in v0.11.0 

func (c *ApiService) CreateCredentialList(TrunkSid string, params *CreateCredentialListParams) (*TrunkingV1CredentialList, error)

func (*ApiService) CreateIpAccessControlList added in v0.11.0 

func (c *ApiService) CreateIpAccessControlList(TrunkSid string, params *CreateIpAccessControlListParams) (*TrunkingV1IpAccessControlList, error)

Associate an IP Access Control List with a Trunk

func (*ApiService) CreateOriginationUrl added in v0.11.0 

func (c *ApiService) CreateOriginationUrl(TrunkSid string, params *CreateOriginationUrlParams) (*TrunkingV1OriginationUrl, error)

func (*ApiService) CreatePhoneNumber added in v0.11.0 

func (c *ApiService) CreatePhoneNumber(TrunkSid string, params *CreatePhoneNumberParams) (*TrunkingV1PhoneNumber, error)

func (*ApiService) CreateTrunk added in v0.11.0 

func (c *ApiService) CreateTrunk(params *CreateTrunkParams) (*TrunkingV1Trunk, error)

func (*ApiService) DeleteCredentialList added in v0.11.0 

func (c *ApiService) DeleteCredentialList(TrunkSid string, Sid string) error

func (*ApiService) DeleteIpAccessControlList added in v0.11.0 

func (c *ApiService) DeleteIpAccessControlList(TrunkSid string, Sid string) error

Remove an associated IP Access Control List from a Trunk

func (*ApiService) DeleteOriginationUrl added in v0.11.0 

func (c *ApiService) DeleteOriginationUrl(TrunkSid string, Sid string) error

func (*ApiService) DeletePhoneNumber added in v0.11.0 

func (c *ApiService) DeletePhoneNumber(TrunkSid string, Sid string) error

func (*ApiService) DeleteTrunk added in v0.11.0 

func (c *ApiService) DeleteTrunk(Sid string) error

func (*ApiService) FetchCredentialList added in v0.11.0 

func (c *ApiService) FetchCredentialList(TrunkSid string, Sid string) (*TrunkingV1CredentialList, error)

func (*ApiService) FetchIpAccessControlList added in v0.11.0 

func (c *ApiService) FetchIpAccessControlList(TrunkSid string, Sid string) (*TrunkingV1IpAccessControlList, error)

func (*ApiService) FetchOriginationUrl added in v0.11.0 

func (c *ApiService) FetchOriginationUrl(TrunkSid string, Sid string) (*TrunkingV1OriginationUrl, error)

func (*ApiService) FetchPhoneNumber added in v0.11.0 

func (c *ApiService) FetchPhoneNumber(TrunkSid string, Sid string) (*TrunkingV1PhoneNumber, error)

func (*ApiService) FetchRecording added in v0.11.0 

func (c *ApiService) FetchRecording(TrunkSid string) (*TrunkingV1Recording, error)

func (*ApiService) FetchTrunk added in v0.11.0 

func (c *ApiService) FetchTrunk(Sid string) (*TrunkingV1Trunk, error)

func (*ApiService) ListCredentialList added in v0.11.0 

func (c *ApiService) ListCredentialList(TrunkSid string, params *ListCredentialListParams) ([]TrunkingV1CredentialList, error)

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

func (*ApiService) ListIpAccessControlList added in v0.11.0 

func (c *ApiService) ListIpAccessControlList(TrunkSid string, params *ListIpAccessControlListParams) ([]TrunkingV1IpAccessControlList, error)

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

func (*ApiService) ListOriginationUrl added in v0.11.0 

func (c *ApiService) ListOriginationUrl(TrunkSid string, params *ListOriginationUrlParams) ([]TrunkingV1OriginationUrl, error)

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

func (*ApiService) ListPhoneNumber added in v0.11.0 

func (c *ApiService) ListPhoneNumber(TrunkSid string, params *ListPhoneNumberParams) ([]TrunkingV1PhoneNumber, error)

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

func (*ApiService) ListTrunk added in v0.11.0 

func (c *ApiService) ListTrunk(params *ListTrunkParams) ([]TrunkingV1Trunk, error)

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

func (*ApiService) PageCredentialList added in v0.13.0 

func (c *ApiService) PageCredentialList(TrunkSid string, params *ListCredentialListParams, pageToken, pageNumber string) (*ListCredentialListResponse, error)

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

func (*ApiService) PageIpAccessControlList added in v0.13.0 

func (c *ApiService) PageIpAccessControlList(TrunkSid string, params *ListIpAccessControlListParams, pageToken, pageNumber string) (*ListIpAccessControlListResponse, error)

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

func (*ApiService) PageOriginationUrl added in v0.13.0 

func (c *ApiService) PageOriginationUrl(TrunkSid string, params *ListOriginationUrlParams, pageToken, pageNumber string) (*ListOriginationUrlResponse, error)

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

func (*ApiService) PagePhoneNumber added in v0.13.0 

func (c *ApiService) PagePhoneNumber(TrunkSid string, params *ListPhoneNumberParams, pageToken, pageNumber string) (*ListPhoneNumberResponse, error)

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

func (*ApiService) PageTrunk added in v0.13.0 

func (c *ApiService) PageTrunk(params *ListTrunkParams, pageToken, pageNumber string) (*ListTrunkResponse, error)

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

func (*ApiService) StreamCredentialList added in v0.13.0 

func (c *ApiService) StreamCredentialList(TrunkSid string, params *ListCredentialListParams) (chan TrunkingV1CredentialList, chan error)

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

func (*ApiService) StreamIpAccessControlList added in v0.13.0 

func (c *ApiService) StreamIpAccessControlList(TrunkSid string, params *ListIpAccessControlListParams) (chan TrunkingV1IpAccessControlList, chan error)

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

func (*ApiService) StreamOriginationUrl added in v0.13.0 

func (c *ApiService) StreamOriginationUrl(TrunkSid string, params *ListOriginationUrlParams) (chan TrunkingV1OriginationUrl, chan error)

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

func (*ApiService) StreamPhoneNumber added in v0.13.0 

func (c *ApiService) StreamPhoneNumber(TrunkSid string, params *ListPhoneNumberParams) (chan TrunkingV1PhoneNumber, chan error)

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

func (*ApiService) StreamTrunk added in v0.13.0 

func (c *ApiService) StreamTrunk(params *ListTrunkParams) (chan TrunkingV1Trunk, chan error)

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

func (*ApiService) UpdateOriginationUrl added in v0.11.0 

func (c *ApiService) UpdateOriginationUrl(TrunkSid string, Sid string, params *UpdateOriginationUrlParams) (*TrunkingV1OriginationUrl, error)

func (*ApiService) UpdateRecording added in v0.11.0 

func (c *ApiService) UpdateRecording(TrunkSid string, params *UpdateRecordingParams) (*TrunkingV1Recording, error)

func (*ApiService) UpdateTrunk added in v0.11.0 

func (c *ApiService) UpdateTrunk(Sid string, params *UpdateTrunkParams) (*TrunkingV1Trunk, error)

type CreateCredentialListParams 

type CreateCredentialListParams struct {
	// The SID of the [Credential List](https://www.twilio.com/docs/voice/sip/api/sip-credentiallist-resource) that you want to associate with the trunk. Once associated, we will authenticate access to the trunk against this list.
	CredentialListSid *string `json:"CredentialListSid,omitempty"`
}

Optional parameters for the method 'CreateCredentialList'

func (*CreateCredentialListParams) SetCredentialListSid 

func (params *CreateCredentialListParams) SetCredentialListSid(CredentialListSid string) *CreateCredentialListParams

type CreateIpAccessControlListParams 

type CreateIpAccessControlListParams struct {
	// The SID of the [IP Access Control List](https://www.twilio.com/docs/voice/sip/api/sip-ipaccesscontrollist-resource) that you want to associate with the trunk.
	IpAccessControlListSid *string `json:"IpAccessControlListSid,omitempty"`
}

Optional parameters for the method 'CreateIpAccessControlList'

func (*CreateIpAccessControlListParams) SetIpAccessControlListSid 

func (params *CreateIpAccessControlListParams) SetIpAccessControlListSid(IpAccessControlListSid string) *CreateIpAccessControlListParams

type CreateOriginationUrlParams 

type CreateOriginationUrlParams struct {
	// The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority.
	Weight *int `json:"Weight,omitempty"`
	// The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI.
	Priority *int `json:"Priority,omitempty"`
	// Whether the URL is enabled. The default is `true`.
	Enabled *bool `json:"Enabled,omitempty"`
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema.
	SipUrl *string `json:"SipUrl,omitempty"`
}

Optional parameters for the method 'CreateOriginationUrl'

func (*CreateOriginationUrlParams) SetEnabled 

func (params *CreateOriginationUrlParams) SetEnabled(Enabled bool) *CreateOriginationUrlParams

func (*CreateOriginationUrlParams) SetFriendlyName 

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

func (*CreateOriginationUrlParams) SetPriority 

func (params *CreateOriginationUrlParams) SetPriority(Priority int) *CreateOriginationUrlParams

func (*CreateOriginationUrlParams) SetSipUrl 

func (params *CreateOriginationUrlParams) SetSipUrl(SipUrl string) *CreateOriginationUrlParams

func (*CreateOriginationUrlParams) SetWeight 

func (params *CreateOriginationUrlParams) SetWeight(Weight int) *CreateOriginationUrlParams

type CreatePhoneNumberParams 

type CreatePhoneNumberParams struct {
	// The SID of the [Incoming Phone Number](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) that you want to associate with the trunk.
	PhoneNumberSid *string `json:"PhoneNumberSid,omitempty"`
}

Optional parameters for the method 'CreatePhoneNumber'

func (*CreatePhoneNumberParams) SetPhoneNumberSid 

func (params *CreatePhoneNumberParams) SetPhoneNumberSid(PhoneNumberSid string) *CreatePhoneNumberParams

type CreateTrunkParams 

type CreateTrunkParams struct {
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information.
	DomainName *string `json:"DomainName,omitempty"`
	// The URL we should call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.
	DisasterRecoveryUrl *string `json:"DisasterRecoveryUrl,omitempty"`
	// The HTTP method we should use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.
	DisasterRecoveryMethod *string `json:"DisasterRecoveryMethod,omitempty"`
	//
	TransferMode *string `json:"TransferMode,omitempty"`
	// Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information.
	Secure *bool `json:"Secure,omitempty"`
	// Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.
	CnamLookupEnabled *bool `json:"CnamLookupEnabled,omitempty"`
	//
	TransferCallerId *string `json:"TransferCallerId,omitempty"`
}

Optional parameters for the method 'CreateTrunk'

func (*CreateTrunkParams) SetCnamLookupEnabled 

func (params *CreateTrunkParams) SetCnamLookupEnabled(CnamLookupEnabled bool) *CreateTrunkParams

func (*CreateTrunkParams) SetDisasterRecoveryMethod 

func (params *CreateTrunkParams) SetDisasterRecoveryMethod(DisasterRecoveryMethod string) *CreateTrunkParams

func (*CreateTrunkParams) SetDisasterRecoveryUrl 

func (params *CreateTrunkParams) SetDisasterRecoveryUrl(DisasterRecoveryUrl string) *CreateTrunkParams

func (*CreateTrunkParams) SetDomainName 

func (params *CreateTrunkParams) SetDomainName(DomainName string) *CreateTrunkParams

func (*CreateTrunkParams) SetFriendlyName 

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

func (*CreateTrunkParams) SetSecure 

func (params *CreateTrunkParams) SetSecure(Secure bool) *CreateTrunkParams

func (*CreateTrunkParams) SetTransferCallerId added in v0.16.0 

func (params *CreateTrunkParams) SetTransferCallerId(TransferCallerId string) *CreateTrunkParams

func (*CreateTrunkParams) SetTransferMode 

func (params *CreateTrunkParams) SetTransferMode(TransferMode string) *CreateTrunkParams

type ListCredentialListParams 

type ListCredentialListParams 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 'ListCredentialList'

func (*ListCredentialListParams) SetLimit added in v0.13.0 

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

func (*ListCredentialListParams) SetPageSize 

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

type ListCredentialListResponse 

type ListCredentialListResponse struct {
	CredentialLists []TrunkingV1CredentialList     `json:"credential_lists,omitempty"`
	Meta            ListCredentialListResponseMeta `json:"meta,omitempty"`
}

ListCredentialListResponse struct for ListCredentialListResponse

type ListCredentialListResponseMeta added in v1.0.0 

type ListCredentialListResponseMeta 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"`
}

ListCredentialListResponseMeta struct for ListCredentialListResponseMeta

type ListIpAccessControlListParams 

type ListIpAccessControlListParams 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 'ListIpAccessControlList'

func (*ListIpAccessControlListParams) SetLimit added in v0.13.0 

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

func (*ListIpAccessControlListParams) SetPageSize 

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

type ListIpAccessControlListResponse 

type ListIpAccessControlListResponse struct {
	IpAccessControlLists []TrunkingV1IpAccessControlList `json:"ip_access_control_lists,omitempty"`
	Meta                 ListCredentialListResponseMeta  `json:"meta,omitempty"`
}

ListIpAccessControlListResponse struct for ListIpAccessControlListResponse

type ListOriginationUrlParams 

type ListOriginationUrlParams 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 'ListOriginationUrl'

func (*ListOriginationUrlParams) SetLimit added in v0.13.0 

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

func (*ListOriginationUrlParams) SetPageSize 

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

type ListOriginationUrlResponse 

type ListOriginationUrlResponse struct {
	OriginationUrls []TrunkingV1OriginationUrl     `json:"origination_urls,omitempty"`
	Meta            ListCredentialListResponseMeta `json:"meta,omitempty"`
}

ListOriginationUrlResponse struct for ListOriginationUrlResponse

type ListPhoneNumberParams 

type ListPhoneNumberParams 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 'ListPhoneNumber'

func (*ListPhoneNumberParams) SetLimit added in v0.13.0 

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

func (*ListPhoneNumberParams) SetPageSize 

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

type ListPhoneNumberResponse 

type ListPhoneNumberResponse struct {
	PhoneNumbers []TrunkingV1PhoneNumber        `json:"phone_numbers,omitempty"`
	Meta         ListCredentialListResponseMeta `json:"meta,omitempty"`
}

ListPhoneNumberResponse struct for ListPhoneNumberResponse

type ListTrunkParams 

type ListTrunkParams 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 'ListTrunk'

func (*ListTrunkParams) SetLimit added in v0.13.0 

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

func (*ListTrunkParams) SetPageSize 

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

type ListTrunkResponse 

type ListTrunkResponse struct {
	Trunks []TrunkingV1Trunk              `json:"trunks,omitempty"`
	Meta   ListCredentialListResponseMeta `json:"meta,omitempty"`
}

ListTrunkResponse struct for ListTrunkResponse

type TrunkingV1CredentialList added in v0.14.0 

type TrunkingV1CredentialList struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialList resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string that we created to identify the CredentialList resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the Trunk the credential list in associated with.
	TrunkSid *string `json:"trunk_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
}

TrunkingV1CredentialList struct for TrunkingV1CredentialList

type TrunkingV1IpAccessControlList added in v0.14.0 

type TrunkingV1IpAccessControlList struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IpAccessControlList resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string that we created to identify the IpAccessControlList resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the Trunk the resource is associated with.
	TrunkSid *string `json:"trunk_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
}

TrunkingV1IpAccessControlList struct for TrunkingV1IpAccessControlList

type TrunkingV1OriginationUrl added in v0.14.0 

type TrunkingV1OriginationUrl struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OriginationUrl resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string that we created to identify the OriginationUrl resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the Trunk that owns the Origination URL.
	TrunkSid *string `json:"trunk_sid,omitempty"`
	// The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority.
	Weight *int `json:"weight,omitempty"`
	// Whether the URL is enabled. The default is `true`.
	Enabled *bool `json:"enabled,omitempty"`
	// The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema.
	SipUrl *string `json:"sip_url,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI.
	Priority *int `json:"priority,omitempty"`
	// The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
}

TrunkingV1OriginationUrl struct for TrunkingV1OriginationUrl

type TrunkingV1PhoneNumber added in v0.14.0 

type TrunkingV1PhoneNumber struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource.
	AccountSid          *string `json:"account_sid,omitempty"`
	AddressRequirements *string `json:"address_requirements,omitempty"`
	// The API version used to start a new TwiML session.
	ApiVersion *string `json:"api_version,omitempty"`
	// Whether the phone number is new to the Twilio platform. Can be: `true` or `false`.
	Beta *bool `json:"beta,omitempty"`
	// The set of Boolean properties that indicate whether a phone number can receive calls or messages.  Capabilities are  `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.
	Capabilities *map[string]interface{} `json:"capabilities,omitempty"`
	// The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The URLs of related resources.
	Links *map[string]interface{} `json:"links,omitempty"`
	// The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
	PhoneNumber *string `json:"phone_number,omitempty"`
	// The unique string that we created to identify the PhoneNumber resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application.
	SmsApplicationSid *string `json:"sms_application_sid,omitempty"`
	// The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`.
	SmsFallbackMethod *string `json:"sms_fallback_method,omitempty"`
	// The URL that we call using the `sms_fallback_method` when an error occurs while retrieving or executing the TwiML from `sms_url`.
	SmsFallbackUrl *string `json:"sms_fallback_url,omitempty"`
	// The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`.
	SmsMethod *string `json:"sms_method,omitempty"`
	// The URL we call using the `sms_method` when the phone number receives an incoming SMS message.
	SmsUrl *string `json:"sms_url,omitempty"`
	// The URL we call using the `status_callback_method` to send status information to your application.
	StatusCallback *string `json:"status_callback,omitempty"`
	// The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`.
	StatusCallbackMethod *string `json:"status_callback_method,omitempty"`
	// The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice URLs and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
	TrunkSid *string `json:"trunk_sid,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
	// The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice URLs and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
	VoiceApplicationSid *string `json:"voice_application_sid,omitempty"`
	// Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: `true` or `false`.
	VoiceCallerIdLookup *bool `json:"voice_caller_id_lookup,omitempty"`
	// The HTTP method that we use to call `voice_fallback_url`. Can be: `GET` or `POST`.
	VoiceFallbackMethod *string `json:"voice_fallback_method,omitempty"`
	// The URL that we call using the `voice_fallback_method` when an error occurs retrieving or executing the TwiML requested by `url`.
	VoiceFallbackUrl *string `json:"voice_fallback_url,omitempty"`
	// The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`.
	VoiceMethod *string `json:"voice_method,omitempty"`
	// The URL we call using the `voice_method` when the phone number receives a call. The `voice_url` is not be used if a `voice_application_sid` or a `trunk_sid` is set.
	VoiceUrl *string `json:"voice_url,omitempty"`
}

TrunkingV1PhoneNumber struct for TrunkingV1PhoneNumber

type TrunkingV1Recording added in v0.14.0 

type TrunkingV1Recording struct {
	Mode *string `json:"mode,omitempty"`
	Trim *string `json:"trim,omitempty"`
}

TrunkingV1Recording struct for TrunkingV1Recording

type TrunkingV1Trunk 

type TrunkingV1Trunk struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Trunk resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information.
	DomainName *string `json:"domain_name,omitempty"`
	// The HTTP method we use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.
	DisasterRecoveryMethod *string `json:"disaster_recovery_method,omitempty"`
	// The URL we call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from this URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.
	DisasterRecoveryUrl *string `json:"disaster_recovery_url,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information.
	Secure *bool `json:"secure,omitempty"`
	// The recording settings for the trunk. Can be: `do-not-record`, `record-from-ringing`, `record-from-answer`. If set to `record-from-ringing` or `record-from-answer`, all calls going through the trunk will be recorded. The only way to change recording parameters is on a sub-resource of a Trunk after it has been created. e.g.`/Trunks/[Trunk_SID]/Recording -XPOST -d'Mode=record-from-answer'`. See [Recording](https://www.twilio.com/docs/sip-trunking#recording) for more information.
	Recording        *interface{} `json:"recording,omitempty"`
	TransferMode     *string      `json:"transfer_mode,omitempty"`
	TransferCallerId *string      `json:"transfer_caller_id,omitempty"`
	// Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.
	CnamLookupEnabled *bool `json:"cnam_lookup_enabled,omitempty"`
	// The types of authentication mapped to the domain. Can be: `IP_ACL` and `CREDENTIAL_LIST`. If both are mapped, the values are returned in a comma delimited list. If empty, the domain will not receive any traffic.
	AuthType *string `json:"auth_type,omitempty"`
	// Reserved.
	AuthTypeSet *[]string `json:"auth_type_set,omitempty"`
	// The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The unique string that we created to identify the Trunk resource.
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
	// The URLs of related resources.
	Links *map[string]interface{} `json:"links,omitempty"`
}

TrunkingV1Trunk struct for TrunkingV1Trunk

type UpdateOriginationUrlParams 

type UpdateOriginationUrlParams struct {
	// The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority.
	Weight *int `json:"Weight,omitempty"`
	// The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI.
	Priority *int `json:"Priority,omitempty"`
	// Whether the URL is enabled. The default is `true`.
	Enabled *bool `json:"Enabled,omitempty"`
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. `sips` is NOT supported.
	SipUrl *string `json:"SipUrl,omitempty"`
}

Optional parameters for the method 'UpdateOriginationUrl'

func (*UpdateOriginationUrlParams) SetEnabled 

func (params *UpdateOriginationUrlParams) SetEnabled(Enabled bool) *UpdateOriginationUrlParams

func (*UpdateOriginationUrlParams) SetFriendlyName 

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

func (*UpdateOriginationUrlParams) SetPriority 

func (params *UpdateOriginationUrlParams) SetPriority(Priority int) *UpdateOriginationUrlParams

func (*UpdateOriginationUrlParams) SetSipUrl 

func (params *UpdateOriginationUrlParams) SetSipUrl(SipUrl string) *UpdateOriginationUrlParams

func (*UpdateOriginationUrlParams) SetWeight 

func (params *UpdateOriginationUrlParams) SetWeight(Weight int) *UpdateOriginationUrlParams

type UpdateRecordingParams 

type UpdateRecordingParams struct {
	//
	Mode *string `json:"Mode,omitempty"`
	//
	Trim *string `json:"Trim,omitempty"`
}

Optional parameters for the method 'UpdateRecording'

func (*UpdateRecordingParams) SetMode 

func (params *UpdateRecordingParams) SetMode(Mode string) *UpdateRecordingParams

func (*UpdateRecordingParams) SetTrim 

func (params *UpdateRecordingParams) SetTrim(Trim string) *UpdateRecordingParams

type UpdateTrunkParams 

type UpdateTrunkParams struct {
	// A descriptive string that you create to describe the resource. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information.
	DomainName *string `json:"DomainName,omitempty"`
	// The URL we should call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.
	DisasterRecoveryUrl *string `json:"DisasterRecoveryUrl,omitempty"`
	// The HTTP method we should use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.
	DisasterRecoveryMethod *string `json:"DisasterRecoveryMethod,omitempty"`
	//
	TransferMode *string `json:"TransferMode,omitempty"`
	// Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information.
	Secure *bool `json:"Secure,omitempty"`
	// Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.
	CnamLookupEnabled *bool `json:"CnamLookupEnabled,omitempty"`
	//
	TransferCallerId *string `json:"TransferCallerId,omitempty"`
}

Optional parameters for the method 'UpdateTrunk'

func (*UpdateTrunkParams) SetCnamLookupEnabled 

func (params *UpdateTrunkParams) SetCnamLookupEnabled(CnamLookupEnabled bool) *UpdateTrunkParams

func (*UpdateTrunkParams) SetDisasterRecoveryMethod 

func (params *UpdateTrunkParams) SetDisasterRecoveryMethod(DisasterRecoveryMethod string) *UpdateTrunkParams

func (*UpdateTrunkParams) SetDisasterRecoveryUrl 

func (params *UpdateTrunkParams) SetDisasterRecoveryUrl(DisasterRecoveryUrl string) *UpdateTrunkParams

func (*UpdateTrunkParams) SetDomainName 

func (params *UpdateTrunkParams) SetDomainName(DomainName string) *UpdateTrunkParams

func (*UpdateTrunkParams) SetFriendlyName 

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

func (*UpdateTrunkParams) SetSecure 

func (params *UpdateTrunkParams) SetSecure(Secure bool) *UpdateTrunkParams

func (*UpdateTrunkParams) SetTransferCallerId added in v0.16.0 

func (params *UpdateTrunkParams) SetTransferCallerId(TransferCallerId string) *UpdateTrunkParams

func (*UpdateTrunkParams) SetTransferMode 

func (params *UpdateTrunkParams) SetTransferMode(TransferMode string) *UpdateTrunkParams

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.