🔔 Notification Management

Push notifications, SMS, and messaging endpoints. 20 endpoints available.

🎯 Quick Stats

Total Endpoints: 20
Base URL: https://api.market.decenctype.com
Authentication: Bearer Token / API Key

📊 Methods

📝 POST: 8 endpoints
🔍 GET: 8 endpoints
✏️ PUT: 2 endpoints
🗑️ DELETE: 2 endpoints

🔐 Authentication

All endpoints in this section use the same authentication methods. Choose one:

🔑 Bearer Token (Recommended)

For user session authentication

Add to request headers:

Authorization: Bearer YOUR_TOKEN

🔧 API Key

For server-side authentication

Add to request headers:

X-API-KEY: YOUR_API_KEY

⚠️ Important: Do not use both authentication methods simultaneously in the same request.

🔗 Endpoints Overview

Method	Endpoint	Description
📝 `POST`	`/notification/sms/verification/send`	Send SMS to the provided mobile number
📝 `POST`	`/notification/sms/merchant/verification/send`	Send SMS to the provided mobile number for a specific merchant
📝 `POST`	`/notification`	Create notification
🔍 `GET`	`/notification`	Get user notifications
🔍 `GET`	`/notification/{notificationId}`	Get notification details
✏️ `PUT`	`/notification/{notificationId}`	Update notification
🗑️ `DELETE`	`/notification/{notificationId}`	Delete notification
📝 `POST`	`/notification/mark-read`	Mark notifications as read
📝 `POST`	`/notification/mark-all-read`	Mark all notifications as read
🔍 `GET`	`/notification/stats/overview`	Get notification statistics
🔍 `GET`	`/notification/unread/count`	Get unread notification count
📝 `POST`	`/notification/cleanup/expired`	Clean expired notifications
📝 `POST`	`/notification/categories`	Create notification category
🔍 `GET`	`/notification/categories`	Get notification categories
🔍 `GET`	`/notification/categories/active`	Get active categories
🔍 `GET`	`/notification/categories/{categoryId}`	Get category details
✏️ `PUT`	`/notification/categories/{categoryId}`	Update notification category
🗑️ `DELETE`	`/notification/categories/{categoryId}`	Delete notification category
🔍 `GET`	`/notification/categories/code/{code}`	Get category by code
📝 `POST`	`/notification/categories/initialize`	Initialize default categories

📖 Detailed Documentation

Send SMS to the provided mobile number

POST/notification/sms/verification/send

Full URL

https://api.market.decenctype.com/notification/sms/verification/send

📝 Request Body Parameters

Parameter	Type	Required	Description
`mobile`	`string`	✅	Mobile number to send the SMS to
`merchant`	`string`	❌	Merchant name, required if for specific merchant

Description: Send SMS to the provided mobile number

Operation ID: sendSms

Response Status:

✅ 201: SMS sent

📋 Response Examples

response.json

1{
2  "result": "example-result",
3  "desc": "example-desc",
4  "msgid": "example-id",
5  "custid": "example-id"
6}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/notification/sms/verification/send" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "mobile": "example-mobile"
}'

Send SMS to the provided mobile number for a specific merchant

POST/notification/sms/merchant/verification/send

Full URL

https://api.market.decenctype.com/notification/sms/merchant/verification/send

📝 Request Body Parameters

Parameter	Type	Required	Description
`mobile`	`string`	✅	Mobile number to send the SMS to
`merchant`	`string`	❌	Merchant name, required if for specific merchant

Description: Send SMS to the provided mobile number for a specific merchant

Operation ID: sendMerchantSms

Response Status:

✅ 201: SMS sent

📋 Response Examples

response.json

1{
2  "result": "example-result",
3  "desc": "example-desc",
4  "msgid": "example-id",
5  "custid": "example-id"
6}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/notification/sms/merchant/verification/send" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "mobile": "example-mobile"
}'

Create notification

POST/notification

Full URL

https://api.market.decenctype.com/notification

📝 Request Body Parameters

Parameter	Type	Required	Description
`userId`	`string`	✅	用户ID
`categoryId`	`number`	❌	通知分类ID
`title`	`string`	✅	通知标题
`content`	`string`	✅	通知内容
`type`	`string (system, transaction, order, security, marketing, kyc, payment)`	✅	通知类型
`priority`	`string (low, medium, high, urgent)`	❌	通知优先级 (默认: medium)
`metadata`	`object`	❌	通知元数据
`channels`	`array`	❌	通知渠道
`expiresAt`	`string`	❌	过期时间

