YM REST Services

SMSCampaignReports

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/SMSCampaignReports/{CampaignId}/Messages	Return the SMS Campaign Report details.
GET	/Ams/{ClientID}/SMSCampaignReports/{CampaignId}/Messages/{MessageId}	Return a SMS message's trace actions.
GET	/Ams/{ClientID}/SMSCampaignReports/{CampaignId}	Return the SMS Campaign Report details.

**SMSCampaignReports** Parameters:
Name	Parameter	Data Type	Required
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

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**SMSCampaignReportsResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	SMSCampaignReportItem<int>	No
Rate	form	SMSCampaignReportItem<float>	No
MessageActivity	form	List<SMSCampaignReportMessageActivity>	No
Messages	form	List<SMSCampaignReportMessage>	No

**SMSCampaignReportItem<T>** Parameters:
Name	Parameter	Data Type	Required
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

**SMSCampaignReportMessageActivity** Parameters:
Name	Parameter	Data Type	Required
TypeId	form	int	No
ActivityType	form	string	No
Date	form	DateTime	No

**SMSCampaignReportMessage** Parameters:
Name	Parameter	Data Type	Required
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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Total: 
	{
		Date: 0001-01-01,
		ListSize: 0,
		Process: 0,
		Send: 0,
		Delivery: 0,
		Fail: 0,
		NotSend: 0,
		Undeliverable: 0
	},
	Rate: 
	{
		Date: 0001-01-01,
		ListSize: 0,
		Process: 0,
		Send: 0,
		Delivery: 0,
		Fail: 0,
		NotSend: 0,
		Undeliverable: 0
	},
	MessageActivity: 
	[
		{
			TypeId: 0,
			ActivityType: String,
			Date: 0001-01-01
		}
	],
	Messages: 
	[
		{
			MemberId: 0,
			FirstName: String,
			LastName: String,
			Mobile: String,
			MessageId: String,
			Activity: 
			{
				TypeId: 0,
				ActivityType: String,
				Date: 0001-01-01
			}
		}
	],
	CampaignId: 0,
	MessageId: String,
	ActivityFilter: 0,
	RequestAction: Details,
	TotalActivity: 0,
	PageSize: 0,
	PageNumber: 0,
	UsingRedis: True,
	AppInitTime: 2025-01-15T07:36:41.2404784-05:00,
	ServerID: WS-5-212-532,
	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: 2025-01-15T08:33:50.6915438-05:00,
	Device: Desktop
}