rcs5g

package
v1.2.21 Latest Latest
Warning

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

Go to latest
Published: Mar 19, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package rcs5giface provides an interface to enable mocking the RCS_5G service client for testing your code.

It is important to note that this interface will have breaking changes when the service model is updated and adds new API operations, paginators, and waiters.

Index

Constants

View Source
const (
	ServiceName = "rcs_5g"    // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "rcs_5g"    // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source
const (
	// EnumOfChannelTypeForSendBatchRcsInputRcs is a EnumOfChannelTypeForSendBatchRcsInput enum value
	EnumOfChannelTypeForSendBatchRcsInputRcs = "RCS"
)
View Source
const (
	// EnumOfChannelTypeForSendRcsInputRcs is a EnumOfChannelTypeForSendRcsInput enum value
	EnumOfChannelTypeForSendRcsInputRcs = "RCS"
)
View Source
const (
	// EnumOfMessageTypeForSendBatchRcsInputTemplate is a EnumOfMessageTypeForSendBatchRcsInput enum value
	EnumOfMessageTypeForSendBatchRcsInputTemplate = "TEMPLATE"
)
View Source
const (
	// EnumOfMessageTypeForSendRcsInputTemplate is a EnumOfMessageTypeForSendRcsInput enum value
	EnumOfMessageTypeForSendRcsInputTemplate = "TEMPLATE"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type DataForSendBatchRcsOutput

type DataForSendBatchRcsOutput struct {
	MessageId *string `type:"string" json:",omitempty"`
	// contains filtered or unexported fields
}

func (DataForSendBatchRcsOutput) GoString

func (s DataForSendBatchRcsOutput) GoString() string

GoString returns the string representation

func (*DataForSendBatchRcsOutput) SetMessageId

SetMessageId sets the MessageId field's value.

func (DataForSendBatchRcsOutput) String

func (s DataForSendBatchRcsOutput) String() string

String returns the string representation

type DataForSendRcsOutput

type DataForSendRcsOutput struct {
	MessageId *string `type:"string" json:",omitempty"`
	// contains filtered or unexported fields
}

func (DataForSendRcsOutput) GoString

func (s DataForSendRcsOutput) GoString() string

GoString returns the string representation

func (*DataForSendRcsOutput) SetMessageId

func (s *DataForSendRcsOutput) SetMessageId(v string) *DataForSendRcsOutput

SetMessageId sets the MessageId field's value.

func (DataForSendRcsOutput) String

func (s DataForSendRcsOutput) String() string

String returns the string representation

type RCS5G

type RCS5G struct {
	*client.Client
}

RCS5G provides the API operation methods for making requests to RCS_5G. See this package's package overview docs for details on the service.

RCS5G methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*volcengine.Config) *RCS5G

New create int can support ssl or region locate set

func (*RCS5G) SendBatchRcs

func (c *RCS5G) SendBatchRcs(input *SendBatchRcsInput) (*SendBatchRcsOutput, error)

SendBatchRcs API operation for RCS_5G.

Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions with volcengineerr.Error's Code and Message methods to get detailed information about the error.

See the VOLCENGINE API reference guide for RCS_5G's API operation SendBatchRcs for usage and error information.

func (*RCS5G) SendBatchRcsCommon

func (c *RCS5G) SendBatchRcsCommon(input *map[string]interface{}) (*map[string]interface{}, error)

SendBatchRcsCommon API operation for RCS_5G.

Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions with volcengineerr.Error's Code and Message methods to get detailed information about the error.

See the VOLCENGINE API reference guide for RCS_5G's API operation SendBatchRcsCommon for usage and error information.

func (*RCS5G) SendBatchRcsCommonRequest

func (c *RCS5G) SendBatchRcsCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

SendBatchRcsCommonRequest generates a "volcengine/request.Request" representing the client's request for the SendBatchRcsCommon operation. The "output" return value will be populated with the SendBatchRcsCommon request's response once the request completes successfully.

Use "Send" method on the returned SendBatchRcsCommon Request to send the API call to the service. the "output" return value is not valid until after SendBatchRcsCommon Send returns without error.

See SendBatchRcsCommon for more information on using the SendBatchRcsCommon API call, and error handling.

// Example sending a request using the SendBatchRcsCommonRequest method.
req, resp := client.SendBatchRcsCommonRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*RCS5G) SendBatchRcsCommonWithContext

func (c *RCS5G) SendBatchRcsCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

SendBatchRcsCommonWithContext is the same as SendBatchRcsCommon with the addition of the ability to pass a context and additional request options.

See SendBatchRcsCommon for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RCS5G) SendBatchRcsRequest