Description: Create notification

Operation ID: createNotification

Response Status:

✅ 201: 通知创建成功

Create a new notification message

📋 Response Examples

response.json

1{
2  "id": 1,
3  "userId": 1,
4  "categoryId": 1,
5  "category": "example-category",
6  "title": "交易成功通知",
7  "content": "您的交易已成功完成，交易金额为 $100",
8  "type": "transaction",
9  "priority": "medium",
10  "metadata": {
11    "transaction_id": 123,
12    "amount": 100
13  },
14  "channels": [
15    "push",
16    "email",
17    "sms"
18  ],
19  "isRead": false,
20  "readAt": "2024-01-15T10:30:00Z",
21  "isDeleted": false,
22  "deletedAt": "2024-01-15T10:30:00Z",
23  "expiresAt": "2024-12-31T23:59:59Z",
24  "createdAt": "2024-01-15T10:00:00Z",
25  "updatedAt": "2024-01-15T10:30:00Z"
26}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/notification" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "交易成功通知",
  "content": "您的交易已成功完成，交易金额为 $100",
  "type": "transaction"
}'

Get user notifications

GET/notification

Full URL

https://api.market.decenctype.com/notification

📋 Query Parameters

Parameter	Type	Required	Description
`sortField`	`string`	❌	排序字段
`sort`	`string`	❌	排序方式
`page`	`number`	❌	页码（从1开始）
`pageSize`	`number`	❌	每页条数
`type`	`string`	❌	通知类型 (示例: `transaction`)
`priority`	`string`	❌	通知优先级 (示例: `high`)
`isRead`	`boolean`	❌	是否已读
`isDeleted`	`boolean`	❌	是否已删除
`startDate`	`string`	❌	开始时间 (示例: `2024-01-01T00:00:00Z`)
`endDate`	`string`	❌	结束时间 (示例: `2024-12-31T23:59:59Z`)
`search`	`string`	❌	搜索关键词 (示例: `交易`)
`categoryId`	`number`	❌	分类ID (示例: `1`)
`categoryCode`	`string`	❌	分类代码 (示例: `system`)

Description: Get user notifications

Operation ID: getUserNotifications

Response Status:

✅ 200: 获取通知列表成功

Get notification list for current user with pagination and filtering support

📋 Response Examples

response.json

1{
2  "data": [
3    {
4      "id": 1,
5      "userId": 1,
6      "title": "交易成功通知",
7      "content": "您的交易已成功完成，交易金额为 $100",
8      "type": "transaction",
9      "priority": "medium",
10      "isRead": false,
11      "isDeleted": false,
12      "createdAt": "2024-01-15T10:00:00Z",
13      "updatedAt": "2024-01-15T10:30:00Z"
14    }
15  ],
16  "total": 100,
17  "page": 1,
18  "limit": 20,
19  "totalPages": 5,
20  "unreadCount": 15
21}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/notification" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get notification details

GET/notification/{notificationId}

Full URL

https://api.market.decenctype.com/notification/{notificationId}

🎯 Path Parameters

notificationId (number) - ✅ Required: 通知ID

Description: Get notification details

Operation ID: getNotificationById

Response Status:

✅ 200: 获取通知详情成功

Get detailed information by notification ID

📋 Response Examples

response.json

1{
2  "id": 1,
3  "userId": 1,
4  "categoryId": 1,
5  "category": "example-category",
6  "title": "交易成功通知",
7  "content": "您的交易已成功完成，交易金额为 $100",
8  "type": "transaction",
9  "priority": "medium",
10  "metadata": {
11    "transaction_id": 123,
12    "amount": 100
13  },
14  "channels": [
15    "push",
16    "email",
17    "sms"
18  ],
19  "isRead": false,
20  "readAt": "2024-01-15T10:30:00Z",
21  "isDeleted": false,
22  "deletedAt": "2024-01-15T10:30:00Z",
23  "expiresAt": "2024-12-31T23:59:59Z",
24  "createdAt": "2024-01-15T10:00:00Z",
25  "updatedAt": "2024-01-15T10:30:00Z"
26}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/notification/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Update notification

PUT/notification/{notificationId}

Full URL

https://api.market.decenctype.com/notification/{notificationId}

🎯 Path Parameters

notificationId (number) - ✅ Required: 通知ID

