GET v1/Blacklist/GetBlacklist/{facilityId}
Gets the blacklist.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
facilityId |
The facility identifier. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of BlacklistItemName | Description | Type | Additional information |
---|---|---|---|
MessageAccountId | string |
None. |
|
FacilityId | globally unique identifier |
None. |
|
TenantId | string |
None. |
|
PhoneNumber | string |
None. |
|
EmailAddress | string |
None. |
|
MessageId | string |
None. |
|
KeywordFound | string |
None. |
|
MessageBody | string |
None. |
|
Source | integer |
None. |
|
Status | integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "MessageAccountId": "sample string 1", "FacilityId": "1d87daad-0a00-4917-ae48-7ebc90f0424d", "TenantId": "sample string 3", "PhoneNumber": "sample string 4", "EmailAddress": "sample string 5", "MessageId": "sample string 6", "KeywordFound": "sample string 7", "MessageBody": "sample string 8", "Source": 9, "Status": 10 }, { "MessageAccountId": "sample string 1", "FacilityId": "1d87daad-0a00-4917-ae48-7ebc90f0424d", "TenantId": "sample string 3", "PhoneNumber": "sample string 4", "EmailAddress": "sample string 5", "MessageId": "sample string 6", "KeywordFound": "sample string 7", "MessageBody": "sample string 8", "Source": 9, "Status": 10 } ]
application/xml, text/xml
Sample:
<ArrayOfBlacklistModel.BlacklistItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.Messaging"> <BlacklistModel.BlacklistItem> <EmailAddress>sample string 5</EmailAddress> <FacilityId>1d87daad-0a00-4917-ae48-7ebc90f0424d</FacilityId> <KeywordFound>sample string 7</KeywordFound> <MessageAccountId>sample string 1</MessageAccountId> <MessageBody>sample string 8</MessageBody> <MessageId>sample string 6</MessageId> <PhoneNumber>sample string 4</PhoneNumber> <Source>9</Source> <Status>10</Status> <TenantId>sample string 3</TenantId> </BlacklistModel.BlacklistItem> <BlacklistModel.BlacklistItem> <EmailAddress>sample string 5</EmailAddress> <FacilityId>1d87daad-0a00-4917-ae48-7ebc90f0424d</FacilityId> <KeywordFound>sample string 7</KeywordFound> <MessageAccountId>sample string 1</MessageAccountId> <MessageBody>sample string 8</MessageBody> <MessageId>sample string 6</MessageId> <PhoneNumber>sample string 4</PhoneNumber> <Source>9</Source> <Status>10</Status> <TenantId>sample string 3</TenantId> </BlacklistModel.BlacklistItem> </ArrayOfBlacklistModel.BlacklistItem>