CMS Web Services - v4.0.6521.16602 [cms-b]

<back to all web services

MessageDeliveryList

Returns a list of addressees for this message and their delivery status

The following routes are available for this service:
POST,GET/message/delivery/list
MessageDeliveryList Parameters:
NameParameterData TypeRequiredDescription
MessageIdbodystringYesThe ID of the message
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
MessageDeliveryListResponse Parameters:
NameParameterData TypeRequiredDescription
DeliveryListformList<DeliveryListRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
DeliveryListRecord Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
ForwardedformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /message/delivery/list HTTP/1.1 
Host: cms.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"MessageId":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DeliveryList":[{"Address":"String","Forwarded":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}