game-center/game-module/game-sdk/src/main/java/com/zanxiang/sdk/service/ISmsService.java

package com.zanxiang.sdk.service;

import com.zanxiang.common.domain.ResultVO;
import com.zanxiang.common.enums.HttpStatusEnum;
import com.zanxiang.sdk.domain.params.SmsCheckParam;
import com.zanxiang.sdk.domain.params.SmsSendParam;
import com.zanxiang.sdk.domain.params.UserData;

/**
 * @author : lingfeng
 * @time : 2022-06-13
 * @description :
 */
public interface ISmsService {

    /**
     * 短信发送
     *
     * @param smsSendParam : 获取短信验证码参数
     * @param userData     : 用户信息
     * @return {@link ResultVO}<{@link Boolean}>
     */
    ResultVO<Boolean> smsSend(SmsSendParam smsSendParam, UserData userData);

    /**
     * 前端校验短信验证码
     *
     * @param smsCheckParam : 参数
     * @return {@link ResultVO}<{@link String}>
     */
    ResultVO<String> smsCheck(SmsCheckParam smsCheckParam);

    /**
     * 校验短信验证码
     *
     * @param type   : 短信类型
     * @param mobile : 手机号
     * @param code   : 验证码
     * @return {@link HttpStatusEnum}
     */
    HttpStatusEnum smsCheck(Integer type, String mobile, String code);
}