GET api/campaigns/{id}/report?select={select}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required
select		integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

SmsCampaignReport

Name	Type	Additional information
Name	string	None.
Status	string	None.
TotalRecipients	integer	None.
TotalDelivered	integer	None.
TotalBounced	integer	None.
TotalReplies	integer	None.
TotalUnsubscribed	integer	None.
Recipients	Collection of string	None.
Delivered	Collection of SmsNumberInfo	None.
Bounced	Collection of SmsNumberInfo	None.
Replies	Collection of SmsReply	None.
Unsubscribed	Collection of SmsNumberInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Status": "sample string 2",
  "TotalRecipients": 3,
  "TotalDelivered": 4,
  "TotalBounced": 5,
  "TotalReplies": 6,
  "TotalUnsubscribed": 7,
  "Recipients": [
    "sample string 1",
    "sample string 2"
  ],
  "Delivered": [
    {
      "Number": "sample string 1",
      "Date": "2026-11-03T23:03:50.7724312+02:00"
    },
    {
      "Number": "sample string 1",
      "Date": "2026-11-03T23:03:50.7724312+02:00"
    }
  ],
  "Bounced": [
    {
      "Number": "sample string 1",
      "Date": "2026-11-03T23:03:50.7724312+02:00"
    },
    {
      "Number": "sample string 1",
      "Date": "2026-11-03T23:03:50.7724312+02:00"
    }
  ],
  "Replies": [
    {
      "Message": "sample string 1",
      "Number": "sample string 2",
      "Date": "2026-11-03T23:03:50.7735183+02:00"
    },
    {
      "Message": "sample string 1",
      "Number": "sample string 2",
      "Date": "2026-11-03T23:03:50.7735183+02:00"
    }
  ],
  "Unsubscribed": [
    {
      "Number": "sample string 1",
      "Date": "2026-11-03T23:03:50.7724312+02:00"
    },
    {
      "Number": "sample string 1",
      "Date": "2026-11-03T23:03:50.7724312+02:00"
    }
  ]
}

application/xml, text/xml

Sample:

<SmsCampaignReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBP5.API.Sms.Models">
  <Bounced xmlns:d2p1="http://schemas.datacontract.org/2004/07/TBP5.Services.DataContracts.SMS.Api.Model">
    <d2p1:SmsNumberInfo>
      <d2p1:Date>2026-11-03T23:03:50.7724312+02:00</d2p1:Date>
      <d2p1:Number>sample string 1</d2p1:Number>
    </d2p1:SmsNumberInfo>
    <d2p1:SmsNumberInfo>
      <d2p1:Date>2026-11-03T23:03:50.7724312+02:00</d2p1:Date>
      <d2p1:Number>sample string 1</d2p1:Number>
    </d2p1:SmsNumberInfo>
  </Bounced>
  <Delivered xmlns:d2p1="http://schemas.datacontract.org/2004/07/TBP5.Services.DataContracts.SMS.Api.Model">
    <d2p1:SmsNumberInfo>
      <d2p1:Date>2026-11-03T23:03:50.7724312+02:00</d2p1:Date>
      <d2p1:Number>sample string 1</d2p1:Number>
    </d2p1:SmsNumberInfo>
    <d2p1:SmsNumberInfo>
      <d2p1:Date>2026-11-03T23:03:50.7724312+02:00</d2p1:Date>
      <d2p1:Number>sample string 1</d2p1:Number>
    </d2p1:SmsNumberInfo>
  </Delivered>
  <Name>sample string 1</Name>
  <Recipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Recipients>
  <Replies xmlns:d2p1="http://schemas.datacontract.org/2004/07/TBP5.Services.DataContracts.SMS.Api.Model">
    <d2p1:SmsReply>
      <d2p1:Date>2026-11-03T23:03:50.7735183+02:00</d2p1:Date>
      <d2p1:Number>sample string 2</d2p1:Number>
      <d2p1:Message>sample string 1</d2p1:Message>
    </d2p1:SmsReply>
    <d2p1:SmsReply>
      <d2p1:Date>2026-11-03T23:03:50.7735183+02:00</d2p1:Date>
      <d2p1:Number>sample string 2</d2p1:Number>
      <d2p1:Message>sample string 1</d2p1:Message>
    </d2p1:SmsReply>
  </Replies>
  <Status>sample string 2</Status>
  <TotalBounced>5</TotalBounced>
  <TotalDelivered>4</TotalDelivered>
  <TotalRecipients>3</TotalRecipients>
  <TotalReplies>6</TotalReplies>
  <TotalUnsubscribed>7</TotalUnsubscribed>
  <Unsubscribed xmlns:d2p1="http://schemas.datacontract.org/2004/07/TBP5.Services.DataContracts.SMS.Api.Model">
    <d2p1:SmsNumberInfo>
      <d2p1:Date>2026-11-03T23:03:50.7724312+02:00</d2p1:Date>
      <d2p1:Number>sample string 1</d2p1:Number>
    </d2p1:SmsNumberInfo>
    <d2p1:SmsNumberInfo>
      <d2p1:Date>2026-11-03T23:03:50.7724312+02:00</d2p1:Date>
      <d2p1:Number>sample string 1</d2p1:Number>
    </d2p1:SmsNumberInfo>
  </Unsubscribed>
</SmsCampaignReport>