utilities

Documentation

Index

• type SendVerificationCodeOpts
  • func (opts SendVerificationCodeOpts) ToSendVerificationCodeMap() (map[string]interface{}, error)
• type SendVerificationCodeOptsBuilder
• type SendVerificationCodeResp
• type SendVerificationCodeResult
  • func SendVerificationCode(client *gophercloud.ServiceClient, opts SendVerificationCodeOptsBuilder) (r SendVerificationCodeResult)
  • func (r SendVerificationCodeResult) Extract() (*SendVerificationCodeResp, error)

Types

type SendVerificationCodeOpts

type SendVerificationCodeOpts struct {
	//Settings.
	ReceiverType *int `json:"receiverType" required:"true"`

	//Timeout duration of a verification code.
	Timeout int `json:"timeout,omitempty"`

	//The sender email address.
	Email string `json:"email,omitempty"`

	//Mobile number.
	MobilePhone string `json:"mobilePhone,omitempty"`

	//Country code.
	CountryCode string `json:"countryCode,omitempty"`

	//If no template information is found for the selected language, the template information for the default language is used.
	Lang string `json:"lang,omitempty"`

	//Supported scenarios
	Scene string `json:"scene,omitempty"`

	//Customer ID.
	CustomerId string `json:"customerId,omitempty"`
}

func (SendVerificationCodeOpts) ToSendVerificationCodeMap

func (opts SendVerificationCodeOpts) ToSendVerificationCodeMap() (map[string]interface{}, error)

type SendVerificationCodeOptsBuilder

type SendVerificationCodeOptsBuilder interface {
	ToSendVerificationCodeMap() (map[string]interface{}, error)
}

type SendVerificationCodeResp

type SendVerificationCodeResp struct {
	//Error code
	ErrorCode string `json:"error_code"`

	//Error description.
	ErrorMsg string `json:"error_msg"`
}

type SendVerificationCodeResult

type SendVerificationCodeResult struct {
	gophercloud.Result
}

func SendVerificationCode

func SendVerificationCode(client *gophercloud.ServiceClient, opts SendVerificationCodeOptsBuilder) (r SendVerificationCodeResult)

*

• If customers enter email addresses for registration, this API is used to send a registration verification code to the email addresses to verify the registration information.
• This API can be invoked only by the partner AK/SK or token.

func (SendVerificationCodeResult) Extract

func (r SendVerificationCodeResult) Extract() (*SendVerificationCodeResp, error)