ℹ️ The Auron SMS Server is now Auron Omni. Learn more here.

How can we help?

AxMmServer.Constants


In C#, VB.Net, C++ and other compiled languages the namespace for most classes is AXMMCFGLib instead of AxMmServer. For interpreted languages like VBScript, JavaScript or Powershell it is AxMmServer.

Status definitions

Constant Value Description
MESSAGESTATUS_CREATING CREATING This message is being created. The message will not be processed.
MESSAGESTATUS_SCHEDULED SCHEDULED This message is scheduled to be routed (sent) at or after the scheduled time.
MESSAGESTATUS_QUEUED QUEUED This message is routed and ready to be sent by the designated channel.
MESSAGESTATUS_SENDING SENDING A channel is currently sending this message.
MESSAGESTATUS_SENT SENT The message is sent.
MESSAGESTATUS_FAILED FAILED The message failed. Check the message details and trace to find more information.
MESSAGESTATUS_BLOCKED BLOCKED The message was blocked by one of the blocking rules.
MESSAGESTATUS_NOCHANNEL NOCHANNEL No channel is configured to send this message.
MESSAGESTATUS_DAILYLIMIT DAILYLIMIT This message was not sent because the daily limit was reached.
MESSAGESTATUS_RECEIVING RECEIVING A channel is currently receiving this message.
MESSAGESTATUS_RECEIVED RECEIVED This message was received.
MESSAGESTATUS_DELIVERED DELIVERED This message was delivered. This can be used by SMS messages after delivery is confirmed.
MESSAGESTATUS_NOTDELIVERED NOTDELIVERED This message was not delivered. This can be used by SMS messages if the message could not be delivered.
MESSAGESTATUS_NOREPORT NOREPORT Delivery report timed out. This can be used by SMS messages if no delivery report was received.

The message status indicates the channel status of a message. The constants below can be used with the Message.StatusID property. They can also be used in any of the MessageDB methods that require a filter.

Trigger status definitions

Constant Value Description
MESSAGETRGSTATUS_NA NA Ready to be processed.
MESSAGETRGSTATUS_PENDING PENDING Queued to be processed.
MESSAGETRGSTATUS_PROCESSING PROCESSING Currently being processed.
MESSAGETRGSTATUS_PROCESSED PROCESSED Successfully processed.
MESSAGETRGSTATUS_FAILED FAILED Error while processing this message. Check the message details and trace to find more information.
MESSAGETRGSTATUS_NOTRIGGERS NOTRIGGERS No triggers defined.
MESSAGETRGSTATUS_NOMATCH NOMATCH No trigger condition matched.

The Message.TriggerStatusID property specifies the state of trigger processing for this message.

Ack status definitions

Constant Value Description
MESSAGEACKSTATUS_NA NA Ack status is not applicable or no information is available yet.
MESSAGEACKSTATUS_ACK ACK The message was acknowledged.
MESSAGEACKSTATUS_NACK NACK The message was negatively acknowledged.
MESSAGEACKSTATUS_WAITING WAITING The message is waiting for acknowledgement.

The Message.AckStatusID property specifies the acknowledge status. When a message should be acknowledged or negatively acknowledged, one of these constants is used. This property is only used on channels and situations where it makes sense. If the property is not used, it will stay empty (N/A).

Direction definitions

Constant Value Description
MESSAGEDIRECTION_IN IN Incoming message.
MESSAGEDIRECTION_OUT OUT Outgoing message.

A message direction indicates the direction of a message. The constants below can be used with the Message.DirectionID property. They can also be used in any of the MessageDB methods that require a filter.

Message flag definitions

Constant Value Description
FLAG_SAVE_AS_COPY 1 Save this message with a new ID.
FLAG_SAVE_CREATE 8 Try to create a new record (not for messages).
FLAG_SAVE_MODIFY 16 Try to update an existing record (not for messages).
FLAG_FINDFIRST_READ_UNCOMMITTED 2 Read uncommitted data. Uses the NOLOCK option when selecting.
FLAG_FINDFIRST_IGNORE_ATTACHMENTS 4 Do not read message attachments from the database.
FLAG_FINDFIRST_GENERICMESSAGE 64 Return all message objects as generic message objects.
FLAG_LOAD_IGNORE_ATTACHMENTS 4 Do not read message attachments from the database.
FLAG_LOAD_READ_UNCOMMITTED 2 Read uncommitted data. Uses the NOLOCK option when selecting.
FLAG_LOAD_GENERICMESSAGE 64 Return all message objects as generic message objects.
FLAG_LOAD_FROM_ARCHIVE 256 Load the message from the archive database instead of the server database.
FLAG_CREATE_GENERICMESSAGE 64 Create the message objects as a generic message object.
FLAG_RESET_ARCHIVEDATABASE 128 Reset the archive database connection.

These flags can be used when creating, loading or saving any database objects including messages. Multiple flags can be combined by OR-ing them or adding them together.

Body format definitions

Constant Value Description
MESSAGEBODYFORMAT_SMS_TEXT 0 Plain text (only for SMS messages, i.e. messages that have Message.Type set to MESSAGETYPE_SMS).
MESSAGEBODYFORMAT_SMS_DATA 2 Data (only for SMS messages).
MESSAGEBODYFORMAT_SMS_WAPPUSH 6 WAP Push (only for SMS messages).

A BodyFormat indicates the format of the body of the SMS or e-mail message. You can assign the following Body Format constants to the Message.BodyFormatID property.

Batch status definitions

Constant Value Description
BATCHSTATUS_SUCCESS SUCCESS Completed successfully.
BATCHSTATUS_CANCELLED CANCELLED Cancelled by the user.
BATCHSTATUS_FAILED FAILED Failed to generate all messages.
BATCHSTATUS_OPEN OPEN Incomplete. Possibly still generating messages.

This is the status identifier of a campaign batch. These constants are used by the StopBatch method.