SMSOptions.cs 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. namespace Admin.NET.Core;
  7. /// <summary>
  8. /// 短信配置选项
  9. /// </summary>
  10. public sealed class SMSOptions : IConfigurableOptions
  11. {
  12. /// <summary>
  13. /// 验证码缓存过期时间(秒)
  14. /// 默认: 60秒
  15. /// </summary>
  16. public int VerifyCodeExpireSeconds { get; set; } = 60;
  17. /// <summary>
  18. /// Aliyun
  19. /// </summary>
  20. public SMSSettings Aliyun { get; set; }
  21. /// <summary>
  22. /// Tencentyun
  23. /// </summary>
  24. public SMSSettings Tencentyun { get; set; }
  25. /// <summary>
  26. /// Custom 自定义短信接口
  27. /// </summary>
  28. public CustomSMSSettings Custom { get; set; }
  29. }
  30. public sealed class SMSSettings
  31. {
  32. /// <summary>
  33. /// SdkAppId
  34. /// </summary>
  35. public string SdkAppId { get; set; }
  36. /// <summary>
  37. /// AccessKey ID
  38. /// </summary>
  39. public string AccessKeyId { get; set; }
  40. /// <summary>
  41. /// AccessKey Secret
  42. /// </summary>
  43. public string AccessKeySecret { get; set; }
  44. /// <summary>
  45. /// Templates
  46. /// </summary>
  47. public List<SmsTemplate> Templates { get; set; }
  48. /// <summary>
  49. /// GetTemplate
  50. /// </summary>
  51. public SmsTemplate GetTemplate(string id = "0")
  52. {
  53. foreach (var template in Templates)
  54. {
  55. if (template.Id == id) { return template; }
  56. }
  57. return null;
  58. }
  59. }
  60. public class SmsTemplate
  61. {
  62. public string Id { get; set; } = string.Empty;
  63. public string SignName { get; set; }
  64. public string TemplateCode { get; set; }
  65. public string Content { get; set; }
  66. }
  67. /// <summary>
  68. /// 自定义短信配置
  69. /// </summary>
  70. public sealed class CustomSMSSettings
  71. {
  72. /// <summary>
  73. /// 是否启用自定义短信接口
  74. /// </summary>
  75. public bool Enabled { get; set; }
  76. /// <summary>
  77. /// API 接口地址模板
  78. /// <para>支持占位符: {mobile} - 手机号, {content} - 短信内容, {code} - 验证码</para>
  79. /// </summary>
  80. /// <remarks>示例: https://api.xxxx.com/sms?u=xxxx&amp;key=59e03f49c3dbb5033&amp;m={mobile}&amp;c={content}</remarks>
  81. public string ApiUrl { get; set; }
  82. /// <summary>
  83. /// 请求方法 (GET/POST)
  84. /// </summary>
  85. public string Method { get; set; } = "GET";
  86. /// <summary>
  87. /// POST 请求的 Content-Type (application/json 或 application/x-www-form-urlencoded)
  88. /// 默认: application/x-www-form-urlencoded
  89. /// </summary>
  90. public string ContentType { get; set; } = "application/x-www-form-urlencoded";
  91. /// <summary>
  92. /// POST 请求的数据模板(支持占位符)
  93. /// </summary>
  94. /// <remarks>
  95. /// JSON 格式示例: {"mobile":"{mobile}","content":"{content}","apikey":"your_key"} <br />
  96. /// Form 格式示例: mobile={mobile}&amp;content={content}&amp;apikey=your_key
  97. /// </remarks>
  98. public string PostData { get; set; }
  99. /// <summary>
  100. /// 成功响应标识(用于判断发送是否成功)
  101. /// 如果响应内容包含此字符串,则认为发送成功
  102. /// </summary>
  103. public string SuccessFlag { get; set; } = "0";
  104. /// <summary>
  105. /// 短信模板列表
  106. /// </summary>
  107. public List<SmsTemplate> Templates { get; set; }
  108. /// <summary>
  109. /// 获取模板
  110. /// </summary>
  111. public SmsTemplate GetTemplate(string id = "0")
  112. {
  113. foreach (var template in Templates)
  114. {
  115. if (template.Id == id) { return template; }
  116. }
  117. return null;
  118. }
  119. }