📝 Request Body Parameters

Parameter	Type	Required	Description
`userId`	`string`	❌	用户ID
`categoryId`	`number`	❌	通知分类ID
`title`	`string`	❌	通知标题
`content`	`string`	❌	通知内容
`type`	`string (system, transaction, order, security, marketing, kyc, payment)`	❌	通知类型
`priority`	`string (low, medium, high, urgent)`	❌	通知优先级 (默认: medium)
`metadata`	`object`	❌	通知元数据
`channels`	`array`	❌	通知渠道
`expiresAt`	`string`	❌	过期时间
`isRead`	`boolean`	❌	是否已读
`readAt`	`string`	❌	已读时间
`isDeleted`	`boolean`	❌	是否已删除
`deletedAt`	`string`	❌	删除时间

Description: Update notification

Operation ID: updateNotification

Response Status:

✅ 200: 更新通知成功

Update notification status or content

📋 Response Examples

response.json

1{
2  "id": 1,
3  "userId": 1,
4  "categoryId": 1,
5  "category": "example-category",
6  "title": "交易成功通知",
7  "content": "您的交易已成功完成，交易金额为 $100",
8  "type": "transaction",
9  "priority": "medium",
10  "metadata": {
11    "transaction_id": 123,
12    "amount": 100
13  },
14  "channels": [
15    "push",
16    "email",
17    "sms"
18  ],
19  "isRead": false,
20  "readAt": "2024-01-15T10:30:00Z",
21  "isDeleted": false,
22  "deletedAt": "2024-01-15T10:30:00Z",
23  "expiresAt": "2024-12-31T23:59:59Z",
24  "createdAt": "2024-01-15T10:00:00Z",
25  "updatedAt": "2024-01-15T10:30:00Z"
26}

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/notification/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{}'

Delete notification

DELETE/notification/{notificationId}

Full URL

https://api.market.decenctype.com/notification/{notificationId}

🎯 Path Parameters

notificationId (number) - ✅ Required: 通知ID

Description: Delete notification

Operation ID: deleteNotification

Response Status:

✅ 200: 删除通知成功

Soft delete the specified notification

📝 Example Request

curl -X DELETE "https://api.market.decenctype.com/notification/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Mark notifications as read

POST/notification/mark-read

Full URL

https://api.market.decenctype.com/notification/mark-read

📝 Request Body Parameters

Parameter	Type	Required	Description
`notificationIds`	`array`	✅	通知ID列表

Description: Mark notifications as read

Operation ID: markAsRead

Response Status:

✅ 200: 标记成功
✅ 201: Success

Batch mark specified notifications as read

📝 Example Request

curl -X POST "https://api.market.decenctype.com/notification/mark-read" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "notificationIds": [
    1,
    2,
    3
  ]
}'

Mark all notifications as read

POST/notification/mark-all-read

Full URL

https://api.market.decenctype.com/notification/mark-all-read

📝 Request Body Parameters

Parameter	Type	Required	Description
`type`	`string`	❌	通知类型
`onlyType`	`boolean`	❌	是否只标记特定类型的通知 (默认: false)

Description: Mark all notifications as read

Operation ID: markAllAsRead

Response Status:

✅ 200: 标记成功
✅ 201: Success

Mark all user notifications as read

📝 Example Request

curl -X POST "https://api.market.decenctype.com/notification/mark-all-read" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{}'

Get notification statistics

GET/notification/stats/overview

Full URL

https://api.market.decenctype.com/notification/stats/overview

🔐 Authentication: Required (see authentication section above)

Description: Get notification statistics

Operation ID: getNotificationStats

Response Status:

✅ 200: 获取统计成功

Get notification statistics for user

📋 Response Examples

response.json

1{
2  "total": 100,
3  "unread": 15,
4  "read": 85,
5  "byType": {
6    "system": 20,
7    "transaction": 30,
8    "order": 25,
9    "security": 15,
10    "marketing": 10
11  },
12  "byPriority": {
13    "low": 10,
14    "medium": 60,
15    "high": 25,
16    "urgent": 5
17  }
18}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/notification/stats/overview" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get unread notification count

GET/notification/unread/count

Full URL

https://api.market.decenctype.com/notification/unread/count

🔐 Authentication: Required (see authentication section above)

Description: Get unread notification count

Operation ID: getUnreadCount

Response Status:

✅ 200: 获取未读数量成功

