isms

Documentation

Overview

Package isms include resources of ucloud isms product

See also

• API: https://docs.ucloud.cn/api/isms-api/index
• Product: https://www.ucloud.cn/site/product/isms.html

for detail.

Index

• type GetISMSSendReceiptRequest
• type GetISMSSendReceiptResponse
• type ISMSClient
  • func NewClient(config *ucloud.Config, credential *auth.Credential) *ISMSClient
  • func (c *ISMSClient) GetISMSSendReceipt(req *GetISMSSendReceiptRequest) (*GetISMSSendReceiptResponse, error)
  • func (c *ISMSClient) NewGetISMSSendReceiptRequest() *GetISMSSendReceiptRequest
  • func (c *ISMSClient) NewSendISMSMessageRequest() *SendISMSMessageRequest
  • func (c *ISMSClient) SendISMSMessage(req *SendISMSMessageRequest) (*SendISMSMessageResponse, error)
• type ReceiptPerPhone
• type ReceiptPerTask
• type SendISMSMessageRequest
• type SendISMSMessageResponse

Types

type GetISMSSendReceiptRequest

type GetISMSSendReceiptRequest struct {
	request.CommonBase

	// 发送记录TaskId集合。调用SendUSMSVideoMessage时返回的TaskId的集合。以TaskIdSet.0、TaskIdSet.1...TaskIdSet.N的形式传入。每次请求最多支持100个
	TaskIdSet []string `required:"true"`
}

GetISMSSendReceiptRequest is request schema for GetISMSSendReceipt action

type GetISMSSendReceiptResponse

type GetISMSSendReceiptResponse struct {
	response.CommonBase

	// 本次请求结果
	Data []ReceiptPerTask

	// 错误信息
	Message string

	// 本次请求uuid
	ReqUuid string
}

GetISMSSendReceiptResponse is response schema for GetISMSSendReceipt action

type ISMSClient

type ISMSClient struct {
	*ucloud.Client
}

ISMSClient is the client of ISMS

func NewClient

func NewClient(config *ucloud.Config, credential *auth.Credential) *ISMSClient

NewClient will return a instance of ISMSClient

func (*ISMSClient) GetISMSSendReceipt

func (c *ISMSClient) GetISMSSendReceipt(req *GetISMSSendReceiptRequest) (*GetISMSSendReceiptResponse, error)

API: GetISMSSendReceipt

获取视频短信发送记录的状态回执

func (*ISMSClient) NewGetISMSSendReceiptRequest

func (c *ISMSClient) NewGetISMSSendReceiptRequest() *GetISMSSendReceiptRequest

NewGetISMSSendReceiptRequest will create request of GetISMSSendReceipt action.

func (*ISMSClient) NewSendISMSMessageRequest

func (c *ISMSClient) NewSendISMSMessageRequest() *SendISMSMessageRequest

NewSendISMSMessageRequest will create request of SendISMSMessage action.

func (*ISMSClient) SendISMSMessage

func (c *ISMSClient) SendISMSMessage(req *SendISMSMessageRequest) (*SendISMSMessageResponse, error)

API: SendISMSMessage

发送视频短信

type ReceiptPerPhone

type ReceiptPerPhone struct {

	// 手机号码
	Phone string

	// 回执码
	ReceiptCode string

	// 回执结果描述
	ReceiptDesc string

	// 回执结果(发送成功、发送失败、状态未知)
	ReceiptResult string

	// 回执返回时间
	ReceiptTime int

	// SessionId
	SessionId string
}

ReceiptPerPhone - 每个目的手机号的发送回执信息

type ReceiptPerTask

type ReceiptPerTask struct {

	// 每个手机号的短信回执信息集合
	ReceiptSet []ReceiptPerPhone

	// 发送短信时返回的TaskId
	TaskId string
}

ReceiptPerTask - 每个提交任务的视频短信的回执结果集合

type SendISMSMessageRequest

type SendISMSMessageRequest struct {
	request.CommonBase

	// 手机号码列表。暂时只支持中国大陆号码。若号码中带区号，需要将区号使用小括号包含，放在号码前面。如: (86)1851623xxxx
	PhoneSet []string `required:"true"`

	// 视频短信模板Id
	TemplateId *string `required:"true"`
}

SendISMSMessageRequest is request schema for SendISMSMessage action

type SendISMSMessageResponse

type SendISMSMessageResponse struct {
	response.CommonBase

	// 错误信息
	Message string

	// 本次请求uuid
	ReqUuid string

	// 本次调用TaskId，使用该字段查询回执信息
	TaskId string
}

SendISMSMessageResponse is response schema for SendISMSMessage action