openapi

package
v1.0.0-rc.8 Latest Latest
Warning

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

 Go to latest Published: Sep 7, 2022 License: MIT Imports: 6 Imported by: 3

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.35.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://messaging.twilio.com

Class Method HTTP request Description
A2pBrandRegistrationsApi CreateBrandRegistrations Post /v1/a2p/BrandRegistrations
A2pBrandRegistrationsApi FetchBrandRegistrations Get /v1/a2p/BrandRegistrations/{Sid}
A2pBrandRegistrationsApi ListBrandRegistrations Get /v1/a2p/BrandRegistrations
A2pBrandRegistrationsApi UpdateBrandRegistrations Post /v1/a2p/BrandRegistrations/{Sid}
A2pBrandRegistrationsVettingsApi CreateBrandVetting Post /v1/a2p/BrandRegistrations/{BrandSid}/Vettings
A2pBrandRegistrationsVettingsApi FetchBrandVetting Get /v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}
A2pBrandRegistrationsVettingsApi ListBrandVetting Get /v1/a2p/BrandRegistrations/{BrandSid}/Vettings
DeactivationsApi FetchDeactivation Get /v1/Deactivations
ServicesApi CreateService Post /v1/Services
ServicesApi DeleteService Delete /v1/Services/{Sid}
ServicesApi FetchService Get /v1/Services/{Sid}
ServicesApi ListService Get /v1/Services
ServicesApi UpdateService Post /v1/Services/{Sid}
ServicesAlphaSendersApi CreateAlphaSender Post /v1/Services/{ServiceSid}/AlphaSenders
ServicesAlphaSendersApi DeleteAlphaSender Delete /v1/Services/{ServiceSid}/AlphaSenders/{Sid}
ServicesAlphaSendersApi FetchAlphaSender Get /v1/Services/{ServiceSid}/AlphaSenders/{Sid}
ServicesAlphaSendersApi ListAlphaSender Get /v1/Services/{ServiceSid}/AlphaSenders
ServicesComplianceUsa2pApi CreateUsAppToPerson Post /v1/Services/{MessagingServiceSid}/Compliance/Usa2p
ServicesComplianceUsa2pApi DeleteUsAppToPerson Delete /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}
ServicesComplianceUsa2pApi FetchUsAppToPerson Get /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}
ServicesComplianceUsa2pApi ListUsAppToPerson Get /v1/Services/{MessagingServiceSid}/Compliance/Usa2p
ServicesComplianceUsa2pUsecasesApi FetchUsAppToPersonUsecase Get /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases
ServicesPhoneNumbersApi CreatePhoneNumber Post /v1/Services/{ServiceSid}/PhoneNumbers
ServicesPhoneNumbersApi DeletePhoneNumber Delete /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
ServicesPhoneNumbersApi FetchPhoneNumber Get /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
ServicesPhoneNumbersApi ListPhoneNumber Get /v1/Services/{ServiceSid}/PhoneNumbers
ServicesPreregisteredUsa2pApi CreateExternalCampaign Post /v1/Services/PreregisteredUsa2p
ServicesShortCodesApi CreateShortCode Post /v1/Services/{ServiceSid}/ShortCodes
ServicesShortCodesApi DeleteShortCode Delete /v1/Services/{ServiceSid}/ShortCodes/{Sid}
ServicesShortCodesApi FetchShortCode Get /v1/Services/{ServiceSid}/ShortCodes/{Sid}
ServicesShortCodesApi ListShortCode Get /v1/Services/{ServiceSid}/ShortCodes
ServicesUsecasesApi FetchUsecase Get /v1/Services/Usecases
TollfreeVerificationsApi CreateTollfreeVerification Post /v1/Tollfree/Verifications
TollfreeVerificationsApi FetchTollfreeVerification Get /v1/Tollfree/Verifications/{Sid}
TollfreeVerificationsApi ListTollfreeVerification Get /v1/Tollfree/Verifications

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

func (c *ApiService) CreateAlphaSender(ServiceSid string, params *CreateAlphaSenderParams) (*MessagingV1AlphaSender, error)

func (*ApiService) CreateBrandRegistrations added in v0.11.0 

func (c *ApiService) CreateBrandRegistrations(params *CreateBrandRegistrationsParams) (*MessagingV1BrandRegistrations, error)

func (*ApiService) CreateBrandVetting added in v0.17.0 

func (c *ApiService) CreateBrandVetting(BrandSid string, params *CreateBrandVettingParams) (*MessagingV1BrandVetting, error)

func (*ApiService) CreateExternalCampaign added in v0.11.0 

func (c *ApiService) CreateExternalCampaign(params *CreateExternalCampaignParams) (*MessagingV1ExternalCampaign, error)

func (*ApiService) CreatePhoneNumber added in v0.11.0 

func (c *ApiService) CreatePhoneNumber(ServiceSid string, params *CreatePhoneNumberParams) (*MessagingV1PhoneNumber, error)

func (*ApiService) CreateService added in v0.11.0 

func (c *ApiService) CreateService(params *CreateServiceParams) (*MessagingV1Service, error)

func (*ApiService) CreateShortCode added in v0.11.0 

func (c *ApiService) CreateShortCode(ServiceSid string, params *CreateShortCodeParams) (*MessagingV1ShortCode, error)

func (*ApiService) CreateTollfreeVerification added in v1.0.0 

func (c *ApiService) CreateTollfreeVerification(params *CreateTollfreeVerificationParams) (*MessagingV1TollfreeVerification, error)

func (*ApiService) CreateUsAppToPerson added in v0.11.0 

func (c *ApiService) CreateUsAppToPerson(MessagingServiceSid string, params *CreateUsAppToPersonParams) (*MessagingV1UsAppToPerson, error)

func (*ApiService) DeleteAlphaSender added in v0.11.0 

func (c *ApiService) DeleteAlphaSender(ServiceSid string, Sid string) error

func (*ApiService) DeletePhoneNumber added in v0.11.0 

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

func (*ApiService) DeleteService added in v0.11.0 

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

func (*ApiService) DeleteShortCode added in v0.11.0 

func (c *ApiService) DeleteShortCode(ServiceSid string, Sid string) error

func (*ApiService) DeleteUsAppToPerson added in v0.11.0 

func (c *ApiService) DeleteUsAppToPerson(MessagingServiceSid string, Sid string) error

func (*ApiService) FetchAlphaSender added in v0.11.0 

func (c *ApiService) FetchAlphaSender(ServiceSid string, Sid string) (*MessagingV1AlphaSender, error)

func (*ApiService) FetchBrandRegistrations added in v0.11.0 

func (c *ApiService) FetchBrandRegistrations(Sid string) (*MessagingV1BrandRegistrations, error)

