POST example/api/smsstatistics/GetUndeliveredByUndeliveryId
https://app.bwz.se/bedrock/example/api/smsstatistics/GetUndeliveredByUndeliveryId
Gets openings.
Request Information
URI Parameters
None.
Body Parameters
Max number of undelivered to get
GetUndeliveredByIdArgsName | Description | Type | Additional information |
---|---|---|---|
FromUndeliveryId |
Id of the first undelivered to be returned |
integer |
Required |
BatchSize |
Max number of undelivered to get |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "FromUndeliveryId": 1, "BatchSize": 2 }
application/xml, text/xml
Sample:
<GetUndeliveredByIdArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsStatistics"> <BatchSize>2</BatchSize> <FromUndeliveryId>1</FromUndeliveryId> </GetUndeliveredByIdArgs>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
An array of SmsMessageOpeningModels.
Collection of SmsMessageUndeliveredModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Gets or sets the id. |
integer |
None. |
SmsRecipientModel |
Gets or sets the SmsRecipientModel that opened. |
SmsRecipientModel |
None. |
SmsMessageQueueId |
Gets or sets the id of the SmsMessageQueue. |
integer |
None. |
CreatedDate |
Gets or sets the creation date and time. |
date |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": 1, "SmsRecipientModel": { "CreatedByUserId": 1, "CreationDate": "2024-12-23T06:44:14.4937802+01:00", "MobileNumber": "sample string 3", "Id": 4, "RecipientEntrySource": "sample string 5", "Properties": [ { "Name": "sample string 1", "Value": {} }, { "Name": "sample string 1", "Value": {} } ] }, "SmsMessageQueueId": 2, "CreatedDate": "2024-12-23T06:44:14.4937802+01:00" }, { "Id": 1, "SmsRecipientModel": { "CreatedByUserId": 1, "CreationDate": "2024-12-23T06:44:14.4937802+01:00", "MobileNumber": "sample string 3", "Id": 4, "RecipientEntrySource": "sample string 5", "Properties": [ { "Name": "sample string 1", "Value": {} }, { "Name": "sample string 1", "Value": {} } ] }, "SmsMessageQueueId": 2, "CreatedDate": "2024-12-23T06:44:14.4937802+01:00" } ]
application/xml, text/xml
Sample:
<ArrayOfSmsMessageUndeliveredModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsStatistics"> <SmsMessageUndeliveredModel> <CreatedDate>2024-12-23T06:44:14.4937802+01:00</CreatedDate> <Id>1</Id> <SmsMessageQueueId>2</SmsMessageQueueId> <SmsRecipientModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsRecipient"> <d3p1:CreatedByUserId>1</d3p1:CreatedByUserId> <d3p1:CreationDate>2024-12-23T06:44:14.4937802+01:00</d3p1:CreationDate> <d3p1:Id>4</d3p1:Id> <d3p1:MobileNumber>sample string 3</d3p1:MobileNumber> <d3p1:Properties xmlns:d4p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailRecipient"> <d4p1:PropertyValueModel> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Value /> </d4p1:PropertyValueModel> <d4p1:PropertyValueModel> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Value /> </d4p1:PropertyValueModel> </d3p1:Properties> <d3p1:RecipientEntrySource>sample string 5</d3p1:RecipientEntrySource> </SmsRecipientModel> </SmsMessageUndeliveredModel> <SmsMessageUndeliveredModel> <CreatedDate>2024-12-23T06:44:14.4937802+01:00</CreatedDate> <Id>1</Id> <SmsMessageQueueId>2</SmsMessageQueueId> <SmsRecipientModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsRecipient"> <d3p1:CreatedByUserId>1</d3p1:CreatedByUserId> <d3p1:CreationDate>2024-12-23T06:44:14.4937802+01:00</d3p1:CreationDate> <d3p1:Id>4</d3p1:Id> <d3p1:MobileNumber>sample string 3</d3p1:MobileNumber> <d3p1:Properties xmlns:d4p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailRecipient"> <d4p1:PropertyValueModel> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Value /> </d4p1:PropertyValueModel> <d4p1:PropertyValueModel> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Value /> </d4p1:PropertyValueModel> </d3p1:Properties> <d3p1:RecipientEntrySource>sample string 5</d3p1:RecipientEntrySource> </SmsRecipientModel> </SmsMessageUndeliveredModel> </ArrayOfSmsMessageUndeliveredModel>