ATSNonCustodial/src/3.contracts/ATS.NonCustodial.Application.Contracts/Interfaces/Admins/SMS/ISMSService.cs

using ATS.NonCustodial.Application.Contracts.Interfaces.Admins.SMS.Input;
using ATS.NonCustodial.Domain.Shared.Enums;
using ATS.NonCustodial.Shared.Common.UnifiedResults;

namespace ATS.NonCustodial.Application.Contracts.Interfaces.Admins.SMS
{
    public interface ISMSService
    {

        Task<IResultOutput> GetPageAsync(SmsGetpageInput input);
        /// <summary>
        /// 发送验证码
        /// </summary>
        /// <param name="phone"></param>
        /// <returns></returns>
        Task<IResultOutput> SendCheckCodeSMS(string phone, string ipAddress = "", string type = "CheckCode");

        /// <summary>
        /// 校验验证码
        /// </summary>
        /// <param name="phoneNumber"></param>
        /// <param name="code"></param>
        /// <param name="type"></param>
        /// <returns></returns>
        Task<bool> CheckCodeAsync(string phoneNumber, string code, string type = "default");
        /// <summary>
        /// 用于触发给指定人员发送短信
        /// </summary>
        /// <param name="alert">短信通知类型</param>
        /// <param name="supervisor">监管人姓名</param>
        /// <param name="phone">需要通知的电话</param>
        /// <param name="dateTime">发送的日期</param>
        /// <param name="msg">触发的消息内容（小于等于6个字）</param>
        /// <param name="ipAddress"></param>
        /// <param name="supervisedPerson">被监管人姓名</param>
        /// <returns></returns>
        Task<IResultOutput> SendMessageSMS(MessageAlertTypeEnum alert, string supervisor, string phone, DateTime? dateTime, string msg = "", string ipAddress = "", string supervisedPerson = "");

        /// <summary>
        /// 发送前校验
        /// </summary>
        /// <param name="phone"></param>
        /// <returns></returns>
        Task<bool> CanSendCodeAsync(string phone);
    }
}