GET example/api/SmsMessageQueue?SmsMessageId={SmsMessageId}
https://app.bwz.se/bedrock/example/api/SmsMessageQueue?SmsMessageId={SmsMessageId}
Gets all SmsMessageQueueModels matching a given filter.
Request Information
URI Parameters
None.
Body Parameters
Gets or sets the SMS message identifier. The SMS message identifier.
SmsMessageQueueFilterOptionsName | Description | Type | Additional information |
---|---|---|---|
SmsMessageId |
Gets or sets the SMS message identifier. |
integer |
Required |
Response Information
Resource Description
An array of SmsMessageQueueModels.
Collection of SmsMessageQueuedModelName | Description | Type | Additional information |
---|---|---|---|
SmsMessageQueueId |
Id of the SMS message queue created when sending the SMS message. Use this id for retreiving statistics |
integer |
None. |
Id |
Id of the SmsMessage. |
integer |
None. |
Name |
Name of the SmsMessage. |
string |
None. |
CreatedByUserId |
Id of the User creating the SmsMessage. |
integer |
None. |
MessageStatus |
The MessageStatus of the SmsMessage. |
MessageStatus |
None. |
CreationDate |
Date and time when the SmsMessage was created. |
date |
None. |
ModifiedDate |
Date and time when the SmsMessage was last modified. |
date |
None. |
PublicationId |
Id the of Publication the SmsMessage belongs to. |
integer |
None. |
SenderName |
Sender name of the SmsMessage. |
string |
None. |
DefaultCountryCode |
Default country code of the SmsMessage. Will be used for all recipients without country code in their mobile number. |
integer |
None. |
SmsContentId |
Id of the Content holding the content of the SmsMessage. |
integer |
None. |
ScheduledSendDate |
Date and time when the SmsMessage will be sent. |
date |
None. |
Response Formats
application/json, text/json
[ { "SmsMessageQueueId": 1, "Id": 2, "Name": "sample string 3", "CreatedByUserId": 4, "MessageStatus": 0, "CreationDate": "2024-11-21T17:43:18.9314197+01:00", "ModifiedDate": "2024-11-21T17:43:18.9314197+01:00", "PublicationId": 7, "SenderName": "sample string 8", "DefaultCountryCode": 9, "SmsContentId": 1, "ScheduledSendDate": "2024-11-21T17:43:18.9314197+01:00" }, { "SmsMessageQueueId": 1, "Id": 2, "Name": "sample string 3", "CreatedByUserId": 4, "MessageStatus": 0, "CreationDate": "2024-11-21T17:43:18.9314197+01:00", "ModifiedDate": "2024-11-21T17:43:18.9314197+01:00", "PublicationId": 7, "SenderName": "sample string 8", "DefaultCountryCode": 9, "SmsContentId": 1, "ScheduledSendDate": "2024-11-21T17:43:18.9314197+01:00" } ]
application/xml, text/xml
<ArrayOfSmsMessageQueuedModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsMessage"> <SmsMessageQueuedModel> <CreatedByUserId>4</CreatedByUserId> <CreationDate>2024-11-21T17:43:18.9314197+01:00</CreationDate> <DefaultCountryCode>9</DefaultCountryCode> <Id>2</Id> <MessageStatus>NotReadyToSend</MessageStatus> <ModifiedDate>2024-11-21T17:43:18.9314197+01:00</ModifiedDate> <Name>sample string 3</Name> <PublicationId>7</PublicationId> <ScheduledSendDate>2024-11-21T17:43:18.9314197+01:00</ScheduledSendDate> <SenderName>sample string 8</SenderName> <SmsContentId>1</SmsContentId> <SmsMessageQueueId>1</SmsMessageQueueId> </SmsMessageQueuedModel> <SmsMessageQueuedModel> <CreatedByUserId>4</CreatedByUserId> <CreationDate>2024-11-21T17:43:18.9314197+01:00</CreationDate> <DefaultCountryCode>9</DefaultCountryCode> <Id>2</Id> <MessageStatus>NotReadyToSend</MessageStatus> <ModifiedDate>2024-11-21T17:43:18.9314197+01:00</ModifiedDate> <Name>sample string 3</Name> <PublicationId>7</PublicationId> <ScheduledSendDate>2024-11-21T17:43:18.9314197+01:00</ScheduledSendDate> <SenderName>sample string 8</SenderName> <SmsContentId>1</SmsContentId> <SmsMessageQueueId>1</SmsMessageQueueId> </SmsMessageQueuedModel> </ArrayOfSmsMessageQueuedModel>