通知服务配置

本地

POST

http://127.0.0.1:9999/api/v1/notification/services/config

通知服务配置

当notice_type=EMAIL时，参数中email_config不得为空，当notice_type=SMS时，参数中sms_config不得为空。

请求参数

Header 参数

x-token

string

可选

默认值:

Body 参数application/json

email_config

object

邮箱配置

可选

通知类型为EMAIL 时使用

from_email

string

发件人邮箱

必需

from_password

string

发件人密码

必需

host

string

邮箱服务器地址

必需

port

integer

邮箱服务器端口

必需

ssl

boolean

是否使用SSL

可选

notice_type

enum<string>

通知类型

必需

EMAIL /SMS_CODE/SMS_ALARM

<= 36 字符

枚举值:

EMAILSME_CODESMS_ALARM

remark

string

备注

可选

<= 36 字符

sms_config

object

短信配置

可选

通知类型为SMS_CODE/SMS_ALARM时使用

provider

string

服务商

必需

ALIYUN

aliyun_sms_config

object

可选

服务商是ALIYUN时使用

status

string

必需

状态 OPEN-开启 CLOSE-关闭

<= 36 字符

示例

{
  "notice_type": "eiusmod ut",
  "status": "cupidatat aliqua dolor vo",
  "email_config": {
    "email": "k.cbxuuijmn@qq.com",
    "from_email": "b.dltevmbn@qq.com",
    "from_password": "sit",
    "host": "proident nostrud do",
    "port": 11,
    "ssl": true
  },
  "sme_config": {},
  "remark": "ea quis ad aliqua"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1:9999/api/v1/notification/services/config' \
--header 'x-token: {{x-token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "notice_type": "eiusmod ut",
    "status": "cupidatat aliqua dolor vo",
    "email_config": {
        "email": "k.cbxuuijmn@qq.com",
        "from_email": "b.dltevmbn@qq.com",
        "from_password": "sit",
        "host": "proident nostrud do",
        "port": 11,
        "ssl": true
    },
    "sme_config": {},
    "remark": "ea quis ad aliqua"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

string

必需

config

string

必需

notice_type

string

必需

status

string

必需

remark

string

必需

示例

{
  "code": 200,
  "message": "操作成功",
  "data": {
    "id": "ec99038f-b4c3-0e7e-6c6a-beed485bcd59",
    "config": "{\"provider\":\"ALIYUN\",\"aliyun_sms_config\":{\"access_key_id\":\"56\",\"access_key_secret\":\"ut elit\",\"endpoint\":\"minim esse qui nisi\",\"sign_name\":\"欧呈轩\",\"template_code\":\"25\"}}",
    "notice_type": "SME_CODE",
    "status": "OPEN",
    "remark": "---"
  }
}

修改于 2025-04-27 04:00:42

发送短信测试

发送测试邮件