sms

Documentation

Index

• Constants
• type Client
  • func NewClient(ak, sk, endpoint string) (*Client, error)
  • func (c *Client) CreateSignature(args *api.CreateSignatureArgs) (*api.CreateSignatureResult, error)
  • func (c *Client) CreateTemplate(args *api.CreateTemplateArgs) (*api.CreateTemplateResult, error)
  • func (c *Client) DeleteSignature(args *api.DeleteSignatureArgs) error
  • func (c *Client) DeleteTemplate(args *api.DeleteTemplateArgs) error
  • func (c *Client) GetSignature(args *api.GetSignatureArgs) (*api.GetSignatureResult, error)
  • func (c *Client) GetTemplate(args *api.GetTemplateArgs) (*api.GetTemplateResult, error)
  • func (c *Client) ModifySignature(args *api.ModifySignatureArgs) error
  • func (c *Client) ModifyTemplate(args *api.ModifyTemplateArgs) error
  • func (c *Client) QueryQuotaAndRateLimit() (*api.QueryQuotaRateResult, error)
  • func (c *Client) SendSms(args *api.SendSmsArgs) (*api.SendSmsResult, error)
  • func (c *Client) UpdateQuotaAndRateLimit(args *api.UpdateQuotaRateArgs) error

Constants

const (
	REGION_BJ              = "bj"
	REGION_SU              = "su"
	DEFAULT_SERVICE_DOMAIN = "smsv3." + bce.DEFAULT_REGION + "." + bce.DEFAULT_DOMAIN
)

Types

type Client

type Client struct {
	*bce.BceClient
}

Client of SMS service is a kind of BceClient, so derived from BceClient

func NewClient

func NewClient(ak, sk, endpoint string) (*Client, error)

NewClient make the SMS service client with default configuration. Use `cli.Config.xxx` to access the config or change it to non-default value.

func (*Client) CreateSignature

func (c *Client) CreateSignature(args *api.CreateSignatureArgs) (*api.CreateSignatureResult, error)

CreateSignature - create an sms signature

PARAMS:

• args: the arguments to create an sms signature

RETURNS:

• *api.CreateSignatureResult: the result of creating an sms signature
• error: the return error if any occurs

func (*Client) CreateTemplate

func (c *Client) CreateTemplate(args *api.CreateTemplateArgs) (*api.CreateTemplateResult, error)

CreateTemplate - create an sms template

PARAMS:

• args: the arguments to create an sms template

RETURNS:

• *api.CreateTemplateResult: the result of creating an sms template
• error: the return error if any occurs

func (*Client) DeleteSignature

func (c *Client) DeleteSignature(args *api.DeleteSignatureArgs) error

DeleteSignature - delete an sms signature

PARAMS:

• args: the arguments to delete an sms signature

RETURNS:

• error: the return error if any occurs

func (*Client) DeleteTemplate

func (c *Client) DeleteTemplate(args *api.DeleteTemplateArgs) error

DeleteTemplate - delete an sms template

PARAMS:

• args: the arguments to delete an sms template

RETURNS:

• error: the return error if any occurs

func (*Client) GetSignature

func (c *Client) GetSignature(args *api.GetSignatureArgs) (*api.GetSignatureResult, error)

GetSignature - get the detail of an sms signature

PARAMS:

• args: the arguments to get the detail of an sms signature

RETURNS:

• *api.GetSignatureResult: the detail of an sms signature
• error: the return error if any occurs

func (*Client) GetTemplate

func (c *Client) GetTemplate(args *api.GetTemplateArgs) (*api.GetTemplateResult, error)

GetTemplate - modify an sms template

PARAMS:

• args: the arguments to modify an sms template

RETURNS:

• error: the return error if any occurs

func (*Client) ModifySignature

func (c *Client) ModifySignature(args *api.ModifySignatureArgs) error

ModifySignature - modify an sms signature

PARAMS:

• args: the arguments to modify an sms signature

RETURNS:

• error: the return error if any occurs

func (*Client) ModifyTemplate

func (c *Client) ModifyTemplate(args *api.ModifyTemplateArgs) error

ModifyTemplate - modify an sms template

PARAMS:

• args: the arguments to modify an sms template

RETURNS:

• error: the return error if any occurs

func (*Client) QueryQuotaAndRateLimit

func (c *Client) QueryQuotaAndRateLimit() (*api.QueryQuotaRateResult, error)

QueryQuotaAndRateLimit - query the quota and rate limit

RETURNS:

• QueryQuotaRateResult: the result of querying the quota and rate limit
• error: the return error if any occurs

func (*Client) SendSms

func (c *Client) SendSms(args *api.SendSmsArgs) (*api.SendSmsResult, error)

SendSms - send an sms message

PARAMS:

• args: the arguments to send an sms message

RETURNS:

• *api.SendSmsResult: the result of sending an sms message
• error: the return error if any occurs

func (*Client) UpdateQuotaAndRateLimit

func (c *Client) UpdateQuotaAndRateLimit(args *api.UpdateQuotaRateArgs) error

UpdateQuotaAndRateLimit - update the quota or rate limit PARAMS:

• args: the arguments to update the quota or rate limit

RETURNS:

• error: the return error if any occurs