YM REST Services

<back to all web services

SMSCampaigns

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
POST/Ams/{ClientID}/SMSCampaigns/{CampaignId}/SendTestSend 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:
NameParameterData TypeRequiredDescription
CampaignIDpathintNo
ListIDbodyintNo
CampaignNamebodystringNo
MessagebodystringNo
CampaignStatusbodyBulkEmailStatusNo
DateScheduledbodyDateTimeNo
TestCountryCodebodystringNo
TestMobileNumberbodystringNo
DateStartProcessingbodyDateTime?No
DateEndProcessingbodyDateTime?No
AdminNamebodystringNo
SenderNumberbodystringNo
DateJobSubmittedbodyDateTimeNo
ListNamebodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
SMSCampaignsResponse Parameters:
NameParameterData TypeRequiredDescription
SenderNumberformstringNo
SenderAliasformstringNo
NoOptOutformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"CampaignID":0,"ListID":0,"CampaignName":"String","Message":"String","CampaignStatus":"InQueue","DateScheduled":"0001-01-01T00:00:00.0000000","TestCountryCode":"String","TestMobileNumber":"String","DateStartProcessing":"0001-01-01T00:00:00.0000000","DateEndProcessing":"0001-01-01T00:00:00.0000000","AdminName":"String","SenderNumber":"String","DateJobSubmitted":"0001-01-01T00:00:00.0000000","ListName":"String","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:50:59.0905422-05:00","Device":"Desktop"}

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

{"SenderNumber":"String","SenderAlias":"String","NoOptOut":"String","CampaignID":0,"ListID":0,"CampaignName":"String","Message":"String","CampaignStatus":"InQueue","DateScheduled":"0001-01-01T00:00:00.0000000","TestCountryCode":"String","TestMobileNumber":"String","DateStartProcessing":"0001-01-01T00:00:00.0000000","DateEndProcessing":"0001-01-01T00:00:00.0000000","AdminName":"String","DateJobSubmitted":"0001-01-01T00:00:00.0000000","ListName":"String","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:50:59.1123696-05:00","Device":"Desktop"}