sms

Documentation

Index

• Constants
• func NewValidate() *validator.Validate
• type ExtraConfig
• type MessageStatus
• type ReceiveResult
• type ReceiveResultDetail
• type Recipient
• type RequestStatus
• type ResultQuery
• type SendResponse
• type TextMessage
• type ToastClient
  • func NewToastClient(AppKey string, ApiSecret string, extras ...*ExtraConfig) *ToastClient
  • func (t ToastClient) SendMessage(message TextMessage)
  • func (t ToastClient) Validate(schema interface{})

Constants

const DEFAULT_API_VERSION = "v3.0"

const DEFAULT_MAX_CONNCURRENCY = 10

const DEFAULT_TIMEOUT = 10 * time.Second

const DOMAIN = "https://api-sms.cloud.toast.com"

Functions

func NewValidate

func NewValidate() *validator.Validate

Schema의 구조체 레벨 Validaton을 수행하는 Validator구조체 생성자이다.

Types

type ExtraConfig

type ExtraConfig struct {
	TimoutSecond  uint
	MaxConcurreny int
	ApiVersion    string
}

type MessageStatus

type MessageStatus string

메시지 상태 코드

const (
	MESSAGE_FAIL        MessageStatus = "0"
	MESSAGE_REQUEST     MessageStatus = "1"
	MESSAGE_IN_PROGRESS MessageStatus = "2"
	MESSAGE_SUCCESS     MessageStatus = "3"
	MESSAGE_CANCELED    MessageStatus = "4"
	MESSAGE_DUPLICATED  MessageStatus = "5"
)

type ReceiveResult

type ReceiveResult string

수신 결과 코드

const (
	RECEIVE_SUCCESS ReceiveResult = "MTR1"
	RECEIVE_FAIL    ReceiveResult = "MTR2"
)

type ReceiveResultDetail

type ReceiveResultDetail string

수신 결과 코드 상세

const (
	RECEIVE_INVALID_REQUEST ReceiveResultDetail = "MTR2_1"
	RECEIVE_CARRIER_PROBLEM ReceiveResultDetail = "MTR2_2"
	RECEIVE_DEVICE_PROBLEM  ReceiveResultDetail = "MTR2_3"
)

type Recipient

type Recipient struct {
	RecipientNo              string                 `json:"recipientNo" validate:"max=50,required_without=InternationalRecipientNo"`
	CountryCode              string                 `json:"countryCode" validate:"max=8"`
	InternationalRecipientNo string                 `json:"internationalRecipientNo,omitempty" validate:"max=20,required_without=RecipientNo"`
	TemplateParameter        map[string]interface{} `json:"templateParameter,omitempty" validate:"omitempty,max=20"`
	RecipientGroupingKey     string                 `json:"recipientGroupingKey,omitempty" validate:"max=100"`
}

Toast SMS API 수신인이다 RecipientNo는 전화번호이며 필수이다 CountryCode는 국가코드이며 없는 경우 자동으로 82가 된다 InternationalRecipentNo는 국가코드를 포함한 전화번호이며 recipentNo가 있는 경우 무시된다 TemplateParameter Toast에서 동적으로 문자 템플릿을 만들때 사용하며 Map 타입이다 RecipientGroupingKey는 수신자 그룹키이다

type RequestStatus

type RequestStatus string

const (
	REQUEST_IN_PROGRESS RequestStatus = "1"
	REQUEST_COMPLETED   RequestStatus = "2"
	REQUEST_FAILED      RequestStatus = "3"
)

type ResultQuery