func (*ApiService) FetchBrandVetting added in v0.18.1 

func (c *ApiService) FetchBrandVetting(BrandSid string, BrandVettingSid string) (*MessagingV1BrandVetting, error)

func (*ApiService) FetchDeactivation added in v0.11.0 

func (c *ApiService) FetchDeactivation(params *FetchDeactivationParams) (*MessagingV1Deactivation, error)

Fetch a list of all United States numbers that have been deactivated on a specific date.

func (*ApiService) FetchPhoneNumber added in v0.11.0 

func (c *ApiService) FetchPhoneNumber(ServiceSid string, Sid string) (*MessagingV1PhoneNumber, error)

func (*ApiService) FetchService added in v0.11.0 

func (c *ApiService) FetchService(Sid string) (*MessagingV1Service, error)

func (*ApiService) FetchShortCode added in v0.11.0 

func (c *ApiService) FetchShortCode(ServiceSid string, Sid string) (*MessagingV1ShortCode, error)

func (*ApiService) FetchTollfreeVerification added in v1.0.0 

func (c *ApiService) FetchTollfreeVerification(Sid string) (*MessagingV1TollfreeVerification, error)

func (*ApiService) FetchUsAppToPerson added in v0.11.0 

func (c *ApiService) FetchUsAppToPerson(MessagingServiceSid string, Sid string) (*MessagingV1UsAppToPerson, error)

func (*ApiService) FetchUsAppToPersonUsecase added in v0.11.0 

func (c *ApiService) FetchUsAppToPersonUsecase(MessagingServiceSid string, params *FetchUsAppToPersonUsecaseParams) (*MessagingV1UsAppToPersonUsecase, error)

func (*ApiService) FetchUsecase added in v0.11.0 

func (c *ApiService) FetchUsecase() (*MessagingV1Usecase, error)

func (*ApiService) ListAlphaSender added in v0.11.0 

func (c *ApiService) ListAlphaSender(ServiceSid string, params *ListAlphaSenderParams) ([]MessagingV1AlphaSender, error)

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

func (*ApiService) ListBrandRegistrations added in v0.11.0 

func (c *ApiService) ListBrandRegistrations(params *ListBrandRegistrationsParams) ([]MessagingV1BrandRegistrations, error)

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

func (*ApiService) ListBrandVetting added in v0.17.0 

func (c *ApiService) ListBrandVetting(BrandSid string, params *ListBrandVettingParams) ([]MessagingV1BrandVetting, error)

Lists BrandVetting 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(ServiceSid string, params *ListPhoneNumberParams) ([]MessagingV1PhoneNumber, 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) ListService added in v0.11.0 

func (c *ApiService) ListService(params *ListServiceParams) ([]MessagingV1Service, error)

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

func (*ApiService) ListShortCode added in v0.11.0 

func (c *ApiService) ListShortCode(ServiceSid string, params *ListShortCodeParams) ([]MessagingV1ShortCode, error)

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

func (*ApiService) ListTollfreeVerification added in v1.0.0 

func (c *ApiService) ListTollfreeVerification(params *ListTollfreeVerificationParams) ([]MessagingV1TollfreeVerification, error)

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

func (*ApiService) ListUsAppToPerson added in v0.11.0 

func (c *ApiService) ListUsAppToPerson(MessagingServiceSid string, params *ListUsAppToPersonParams) ([]MessagingV1UsAppToPerson, error)

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

func (*ApiService) PageAlphaSender added in v0.13.0 

func (c *ApiService) PageAlphaSender(ServiceSid string, params *ListAlphaSenderParams, pageToken, pageNumber string) (*ListAlphaSenderResponse, error)

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

func (*ApiService) PageBrandRegistrations added in v0.13.0 

func (c *ApiService) PageBrandRegistrations(params *ListBrandRegistrationsParams, pageToken, pageNumber string) (*ListBrandRegistrationsResponse, error)

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

func (*ApiService) PageBrandVetting added in v0.17.0 

func (c *ApiService) PageBrandVetting(BrandSid string, params *ListBrandVettingParams, pageToken, pageNumber string) (*ListBrandVettingResponse, error)

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

func (*ApiService) PagePhoneNumber added in v0.13.0 

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

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

func (*ApiService) PageService added in v0.13.0 

func (c *ApiService) PageService(params *ListServiceParams, pageToken, pageNumber string) (*ListServiceResponse, error)

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

func (*ApiService) PageShortCode added in v0.13.0 

func (c *ApiService) PageShortCode(ServiceSid string, params *ListShortCodeParams, pageToken, pageNumber string) (*ListShortCodeResponse, error)

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

func (*ApiService) PageTollfreeVerification added in v1.0.0 

func (c *ApiService) PageTollfreeVerification(params *ListTollfreeVerificationParams, pageToken, pageNumber string) (*ListTollfreeVerificationResponse, error)

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

func (*ApiService) PageUsAppToPerson added in v0.13.0 

func (c *ApiService) PageUsAppToPerson(MessagingServiceSid string, params *ListUsAppToPersonParams, pageToken, pageNumber string) (*ListUsAppToPersonResponse, error)

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

func (*ApiService) StreamAlphaSender added in v0.13.0 

func (c *ApiService) StreamAlphaSender(ServiceSid string, params *ListAlphaSenderParams) (chan MessagingV1AlphaSender, chan error)

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

func (*ApiService) StreamBrandRegistrations added in v0.13.0 

func (c *ApiService) StreamBrandRegistrations(params *ListBrandRegistrationsParams) (chan MessagingV1BrandRegistrations, chan error)

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

func (*ApiService) StreamBrandVetting added in v0.17.0 

func (c *ApiService) StreamBrandVetting(BrandSid string, params *ListBrandVettingParams) (chan MessagingV1BrandVetting, chan error)

Streams BrandVetting 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(ServiceSid string, params *ListPhoneNumberParams) (chan MessagingV1PhoneNumber, 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) StreamService added in v0.13.0 

func (c *ApiService) StreamService(params *ListServiceParams) (chan MessagingV1Service, chan error)

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

func (*ApiService) StreamShortCode added in v0.13.0 

func (c *ApiService) StreamShortCode(ServiceSid string, params *ListShortCodeParams) (chan MessagingV1ShortCode, chan error)

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

func (*ApiService) StreamTollfreeVerification added in v1.0.0 

func (c *ApiService) StreamTollfreeVerification(params *ListTollfreeVerificationParams) (chan MessagingV1TollfreeVerification, chan error)

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

func (*ApiService) StreamUsAppToPerson added in v0.13.0 

func (c *ApiService) StreamUsAppToPerson(MessagingServiceSid string, params *ListUsAppToPersonParams) (chan MessagingV1UsAppToPerson, chan error)

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

