ExAliyun.OpenAPI (ex_aliyun_openapi v0.10.0)

Aliyun Describe Ipv4/6 Location Service(查询IPv4地理位置信息) Please note that when using API to query IP Location Information, you need to open the relevant service in the Product package page first. You can read the doc in Official Link.

call_global_sms(params, access_info \\ nil)

Global Aliyun Short Message Service(国际短信服务). You can read the doc in Official Link.

call_sms(params, access_info \\ nil)

Aliyun Short Message Service(短信服务). You can read the doc in Official Link.

call_sts(params, access_info \\ nil)

Aliyun Security Token Service(短期访问权限). You can read the doc in Official Link.

get_access_info(service)

get_timestamp()

should_retry(arg)

Types

captcha_request()

@type captcha_request() :: %{required(String.t()) => String.t()}

VerifyIntelligentCaptcha request params. CaptchaVerifyParam is required, SceneId is optional.

captcha_response_body()

@type captcha_response_body() :: %{
  optional(:RequestId) => String.t(),
  optional(:Success) => boolean(),
  optional(:Code) => String.t(),
  optional(:Message) => String.t(),
  optional(:Result) => captcha_verify_result()
}

VerifyIntelligentCaptcha response body. Check Result.VerifyResult for verification outcome:

true — verification passed
false — verification failed (check Result.VerifyCode for reason)

captcha_scene_id()

@type captcha_scene_id() :: String.t()

Captcha scene ID

captcha_verify_param()

@type captcha_verify_param() :: String.t()

Captcha verify param string from frontend callback

captcha_verify_result()

@type captcha_verify_result() :: %{
  optional(:VerifyResult) => boolean(),
  optional(:VerifyCode) => String.t(),
  optional(:CertifyId) => String.t()
}

Verify result in response body

Functions

call_captcha(params, access_info \\ nil)

@spec call_captcha(captcha_request(), keyword() | nil) ::
  {:ok, Tesla.Env.t()} | {:error, term()}

Aliyun Captcha Service(验证码). You can read the doc in Official Link.

call_codeup(params, access_info \\ nil)

Aliyun Project Task Service of CodeUp (云效任务管理). You can read the doc in Official Link.

call_cps(params, access_info \\ nil)

Aliyun Cloud Push Service(移动推送). You can read the doc in Official Link.