Get total count of unread notifications for user

📝 Example Request

curl -X GET "https://api.market.decenctype.com/notification/unread/count" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Clean expired notifications

POST/notification/cleanup/expired

Full URL

https://api.market.decenctype.com/notification/cleanup/expired

🔐 Authentication: Required (see authentication section above)

Description: Clean expired notifications

Operation ID: cleanExpiredNotifications

Response Status:

✅ 200: 清理成功
✅ 201: Success

Clean all expired notifications (admin function)

📝 Example Request

curl -X POST "https://api.market.decenctype.com/notification/cleanup/expired" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Create notification category

POST/notification/categories

Full URL

https://api.market.decenctype.com/notification/categories

📝 Request Body Parameters

Parameter	Type	Required	Description
`code`	`string`	✅	分类代码
`name`	`string`	✅	分类名称
`description`	`string`	❌	分类描述
`icon`	`string`	❌	分类图标
`color`	`string`	❌	分类颜色
`status`	`string (active, inactive, deprecated)`	❌	分类状态 (默认: active)
`sortOrder`	`number`	❌	排序权重 (默认: 0) (最小: 0)
`config`	`object`	❌	分类配置
`allowSubscription`	`boolean`	❌	是否允许用户订阅 (默认: true)
`allowUnsubscribe`	`boolean`	❌	是否允许用户取消订阅 (默认: true)
`isSystem`	`boolean`	❌	是否系统默认分类 (默认: false)

Description: Create notification category

Operation ID: createCategory

Response Status:

✅ 201: 分类创建成功

Create a new notification category

📋 Response Examples

response.json

1{
2  "id": 1,
3  "code": "system",
4  "name": "系统通知",
5  "description": "系统相关的通知消息",
6  "icon": "bell",
7  "color": "#1890ff",
8  "status": "active",
9  "sortOrder": 0,
10  "config": {
11    "channels": [
12      "push",
13      "email"
14    ],
15    "defaultPriority": "medium",
16    "ttlDays": 30
17  },
18  "allowSubscription": true,
19  "allowUnsubscribe": true,
20  "isSystem": false,
21  "createdAt": "2024-01-15T10:00:00Z",
22  "updatedAt": "2024-01-15T10:30:00Z"
23}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/notification/categories" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "code": "system",
  "name": "系统通知"
}'

Get notification categories

GET/notification/categories

Full URL

https://api.market.decenctype.com/notification/categories

📋 Query Parameters

Parameter	Type	Required	Description
`page`	`number`	❌	页码 (示例: `1`)
`limit`	`number`	❌	每页数量 (示例: `20`)
`status`	`string`	❌	分类状态 (示例: `active`)
`isSystem`	`boolean`	❌	是否系统分类
`search`	`string`	❌	搜索关键词 (示例: `系统`)

Description: Get notification categories

Operation ID: getCategories

Response Status:

✅ 200: 获取分类列表成功

Get all notification categories with pagination and filtering support

📝 Example Request

curl -X GET "https://api.market.decenctype.com/notification/categories" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get active categories

GET/notification/categories/active

Full URL

https://api.market.decenctype.com/notification/categories/active

🔐 Authentication: Required (see authentication section above)

Description: Get active categories

Operation ID: getActiveCategories

Response Status:

✅ 200: 获取活跃分类成功

Get all active notification categories

📋 Response Examples

response.json

1[
2  {
3    "id": 1,
4    "code": "system",
5    "name": "系统通知",
6    "description": "系统相关的通知消息",
7    "icon": "bell",
8    "color": "#1890ff",
9    "status": "active",
10    "sortOrder": 0,
11    "config": {
12      "channels": [
13        "push",
14        "email"
15      ],
16      "defaultPriority": "medium",
17      "ttlDays": 30
18    },
19    "allowSubscription": true,
20    "allowUnsubscribe": true,
21    "isSystem": false,
22    "createdAt": "2024-01-15T10:00:00Z",
23    "updatedAt": "2024-01-15T10:30:00Z"
24  }
25]

📝 Example Request

curl -X GET "https://api.market.decenctype.com/notification/categories/active" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get category details

GET/notification/categories/{categoryId}

Full URL

https://api.market.decenctype.com/notification/categories/{categoryId}

🎯 Path Parameters

categoryId (number) - ✅ Required: 分类ID

Description: Get category details

Operation ID: getCategoryById

Response Status:

✅ 200: 获取分类详情成功