func (*ApiService) UpdateBrandRegistrations added in v0.20.0 

func (c *ApiService) UpdateBrandRegistrations(Sid string) (*MessagingV1BrandRegistrations, error)

func (*ApiService) UpdateService added in v0.11.0 

func (c *ApiService) UpdateService(Sid string, params *UpdateServiceParams) (*MessagingV1Service, error)

type CreateAlphaSenderParams 

type CreateAlphaSenderParams struct {
	// The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen `-`, plus `+`, underscore `_` and ampersand `&`. This value cannot contain only numbers.
	AlphaSender *string `json:"AlphaSender,omitempty"`
}

Optional parameters for the method 'CreateAlphaSender'

func (*CreateAlphaSenderParams) SetAlphaSender 

func (params *CreateAlphaSenderParams) SetAlphaSender(AlphaSender string) *CreateAlphaSenderParams

type CreateBrandRegistrationsParams 

type CreateBrandRegistrationsParams struct {
	// Customer Profile Bundle Sid.
	CustomerProfileBundleSid *string `json:"CustomerProfileBundleSid,omitempty"`
	// A2P Messaging Profile Bundle Sid.
	A2PProfileBundleSid *string `json:"A2PProfileBundleSid,omitempty"`
	// Type of brand being created. One of: \\\"STANDARD\\\", \\\"STARTER\\\". STARTER is for low volume, starter use cases. STANDARD is for all other use cases.
	BrandType *string `json:"BrandType,omitempty"`
	// A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.
	Mock *bool `json:"Mock,omitempty"`
	// A flag to disable automatic secondary vetting for brands which it would otherwise be done.
	SkipAutomaticSecVet *bool `json:"SkipAutomaticSecVet,omitempty"`
}

Optional parameters for the method 'CreateBrandRegistrations'

func (*CreateBrandRegistrationsParams) SetA2PProfileBundleSid added in v0.16.0 

func (params *CreateBrandRegistrationsParams) SetA2PProfileBundleSid(A2PProfileBundleSid string) *CreateBrandRegistrationsParams

func (*CreateBrandRegistrationsParams) SetBrandType added in v0.14.0 

func (params *CreateBrandRegistrationsParams) SetBrandType(BrandType string) *CreateBrandRegistrationsParams

func (*CreateBrandRegistrationsParams) SetCustomerProfileBundleSid 

func (params *CreateBrandRegistrationsParams) SetCustomerProfileBundleSid(CustomerProfileBundleSid string) *CreateBrandRegistrationsParams

func (*CreateBrandRegistrationsParams) SetMock added in v0.14.2 

func (params *CreateBrandRegistrationsParams) SetMock(Mock bool) *CreateBrandRegistrationsParams

func (*CreateBrandRegistrationsParams) SetSkipAutomaticSecVet added in v0.15.0 

func (params *CreateBrandRegistrationsParams) SetSkipAutomaticSecVet(SkipAutomaticSecVet bool) *CreateBrandRegistrationsParams

type CreateBrandVettingParams added in v0.17.0 

type CreateBrandVettingParams struct {
	//
	VettingProvider *string `json:"VettingProvider,omitempty"`
	// The unique ID of the vetting
	VettingId *string `json:"VettingId,omitempty"`
}

Optional parameters for the method 'CreateBrandVetting'

func (*CreateBrandVettingParams) SetVettingId added in v0.17.0 

func (params *CreateBrandVettingParams) SetVettingId(VettingId string) *CreateBrandVettingParams

func (*CreateBrandVettingParams) SetVettingProvider added in v0.17.0 

func (params *CreateBrandVettingParams) SetVettingProvider(VettingProvider string) *CreateBrandVettingParams

type CreateExternalCampaignParams 

type CreateExternalCampaignParams struct {
	// ID of the preregistered campaign.
	CampaignId *string `json:"CampaignId,omitempty"`
	// The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) that the resource is associated with.
	MessagingServiceSid *string `json:"MessagingServiceSid,omitempty"`
}

Optional parameters for the method 'CreateExternalCampaign'

func (*CreateExternalCampaignParams) SetCampaignId 

func (params *CreateExternalCampaignParams) SetCampaignId(CampaignId string) *CreateExternalCampaignParams

func (*CreateExternalCampaignParams) SetMessagingServiceSid 

func (params *CreateExternalCampaignParams) SetMessagingServiceSid(MessagingServiceSid string) *CreateExternalCampaignParams

type CreatePhoneNumberParams 

type CreatePhoneNumberParams struct {
	// The SID of the Phone Number being added to the Service.
	PhoneNumberSid *string `json:"PhoneNumberSid,omitempty"`
}

Optional parameters for the method 'CreatePhoneNumber'

func (*CreatePhoneNumberParams) SetPhoneNumberSid 

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

type CreateServiceParams 

type CreateServiceParams 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 URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service.
	InboundRequestUrl *string `json:"InboundRequestUrl,omitempty"`
	// The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
	InboundMethod *string `json:"InboundMethod,omitempty"`
	// The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.
	FallbackUrl *string `json:"FallbackUrl,omitempty"`
	// The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.
	FallbackMethod *string `json:"FallbackMethod,omitempty"`
	// The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
	StatusCallback *string `json:"StatusCallback,omitempty"`
	// Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance.
	StickySender *bool `json:"StickySender,omitempty"`
	// Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance.
	MmsConverter *bool `json:"MmsConverter,omitempty"`
	// Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance.
	SmartEncoding *bool `json:"SmartEncoding,omitempty"`
	//
	ScanMessageContent *string `json:"ScanMessageContent,omitempty"`
	// Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance.
	FallbackToLongCode *bool `json:"FallbackToLongCode,omitempty"`
	// Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance.
	AreaCodeGeomatch *bool `json:"AreaCodeGeomatch,omitempty"`
	// How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
	ValidityPeriod *int `json:"ValidityPeriod,omitempty"`
	// Reserved.
	SynchronousValidation *bool `json:"SynchronousValidation,omitempty"`
	// A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..].
	Usecase *string `json:"Usecase,omitempty"`
	// A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service.
	UseInboundWebhookOnNumber *bool `json:"UseInboundWebhookOnNumber,omitempty"`
}

Optional parameters for the method 'CreateService'

func (*CreateServiceParams) SetAreaCodeGeomatch 

func (params *CreateServiceParams) SetAreaCodeGeomatch(AreaCodeGeomatch bool) *CreateServiceParams

func (*CreateServiceParams) SetFallbackMethod 

func (params *CreateServiceParams) SetFallbackMethod(FallbackMethod string) *CreateServiceParams

