Multi-platform communications
Accounts are required to send and receive Messages through Aggregators.
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for the Message that was sent/received[queryable][sortable] |
PhoenixIdentity_CompanyId | System.Int32 | The Company that this Account belongs to[queryable][sortable][required] |
AggregatorId | AggregatorEnum | The Aggregator that this Account belongs to[queryable][sortable] |
MessageTypeId | MessageTypeEnum | The type of Message - eg SMS, MMS, Email, Push Notification[queryable][sortable] |
Name | System.String | A human readable name for this Account[required] |
SystemName | System.String | The Aggregator-generated name for this Account[queryable][sortable][required] |
Originator | System.String | The address that the Message appears to come from (eg '199123' for an SMS) |
Username | System.String | Required when authenticating the Account to the Aggregator |
Password | System.String | Required when authenticating the Account to the Aggregator |
Token | System.String | Required when authenticating the Account to the Aggregator |
ProviderUrl | System.String | The Aggregator endpoint for message requests |
SupportsInbound | System.Boolean | Indicates whether this account supports inbound messages[queryable][sortable][required] |
SupportsOutbound | System.Boolean | Indicates whether this account supports outbound messages[queryable][sortable][required] |
IsProductionGateway | System.Boolean | Indicates whether this account routes messages through the Aggregators production gateway[queryable][sortable][required] |
Certificate | System.Byte | Binary version of the certificate required when authenticating the Account with the Aggregator |
IsActive | System.Boolean | Indicates whether this account is active or not[queryable][sortable][required] |
CreateDate | System.DateTime | UTC date of when this Object was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this Object last viewed[queryable][sortable] |
ProjectAccountMaps | ICollection | Navigation property to ProjectAccountMap [expandable] |
Broadcasts are scheduled bulk sends of Messages to Recipients. The Broadcast can carry either a custom message data through a single Account, or leverage Template Groups at peform a multi-platform Broadcast through multiple Accounts each with different message types (such as Push Notifications, Email and SMS).
Name | Type | Description |
---|---|---|
Id | System.Int32 | the identifier for the Broadcast[queryable][sortable] |
ProjectId | System.Int32 | the Project that this Broadcast belongs to[queryable][sortable][required] |
PhoenixIdentity_GroupId | System.Int32 | the CustomerGroup that this Broadcast should be sent to[queryable][sortable][required] |
ExcludeRecipientAddress | System.String | a comma delimited list of recipient addresses to exclude from the Broadcast |
TemplateGroupId | System.Int32 | the Identity group that this Template belongs too |
AccountId | System.Int32 | the Account that this Broadcast should be sent with[queryable][sortable] |
Subject | System.String | the Subject line or Title of the broadcast |
Payload | System.String | the message body/payload of the Broadcast |
SenderAddress | System.String | the address of the Sender (in the case of SMS, the mask) |
DeliverAfterDate | System.DateTime | the UTC datetime to deliver this broadcast[queryable][sortable][required] |
SendIndividualMessages | System.Boolean | Determines whether the Broadcast should be sent as a single Message or one Message per Recipient[required] |
IsProcessing | System.Boolean | whether this pending broadcast is currently being processed by the MessagingScheduler[queryable][sortable][required] |
StatusTypeId | BroadcastStatusTypeEnum | the Status of the Broadcast[queryable] |
SentDate | System.DateTime | the Actual date the Broadcast was sent |
CreateDate | System.DateTime | UTC date of when this Object was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this Object last viewed[queryable][sortable] |
StatusDescription | System.String | Unavailable |
Account | Account | Navigation property to Account [expandable] |
Project | Project | Navigation property to Project [expandable] |
Substitutes | Dictionary<string, string> | Serialised version of the Substitute property |
Name | Type | Description |
---|
Messages are sent and received to and from Users.
Name | Type | Description |
---|---|---|
Id | System.Int32 | the identifier for the Message[queryable][sortable] |
ProjectId | System.Int32 | the Project of which the Message belongs to[queryable][sortable][required] |
AccountId | System.Int32 | the Account of which the Message belongs to[queryable][sortable][required] |
MessageTypeId | MessageTypeEnum | the Type of Message this is[queryable][sortable] |
DirectionTypeId | DirectionTypeEnum | the Direction the Message was sent in[queryable][sortable] |
SenderAddress | System.String | the address of the sender - email, msisdn[queryable][sortable] |
StatusTypeId | StatusTypeEnum | the Status of the Message[queryable][sortable] |
StatusDesc | System.String | a verbose description of the status |
ProcessDate | System.DateTime | when the record was processed[queryable][sortable] |
Location | System.Data.Spatial.DbGeography | the geo-location of the message (if any) |
Payload | System.String | the body/payload of the message |
RecipientCount | System.Int32 | the total number of recipients this message was sent to[queryable][readonly][sortable][required] |
ExpectedRecipientCount | System.Int32 | expected number of Recipients to receive this message[queryable][sortable] |
Subject | System.String | Topic or theme of the message[queryable][sortable] |
CreateDate | System.DateTime | UTC date of when this Object was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this Object last viewed[queryable][sortable] |
Account | Account | Navigation property to Account [expandable] |
Project | Project | Navigation property to Project [expandable] |
Recipients | ICollection | Navigation property to Recipient [expandable] |
Refers to the core Project in PhoenixIdentity.
Name | Type | Description |
---|---|---|
PhoenixIdentity_ProjectId | System.Int32 | refers to the master ProjectId in the PhoenixSecurity database[queryable][sortable][required] |
CreateDate | System.DateTime | UTC date of when this Object was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this Object last viewed[queryable][sortable] |
A mapping table determining which projects have access to which Accounts.
Name | Type | Description |
---|---|---|
ProjectId | System.Int32 | the Project that this mapping relates to[queryable][sortable][required] |
AccountId | System.Int32 | the Account that this mapping relates to[queryable][sortable][required] |
CreateDate | System.DateTime | UTC date of when this Object was created[readonly] |
ModifyDate | System.DateTime | UTC date of when this Object last viewed |
Project | Project | Navigation property to Project [expandable] |
Each outbound Message can have multiple Recipients - for example in the case where a Broadcast is sent to a group of users.
Name | Type | Description |
---|---|---|
Id | System.Int32 | the identifier of the MessageRecipient[queryable][sortable] |
MessageId | System.Int32 | the Message that was sent to the recipient[queryable][sortable][required] |
RecipientAddress | System.String | the address of the recipient, as per the Message.MessageType[required] |
SendDate | System.DateTime | the UTC datetime the message was sent to the recipient[queryable][sortable] |
ReceiveDate | System.DateTime | the UTC datetime the message was read by the recipient[queryable][sortable] |
Location | System.Data.Spatial.DbGeography | The geographical Longitude and Latitude of the recipient |
StatusTypeId | StatusTypeEnum | the status of the recipient[queryable][sortable] |
StatusDesc | System.String | a verbose description of the status |
CreateDate | System.DateTime | UTC date of when this Object was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this Object last viewed[queryable][sortable] |
PhoenixIdentity_UserId | System.Int32 | the associated Phoenix Identity User to this Recipient |
Reference | System.String | The provider unique reference for the send[queryable][sortable] |
Templates are predefined Message properties from which future Messages can be derived from.
Name | Type | Description |
---|---|---|
Id | System.Int32 | the identifier for the Template[queryable][sortable] |
ProjectId | System.Int32 | the Project that this Template belongs to[queryable][sortable][required] |
AccountId | System.Int32 | the Account that this Template belongs to[queryable][sortable][required] |
Subject | System.String | the Subject of this Template[queryable][required] |
Payload | System.String | the MessageText of the Messages that will be derived from this Template[required] |
SenderAddress | System.String | the SenderAddress for Messages that will be derived from this Template |
Reference | System.String | an optional reference for consumers to retrieve this Template[queryable] |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
TemplateGroupId | System.Int32 | this Template can optionally belong to a TemplateGroup[queryable][sortable] |
PayloadUrl | System.String | the URL to retrieve the payload for the Template (i.e. a templated web page) |
Name | System.String | a short Name for this Template[queryable] |
Account | Account | Navigation property to Account [expandable] |
Project | Project | Navigation property to Project [expandable] |
TemplateGroup | TemplateGroup | Navigation property to TemplateGroup [expandable] |
TemplateGroups allow the logical grouping of Templates and are used within Broadcasts for a multi-platform sends.
Name | Type | Description |
---|---|---|
Id | System.Int32 | the identifier for the TemplateGroup[queryable][sortable][required] |
ProjectId | System.Int32 | the Project that this Template belongs to[queryable][sortable][required] |
Name | System.String | the Name given to this TemplateGroup[required] |
Reference | System.String | an optional reference for consumers to retrieve this TemplateGroup[queryable] |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
Project | Project | Navigation property to Project [expandable] |
Name | Type | Description |
---|
Name | Type | Description |
---|