client

Documentation

Index

• Constants
• Variables
• type ApiParams
• type AvParams
  • func (avParams *AvParams) ToParams() string
• type Client
  • func New(apiKey string) *Client
  • func (client *Client) AdultVerify(ctx context.Context, avParams *AvParams) (*SuccessAvResponse, error)
  • func (client *Client) AvSolo(ctx context.Context, avParams *AvParams) (*SuccessAvSoloResponse, error)
  • func (client *Client) ChargeSms(ctx context.Context, smsParams *SmsParams) (*SuccessChargeResponse, error)
  • func (client *Client) OperatorLookup(ctx context.Context, oplkParams *OperatorLookupParams) (*SuccessOperatorLookupResponse, error)
  • func (client *Client) SendBinSms(ctx context.Context, smsParams *SmsBinParams) (*SuccessResponse, error)
  • func (client *Client) SendSms(ctx context.Context, smsParams *SmsParams) (*SuccessResponse, error)
  • func (client *Client) SendWapPush(ctx context.Context, smsParams *SmsWapParams) (*SuccessWapResponse, error)
  • func (c *Client) SetBaseURL(baseURL string) *Client
  • func (c *Client) SetHttpClient(httpClient *http.Client) *Client
• type OperatorLookupParams
  • func (oplkParams *OperatorLookupParams) ToParams() string
• type SmsBinParams
  • func (smsParams *SmsBinParams) ToParams() string
• type SmsParams
  • func (smsParams *SmsParams) ToParams() string
• type SmsWapParams
  • func (smsParams *SmsWapParams) ToParams() string
• type SuccessAvResponse
• type SuccessAvResponseWrapper
• type SuccessAvSoloResponse
• type SuccessAvSoloResponseWrapper
• type SuccessChargeResponse
• type SuccessChargeResponseWrapper
• type SuccessOperatorLookupResponse
• type SuccessOperatorLookupResponseWrapper
• type SuccessResponse
• type SuccessResponseWrapper
• type SuccessWapResponse
• type SuccessWapResponseWrapper

Constants

const (
	AV_VERIFIED     = "verified"
	AV_NOT_VERIFIED = "no_verified"
	AV_UNKNOWN      = "unknown"
	AV_PENDING      = "pending"
)

const (
	DEFAULT_URL        = "https://sonar.fonix.io"
	DEFAULT_URL_AVSOLO = "https://avsolo.fonix.io"
	V2_SENDSMS         = "v2/sendsms"
	V2_SENDSMSBIN      = "v2/sendbinsms"
	V2_CHARGESMS       = "v2/chargesms"
	V2_SENDWAPPUSH     = "v2/sendwappush"
	V2_ADULTVERIFY     = "v2/adultverify"
	V2_OPERATORLOOKUP  = "v2/operator_lookup"
	V2_AVSOLO          = "v2/avsolo"
)

Variables

var (
	//default timeout for requests is 15 seconds, can be changed by using custom http client
	// or you can change it via this VAr before creation of client.
	CLIENT_TIMEOUT = 15 * time.Second
)

Types

type ApiParams

type ApiParams interface {
	ToParams() string
}

type AvParams

type AvParams struct {
	NetworkRetry string
	Numbers      string
	Dummy        string
}

func (*AvParams) ToParams

func (avParams *AvParams) ToParams() string

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(apiKey string) *Client

func (*Client) AdultVerify

func (client *Client) AdultVerify(ctx context.Context, avParams *AvParams) (*SuccessAvResponse, error)

func (*Client) AvSolo

func (client *Client) AvSolo(ctx context.Context, avParams *AvParams) (*SuccessAvSoloResponse, error)

func (*Client) ChargeSms

func (client *Client) ChargeSms(ctx context.Context, smsParams *SmsParams) (*SuccessChargeResponse, error)

func (*Client) OperatorLookup

func (client *Client) OperatorLookup(ctx context.Context, oplkParams *OperatorLookupParams) (*SuccessOperatorLookupResponse, error)