func (c *RCS5G) SendBatchRcsRequest(input *SendBatchRcsInput) (req *request.Request, output *SendBatchRcsOutput)

SendBatchRcsRequest generates a "volcengine/request.Request" representing the client's request for the SendBatchRcs operation. The "output" return value will be populated with the SendBatchRcsCommon request's response once the request completes successfully.

Use "Send" method on the returned SendBatchRcsCommon Request to send the API call to the service. the "output" return value is not valid until after SendBatchRcsCommon Send returns without error.

See SendBatchRcs for more information on using the SendBatchRcs API call, and error handling.

// Example sending a request using the SendBatchRcsRequest method.
req, resp := client.SendBatchRcsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*RCS5G) SendBatchRcsWithContext

func (c *RCS5G) SendBatchRcsWithContext(ctx volcengine.Context, input *SendBatchRcsInput, opts ...request.Option) (*SendBatchRcsOutput, error)

SendBatchRcsWithContext is the same as SendBatchRcs with the addition of the ability to pass a context and additional request options.

See SendBatchRcs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. Ifthe context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RCS5G) SendRcs

func (c *RCS5G) SendRcs(input *SendRcsInput) (*SendRcsOutput, error)

SendRcs API operation for RCS_5G.

Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions with volcengineerr.Error's Code and Message methods to get detailed information about the error.

See the VOLCENGINE API reference guide for RCS_5G's API operation SendRcs for usage and error information.

func (*RCS5G) SendRcsCommon

func (c *RCS5G) SendRcsCommon(input *map[string]interface{}) (*map[string]interface{}, error)

SendRcsCommon API operation for RCS_5G.

Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions with volcengineerr.Error's Code and Message methods to get detailed information about the error.

See the VOLCENGINE API reference guide for RCS_5G's API operation SendRcsCommon for usage and error information.

func (*RCS5G) SendRcsCommonRequest

func (c *RCS5G) SendRcsCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

SendRcsCommonRequest generates a "volcengine/request.Request" representing the client's request for the SendRcsCommon operation. The "output" return value will be populated with the SendRcsCommon request's response once the request completes successfully.

Use "Send" method on the returned SendRcsCommon Request to send the API call to the service. the "output" return value is not valid until after SendRcsCommon Send returns without error.

See SendRcsCommon for more information on using the SendRcsCommon API call, and error handling.

// Example sending a request using the SendRcsCommonRequest method.
req, resp := client.SendRcsCommonRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*RCS5G) SendRcsCommonWithContext

func (c *RCS5G) SendRcsCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

SendRcsCommonWithContext is the same as SendRcsCommon with the addition of the ability to pass a context and additional request options.

See SendRcsCommon for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RCS5G) SendRcsRequest

func (c *RCS5G) SendRcsRequest(input *SendRcsInput) (req *request.Request, output *SendRcsOutput)

SendRcsRequest generates a "volcengine/request.Request" representing the client's request for the SendRcs operation. The "output" return value will be populated with the SendRcsCommon request's response once the request completes successfully.

Use "Send" method on the returned SendRcsCommon Request to send the API call to the service. the "output" return value is not valid until after SendRcsCommon Send returns without error.

See SendRcs for more information on using the SendRcs API call, and error handling.

// Example sending a request using the SendRcsRequest method.
req, resp := client.SendRcsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*RCS5G) SendRcsWithContext

func (c *RCS5G) SendRcsWithContext(ctx volcengine.Context, input *SendRcsInput, opts ...request.Option) (*SendRcsOutput, error)

SendRcsWithContext is the same as SendRcs with the addition of the ability to pass a context and additional request options.

See SendRcs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. Ifthe context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type RCS5GAPI

type RCS5GAPI interface {
	SendBatchRcsCommon(*map[string]interface{}) (*map[string]interface{}, error)
	SendBatchRcsCommonWithContext(volcengine.Context, *map[string]interface{}, ...request.Option) (*map[string]interface{}, error)
	SendBatchRcsCommonRequest(*map[string]interface{}) (*request.Request, *map[string]interface{})

	SendBatchRcs(*SendBatchRcsInput) (*SendBatchRcsOutput, error)
	SendBatchRcsWithContext(volcengine.Context, *SendBatchRcsInput, ...request.Option) (*SendBatchRcsOutput, error)
	SendBatchRcsRequest(*SendBatchRcsInput) (*request.Request, *SendBatchRcsOutput)

	SendRcsCommon(*map[string]interface{}) (*map[string]interface{}, error)
	SendRcsCommonWithContext(volcengine.Context, *map[string]interface{}, ...request.Option) (*map[string]interface{}, error)
	SendRcsCommonRequest(*map[string]interface{}) (*request.Request, *map[string]interface{})

	SendRcs(*SendRcsInput) (*SendRcsOutput, error)
	SendRcsWithContext(volcengine.Context, *SendRcsInput, ...request.Option) (*SendRcsOutput, error)
	SendRcsRequest(*SendRcsInput) (*request.Request, *SendRcsOutput)
}

