cn.authing.sdk.java.dto.SendSMSDto Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of authing-java-sdk Show documentation
java backend sdk for authing
There is a newer version: 3.1.10
package cn.authing.sdk.java.dto;

import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty;


public class SendSMSDto {
    /**
     * 短信通道，指定发送此短信的目的：
     * - `CHANNEL_LOGIN`: 用于用户登录
     * - `CHANNEL_REGISTER`: 用于用户注册
     * - `CHANNEL_RESET_PASSWORD`: 用于重置密码
     * - `CHANNEL_BIND_PHONE`: 用于绑定手机号
     * - `CHANNEL_UNBIND_PHONE`: 用于解绑手机号
     * - `CHANNEL_BIND_MFA`: 用于绑定 MFA
     * - `CHANNEL_VERIFY_MFA`: 用于验证 MFA
     * - `CHANNEL_UNBIND_MFA`: 用于解绑 MFA
     * - `CHANNEL_COMPLETE_PHONE`: 用于在注册/登录时补全手机号信息
     * - `CHANNEL_IDENTITY_VERIFICATION`: 用于进行用户实名认证
     * - `CHANNEL_DELETE_ACCOUNT`: 用于注销账号
     *
     */
    @JsonProperty("channel")
    private Channel channel;
    /**
     * 手机号，不带区号。如果是国外手机号，请在 phoneCountryCode 参数中指定区号。
     */
    @JsonProperty("phoneNumber")
    private String phoneNumber;
    /**
     * 手机区号，中国大陆手机号可不填。Authing 短信服务暂不内置支持国际手机号，你需要在 Authing 控制台配置对应的国际短信服务。完整的手机区号列表可参阅 https://en.wikipedia.org/wiki/List_of_country_calling_codes。
     */
    @JsonProperty("phoneCountryCode")
    private String phoneCountryCode;

    public Channel getChannel() {
        return channel;
    }
    public void setChannel(Channel channel) {
        this.channel = channel;
    }

    public String getPhoneNumber() {
        return phoneNumber;
    }
    public void setPhoneNumber(String phoneNumber) {
        this.phoneNumber = phoneNumber;
    }

    public String getPhoneCountryCode() {
        return phoneCountryCode;
    }
    public void setPhoneCountryCode(String phoneCountryCode) {
        this.phoneCountryCode = phoneCountryCode;
    }


    /**
     * 短信通道，指定发送此短信的目的：
     * - `CHANNEL_LOGIN`: 用于用户登录
     * - `CHANNEL_REGISTER`: 用于用户注册
     * - `CHANNEL_RESET_PASSWORD`: 用于重置密码
     * - `CHANNEL_BIND_PHONE`: 用于绑定手机号
     * - `CHANNEL_UNBIND_PHONE`: 用于解绑手机号
     * - `CHANNEL_BIND_MFA`: 用于绑定 MFA
     * - `CHANNEL_VERIFY_MFA`: 用于验证 MFA
     * - `CHANNEL_UNBIND_MFA`: 用于解绑 MFA
     * - `CHANNEL_COMPLETE_PHONE`: 用于在注册/登录时补全手机号信息
     * - `CHANNEL_IDENTITY_VERIFICATION`: 用于进行用户实名认证
     * - `CHANNEL_DELETE_ACCOUNT`: 用于注销账号
     *
     */
    public static enum Channel {

        @JsonProperty("CHANNEL_LOGIN")
        CHANNEL_LOGIN("CHANNEL_LOGIN"),

        @JsonProperty("CHANNEL_REGISTER")
        CHANNEL_REGISTER("CHANNEL_REGISTER"),

        @JsonProperty("CHANNEL_RESET_PASSWORD")
        CHANNEL_RESET_PASSWORD("CHANNEL_RESET_PASSWORD"),

        @JsonProperty("CHANNEL_BIND_PHONE")
        CHANNEL_BIND_PHONE("CHANNEL_BIND_PHONE"),

        @JsonProperty("CHANNEL_UNBIND_PHONE")
        CHANNEL_UNBIND_PHONE("CHANNEL_UNBIND_PHONE"),

        @JsonProperty("CHANNEL_BIND_MFA")
        CHANNEL_BIND_MFA("CHANNEL_BIND_MFA"),

        @JsonProperty("CHANNEL_VERIFY_MFA")
        CHANNEL_VERIFY_MFA("CHANNEL_VERIFY_MFA"),

        @JsonProperty("CHANNEL_UNBIND_MFA")
        CHANNEL_UNBIND_MFA("CHANNEL_UNBIND_MFA"),

        @JsonProperty("CHANNEL_COMPLETE_PHONE")
        CHANNEL_COMPLETE_PHONE("CHANNEL_COMPLETE_PHONE"),

        @JsonProperty("CHANNEL_IDENTITY_VERIFICATION")
        CHANNEL_IDENTITY_VERIFICATION("CHANNEL_IDENTITY_VERIFICATION"),

        @JsonProperty("CHANNEL_DELETE_ACCOUNT")
        CHANNEL_DELETE_ACCOUNT("CHANNEL_DELETE_ACCOUNT"),
        ;

        private String value;

        Channel(String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }
    }


}