OutboundMessage

List all existing outbound messages.

get/v1/outbound/messages

Query parameters

Idinteger
DepartmentScopeDepartmentPageSelection

Selects departments for a page-level query. The query-string value can be all or a comma-separated list of positive department IDs, such as 12,34.

Selects departments for a page-level query. The query-string value can be all or a comma-separated list of positive department IDs, such as 12,34.

Namestring
Type1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
<p>Enum values:</p><ul><li><i>1 = Chat</i></li><li><i>2 = Post</i></li><li><i>3 = Email</i></li><li><i>4 = Chatbot</i></li><li><i>5 = ProductTour</i></li><li><i>6 = Banner</i></li><li><i>7 = MobilePush</i></li><li><i>8 = MobileCarousel</i></li><li><i>9 = SocialMedia</i></li><li><i>10 = Sms</i></li></ul>
<p>Enum values:</p><ul><li><i>1 = Chat</i></li><li><i>2 = Post</i></li><li><i>3 = Email</i></li><li><i>4 = Chatbot</i></li><li><i>5 = ProductTour</i></li><li><i>6 = Banner</i></li><li><i>7 = MobilePush</i></li><li><i>8 = MobileCarousel</i></li><li><i>9 = SocialMedia</i></li><li><i>10 = Sms</i></li></ul><p>Enum values:</p><ul><li><i>1 = Chat</i></li><li><i>2 = Post</i></li><li><i>3 = Email</i></li><li><i>4 = Chatbot</i></li><li><i>5 = ProductTour</i></li><li><i>6 = Banner</i></li><li><i>7 = MobilePush</i></li><li><i>8 = MobileCarousel</i></li><li><i>9 = SocialMedia</i></li><li><i>10 = Sms</i></li></ul>
SendType1 | 2
<p>Enum values:</p><ul><li><i>1 = Ongoing</i></li><li><i>2 = OneOff</i></li></ul>
<p>Enum values:</p><ul><li><i>1 = Ongoing</i></li><li><i>2 = OneOff</i></li></ul><p>Enum values:</p><ul><li><i>1 = Ongoing</i></li><li><i>2 = OneOff</i></li></ul>
Statusinteger
FromCreatedAtstring
ToCreatedAtstring
ViewType0 | 1
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul><p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
Pageinteger
ItemsPerPageinteger
ReturnTotalItemsboolean
sortColstring
sortDirstring

Response

OK

totalItemsinteger

Changes

No recorded changes to this endpoint across all 1 revision of this API.