RCS5GAPI provides an interface to enable mocking the rcs5g.RCS5G service client's API operation,

// volcengine sdk func uses an SDK service client to make a request to
// RCS_5G.
func myFunc(svc RCS5GAPI) bool {
    // Make svc.SendBatchRcs request
}

func main() {
    sess := session.New()
    svc := rcs5g.New(sess)

    myFunc(svc)
}

type ReceiverForSendBatchRcsInput

type ReceiverForSendBatchRcsInput struct {
	Params *string `type:"string" json:",omitempty"`

	Receiver *string `type:"string" json:",omitempty"`
	// contains filtered or unexported fields
}

func (ReceiverForSendBatchRcsInput) GoString

func (s ReceiverForSendBatchRcsInput) GoString() string

GoString returns the string representation

func (*ReceiverForSendBatchRcsInput) SetParams

SetParams sets the Params field's value.

func (*ReceiverForSendBatchRcsInput) SetReceiver

SetReceiver sets the Receiver field's value.

func (ReceiverForSendBatchRcsInput) String

String returns the string representation

type SendBatchRcsInput

type SendBatchRcsInput struct {
	ChannelType *string `type:"string" json:",omitempty" enum:"EnumOfChannelTypeForSendBatchRcsInput"`

	// ChatbotId is a required field
	ChatbotId *string `type:"string" json:",omitempty" required:"true"`

	FailbackFlag *bool `type:"boolean" json:",omitempty"`

	MessageType *string `type:"string" json:",omitempty" enum:"EnumOfMessageTypeForSendBatchRcsInput"`

	Receivers []*ReceiverForSendBatchRcsInput `type:"list" json:",omitempty"`

	SmsSign *string `type:"string" json:",omitempty"`

	SmsSubAccountId *string `type:"string" json:",omitempty"`

	SmsTemplateId *string `type:"string" json:",omitempty"`

	// TemplateCode is a required field
	TemplateCode *string `type:"string" json:",omitempty" required:"true"`
	// contains filtered or unexported fields
}

func (SendBatchRcsInput) GoString

func (s SendBatchRcsInput) GoString() string

GoString returns the string representation

func (*SendBatchRcsInput) SetChannelType

func (s *SendBatchRcsInput) SetChannelType(v string) *SendBatchRcsInput

SetChannelType sets the ChannelType field's value.

func (*SendBatchRcsInput) SetChatbotId

func (s *SendBatchRcsInput) SetChatbotId(v string) *SendBatchRcsInput

SetChatbotId sets the ChatbotId field's value.

func (*SendBatchRcsInput) SetFailbackFlag

func (s *SendBatchRcsInput) SetFailbackFlag(v bool) *SendBatchRcsInput

SetFailbackFlag sets the FailbackFlag field's value.

func (*SendBatchRcsInput) SetMessageType

func (s *SendBatchRcsInput) SetMessageType(v string) *SendBatchRcsInput

SetMessageType sets the MessageType field's value.

func (*SendBatchRcsInput) SetReceivers

SetReceivers sets the Receivers field's value.

func (*SendBatchRcsInput) SetSmsSign

func (s *SendBatchRcsInput) SetSmsSign(v string) *SendBatchRcsInput

SetSmsSign sets the SmsSign field's value.

func (*SendBatchRcsInput) SetSmsSubAccountId

func (s *SendBatchRcsInput) SetSmsSubAccountId(v string) *SendBatchRcsInput

SetSmsSubAccountId sets the SmsSubAccountId field's value.

func (*SendBatchRcsInput) SetSmsTemplateId

func (s *SendBatchRcsInput) SetSmsTemplateId(v string) *SendBatchRcsInput

SetSmsTemplateId sets the SmsTemplateId field's value.

func (*SendBatchRcsInput) SetTemplateCode

func (s *SendBatchRcsInput) SetTemplateCode(v string) *SendBatchRcsInput

SetTemplateCode sets the TemplateCode field's value.

func (SendBatchRcsInput) String

func (s SendBatchRcsInput) String() string

String returns the string representation

func (*SendBatchRcsInput) Validate

