Type list

Retrieves a paginated list of available message types with their configuration and permission status. This endpoint helps understand what types of messages can be sent and which are enabled for the cu

Endpoint

GET/v2/messages/types

Link

Gateway APIstagep.tst-apidmndelss.com

Request

Query Parameters

Parameter	Type	Description	Required	Example
meta.page	integer	Page number (starts from 0).	No	0
meta.pageSize	integer	Number of items per page.	No	20

Headers

Key	Value	Required
Authorization	Bearer <JWT>	Yes
Accept	application/json	Yes

---

Response (200 OK)

Returns a paginated list of message types with their configuration.

Response Fields

1. Meta Object

Field	Type	Description	Example
pageSize	integer	Items per page.	20
page	integer	Current page number.	0
total	string	Total message types available.	"5"

2. Message Type Object (items[])

Field	Type	Description	Example
id	integer	Unique type identifier.	1
name	string	Type name (descriptive).	"Email"
isAllowed	boolean	Permission status for current partner. true = enabled.	true

Example Response:

json

{
  "items": [
    {
      "id": 1,
      "name": "Email",
      "isAllowed": true
    },
    {
      "id": 2,
      "name": "SMS",
      "isAllowed": true
    },
    {
      "id": 3,
      "name": "Push Notification",
      "isAllowed": false
    },
    {
      "id": 4,
      "name": "In-App Notification",
      "isAllowed": true
    },
    {
      "id": 5,
      "name": "Webhook",
      "isAllowed": true
    }
  ],
  "meta": {
    "pageSize": 20,
    "page": 0,
    "total": "5"
  }
}

---

Examples

Request

bash

curl -X GET 'https://stagep.tst-apidmndelss.com/v2/messages/types?meta.page=0&meta.pageSize=10' \
  -H 'Authorization: Bearer eyJhbGci...wNLGA' \
  -H 'Accept: application/json'

Request with Pagination

bash

curl -X GET 'https://stagep.tst-apidmndelss.com/v2/messages/types?meta.page=1&meta.pageSize=5' \
  -H 'Authorization: Bearer eyJhbGci...wNLGA' \
  -H 'Accept: application/json'

---

Common Message Types

• 1 - Email: Standard email notifications
• 2 - SMS: Text message notifications
• 3 - Push Notification: Mobile app push messages
• 4 - In-App Notification: Platform internal notifications
• 5 - Webhook: External system notifications

---

Error Responses

1. Unauthorized:

   json

   { "error": "Unauthorized" }

2. Invalid Page:

   json

   { "error": "Page number must be non-negative" }

---

Notes

• Permission-Based: isAllowed indicates whether the current partner can use this message type.
• Configuration: Message types may have additional configuration requirements (e.g., SMTP for email, SMS gateway for SMS).
• Pagination: Default pageSize is typically 20-50 items.
• Real-time: The list reflects current system configuration and partner permissions.

Usage Examples:

• Display available message channels in UI dropdowns
• Conditionally show/hide features based on isAllowed
• Validate template creation requests

Real request sample

Authorization:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYxMTQwNjI0LCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.ZxxQJJMwaktAsYDtSLIEMho6F2myXfcWFXSiJmQLeM8

Real response sample:

{
  "items": [
    {
      "id": 1,
      "name": "modal_window",
      "isAllowed": true
    },
    {
      "id": 2,
      "name": "web_push",
      "isAllowed": true
    },
    {
      "id": 3,
      "name": "email",
      "isAllowed": true
    },
    {
      "id": 8,
      "name": "telegram",
      "isAllowed": true
    }
  ],
  "meta": {
    "pageSize": 0,
    "page": 0,
    "total": "4"
  }
}