YM REST Services

<back to all web services

SMSCampaignListDetails

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/SMSCampaignListDetails/{ListId}Return the CampaignEmailList details and records.
SMSCampaignListDetails Parameters:
NameParameterData TypeRequiredDescription
ListIDpathintNo
IsForceReloadqueryboolNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
SMSCampaignListDetailsResponse Parameters:
NameParameterData TypeRequiredDescription
ListTypeformEmailListTypeNo
TotalCountformintNo
TotalToSendformintNo
GlobalOptoutsformintNo
MobileMissingCountformintNo
ListReLoadStatusformCampaignListReloadStatusNo

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.

GET /Ams/{ClientID}/SMSCampaignListDetails/{ListId} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ListType":"None","TotalCount":0,"TotalToSend":0,"GlobalOptouts":0,"MobileMissingCount":0,"ListReLoadStatus":"None","ListID":0,"IsForceReload":false,"UsingRedis":true,"AppInitTime":"2024-05-03T04:23:41.3671139-04:00","ServerID":"WS-4-69-031","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-03T05:10:16.1587776-04:00","Device":"Desktop"}