func (*CreateServiceParams) SetFallbackToLongCode 

func (params *CreateServiceParams) SetFallbackToLongCode(FallbackToLongCode bool) *CreateServiceParams

func (*CreateServiceParams) SetFallbackUrl 

func (params *CreateServiceParams) SetFallbackUrl(FallbackUrl string) *CreateServiceParams

func (*CreateServiceParams) SetFriendlyName 

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

func (*CreateServiceParams) SetInboundMethod 

func (params *CreateServiceParams) SetInboundMethod(InboundMethod string) *CreateServiceParams

func (*CreateServiceParams) SetInboundRequestUrl 

func (params *CreateServiceParams) SetInboundRequestUrl(InboundRequestUrl string) *CreateServiceParams

func (*CreateServiceParams) SetMmsConverter 

func (params *CreateServiceParams) SetMmsConverter(MmsConverter bool) *CreateServiceParams

func (*CreateServiceParams) SetScanMessageContent 

func (params *CreateServiceParams) SetScanMessageContent(ScanMessageContent string) *CreateServiceParams

func (*CreateServiceParams) SetSmartEncoding 

func (params *CreateServiceParams) SetSmartEncoding(SmartEncoding bool) *CreateServiceParams

func (*CreateServiceParams) SetStatusCallback 

func (params *CreateServiceParams) SetStatusCallback(StatusCallback string) *CreateServiceParams

func (*CreateServiceParams) SetStickySender 

func (params *CreateServiceParams) SetStickySender(StickySender bool) *CreateServiceParams

func (*CreateServiceParams) SetSynchronousValidation 

func (params *CreateServiceParams) SetSynchronousValidation(SynchronousValidation bool) *CreateServiceParams

func (*CreateServiceParams) SetUseInboundWebhookOnNumber 

func (params *CreateServiceParams) SetUseInboundWebhookOnNumber(UseInboundWebhookOnNumber bool) *CreateServiceParams

func (*CreateServiceParams) SetUsecase added in v0.17.0 

func (params *CreateServiceParams) SetUsecase(Usecase string) *CreateServiceParams

func (*CreateServiceParams) SetValidityPeriod 

func (params *CreateServiceParams) SetValidityPeriod(ValidityPeriod int) *CreateServiceParams

type CreateShortCodeParams 

type CreateShortCodeParams struct {
	// The SID of the ShortCode resource being added to the Service.
	ShortCodeSid *string `json:"ShortCodeSid,omitempty"`
}

Optional parameters for the method 'CreateShortCode'

func (*CreateShortCodeParams) SetShortCodeSid 

func (params *CreateShortCodeParams) SetShortCodeSid(ShortCodeSid string) *CreateShortCodeParams

type CreateTollfreeVerificationParams added in v1.0.0 

type CreateTollfreeVerificationParams struct {
	// The name of the business or organization using the Tollfree number.
	BusinessName *string `json:"BusinessName,omitempty"`
	// The website of the business or organization using the Tollfree number.
	BusinessWebsite *string `json:"BusinessWebsite,omitempty"`
	// The email address to receive the notification about the verification result. .
	NotificationEmail *string `json:"NotificationEmail,omitempty"`
	// The category of the use case for the Tollfree Number. List as many are applicable..
	UseCaseCategories *[]string `json:"UseCaseCategories,omitempty"`
	// Use this to further explain how messaging is used by the business or organization.
	UseCaseSummary *string `json:"UseCaseSummary,omitempty"`
	// An example of message content, i.e. a sample message.
	ProductionMessageSample *string `json:"ProductionMessageSample,omitempty"`
	// Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
	OptInImageUrls *[]string `json:"OptInImageUrls,omitempty"`
	//
	OptInType *string `json:"OptInType,omitempty"`
	// Estimate monthly volume of messages from the Tollfree Number.
	MessageVolume *string `json:"MessageVolume,omitempty"`
	// The SID of the Phone Number associated with the Tollfree Verification.
	TollfreePhoneNumberSid *string `json:"TollfreePhoneNumberSid,omitempty"`
	// Customer's Profile Bundle BundleSid.
	CustomerProfileSid *string `json:"CustomerProfileSid,omitempty"`
	// The address of the business or organization using the Tollfree number.
	BusinessStreetAddress *string `json:"BusinessStreetAddress,omitempty"`
	// The address of the business or organization using the Tollfree number.
	BusinessStreetAddress2 *string `json:"BusinessStreetAddress2,omitempty"`
	// The city of the business or organization using the Tollfree number.
	BusinessCity *string `json:"BusinessCity,omitempty"`
	// The state/province/region of the business or organization using the Tollfree number.
	BusinessStateProvinceRegion *string `json:"BusinessStateProvinceRegion,omitempty"`
	// The postal code of the business or organization using the Tollfree number.
	BusinessPostalCode *string `json:"BusinessPostalCode,omitempty"`
	// The country of the business or organization using the Tollfree number.
	BusinessCountry *string `json:"BusinessCountry,omitempty"`
	// Additional information to be provided for verification.
	AdditionalInformation *string `json:"AdditionalInformation,omitempty"`
	// The first name of the contact for the business or organization using the Tollfree number.
	BusinessContactFirstName *string `json:"BusinessContactFirstName,omitempty"`
	// The last name of the contact for the business or organization using the Tollfree number.
	BusinessContactLastName *string `json:"BusinessContactLastName,omitempty"`
	// The email address of the contact for the business or organization using the Tollfree number.
	BusinessContactEmail *string `json:"BusinessContactEmail,omitempty"`
	// The phone number of the contact for the business or organization using the Tollfree number.
	BusinessContactPhone *string `json:"BusinessContactPhone,omitempty"`
}

Optional parameters for the method 'CreateTollfreeVerification'

