[HTTP GET] ~/campaigns/{campaignId}/reports/textmessages
Description: Get a TextMessages Report for a specific Campaign
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| campaignId |
the specific Campaign Id |
integer |
Required |
Body Parameters
None
Response Information
Description
Successful Response - OK (200):
A TextMessage Channel Report
Response Content : TextMessageChannelReport
| Name | Description | Type | Additional information |
|---|---|---|---|
| TextMessageReports |
A list of Child TextMessageReports |
Collection of TextMessageReport |
None. |
| CampaignId |
The Campaign ID of this Channel Report |
integer |
None. |
| Sent |
How many text messages were sent in total for this Campaign |
integer |
None. |
| Delivered |
How many text messages were delivered |
integer |
None. |
| DeliveredRate |
What % of Text messages were Delivered |
decimal number |
None. |
| Unsubscribes |
How many unsubscribes came from TextMessages |
integer |
None. |
| AutoUnsubscribes |
How many auto-unsubscribes came from TextMessages |
integer |
None. |
| UserUnsubscribes |
How many user-unsubscribes came from TextMessages |
integer |
None. |
| UnsubscribeRate |
What % of Textmessages ended with UnSubscribes |
decimal number |
None. |
| Received |
How many text messages were received |
integer |
None. |
| ReceivedRate |
What % of Text Messages sent were received |
decimal number |
None. |
| Unhandled |
What count of Text Messages sent were Unhandled |
integer |
None. |
| KnownUnhandledCount |
What count of text messages sent do we know to be unhandled |
integer |
None. |
| UnknownUnhandledCount |
What count of text messages do we not know where unhandled |
integer |
None. |
| UnhandledRate |
What % of Text Messages ended up unhandled |
decimal number |
None. |
| Acknowledgements |
How many Text Messages were acknowledged |
integer |
None. |
| AcknowledgementRate |
What % of Text Messages were acknowledged |
decimal number |
None. |
Response Codes:
-
200 - OK
- The specified Campaign's TextMessage Reports were retrieved and returned successfully.
-
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
-
403 - Forbidden
- The user does not have the relevant permissions to perform this action.
-
404 - NotFound
- The specified Campaign or it's SMS reports were not found.
-
500 - InternalServerError
- An error occurred while processing this request.
Formats
application/json, text/json
Sample:
{
"TextMessageReports": [
{
"Id": 1,
"Name": "sample string 2",
"MessageContent": "sample string 3",
"StartDate": "2024-05-06T00:06:40.2947079+01:00",
"EndDate": "2024-05-06T00:06:40.2947079+01:00",
"DayOfWeek": "sample string 6",
"FromNumber": "sample string 7",
"InitialSent": 8,
"Sent": 9,
"Delivered": 10,
"DeliveredRate": 11.1,
"Undelivered": 12,
"UndeliveredRate": 13.1,
"Unsubscribes": 14,
"AutoUnsubscribes": 15,
"UserUnsubscribes": 16,
"UnsubscribeRate": 17.1,
"Received": 18,
"ReceivedRate": 19.1,
"Unhandled": 20,
"KnownUnhandledCount": 21,
"UnknownUnhandledCount": 22,
"UnhandledRate": 23.1,
"Acknowledgements": 24,
"AcknowledgementRate": 25.1
},
{
"Id": 1,
"Name": "sample string 2",
"MessageContent": "sample string 3",
"StartDate": "2024-05-06T00:06:40.2947079+01:00",
"EndDate": "2024-05-06T00:06:40.2947079+01:00",
"DayOfWeek": "sample string 6",
"FromNumber": "sample string 7",
"InitialSent": 8,
"Sent": 9,
"Delivered": 10,
"DeliveredRate": 11.1,
"Undelivered": 12,
"UndeliveredRate": 13.1,
"Unsubscribes": 14,
"AutoUnsubscribes": 15,
"UserUnsubscribes": 16,
"UnsubscribeRate": 17.1,
"Received": 18,
"ReceivedRate": 19.1,
"Unhandled": 20,
"KnownUnhandledCount": 21,
"UnknownUnhandledCount": 22,
"UnhandledRate": 23.1,
"Acknowledgements": 24,
"AcknowledgementRate": 25.1
}
],
"CampaignId": 1,
"Sent": 2,
"Delivered": 3,
"DeliveredRate": 4.1,
"Unsubscribes": 5,
"AutoUnsubscribes": 6,
"UserUnsubscribes": 7,
"UnsubscribeRate": 8.1,
"Received": 9,
"ReceivedRate": 10.1,
"Unhandled": 11,
"KnownUnhandledCount": 12,
"UnknownUnhandledCount": 13,
"UnhandledRate": 14.1,
"Acknowledgements": 15,
"AcknowledgementRate": 16.1
}
application/csp-report
Sample:
{"TextMessageReports":[{"Id":1,"Name":"sample string 2","MessageContent":"sample string 3","StartDate":"2024-05-06T00:06:40.2947079+01:00","EndDate":"2024-05-06T00:06:40.2947079+01:00","DayOfWeek":"sample string 6","FromNumber":"sample string 7","InitialSent":8,"Sent":9,"Delivered":10,"DeliveredRate":11.1,"Undelivered":12,"UndeliveredRate":13.1,"Unsubscribes":14,"AutoUnsubscribes":15,"UserUnsubscribes":16,"UnsubscribeRate":17.1,"Received":18,"ReceivedRate":19.1,"Unhandled":20,"KnownUnhandledCount":21,"UnknownUnhandledCount":22,"UnhandledRate":23.1,"Acknowledgements":24,"AcknowledgementRate":25.1},{"Id":1,"Name":"sample string 2","MessageContent":"sample string 3","StartDate":"2024-05-06T00:06:40.2947079+01:00","EndDate":"2024-05-06T00:06:40.2947079+01:00","DayOfWeek":"sample string 6","FromNumber":"sample string 7","InitialSent":8,"Sent":9,"Delivered":10,"DeliveredRate":11.1,"Undelivered":12,"UndeliveredRate":13.1,"Unsubscribes":14,"AutoUnsubscribes":15,"UserUnsubscribes":16,"UnsubscribeRate":17.1,"Received":18,"ReceivedRate":19.1,"Unhandled":20,"KnownUnhandledCount":21,"UnknownUnhandledCount":22,"UnhandledRate":23.1,"Acknowledgements":24,"AcknowledgementRate":25.1}],"CampaignId":1,"Sent":2,"Delivered":3,"DeliveredRate":4.1,"Unsubscribes":5,"AutoUnsubscribes":6,"UserUnsubscribes":7,"UnsubscribeRate":8.1,"Received":9,"ReceivedRate":10.1,"Unhandled":11,"KnownUnhandledCount":12,"UnknownUnhandledCount":13,"UnhandledRate":14.1,"Acknowledgements":15,"AcknowledgementRate":16.1}
application/xml, text/xml
Sample:
<TextMessageChannelReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Reports">
<AcknowledgementRate>16.1</AcknowledgementRate>
<Acknowledgements>15</Acknowledgements>
<AutoUnsubscribes>6</AutoUnsubscribes>
<CampaignId>1</CampaignId>
<Delivered>3</Delivered>
<DeliveredRate>4.1</DeliveredRate>
<KnownUnhandledCount>12</KnownUnhandledCount>
<Received>9</Received>
<ReceivedRate>10.1</ReceivedRate>
<Sent>2</Sent>
<TextMessageReports>
<TextMessageReport>
<AcknowledgementRate>25.1</AcknowledgementRate>
<Acknowledgements>24</Acknowledgements>
<AutoUnsubscribes>15</AutoUnsubscribes>
<DayOfWeek>sample string 6</DayOfWeek>
<Delivered>10</Delivered>
<DeliveredRate>11.1</DeliveredRate>
<EndDate>2024-05-06T00:06:40.2947079+01:00</EndDate>
<FromNumber>sample string 7</FromNumber>
<Id>1</Id>
<InitialSent>8</InitialSent>
<KnownUnhandledCount>21</KnownUnhandledCount>
<MessageContent>sample string 3</MessageContent>
<Name>sample string 2</Name>
<Received>18</Received>
<ReceivedRate>19.1</ReceivedRate>
<Sent>9</Sent>
<StartDate>2024-05-06T00:06:40.2947079+01:00</StartDate>
<Undelivered>12</Undelivered>
<UndeliveredRate>13.1</UndeliveredRate>
<Unhandled>20</Unhandled>
<UnhandledRate>23.1</UnhandledRate>
<UnknownUnhandledCount>22</UnknownUnhandledCount>
<UnsubscribeRate>17.1</UnsubscribeRate>
<Unsubscribes>14</Unsubscribes>
<UserUnsubscribes>16</UserUnsubscribes>
</TextMessageReport>
<TextMessageReport>
<AcknowledgementRate>25.1</AcknowledgementRate>
<Acknowledgements>24</Acknowledgements>
<AutoUnsubscribes>15</AutoUnsubscribes>
<DayOfWeek>sample string 6</DayOfWeek>
<Delivered>10</Delivered>
<DeliveredRate>11.1</DeliveredRate>
<EndDate>2024-05-06T00:06:40.2947079+01:00</EndDate>
<FromNumber>sample string 7</FromNumber>
<Id>1</Id>
<InitialSent>8</InitialSent>
<KnownUnhandledCount>21</KnownUnhandledCount>
<MessageContent>sample string 3</MessageContent>
<Name>sample string 2</Name>
<Received>18</Received>
<ReceivedRate>19.1</ReceivedRate>
<Sent>9</Sent>
<StartDate>2024-05-06T00:06:40.2947079+01:00</StartDate>
<Undelivered>12</Undelivered>
<UndeliveredRate>13.1</UndeliveredRate>
<Unhandled>20</Unhandled>
<UnhandledRate>23.1</UnhandledRate>
<UnknownUnhandledCount>22</UnknownUnhandledCount>
<UnsubscribeRate>17.1</UnsubscribeRate>
<Unsubscribes>14</Unsubscribes>
<UserUnsubscribes>16</UserUnsubscribes>
</TextMessageReport>
</TextMessageReports>
<Unhandled>11</Unhandled>
<UnhandledRate>14.1</UnhandledRate>
<UnknownUnhandledCount>13</UnknownUnhandledCount>
<UnsubscribeRate>8.1</UnsubscribeRate>
<Unsubscribes>5</Unsubscribes>
<UserUnsubscribes>7</UserUnsubscribes>
</TextMessageChannelReport>