v20210409

Documentation

Index

• Constants
• type Client
  • func NewClient(credential common.CredentialIface, region string, ...) (client *Client, err error)
  • func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)
  • func (c *Client) CreateAccount(request *CreateAccountRequest) (response *CreateAccountResponse, err error)
  • func (c *Client) GetCountryCodes(request *GetCountryCodesRequest) (response *GetCountryCodesResponse, err error)
• type CountryCodeItem
• type CreateAccountRequest
  • func NewCreateAccountRequest() (request *CreateAccountRequest)
  • func (r *CreateAccountRequest) FromJsonString(s string) error
  • func (r *CreateAccountRequest) ToJsonString() string
• type CreateAccountResponse
  • func NewCreateAccountResponse() (response *CreateAccountResponse)
  • func (r *CreateAccountResponse) FromJsonString(s string) error
  • func (r *CreateAccountResponse) ToJsonString() string
• type GetCountryCodesRequest
  • func NewGetCountryCodesRequest() (request *GetCountryCodesRequest)
  • func (r *GetCountryCodesRequest) FromJsonString(s string) error
  • func (r *GetCountryCodesRequest) ToJsonString() string
• type GetCountryCodesResponse
  • func NewGetCountryCodesResponse() (response *GetCountryCodesResponse)
  • func (r *GetCountryCodesResponse) FromJsonString(s string) error
  • func (r *GetCountryCodesResponse) ToJsonString() string

Constants

const (

	// CAM signature/authentication error. Please try again later.
	AUTHFAILURE = "AuthFailure"

	// The email address has already been registered.
	FAILEDOPERATION_MAILISREGISTERED = "FailedOperation.MailIsRegistered"

	// Internal error. Please try again later.
	INTERNALERROR = "InternalError"

	// A parameter error occurred.
	INVALIDPARAMETER = "InvalidParameter"

	// The operation is unauthorized.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
)

const APIVersion = "2021-04-09"

Types

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CreateAccount

func (c *Client) CreateAccount(request *CreateAccountRequest) (response *CreateAccountResponse, err error)

CreateAccount This API is used to create a Tencent Cloud account in the International Partner platform for a customer. After registration, the customer will be automatically bound to the partner account.

Notes:<br>

1. To create the Tencent Cloud account, the partner should enter and verify the customer’s email address and mobile number.<br>

2. The customer needs to complete personal information after the first login.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_MAILISREGISTERED = "FailedOperation.MailIsRegistered"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetCountryCodes

func (c *Client) GetCountryCodes(request *GetCountryCodesRequest) (response *GetCountryCodesResponse, err error)

GetCountryCodes This API is used to obtain country and region codes.

error code that may be returned:

INTERNALERROR = "InternalError"

type CountryCodeItem

type CountryCodeItem struct {

	// Country/region name in English
	EnName *string `json:"EnName,omitempty" name:"EnName"`

	// Country/region name in Chinese
	Name *string `json:"Name,omitempty" name:"Name"`

	// IOS2 standard country/region code
	IOS2 *string `json:"IOS2,omitempty" name:"IOS2"`

	// IOS3 standard country/region code
	IOS3 *string `json:"IOS3,omitempty" name:"IOS3"`

	// Phone code
	Code *string `json:"Code,omitempty" name:"Code"`
}

type CreateAccountRequest

type CreateAccountRequest struct {
	*tchttp.BaseRequest

	// Account type of a new customer. Valid value: `business`.
	AccountType *string `json:"AccountType,omitempty" name:"AccountType"`

	// Registered email address, which should be valid and correct.
	// For example, account@qq.com.
	Mail *string `json:"Mail,omitempty" name:"Mail"`

	// Account password
	// Length limit: 8-20 characters
	// A password must contain numbers, letters, and special symbols [!@#$%^&*()]. Spaces are not allowed.
	Password *string `json:"Password,omitempty" name:"Password"`

	// Confirm the password. It must be the same as the `Password` field.
	ConfirmPassword *string `json:"ConfirmPassword,omitempty" name:"ConfirmPassword"`

	// Customer mobile number, which should be valid and correct.
	// A global mobile number within 1-32 digits is allowed, such as 18888888888.
	PhoneNum *string `json:"PhoneNum,omitempty" name:"PhoneNum"`

	// Country code, which can be obtained via the `GetCountryCodes` API, such as `86`.
	CountryCode *string `json:"CountryCode,omitempty" name:"CountryCode"`

	// ISO2 standard country code, which can be obtained via the `GetCountryCodes` API. It should correspond to the `CountryCode` field.
	Area *string `json:"Area,omitempty" name:"Area"`

	// Expanded field, which is left empty by default.
	Extended *string `json:"Extended,omitempty" name:"Extended"`
}

func NewCreateAccountRequest

func NewCreateAccountRequest() (request *CreateAccountRequest)

func (*CreateAccountRequest) FromJsonString

func (r *CreateAccountRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateAccountRequest) ToJsonString

func (r *CreateAccountRequest) ToJsonString() string

type CreateAccountResponse

type CreateAccountResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Account UIN
		Uin *string `json:"Uin,omitempty" name:"Uin"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateAccountResponse

func NewCreateAccountResponse() (response *CreateAccountResponse)

func (*CreateAccountResponse) FromJsonString

func (r *CreateAccountResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateAccountResponse) ToJsonString

func (r *CreateAccountResponse) ToJsonString() string

type GetCountryCodesRequest

type GetCountryCodesRequest struct {
	*tchttp.BaseRequest
}

func NewGetCountryCodesRequest

func NewGetCountryCodesRequest() (request *GetCountryCodesRequest)

func (*GetCountryCodesRequest) FromJsonString

func (r *GetCountryCodesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetCountryCodesRequest) ToJsonString

func (r *GetCountryCodesRequest) ToJsonString() string

type GetCountryCodesResponse

type GetCountryCodesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// List of country/region codes
		Data []*CountryCodeItem `json:"Data,omitempty" name:"Data"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewGetCountryCodesResponse

func NewGetCountryCodesResponse() (response *GetCountryCodesResponse)

func (*GetCountryCodesResponse) FromJsonString

func (r *GetCountryCodesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetCountryCodesResponse) ToJsonString

func (r *GetCountryCodesResponse) ToJsonString() string