func (*CreateTollfreeVerificationParams) SetAdditionalInformation added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetAdditionalInformation(AdditionalInformation string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessCity added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessCity(BusinessCity string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessContactEmail added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessContactEmail(BusinessContactEmail string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessContactFirstName added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessContactFirstName(BusinessContactFirstName string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessContactLastName added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessContactLastName(BusinessContactLastName string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessContactPhone added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessContactPhone(BusinessContactPhone string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessCountry added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessCountry(BusinessCountry string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessName added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessName(BusinessName string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessPostalCode added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessPostalCode(BusinessPostalCode string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessStateProvinceRegion added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessStateProvinceRegion(BusinessStateProvinceRegion string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessStreetAddress added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessStreetAddress(BusinessStreetAddress string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessStreetAddress2 added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessStreetAddress2(BusinessStreetAddress2 string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetBusinessWebsite added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetBusinessWebsite(BusinessWebsite string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetCustomerProfileSid added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetCustomerProfileSid(CustomerProfileSid string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetMessageVolume added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetMessageVolume(MessageVolume string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetNotificationEmail added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetNotificationEmail(NotificationEmail string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetOptInImageUrls added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetOptInImageUrls(OptInImageUrls []string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetOptInType added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetOptInType(OptInType string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetProductionMessageSample added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetProductionMessageSample(ProductionMessageSample string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetTollfreePhoneNumberSid added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetTollfreePhoneNumberSid(TollfreePhoneNumberSid string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetUseCaseCategories added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetUseCaseCategories(UseCaseCategories []string) *CreateTollfreeVerificationParams

func (*CreateTollfreeVerificationParams) SetUseCaseSummary added in v1.0.0 

func (params *CreateTollfreeVerificationParams) SetUseCaseSummary(UseCaseSummary string) *CreateTollfreeVerificationParams

type CreateUsAppToPersonParams 

type CreateUsAppToPersonParams struct {
	// A2P Brand Registration SID
	BrandRegistrationSid *string `json:"BrandRegistrationSid,omitempty"`
	// A short description of what this SMS campaign does.
	Description *string `json:"Description,omitempty"`
	// Message samples, at least 2 and up to 5 sample messages, <=1024 chars each.
	MessageSamples *[]string `json:"MessageSamples,omitempty"`
	// A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]
	UsAppToPersonUsecase *string `json:"UsAppToPersonUsecase,omitempty"`
	// Indicates that this SMS campaign will send messages that contain links.
	HasEmbeddedLinks *bool `json:"HasEmbeddedLinks,omitempty"`
	// Indicates that this SMS campaign will send messages that contain phone numbers.
	HasEmbeddedPhone *bool `json:"HasEmbeddedPhone,omitempty"`
}

Optional parameters for the method 'CreateUsAppToPerson'

func (*CreateUsAppToPersonParams) SetBrandRegistrationSid 

func (params *CreateUsAppToPersonParams) SetBrandRegistrationSid(BrandRegistrationSid string) *CreateUsAppToPersonParams

func (*CreateUsAppToPersonParams) SetDescription 

func (params *CreateUsAppToPersonParams) SetDescription(Description string) *CreateUsAppToPersonParams
func (params *CreateUsAppToPersonParams) SetHasEmbeddedLinks(HasEmbeddedLinks bool) *CreateUsAppToPersonParams

func (*CreateUsAppToPersonParams) SetHasEmbeddedPhone 

func (params *CreateUsAppToPersonParams) SetHasEmbeddedPhone(HasEmbeddedPhone bool) *CreateUsAppToPersonParams

func (*CreateUsAppToPersonParams) SetMessageSamples 

func (params *CreateUsAppToPersonParams) SetMessageSamples(MessageSamples []string) *CreateUsAppToPersonParams

func (*CreateUsAppToPersonParams) SetUsAppToPersonUsecase 

func (params *CreateUsAppToPersonParams) SetUsAppToPersonUsecase(UsAppToPersonUsecase string) *CreateUsAppToPersonParams

type FetchDeactivationParams 

type FetchDeactivationParams struct {
	// The request will return a list of all United States Phone Numbers that were deactivated on the day specified by this parameter. This date should be specified in YYYY-MM-DD format.
	Date *string `json:"Date,omitempty"`
}

Optional parameters for the method 'FetchDeactivation'

func (*FetchDeactivationParams) SetDate 

func (params *FetchDeactivationParams) SetDate(Date string) *FetchDeactivationParams

type FetchUsAppToPersonUsecaseParams added in v0.14.1 

type FetchUsAppToPersonUsecaseParams struct {
	// The unique string to identify the A2P brand.
	BrandRegistrationSid *string `json:"BrandRegistrationSid,omitempty"`
}

Optional parameters for the method 'FetchUsAppToPersonUsecase'

func (*FetchUsAppToPersonUsecaseParams) SetBrandRegistrationSid added in v0.14.1 

func (params *FetchUsAppToPersonUsecaseParams) SetBrandRegistrationSid(BrandRegistrationSid string) *FetchUsAppToPersonUsecaseParams

type ListAlphaSenderParams 

type ListAlphaSenderParams 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 'ListAlphaSender'

func (*ListAlphaSenderParams) SetLimit added in v0.13.0 

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

func (*ListAlphaSenderParams) SetPageSize 

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

type ListAlphaSenderResponse 

type ListAlphaSenderResponse struct {
	AlphaSenders []MessagingV1AlphaSender    `json:"alpha_senders,omitempty"`
	Meta         ListAlphaSenderResponseMeta `json:"meta,omitempty"`
}

ListAlphaSenderResponse struct for ListAlphaSenderResponse

type ListAlphaSenderResponseMeta added in v1.0.0 

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

ListAlphaSenderResponseMeta struct for ListAlphaSenderResponseMeta

type ListBrandRegistrationsParams 

type ListBrandRegistrationsParams 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 'ListBrandRegistrations'

func (*ListBrandRegistrationsParams) SetLimit added in v0.13.0 

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

func (*ListBrandRegistrationsParams) SetPageSize 

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

type ListBrandRegistrationsResponse 

type ListBrandRegistrationsResponse struct {
	Data []MessagingV1BrandRegistrations `json:"data,omitempty"`
	Meta ListAlphaSenderResponseMeta     `json:"meta,omitempty"`
}

ListBrandRegistrationsResponse struct for ListBrandRegistrationsResponse

type ListBrandVettingParams added in v0.17.0 

type ListBrandVettingParams struct {
	// The third-party provider of the vettings to read
	VettingProvider *string `json:"VettingProvider,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 'ListBrandVetting'

func (*ListBrandVettingParams) SetLimit added in v0.17.0 

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

func (*ListBrandVettingParams) SetPageSize added in v0.17.0 

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

func (*ListBrandVettingParams) SetVettingProvider added in v0.17.0 

func (params *ListBrandVettingParams) SetVettingProvider(VettingProvider string) *ListBrandVettingParams

type ListBrandVettingResponse added in v0.17.0 

type ListBrandVettingResponse struct {
	Data []MessagingV1BrandVetting   `json:"data,omitempty"`
	Meta ListAlphaSenderResponseMeta `json:"meta,omitempty"`
}

ListBrandVettingResponse struct for ListBrandVettingResponse

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 []MessagingV1PhoneNumber    `json:"phone_numbers,omitempty"`
	Meta         ListAlphaSenderResponseMeta `json:"meta,omitempty"`
}

ListPhoneNumberResponse struct for ListPhoneNumberResponse

type ListServiceParams 

type ListServiceParams 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 'ListService'

func (*ListServiceParams) SetLimit added in v0.13.0 

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

func (*ListServiceParams) SetPageSize 

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

type ListServiceResponse 

type ListServiceResponse struct {
	Services []MessagingV1Service        `json:"services,omitempty"`
	Meta     ListAlphaSenderResponseMeta `json:"meta,omitempty"`
}

ListServiceResponse struct for ListServiceResponse

type ListShortCodeParams 

type ListShortCodeParams 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 'ListShortCode'

func (*ListShortCodeParams) SetLimit added in v0.13.0 

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

func (*ListShortCodeParams) SetPageSize 

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

type ListShortCodeResponse 

type ListShortCodeResponse struct {
	ShortCodes []MessagingV1ShortCode      `json:"short_codes,omitempty"`
	Meta       ListAlphaSenderResponseMeta `json:"meta,omitempty"`
}

ListShortCodeResponse struct for ListShortCodeResponse

type ListTollfreeVerificationParams added in v1.0.0 

type ListTollfreeVerificationParams struct {
	// The SID of the Phone Number associated with the Tollfree Verification.
	TollfreePhoneNumberSid *string `json:"TollfreePhoneNumberSid,omitempty"`
	// The compliance status of the Tollfree Verification record.
	Status *string `json:"Status,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 'ListTollfreeVerification'

func (*ListTollfreeVerificationParams) SetLimit added in v1.0.0 

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

func (*ListTollfreeVerificationParams) SetPageSize added in v1.0.0 

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

func (*ListTollfreeVerificationParams) SetStatus added in v1.0.0 

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

func (*ListTollfreeVerificationParams) SetTollfreePhoneNumberSid added in v1.0.0 

func (params *ListTollfreeVerificationParams) SetTollfreePhoneNumberSid(TollfreePhoneNumberSid string) *ListTollfreeVerificationParams

type ListTollfreeVerificationResponse added in v1.0.0 

type ListTollfreeVerificationResponse struct {
	Verifications []MessagingV1TollfreeVerification `json:"verifications,omitempty"`
	Meta          ListAlphaSenderResponseMeta       `json:"meta,omitempty"`
}

ListTollfreeVerificationResponse struct for ListTollfreeVerificationResponse

type ListUsAppToPersonParams 

type ListUsAppToPersonParams 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 'ListUsAppToPerson'

func (*ListUsAppToPersonParams) SetLimit added in v0.13.0 

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

func (*ListUsAppToPersonParams) SetPageSize 

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

type ListUsAppToPersonResponse 

type ListUsAppToPersonResponse struct {
	Compliance []MessagingV1UsAppToPerson  `json:"compliance,omitempty"`
	Meta       ListAlphaSenderResponseMeta `json:"meta,omitempty"`
}

ListUsAppToPersonResponse struct for ListUsAppToPersonResponse

type MessagingV1AlphaSender added in v0.14.0 

type MessagingV1AlphaSender struct {
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The Alphanumeric Sender ID string
	AlphaSender *string `json:"alpha_sender,omitempty"`
	// An array of values that describe whether the number can receive calls or messages
	Capabilities *[]string `json:"capabilities,omitempty"`
	// The absolute URL of the AlphaSender resource
	Url *string `json:"url,omitempty"`
}

MessagingV1AlphaSender struct for MessagingV1AlphaSender

type MessagingV1BrandRegistrations 

type MessagingV1BrandRegistrations struct {
	// A2P BrandRegistration Sid
	Sid *string `json:"sid,omitempty"`
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// A2P Messaging Profile Bundle BundleSid
	CustomerProfileBundleSid *string `json:"customer_profile_bundle_sid,omitempty"`
	// A2P Messaging Profile Bundle BundleSid
	A2pProfileBundleSid *string `json:"a2p_profile_bundle_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// Type of brand. One of: \"STANDARD\", \"STARTER\".
	BrandType *string `json:"brand_type,omitempty"`
	Status    *string `json:"status,omitempty"`
	// Campaign Registry (TCR) Brand ID
	TcrId *string `json:"tcr_id,omitempty"`
	// A reason why brand registration has failed
	FailureReason *string `json:"failure_reason,omitempty"`
	// The absolute URL of the Brand Registration
	Url *string `json:"url,omitempty"`
	// Brand score
	BrandScore *int `json:"brand_score,omitempty"`
	// Brand feedback
	BrandFeedback  *[]string `json:"brand_feedback,omitempty"`
	IdentityStatus *string   `json:"identity_status,omitempty"`
	// Russell 3000
	Russell3000 *bool `json:"russell_3000,omitempty"`
	// Government Entity
	GovernmentEntity *bool `json:"government_entity,omitempty"`
	// Tax Exempt Status
	TaxExemptStatus *string `json:"tax_exempt_status,omitempty"`
	// Skip Automatic Secondary Vetting
	SkipAutomaticSecVet *bool `json:"skip_automatic_sec_vet,omitempty"`
	// A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.
	Mock  *bool                   `json:"mock,omitempty"`
	Links *map[string]interface{} `json:"links,omitempty"`
}

MessagingV1BrandRegistrations struct for MessagingV1BrandRegistrations

type MessagingV1BrandVetting added in v0.17.0 

type MessagingV1BrandVetting struct {
	// The SID of the Account that created the vetting
	AccountSid *string `json:"account_sid,omitempty"`
	// A2P BrandRegistration Sid
	BrandSid *string `json:"brand_sid,omitempty"`
	// SID for third-party vetting record
	BrandVettingSid *string `json:"brand_vetting_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The unique ID of the vetting
	VettingId *string `json:"vetting_id,omitempty"`
	// The type of vetting
	VettingClass *string `json:"vetting_class,omitempty"`
	// Status of vetting attempt
	VettingStatus   *string `json:"vetting_status,omitempty"`
	VettingProvider *string `json:"vetting_provider,omitempty"`
	// The absolute URL of the Brand Vetting
	Url *string `json:"url,omitempty"`
}

MessagingV1BrandVetting struct for MessagingV1BrandVetting

type MessagingV1Deactivation 

type MessagingV1Deactivation struct {
	// Redirect url to the list of deactivated numbers.
	RedirectTo *string `json:"redirect_to,omitempty"`
}

MessagingV1Deactivation struct for MessagingV1Deactivation

type MessagingV1ExternalCampaign 

type MessagingV1ExternalCampaign struct {
	// The unique string that identifies a US A2P Compliance resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// ID of the preregistered campaign.
	CampaignId *string `json:"campaign_id,omitempty"`
	// The SID of the Messaging Service the resource is associated with
	MessagingServiceSid *string `json:"messaging_service_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
}

MessagingV1ExternalCampaign struct for MessagingV1ExternalCampaign

type MessagingV1PhoneNumber added in v0.14.0 

type MessagingV1PhoneNumber struct {
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The phone number in E.164 format
	PhoneNumber *string `json:"phone_number,omitempty"`
	// The 2-character ISO Country Code of the number
	CountryCode *string `json:"country_code,omitempty"`
	// An array of values that describe whether the number can receive calls or messages
	Capabilities *[]string `json:"capabilities,omitempty"`
	// The absolute URL of the PhoneNumber resource
	Url *string `json:"url,omitempty"`
}

MessagingV1PhoneNumber struct for MessagingV1PhoneNumber

type MessagingV1Service 

type MessagingV1Service struct {
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URL we call using inbound_method when a message is received by any phone number or short code in the Service. This field will be overridden if the `use_inbound_webhook_on_number` field is enabled.
	InboundRequestUrl *string `json:"inbound_request_url,omitempty"`
	// The HTTP method we use to call inbound_request_url
	InboundMethod *string `json:"inbound_method,omitempty"`
	// The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. This field will be overridden if the `use_inbound_webhook_on_number` field is enabled.
	FallbackUrl *string `json:"fallback_url,omitempty"`
	// The HTTP method we use to call fallback_url
	FallbackMethod *string `json:"fallback_method,omitempty"`
	// The URL we call to pass status updates about message delivery
	StatusCallback *string `json:"status_callback,omitempty"`
	// Whether to enable Sticky Sender on the Service instance
	StickySender *bool `json:"sticky_sender,omitempty"`
	// Whether to enable the MMS Converter for messages sent through the Service instance
	MmsConverter *bool `json:"mms_converter,omitempty"`
	// Whether to enable Encoding for messages sent through the Service instance
	SmartEncoding      *bool   `json:"smart_encoding,omitempty"`
	ScanMessageContent *string `json:"scan_message_content,omitempty"`
	// Whether to enable Fallback to Long Code for messages sent through the Service instance
	FallbackToLongCode *bool `json:"fallback_to_long_code,omitempty"`
	// Whether to enable Area Code Geomatch on the Service Instance
	AreaCodeGeomatch *bool `json:"area_code_geomatch,omitempty"`
	// Reserved
	SynchronousValidation *bool `json:"synchronous_validation,omitempty"`
	// How long, in seconds, messages sent from the Service are valid
	ValidityPeriod *int `json:"validity_period,omitempty"`
	// The absolute URL of the Service resource
	Url *string `json:"url,omitempty"`
	// The absolute URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// A string describing the scenario in which the Messaging Service will be used
	Usecase *string `json:"usecase,omitempty"`
	// Whether US A2P campaign is registered for this Service.
	UsAppToPersonRegistered *bool `json:"us_app_to_person_registered,omitempty"`
	// If enabled, the webhook url configured on the phone number will be used and will override the `inbound_request_url`/`fallback_url` url called when an inbound message is received.
	UseInboundWebhookOnNumber *bool `json:"use_inbound_webhook_on_number,omitempty"`
}

MessagingV1Service struct for MessagingV1Service

type MessagingV1ShortCode added in v0.14.0 

type MessagingV1ShortCode struct {
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The E.164 format of the short code
	ShortCode *string `json:"short_code,omitempty"`
	// The 2-character ISO Country Code of the number
	CountryCode *string `json:"country_code,omitempty"`
	// An array of values that describe whether the number can receive calls or messages
	Capabilities *[]string `json:"capabilities,omitempty"`
	// The absolute URL of the ShortCode resource
	Url *string `json:"url,omitempty"`
}

MessagingV1ShortCode struct for MessagingV1ShortCode

type MessagingV1TollfreeVerification added in v1.0.0 

type MessagingV1TollfreeVerification struct {
	// Tollfree Verification Sid
	Sid *string `json:"sid,omitempty"`
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// Customer's Profile Bundle BundleSid
	CustomerProfileSid *string `json:"customer_profile_sid,omitempty"`
	// Tollfree TrustProduct Bundle BundleSid
	TrustProductSid *string `json:"trust_product_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The SID of the Regulated Item
	RegulatedItemSid *string `json:"regulated_item_sid,omitempty"`
	// The name of the business or organization using the Tollfree number
	BusinessName *string `json:"business_name,omitempty"`
	// The address of the business or organization using the Tollfree number
	BusinessStreetAddress *string `json:"business_street_address,omitempty"`
	// The address of the business or organization using the Tollfree number
	BusinessStreetAddress2 *string `json:"business_street_address2,omitempty"`
	// The city of the business or organization using the Tollfree number
	BusinessCity *string `json:"business_city,omitempty"`
	// The state/province/region of the business or organization using the Tollfree number
	BusinessStateProvinceRegion *string `json:"business_state_province_region,omitempty"`
	// The postal code of the business or organization using the Tollfree number
	BusinessPostalCode *string `json:"business_postal_code,omitempty"`
	// The country of the business or organization using the Tollfree number
	BusinessCountry *string `json:"business_country,omitempty"`
	// The website of the business or organization using the Tollfree number
	BusinessWebsite *string `json:"business_website,omitempty"`
	// The first name of the contact for the business or organization using the Tollfree number
	BusinessContactFirstName *string `json:"business_contact_first_name,omitempty"`
	// The last name of the contact for the business or organization using the Tollfree number
	BusinessContactLastName *string `json:"business_contact_last_name,omitempty"`
	// The email address of the contact for the business or organization using the Tollfree number
	BusinessContactEmail *string `json:"business_contact_email,omitempty"`
	// The phone number of the contact for the business or organization using the Tollfree number
	BusinessContactPhone *string `json:"business_contact_phone,omitempty"`
	// The email address to receive the notification about the verification result.
	NotificationEmail *string `json:"notification_email,omitempty"`
	// The category of the use case for the Tollfree Number. List as many are applicable.
	UseCaseCategories *[]string `json:"use_case_categories,omitempty"`
	// Further explaination on how messaging is used by the business or organization
	UseCaseSummary *string `json:"use_case_summary,omitempty"`
	// An example of message content, i.e. a sample message
	ProductionMessageSample *string `json:"production_message_sample,omitempty"`
	// Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL
	OptInImageUrls *[]string `json:"opt_in_image_urls,omitempty"`
	OptInType      *string   `json:"opt_in_type,omitempty"`
	// Estimate monthly volume of messages from the Tollfree Number
	MessageVolume *string `json:"message_volume,omitempty"`
	// Additional information to be provided for verification
	AdditionalInformation *string `json:"additional_information,omitempty"`
	// The SID of the Phone Number associated with the Tollfree Verification
	TollfreePhoneNumberSid *string `json:"tollfree_phone_number_sid,omitempty"`
	Status                 *string `json:"status,omitempty"`
	// The absolute URL of the Tollfree Verification
	Url *string `json:"url,omitempty"`
	// The URLs of the documents associated with the Tollfree Verification resource
	ResourceLinks *interface{} `json:"resource_links,omitempty"`
}

MessagingV1TollfreeVerification struct for MessagingV1TollfreeVerification

type MessagingV1UsAppToPerson added in v0.14.0 

type MessagingV1UsAppToPerson struct {
	// The unique string that identifies a US A2P Compliance resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// A2P Brand Registration SID
	BrandRegistrationSid *string `json:"brand_registration_sid,omitempty"`
	// The SID of the Messaging Service the resource is associated with
	MessagingServiceSid *string `json:"messaging_service_sid,omitempty"`
	// A short description of what this SMS campaign does
	Description *string `json:"description,omitempty"`
	// Message samples
	MessageSamples *[]string `json:"message_samples,omitempty"`
	// A2P Campaign Use Case.
	UsAppToPersonUsecase *string `json:"us_app_to_person_usecase,omitempty"`
	// Indicate that this SMS campaign will send messages that contain links
	HasEmbeddedLinks *bool `json:"has_embedded_links,omitempty"`
	// Indicates that this SMS campaign will send messages that contain phone numbers
	HasEmbeddedPhone *bool `json:"has_embedded_phone,omitempty"`
	// Campaign status
	CampaignStatus *string `json:"campaign_status,omitempty"`
	// The Campaign Registry (TCR) Campaign ID.
	CampaignId *string `json:"campaign_id,omitempty"`
	// Indicates whether the campaign was registered externally or not
	IsExternallyRegistered *bool `json:"is_externally_registered,omitempty"`
	// Rate limit and/or classification set by each carrier
	RateLimits *interface{} `json:"rate_limits,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the US App to Person resource
	Url *string `json:"url,omitempty"`
	// A boolean that specifies whether campaign is a mock or not.
	Mock *bool `json:"mock,omitempty"`
}

MessagingV1UsAppToPerson struct for MessagingV1UsAppToPerson

type MessagingV1UsAppToPersonUsecase added in v0.14.0 

type MessagingV1UsAppToPersonUsecase struct {
	// Human readable A2P Use Case details
	UsAppToPersonUsecases *[]interface{} `json:"us_app_to_person_usecases,omitempty"`
}

MessagingV1UsAppToPersonUsecase struct for MessagingV1UsAppToPersonUsecase

type MessagingV1Usecase 

type MessagingV1Usecase struct {
	// Human readable Messaging Service Use Case details
	Usecases *[]interface{} `json:"usecases,omitempty"`
}

MessagingV1Usecase struct for MessagingV1Usecase

type UpdateServiceParams 

type UpdateServiceParams 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 URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service.
	InboundRequestUrl *string `json:"InboundRequestUrl,omitempty"`
	// The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
	InboundMethod *string `json:"InboundMethod,omitempty"`
	// The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.
	FallbackUrl *string `json:"FallbackUrl,omitempty"`
	// The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.
	FallbackMethod *string `json:"FallbackMethod,omitempty"`
	// The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
	StatusCallback *string `json:"StatusCallback,omitempty"`
	// Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance.
	StickySender *bool `json:"StickySender,omitempty"`
	// Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance.
	MmsConverter *bool `json:"MmsConverter,omitempty"`
	// Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance.
	SmartEncoding *bool `json:"SmartEncoding,omitempty"`
	//
	ScanMessageContent *string `json:"ScanMessageContent,omitempty"`
	// Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance.
	FallbackToLongCode *bool `json:"FallbackToLongCode,omitempty"`
	// Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance.
	AreaCodeGeomatch *bool `json:"AreaCodeGeomatch,omitempty"`
	// How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.
	ValidityPeriod *int `json:"ValidityPeriod,omitempty"`
	// Reserved.
	SynchronousValidation *bool `json:"SynchronousValidation,omitempty"`
	// A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]
	Usecase *string `json:"Usecase,omitempty"`
	// A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service.
	UseInboundWebhookOnNumber *bool `json:"UseInboundWebhookOnNumber,omitempty"`
}

Optional parameters for the method 'UpdateService'

func (*UpdateServiceParams) SetAreaCodeGeomatch 

func (params *UpdateServiceParams) SetAreaCodeGeomatch(AreaCodeGeomatch bool) *UpdateServiceParams

func (*UpdateServiceParams) SetFallbackMethod 

func (params *UpdateServiceParams) SetFallbackMethod(FallbackMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetFallbackToLongCode 

func (params *UpdateServiceParams) SetFallbackToLongCode(FallbackToLongCode bool) *UpdateServiceParams

func (*UpdateServiceParams) SetFallbackUrl 

func (params *UpdateServiceParams) SetFallbackUrl(FallbackUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetFriendlyName 

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

func (*UpdateServiceParams) SetInboundMethod 

func (params *UpdateServiceParams) SetInboundMethod(InboundMethod string) *UpdateServiceParams

func (*UpdateServiceParams) SetInboundRequestUrl 

func (params *UpdateServiceParams) SetInboundRequestUrl(InboundRequestUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetMmsConverter 

func (params *UpdateServiceParams) SetMmsConverter(MmsConverter bool) *UpdateServiceParams

func (*UpdateServiceParams) SetScanMessageContent 

func (params *UpdateServiceParams) SetScanMessageContent(ScanMessageContent string) *UpdateServiceParams

func (*UpdateServiceParams) SetSmartEncoding 

func (params *UpdateServiceParams) SetSmartEncoding(SmartEncoding bool) *UpdateServiceParams

func (*UpdateServiceParams) SetStatusCallback 

func (params *UpdateServiceParams) SetStatusCallback(StatusCallback string) *UpdateServiceParams

func (*UpdateServiceParams) SetStickySender 

func (params *UpdateServiceParams) SetStickySender(StickySender bool) *UpdateServiceParams

func (*UpdateServiceParams) SetSynchronousValidation 

func (params *UpdateServiceParams) SetSynchronousValidation(SynchronousValidation bool) *UpdateServiceParams

func (*UpdateServiceParams) SetUseInboundWebhookOnNumber 

func (params *UpdateServiceParams) SetUseInboundWebhookOnNumber(UseInboundWebhookOnNumber bool) *UpdateServiceParams

func (*UpdateServiceParams) SetUsecase added in v0.17.0 

func (params *UpdateServiceParams) SetUsecase(Usecase string) *UpdateServiceParams

func (*UpdateServiceParams) SetValidityPeriod 

func (params *UpdateServiceParams) SetValidityPeriod(ValidityPeriod int) *UpdateServiceParams

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.