API V3 Documentation – MSG
Diese Dokumentation gibt es nur auf Englisch.
Vorschau: Diese Dokumentation beschreibt PQFORCE 4.26.6, das noch nicht veröffentlicht ist.
Endpoints
GET /API/V3/MSG/CurrentUser/Message/:messageId
Returns a message from the inbox of the current user's resource
HTTP syntax
GET /API/V3/MSG/CurrentUser/Message/:messageId
<- application/json : Message
JavaScript syntax
Pqf.msg.getCurrentUserMessage(messageId) // returns Message
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
messageId |
UUID | The message's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: Message
DELETE /API/V3/MSG/CurrentUser/Message/:messageId
Deletes a message from the inbox of the current user's resource. The message remains available to its other recipients
HTTP syntax
DELETE /API/V3/MSG/CurrentUser/Message/:messageId
JavaScript syntax
Pqf.msg.delCurrentUserMessage(messageId) // returns Number - the return code (HTTP 2xx code) of the call
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
messageId |
UUID | The message's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
POST /API/V3/MSG/CurrentUser/Message/:messageId/Read
Marks a message in the inbox of the current user's resource as read
HTTP syntax
POST /API/V3/MSG/CurrentUser/Message/:messageId/Read
JavaScript syntax
Pqf.msg.readCurrentUserMessage(messageId) // returns Number - the return code (HTTP 2xx code) of the call
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
messageId |
UUID | The message's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
POST /API/V3/MSG/CurrentUser/Message/Post
Sends a message from the current user's resource to other resources. A user without a resource sends as administrator and needs the admin permission
HTTP syntax
POST /API/V3/MSG/CurrentUser/Message/Post
-> application/json : IndividualMessageContent
<- application/json : PF.Reference
JavaScript syntax
Pqf.msg.postCurrentUserMessage(requestJson) // returns PF.Reference
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
requestJson |
IndividualMessageContent | JSON object of type IndividualMessageContent | ✔️ |
Result
This endpoint returns the following data: PF.Reference
PUT /API/V3/MSG/CurrentUser/MessageForwardRule/:ruleId
Creates or updates a message forwarding rule of the current user's resource. A deleted rule is restored
HTTP syntax
PUT /API/V3/MSG/CurrentUser/MessageForwardRule/:ruleId
-> application/json : MessageForwardRule
JavaScript syntax
Pqf.msg.putCurrentUserMessageForwardRule(ruleId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
ruleId |
UUID | The forward rule's ID | ✔️ | matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.) |
requestJson |
MessageForwardRule | JSON object of type MessageForwardRule | ✔️ |
GET /API/V3/MSG/CurrentUser/MessageForwardRules
Returns references to all message forwarding rules of the current user's resource, by default in the order they are applied (lowest sort index first)
HTTP syntax
GET /API/V3/MSG/CurrentUser/MessageForwardRules?sort=...
<- application/json
JavaScript syntax
Pqf.msg.getAllCurrentUserMessageForwardRules(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.msg.getAllCurrentUserMessageForwardRules() // returns PF.Reference[]
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, sortIndex | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/MSG/CurrentUser/MessageForwardRules/:ruleIds
Returns message forwarding rules of the current user's resource by IDs
HTTP syntax
GET /API/V3/MSG/CurrentUser/MessageForwardRules/:ruleIds
<- application/json
JavaScript syntax
Pqf.msg.getCurrentUserMessageForwardRules(ruleIds) // returns MessageForwardRule[]
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
ruleIds |
array of UUID | The forward rules' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of MessageForwardRule
DELETE /API/V3/MSG/CurrentUser/MessageForwardRules/:ruleIds
Deletes message forwarding rules of the current user's resource. Rules that do not exist or were already deleted are reported per element
HTTP syntax
DELETE /API/V3/MSG/CurrentUser/MessageForwardRules/:ruleIds
JavaScript syntax
Pqf.msg.delCurrentUserMessageForwardRules(ruleIds) // returns Number - the return code (HTTP 2xx code) of the call
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
ruleIds |
array of UUID | The forward rules' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/MSG/CurrentUser/Messages
Returns references to the messages in the inbox of the current user's resource that are valid today, by default the most recent first
HTTP syntax
GET /API/V3/MSG/CurrentUser/Messages?includeRead=...&sort=...
<- application/json
JavaScript syntax
Pqf.msg.getAllCurrentUserMessages(includeRead, sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.msg.getAllCurrentUserMessages(includeRead) // returns PF.Reference[]
Pqf.msg.getAllCurrentUserMessages() // returns PF.Reference[]
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
includeRead |
boolean | Include also messages that have been read | false |
||
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, subject, urgency, privacy, trigger, validityStart, validityUntil, createdAt, readAt | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/MSG/CurrentUser/Messages/:messageIds
Returns messages from the inbox of the current user's resource by IDs
HTTP syntax
GET /API/V3/MSG/CurrentUser/Messages/:messageIds
<- application/json
JavaScript syntax
Pqf.msg.getCurrentUserMessages(messageIds) // returns Message[]
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
messageIds |
array of UUID | The messages' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of Message
POST /API/V3/MSG/Email/:templateId/Send
Sends an email based on a template to some recipients, returns ID of sent message
JavaScript syntax
Pqf.msg.sendMailByTemplate(templateId, tos, ccs, bccs, subject, lang, wait, requestJson) // returns String
// Overloads for optional parameters
Pqf.msg.sendMailByTemplate(templateId, tos, ccs, bccs, subject, lang, requestJson) // returns String
Pqf.msg.sendMailByTemplate(templateId, tos, ccs, bccs, subject, requestJson) // returns String
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
templateId |
string | the template ID (ID of the attachment) | ✔️ | matches '[0-9A-Z]{52} (The value must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).) |
|
tos |
array of string | The list of recipients | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an e-mail address.) |
||
ccs |
array of string | The list of CC recipients | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an e-mail address.) |
||
bccs |
array of string | The list of BCC recipients | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an e-mail address.) |
||
subject |
string | The subject | ✔️ | ||
lang |
string | The template's language, defaults to calling user's language | matches '[a-zA-Z]{2}(?:-[a-zA-Z]+)*' (The value, if present, must be a language tag such as "de" or "en-GB".) |
||
wait |
boolean | True if script should wait until sent (method returns null in case of false) | true |
||
requestJson |
JSON | Raw content of mime type application/json | ✔️ |
Result
This endpoint returns the following data: string
POST /API/V3/MSG/Email/Send
Sends an email to some recipients, returns ID of sent message
JavaScript syntax
Pqf.msg.sendMail(tos, ccs, bccs, subject, body, html, wait) // returns String
// Overloads for optional parameters
Pqf.msg.sendMail(tos, ccs, bccs, subject, body, html) // returns String
Pqf.msg.sendMail(tos, ccs, bccs, subject, body) // returns String
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
tos |
array of string | The list of recipients | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an e-mail address.) |
||
ccs |
array of string | The list of CC recipients | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an e-mail address.) |
||
bccs |
array of string | The list of BCC recipients | null;non-null & matches '[ (The array is optional. Each element must not be null and must be an e-mail address.) |
||
subject |
string | The subject | ✔️ | ||
body |
string | The text (html or plain) | ✔️ | ||
html |
boolean | True for HTML-Body, false for text body | false |
||
wait |
boolean | True if script should wait until sent (method returns null in case of false) | true |
Result
This endpoint returns the following data: string
GET /API/V3/MSG/MessageTriggers
Returns all message triggers that are known for the current tenant
HTTP syntax
GET /API/V3/MSG/MessageTriggers?sort=...
<- application/json
JavaScript syntax
Pqf.msg.getAllMessageTriggers(sort) // returns PF.NamedReference[]
// Overloads for optional parameters
Pqf.msg.getAllMessageTriggers() // returns PF.NamedReference[]
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.NamedReference
PUT /API/V3/MSG/Resource/:resourceId/MessageForwardRule/:ruleId
Creates or updates a message forwarding rule of a given resource. A deleted rule is restored
HTTP syntax
PUT /API/V3/MSG/Resource/:resourceId/MessageForwardRule/:ruleId
-> application/json : MessageForwardRule
JavaScript syntax
Pqf.msg.putResourceMessageForwardRule(resourceId, ruleId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
ruleId |
UUID | The forward rule's ID | ✔️ | matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.) |
requestJson |
MessageForwardRule | JSON object of type MessageForwardRule | ✔️ |
GET /API/V3/MSG/Resource/:resourceId/MessageForwardRules
Returns references to all message forwarding rules of a given resource, by default in the order they are applied (lowest sort index first)
HTTP syntax
GET /API/V3/MSG/Resource/:resourceId/MessageForwardRules?sort=...
<- application/json
JavaScript syntax
Pqf.msg.getAllResourceMessageForwardRules(resourceId, sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.msg.getAllResourceMessageForwardRules(resourceId) // returns PF.Reference[]
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, sortIndex | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/MSG/Resource/:resourceId/MessageForwardRules/:ruleIds
Returns message forwarding rules of a given resource by IDs
HTTP syntax
GET /API/V3/MSG/Resource/:resourceId/MessageForwardRules/:ruleIds
<- application/json
JavaScript syntax
Pqf.msg.getResourceMessageForwardRules(resourceId, ruleIds) // returns MessageForwardRule[]
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
ruleIds |
array of UUID | The forward rules' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of MessageForwardRule
DELETE /API/V3/MSG/Resource/:resourceId/MessageForwardRules/:ruleIds
Deletes message forwarding rules of a given resource. Rules that do not exist or were already deleted are reported per element
HTTP syntax
DELETE /API/V3/MSG/Resource/:resourceId/MessageForwardRules/:ruleIds
JavaScript syntax
Pqf.msg.delResourceMessageForwardRules(resourceId, ruleIds) // returns Number - the return code (HTTP 2xx code) of the call
Required permission
Requires permission 105D1AD65BC5405AA93607A0A20D3703.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
resourceId |
UUID | The resource's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
ruleIds |
array of UUID | The forward rules' IDs | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Data types
MSG.IndividualMessageContent
This is a structure data contract.
Describes the content of a message that should be sent to individual persons
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
subject |
string | ✔️ | The subject of the message | |
body |
string | ✔️ | The body (content) of a message | |
urgency |
MessageUrgency | ✔️ | Describes a level how urgent this message is | |
privacy |
MessagePrivacy | ✔️ | Describes a privacy level | |
validityStart |
date | ✔️ | the start of validity (may be null) | |
validityUntil |
date | ✔️ | the end of validity (may be null) | |
addresseeIds |
array of UUID | The persons (resources) that should receive the message | non-null & pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array is required and must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
MSG.MaintenanceMessageContent
This is a structure data contract.
Describes the content of a maintenance message that should be sent to all active users of one or all tenants
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
subject |
string | ✔️ | The subject of the message | |
body |
string | ✔️ | The body (content) of a message | |
urgency |
MessageUrgency | ✔️ | Describes a level how urgent this message is | |
privacy |
MessagePrivacy | ✔️ | Describes a privacy level | |
validityStart |
date | ✔️ | the start of validity (may be null) | |
validityUntil |
date | ✔️ | the end of validity (may be null) | |
addresseeIds |
array of UUID | Ignored, maintenance messages go to all active users of the tenant(s); may be null | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
MSG.Message
This is a structure data contract.
Describes a message in the inbox of a resource
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subject |
string | The subject of the message | ||
body |
string | The body (content) of a message | ||
source |
PF.Reference | The source of the message. This may be a sender (resource), a user or any other object | ||
addresseesShown |
array of PF.Reference | The addressees as given by the sender (there may be more recipients, e.g. the members of an addressed group) | ||
trigger |
PF.Reference | The trigger that created this message | ||
triggerReason |
string | The reason why the trigger created this message, in the user's language | ||
urgency |
MessageUrgency | Describes a level how urgent this message is | ||
privacy |
MessagePrivacy | Describes a privacy level | ||
validityStart |
date | The first day the message is valid (may be null) | ||
validityUntil |
date | The first day the message is no longer valid (may be null) | ||
createdAt |
datetime | The point in time when the message was created | ||
createdBy |
PF.Reference | The user that created the message | ||
readAt |
datetime | The point in time when the message was read, null if it is unread | ||
forwardedAt |
datetime | The point in time when the message was forwarded by email, null if it was not forwarded |
MSG.MessageContent
This is a structure data contract.
Describes the common content of a message that should be sent
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
subject |
string | The subject of the message | ||
body |
string | The body (content) of a message | ||
urgency |
MessageUrgency | Describes a level how urgent this message is | ||
privacy |
MessagePrivacy | Describes a privacy level | ||
validityStart |
date | the start of validity (may be null) | ||
validityUntil |
date | the end of validity (may be null) |
MSG.MessageForwardRule
This is a structure data contract.
Describes a message forwarding rule. A received message is forwarded by email if all given patterns match it fully; the first matching rule (lowest sort index) applies
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
subjectRegEx |
string | The regular expression to match the subject (null matches any) | matches '.{0,256}' (The value, if present, must be a single line of at most 256 characters.) |
|
bodyRegEx |
string | The regular expression to match the body (null matches any) | matches '.{0,256}' (The value, if present, must be a single line of at most 256 characters.) |
|
sourceTypeRegEx |
string | The regular expression to match the source's type (null matches any) | matches '.{0,256}' (The value, if present, must be a single line of at most 256 characters.) |
|
sourceIdRegEx |
string | The regular expression to match the source's ID (null matches any) | matches '.{0,256}' (The value, if present, must be a single line of at most 256 characters.) |
|
addresseesShownRegEx |
string | The regular expression that at least one shown addressee's ID must match (null matches any) | matches '.{0,256}' (The value, if present, must be a single line of at most 256 characters.) |
|
triggerRegEx |
string | The regular expression to match the trigger's ID (null matches any) | matches '.{0,256}' (The value, if present, must be a single line of at most 256 characters.) |
|
sortIndex |
double | The sort index of the rule (lowest first) |
MSG.MessagePrivacy
This is an enumeration data contract.
Describes a privacy level
Enum values
| ID | Description |
|---|---|
Public |
This information is publicly available |
Normal |
This information is for internal use only |
Private |
This information is confidential |
MSG.MessageUrgency
This is an enumeration data contract.
Describes a level how urgent a message is
Enum values
| ID | Description |
|---|---|
Normal |
Normal level |
Urgent |
Needs immediate action |
BreakingNews |
Needs to spread as fast as possible |
MAIN
API V3 Documentation
MTG