type ResultQuery struct {
	RequestId            string              `json:"requestId" validate:"max=25"`
	StartRequestDate     string              `json:"startRequestDate" validate:"omitempty,datetime=2006-01-02 15:04:05"`
	EndRequestDate       string              `json:"endRequestDate" validate:"omitempty,datetime=2006-01-02 15:04:05"`
	StartCreateDate      string              `json:"startCreateDate" validate:"omitempty,datetime=2006-01-02 15:04:05"`
	EndCreateDate        string              `json:"endCreateDate" validate:"omitempty,datetime=2006-01-02 15:04:05"`
	StartResultDate      string              `json:"startResultDate" validate:"omitempty,datetime=2006-01-02 15:04:05"`
	EndResultDate        string              `json:"endResultDate" validate:"omitempty,datetime=2006-01-02 15:04:05"`
	SendNo               string              `json:"sendNo" validate:"max=13"`
	RecipientNo          string              `json:"recipientNo" validate:"max=20"`
	TemplateId           string              `json:"templateId" validate:"max=50"`
	MsgStatus            MessageStatus       `json:"msgStatus" validate:"omitempty,oneof=0 1 2 3 4 5"`
	ResultCode           ReceiveResult       `json:"resultCode" validate:"omitempty,oneof=MTR1 MTR2"`
	SubResultCode        ReceiveResultDetail `json:"subResultCode" validate:"omitempty,oneof=MTR2_1 MTR2_2 MTR2_3"`
	SenderGroupingKey    string              `json:"senderGroupingKey" validate:"max=100"`
	RecipientGroupingKey string              `json:"recipientGroupingKey" validate:"max=100"`
	PageNum              uint                `json:"pageNum" validate:"omitempty,min=1"`
	PageSize             uint16              `json:"pageSize" validate:"omitempty,min=1,max=1000"`
}

결과 조회를 위한 Request Body이다.

type SendResponse

type SendResponse struct {
	Header struct {
		IsSuccessFul  bool   `json:"isSuccessful"`
		ResultCode    int    `json:"resultCode"`
		ResultMessage string `json:"resultMessage"`
	} `json:"header"`
	Body struct {
		Data struct {
			RequestId         string `json:"requestId"`
			StatusCode        string `json:"statusCode"`
			SenderGroupingKey string `json:"senderGroupingKey"`
			SendResultList    []struct {
				RecipientNo          string `json:"recipientNo"`
				ResultCode           int    `json:"resultCode"`
				ResultMessage        string `json:"resultMessage"`
				RecipientSeq         int    `json:"recipientSeq"`
				RecipientGroupingKey string `json:"recipientGroupingKey"`
			} `json:"sendResultList"`
		}
	} `json:"body"`
}

메시지 발송의 Response Body이다. Response이므로 별도의 validation은 하지 않는다.

type TextMessage

type TextMessage struct {
	Type              string      `json:"-" validate:"required,oneof=sms mms"`
	TemplateId        string      `json:"templateId" validate:"max=50,required_without=Body"`
	Title             string      `json:"title" validate:"max=120"`
	Body              string      `json:"body" validate:"max=4000,required_without=TemplateId"`
	SendNo            string      `json:"sendNo" validate:"max=13,required"`
	RequestDate       string      `json:"requestDate" validate:"omitempty,datetime=2006-01-02 15:04"`
	SenderGroupingKey string      `json:"senderGroupingKey" validate:"max=100"`
	RecipientList     []Recipient `json:"recipientList" validate:"max=1000,required"`
	UserId            string      `json:"userId" validate:"max=100"`
	StatsId           string      `json:"statsId" validate:"max=10"`
}

Toast SMS 문자 메시지의 Request Body이다 Body는 필수이나 TemplateId가 있는 경우에는 필수가 아니다. SendNo는 발신인 번호를 의미하며 필수이다. RequestDate는 yyyy-mm-dd HH:MM 포맷이며 발송 예약일시이다. SenderGroupingKey는 발신자 그룹키이다 RecipientList는 수신자 리스트이며 최대 1,000명까지 가능하다. UserId는 발송구분자이다. Stats Id는 통계 ID로 검색 조건에는 포함되지 않는다. FIXME: Title은 MMS에서 적용되므로 별도의 required 조건이 추가되야 한다.

type ToastClient

type ToastClient struct {
	AppKey        string
	ApiSecret     string
	ApiVersion    string
	MaxConcurreny int
	Validator     *validator.Validate
	Client        *http.Client
}

func NewToastClient

func NewToastClient(AppKey string, ApiSecret string, extras ...*ExtraConfig) *ToastClient

ToastClient를 생성한다.

func (ToastClient) SendMessage

func (t ToastClient) SendMessage(message TextMessage)

Toast로 SMS 메시지를 보낸다

func (ToastClient) Validate

func (t ToastClient) Validate(schema interface{})

코드를 Validation한다.