Get detailed information by category ID

📋 Response Examples

response.json

1{
2  "id": 1,
3  "code": "system",
4  "name": "系统通知",
5  "description": "系统相关的通知消息",
6  "icon": "bell",
7  "color": "#1890ff",
8  "status": "active",
9  "sortOrder": 0,
10  "config": {
11    "channels": [
12      "push",
13      "email"
14    ],
15    "defaultPriority": "medium",
16    "ttlDays": 30
17  },
18  "allowSubscription": true,
19  "allowUnsubscribe": true,
20  "isSystem": false,
21  "createdAt": "2024-01-15T10:00:00Z",
22  "updatedAt": "2024-01-15T10:30:00Z"
23}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/notification/categories/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Update notification category

PUT/notification/categories/{categoryId}

Full URL

https://api.market.decenctype.com/notification/categories/{categoryId}

🎯 Path Parameters

categoryId (number) - ✅ Required: 分类ID

📝 Request Body Parameters

Parameter	Type	Required	Description
`name`	`string`	❌	分类名称
`description`	`string`	❌	分类描述
`icon`	`string`	❌	分类图标
`color`	`string`	❌	分类颜色
`status`	`string (active, inactive, deprecated)`	❌	分类状态
`sortOrder`	`number`	❌	排序权重 (最小: 0)
`config`	`object`	❌	分类配置
`allowSubscription`	`boolean`	❌	是否允许用户订阅
`allowUnsubscribe`	`boolean`	❌	是否允许用户取消订阅

Description: Update notification category

Operation ID: updateCategory

Response Status:

✅ 200: 更新分类成功

Update information for specified category

📋 Response Examples

response.json

1{
2  "id": 1,
3  "code": "system",
4  "name": "系统通知",
5  "description": "系统相关的通知消息",
6  "icon": "bell",
7  "color": "#1890ff",
8  "status": "active",
9  "sortOrder": 0,
10  "config": {
11    "channels": [
12      "push",
13      "email"
14    ],
15    "defaultPriority": "medium",
16    "ttlDays": 30
17  },
18  "allowSubscription": true,
19  "allowUnsubscribe": true,
20  "isSystem": false,
21  "createdAt": "2024-01-15T10:00:00Z",
22  "updatedAt": "2024-01-15T10:30:00Z"
23}

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/notification/categories/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{}'

Delete notification category

DELETE/notification/categories/{categoryId}

Full URL

https://api.market.decenctype.com/notification/categories/{categoryId}

🎯 Path Parameters

categoryId (number) - ✅ Required: 分类ID

Description: Delete notification category

Operation ID: deleteCategory

Response Status:

✅ 200: 删除分类成功

Delete the specified notification category

📝 Example Request

curl -X DELETE "https://api.market.decenctype.com/notification/categories/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get category by code

GET/notification/categories/code/{code}

Full URL

https://api.market.decenctype.com/notification/categories/code/{code}

🎯 Path Parameters

code (string) - ✅ Required: 分类代码

Description: Get category by code

Operation ID: getCategoryByCode

Response Status:

✅ 200: 获取分类成功

Get category information by category code

📋 Response Examples

response.json

1{
2  "id": 1,
3  "code": "system",
4  "name": "系统通知",
5  "description": "系统相关的通知消息",
6  "icon": "bell",
7  "color": "#1890ff",
8  "status": "active",
9  "sortOrder": 0,
10  "config": {
11    "channels": [
12      "push",
13      "email"
14    ],
15    "defaultPriority": "medium",
16    "ttlDays": 30
17  },
18  "allowSubscription": true,
19  "allowUnsubscribe": true,
20  "isSystem": false,
21  "createdAt": "2024-01-15T10:00:00Z",
22  "updatedAt": "2024-01-15T10:30:00Z"
23}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/notification/categories/code/example-code" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Initialize default categories

POST/notification/categories/initialize

Full URL

https://api.market.decenctype.com/notification/categories/initialize

🔐 Authentication: Required (see authentication section above)

Description: Initialize default categories

Operation ID: initializeDefaultCategories

Response Status:

✅ 200: 初始化成功
✅ 201: Success

Initialize system default notification categories

📝 Example Request

curl -X POST "https://api.market.decenctype.com/notification/categories/initialize" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

🔔 Notification Management

🎯 Quick Stats

📊 Methods

🔑 Bearer Token (Recommended)

🔧 API Key

On this page