| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/SMSCampaignReports/{CampaignId}/Messages | Return the SMS Campaign Report details. | |
|---|---|---|---|
| GET | /Ams/{ClientID}/SMSCampaignReports/{CampaignId} | Return the SMS Campaign Report details. | |
| GET | /Ams/{ClientID}/SMSCampaignReports/{CampaignId}/Messages/{MessageId} | Return a SMS message's trace actions. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CampaignId | path | int | No | |
| MessageId | path | string | No | |
| ActivityFilter | query | int | No | |
| RequestAction | query | RequestAction | No | |
| TotalActivity | query | int | No | |
| PageSize | query | int | No | |
| PageNumber | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Total | form | SMSCampaignReportItem<int> | No | |
| Rate | form | SMSCampaignReportItem<float> | No | |
| MessageActivity | form | List<SMSCampaignReportMessageActivity> | No | |
| Messages | form | List<SMSCampaignReportMessage> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Date | form | DateTime? | No | |
| ListSize | form | T | No | |
| Process | form | T | No | |
| Send | form | T | No | |
| Delivery | form | T | No | |
| Fail | form | T | No | |
| NotSend | form | T | No | |
| Undeliverable | form | T | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TypeId | form | int | No | |
| ActivityType | form | string | No | |
| Date | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberId | form | int | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| Mobile | form | string | No | |
| MessageId | form | string | No | |
| Activity | form | SMSCampaignReportMessageActivity | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/SMSCampaignReports/{CampaignId}/Messages HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Total":{"Date":"0001-01-01T00:00:00.0000000","ListSize":0,"Process":0,"Send":0,"Delivery":0,"Fail":0,"NotSend":0,"Undeliverable":0},"Rate":{"Date":"0001-01-01T00:00:00.0000000","ListSize":0,"Process":0,"Send":0,"Delivery":0,"Fail":0,"NotSend":0,"Undeliverable":0},"MessageActivity":[{"TypeId":0,"ActivityType":"String","Date":"0001-01-01T00:00:00.0000000"}],"Messages":[{"MemberId":0,"FirstName":"String","LastName":"String","Mobile":"String","MessageId":"String","Activity":{"TypeId":0,"ActivityType":"String","Date":"0001-01-01T00:00:00.0000000"}}],"CampaignId":0,"MessageId":"String","ActivityFilter":0,"RequestAction":"Details","TotalActivity":0,"PageSize":0,"PageNumber":0,"UsingRedis":true,"AppInitTime":"2024-05-03T09:25:23.9339333-04:00","ServerID":"WS-6-183-431","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T10:45:47.3427210-04:00","Device":"Desktop"}