func (*Client) SendBinSms

func (client *Client) SendBinSms(ctx context.Context, smsParams *SmsBinParams) (*SuccessResponse, error)

func (*Client) SendSms

func (client *Client) SendSms(ctx context.Context, smsParams *SmsParams) (*SuccessResponse, error)

func (*Client) SendWapPush

func (client *Client) SendWapPush(ctx context.Context, smsParams *SmsWapParams) (*SuccessWapResponse, error)

func (*Client) SetBaseURL

func (c *Client) SetBaseURL(baseURL string) *Client

Configuration

func (*Client) SetHttpClient

func (c *Client) SetHttpClient(httpClient *http.Client) *Client

type OperatorLookupParams

type OperatorLookupParams struct {
	Number string
	Dummy  string
}

func (*OperatorLookupParams) ToParams

func (oplkParams *OperatorLookupParams) ToParams() string

type SmsBinParams

type SmsBinParams struct {
	Originator string
	Numbers    string
	BinBody    string
	Dummy      string
}

func (*SmsBinParams) ToParams

func (smsParams *SmsBinParams) ToParams() string

type SmsParams

type SmsParams struct {
	Originator string
	Numbers    string
	Body       string
	Dummy      string
}

func (*SmsParams) ToParams

func (smsParams *SmsParams) ToParams() string

type SmsWapParams

type SmsWapParams struct {
	Originator string
	Numbers    string
	PushTitle  string
	PushLink   string
	Dummy      string
}

func (*SmsWapParams) ToParams

func (smsParams *SmsWapParams) ToParams() string

type SuccessAvResponse

type SuccessAvResponse struct {
	TxGuid  string `json:"txguid"`
	Numbers string `json:"numbers"`
}

type SuccessAvResponseWrapper

type SuccessAvResponseWrapper struct {
	SuccessData SuccessAvResponse `json:"success"`
}

type SuccessAvSoloResponse

type SuccessAvSoloResponse struct {
	Status    string
	IfVersion string `json:"ifversion"`
	Operator  string `json:"operator"`
	Guid      string `json:"guid"`
}

type SuccessAvSoloResponseWrapper

type SuccessAvSoloResponseWrapper struct {
	VerifiedData    *SuccessAvSoloResponse `json:"verified"`
	NotVerifiedData *SuccessAvSoloResponse `json:"not_verified"`
	UnknownData     *SuccessAvSoloResponse `json:"unknown"`
	PendingData     *SuccessAvSoloResponse `json:"pending"`
}

type SuccessChargeResponse

type SuccessChargeResponse struct {
	TxGuid   string `json:"txguid"`
	Numbers  string `json:"numbers"`
	Price    string `json:"price"`
	Encoding string `json:"encoding"`
}

type SuccessChargeResponseWrapper

type SuccessChargeResponseWrapper struct {
	SuccessData SuccessChargeResponse `json:"success"`
}

type SuccessOperatorLookupResponse

type SuccessOperatorLookupResponse struct {
	Mnc      string `json:"mnc"`
	Mcc      string `json:"mcc"`
	Operator string `json:"operator"`
}

type SuccessOperatorLookupResponseWrapper

type SuccessOperatorLookupResponseWrapper struct {
	SuccessData SuccessOperatorLookupResponse `json:"success"`
}

type SuccessResponse

type SuccessResponse struct {
	TxGuid   string `json:"txguid"`
	Numbers  string `json:"numbers"`
	SmsParts string `json:"smsparts"`
	Encoding string `json:"encoding"`
}

type SuccessResponseWrapper

type SuccessResponseWrapper struct {
	SuccessData SuccessResponse `json:"success"`
}

type SuccessWapResponse

type SuccessWapResponse struct {
	TxGuid   string `json:"txguid"`
	Numbers  string `json:"numbers"`
	SmsParts string `json:"smsparts"`
}

type SuccessWapResponseWrapper

type SuccessWapResponseWrapper struct {
	SuccessData SuccessWapResponse `json:"success"`
}