Query the list of email
GET
/api/v1/email
授权
UserHttpBearer
Use existing opaque tokens for authentication
类型HTTP (bearer)
参数
查询参数
id
类型integer
格式
"int64"templateCode
类型string
language
类型string
bizKey
类型string
有效值
"SIGNUP""SIGNIN""PASSWORD_FORGET""PASSWORD_UPDATE""SIGN_CANCEL""MODIFY_MOBILE""BIND_MOBILE""PAY_PASSWORD_UPDATE""REALNAME_AUTH_SUBMIT""REALNAME_AUTH_PASSED""REALNAME_AUDIT_FAILURE""SYS_EXCEPTION_NOTICE""SYS_RECOVERY_NOTICE""SYS_SECURITY_NOTICE""LICENSE_SENT""CHANNEL_TEST""TODO_REALNAME_AUTH""TODO_BUSINESS_CONSULTATION""TODO_OFFLINE_SERVICE""TODO_WORKORDER""TODO_TRANSFER_CONFIRM""TODO_INVOICE_CONFIRM""TODO_WITHDRAW_CONFIRM""RECHARGE_SUCCESS""WITHDRAW_SUCCESS""ORDER_PAY_SUCCESS""ORDER_PAY_PENDING""ORDER_PAY_TIMEOUT""ORDER_TO_EXPIRE""ORDER_CHANGE_SUCCESS""WORKORDER_REPLY_REMINDER""TESTING_EXEC_STARTED""TESTING_EXEC_FINISHED""TESTING_EXEC_FAILED""TESTING_TASK_OVERDUE""INDICATOR_MODIFY_SUBMIT""INDICATOR_AUDIT_PASSED""INDICATOR_AUDIT_FAILED""EVENT_NOTICE"outId
类型string
emailType
类型string
有效值
"TEMPLATE""CUSTOM"html
类型boolean
verificationCode
类型boolean
batch
类型boolean
sendTenantId
类型integer
格式
"int64"sendUserId
类型integer
格式
"int64"urgent
类型boolean
sendStatus
类型string
有效值
"PENDING""SUCCESS""FAILURE"expectedSendDate
类型string
格式
"date-time"actualSendDate
类型string
格式
"date-time"pageNo
Page data size, default 1, maximum 100000
类型integer
格式
"int32"最大值
100000最小值
1pageSize
Page data size, default 10, maximum 2000
类型integer
格式
"int32"最大值
2000最小值
1orderBy
Sort field
类型string
orderSort
Sorting method
类型string
有效值
"ASC""DESC"filters[0].key
Filter field name
类型string
filters[0].op
Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)
类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"filters[0].value
Filter value
filters[1].key
Filter field name
类型string
filters[1].op
Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)
类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"filters[1].value
Filter value
filters[2].key
Filter field name
类型string
filters[2].op
Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)
类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"filters[2].value
Filter value
infoScope
Query information scope
类型string
有效值
"BASIC""DETAIL"响应
OK
*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}
Send email
POST
/api/v1/email
授权
UserHttpBearer
Use existing opaque tokens for authentication
类型HTTP (bearer)
请求体
application/json
JSON
{
"outId": "string",
"bizKey": "SIGNUP",
"language": "zh_CN",
"type": "CUSTOM",
"subject": "subject",
"fromAddress": "cloud@xcan.cloud",
"toAddress": [
[
"user1@xcancloud.com",
"user2@xcancloud.com"
]
],
"ccAddress": [
[
"demo@xcancloud.com"
]
],
"verificationCode": true,
"verificationCodeValidSecond": "300",
"sendTenantId": 0,
"sendUserId": 0,
"html": true,
"content": "string",
"templateParams": {
"additionalProperties": {
}
},
"attachments": [
{
"name": "string",
"url": "string"
}
],
"expectedSendDate": "string",
"urgent": "false",
"receiveObjectType": "string",
"receiveObjectIds": [
0
],
"receivePolicyCodes": [
"string"
],
"batch": "true"
}
响应
OK
*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}
Delete emails
Send the test email to server
POST
/api/v1/email/server/test
授权
UserHttpBearer
Use existing opaque tokens for authentication
类型HTTP (bearer)
请求体
application/json
JSON
{
"serverId": 0,
"toAddress": [
[
"james@xcan.cloud"
]
],
"sendTenantId": 0,
"sendUserId": 0
}
响应
OK
*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}
Query the detail of email
Check the email verification code is valid
GET
/api/v1/email/verificationCode/check
授权
UserHttpBearer
Use existing opaque tokens for authentication
类型HTTP (bearer)
参数
查询参数
bizKey*
Email business key.
类型string
必填有效值
"EVENT_NOTICE""SIGNUP""SIGNIN""PASSWORD_FORGET""PASSWORD_UPDATE""SIGN_CANCEL""MODIFY_EMAIL""BIND_EMAIL""PAY_PASSWORD_UPDATE""REALNAME_AUTH_SUBMIT""REALNAME_AUTH_PASSED""REALNAME_AUDIT_FAILURE""SYS_EXCEPTION_NOTICE""SYS_RECOVERY_NOTICE""SYS_SECURITY_NOTICE""LICENSE_SENT""CHANNEL_TEST""TODO_REALNAME_AUTH""TODO_BUSINESS_CONSULTATION""TODO_OFFLINE_SERVICE""TODO_WORKORDER""TODO_TRANSFER_CONFIRM""TODO_INVOICE_CONFIRM""TODO_WITHDRAW_CONFIRM""RECHARGE_SUCCESS""WITHDRAW_SUCCESS""ORDER_PAY_SUCCESS""ORDER_PAY_PENDING""ORDER_PAY_TIMEOUT""ORDER_TO_EXPIRE""ORDER_CHANGE_SUCCESS""WORKORDER_REPLY_REMINDER""INVOICE_APPLY_SUCCESS""COUPON_DISTRIBUTION""COUPON_TO_EXPIRE""BLOG_SUBSCRIPTION_NOTICE""TESTING_EXEC_STARTED""TESTING_EXEC_FINISHED""TESTING_EXEC_FAILED""TESTING_TASK_OVERDUE""INDICATOR_MODIFY_SUBMIT""INDICATOR_AUDIT_PASSED""INDICATOR_AUDIT_FAILED"示例
"SIGNUP"email*
Verification email address.
类型string
必填最小长度
1verificationCode*
类型string
必填示例
"Email verification code."最大长度
160最小长度
1响应
OK
*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}