func (s *SendBatchRcsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendBatchRcsOutput

type SendBatchRcsOutput struct {
	Metadata *response.ResponseMetadata

	Data *DataForSendBatchRcsOutput `type:"structure" json:",omitempty"`

	Success *bool `type:"boolean" json:",omitempty"`
	// contains filtered or unexported fields
}

func (SendBatchRcsOutput) GoString

func (s SendBatchRcsOutput) GoString() string

GoString returns the string representation

func (*SendBatchRcsOutput) SetData

SetData sets the Data field's value.

func (*SendBatchRcsOutput) SetSuccess

func (s *SendBatchRcsOutput) SetSuccess(v bool) *SendBatchRcsOutput

SetSuccess sets the Success field's value.

func (SendBatchRcsOutput) String

func (s SendBatchRcsOutput) String() string

String returns the string representation

type SendRcsInput

type SendRcsInput struct {
	ChannelType *string `type:"string" json:",omitempty" enum:"EnumOfChannelTypeForSendRcsInput"`

	// ChatbotId is a required field
	ChatbotId *string `type:"string" json:",omitempty" required:"true"`

	FailbackFlag *bool `type:"boolean" json:",omitempty"`

	MessageType *string `type:"string" json:",omitempty" enum:"EnumOfMessageTypeForSendRcsInput"`

	// Params is a required field
	Params *string `type:"string" json:",omitempty" required:"true"`

	// Receiver is a required field
	Receiver *string `type:"string" json:",omitempty" required:"true"`

	SmsSign *string `type:"string" json:",omitempty"`

	SmsSubAccountId *string `type:"string" json:",omitempty"`

	SmsTemplateId *string `type:"string" json:",omitempty"`

	// TemplateCode is a required field
	TemplateCode *string `type:"string" json:",omitempty" required:"true"`
	// contains filtered or unexported fields
}

func (SendRcsInput) GoString

func (s SendRcsInput) GoString() string

GoString returns the string representation

func (*SendRcsInput) SetChannelType

func (s *SendRcsInput) SetChannelType(v string) *SendRcsInput

SetChannelType sets the ChannelType field's value.

func (*SendRcsInput) SetChatbotId

func (s *SendRcsInput) SetChatbotId(v string) *SendRcsInput

SetChatbotId sets the ChatbotId field's value.

func (*SendRcsInput) SetFailbackFlag

func (s *SendRcsInput) SetFailbackFlag(v bool) *SendRcsInput

SetFailbackFlag sets the FailbackFlag field's value.

func (*SendRcsInput) SetMessageType

func (s *SendRcsInput) SetMessageType(v string) *SendRcsInput

SetMessageType sets the MessageType field's value.

func (*SendRcsInput) SetParams

func (s *SendRcsInput) SetParams(v string) *SendRcsInput

SetParams sets the Params field's value.

func (*SendRcsInput) SetReceiver

func (s *SendRcsInput) SetReceiver(v string) *SendRcsInput

SetReceiver sets the Receiver field's value.

func (*SendRcsInput) SetSmsSign

func (s *SendRcsInput) SetSmsSign(v string) *SendRcsInput

SetSmsSign sets the SmsSign field's value.

func (*SendRcsInput) SetSmsSubAccountId

func (s *SendRcsInput) SetSmsSubAccountId(v string) *SendRcsInput

SetSmsSubAccountId sets the SmsSubAccountId field's value.

func (*SendRcsInput) SetSmsTemplateId

func (s *SendRcsInput) SetSmsTemplateId(v string) *SendRcsInput

SetSmsTemplateId sets the SmsTemplateId field's value.

func (*SendRcsInput) SetTemplateCode

func (s *SendRcsInput) SetTemplateCode(v string) *SendRcsInput

SetTemplateCode sets the TemplateCode field's value.

func (SendRcsInput) String

func (s SendRcsInput) String() string

String returns the string representation

func (*SendRcsInput) Validate

func (s *SendRcsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendRcsOutput

type SendRcsOutput struct {
	Metadata *response.ResponseMetadata

	Data *DataForSendRcsOutput `type:"structure" json:",omitempty"`

	Success *bool `type:"boolean" json:",omitempty"`
	// contains filtered or unexported fields
}

func (SendRcsOutput) GoString

func (s SendRcsOutput) GoString() string

GoString returns the string representation

func (*SendRcsOutput) SetData

SetData sets the Data field's value.

func (*SendRcsOutput) SetSuccess

func (s *SendRcsOutput) SetSuccess(v bool) *SendRcsOutput

SetSuccess sets the Success field's value.

func (SendRcsOutput) String

func (s SendRcsOutput) String() string

String returns the string representation

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL