YM REST Services

SMSCampaigns

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

The following routes are available for this service:
POST	/Ams/{ClientID}/SMSCampaigns/{CampaignId}/SendTest	Send the test SMS.
GET	/Ams/{ClientID}/SMSCampaigns/{CampaignID}	Return the details of a SMS Campaign.
PUT	/Ams/{ClientID}/SMSCampaigns/{CampaignId}	Update a given SMS Campaign.
DELETE	/Ams/{ClientID}/SMSCampaigns/{CampaignId}	Delete a given SMS Campaign.

**SMSCampaigns** Parameters:
Name	Parameter	Data Type	Required
CampaignID	path	int	No
ListID	body	int	No
CampaignName	body	string	No
Message	body	string	No
CampaignStatus	body	BulkEmailStatus	No
DateScheduled	body	DateTime	No
TestCountryCode	body	string	No
TestMobileNumber	body	string	No
DateStartProcessing	body	DateTime?	No
DateEndProcessing	body	DateTime?	No
AdminName	body	string	No
SenderNumber	body	string	No
DateJobSubmitted	body	DateTime	No
ListName	body	string	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

**SMSCampaignsResponse** Parameters:
Name	Parameter	Data Type	Required
SenderNumber	form	string	No
SenderAlias	form	string	No
NoOptOut	form	string	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.

POST /Ams/{ClientID}/SMSCampaigns/{CampaignId}/SendTest HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CampaignID: 0,
	ListID: 0,
	CampaignName: String,
	Message: String,
	CampaignStatus: InQueue,
	DateScheduled: 0001-01-01,
	TestCountryCode: String,
	TestMobileNumber: String,
	DateStartProcessing: 0001-01-01,
	DateEndProcessing: 0001-01-01,
	AdminName: String,
	SenderNumber: String,
	DateJobSubmitted: 0001-01-01,
	ListName: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T07:23:49.7169919-04:00,
	ServerID: WS-6-134-823,
	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-03T08:14:15.7520811-04:00,
	Device: Desktop
}

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

{
	SenderNumber: String,
	SenderAlias: String,
	NoOptOut: String,
	CampaignID: 0,
	ListID: 0,
	CampaignName: String,
	Message: String,
	CampaignStatus: InQueue,
	DateScheduled: 0001-01-01,
	TestCountryCode: String,
	TestMobileNumber: String,
	DateStartProcessing: 0001-01-01,
	DateEndProcessing: 0001-01-01,
	AdminName: String,
	DateJobSubmitted: 0001-01-01,
	ListName: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T07:23:49.7169919-04:00,
	ServerID: WS-6-134-823,
	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-03T08:14:15.7628483-04:00,
	Device: Desktop
}