OutGate

The OutGate endpoints enable you to download export files from your bulk SMS gates. Access and retrieve various export file types for data analysis, reporting, and integration with external systems.

Two GET operations are available: one downloads the export file in its default format, and the other lets you request a specific export type via the type path parameter. When type is set to Custom, the columns parameter is also required so you can select exactly which fields are included in the output.

Exported records cover gate configuration and status data such as id, name, status, supplier, price list, billing account, and VPN connection details, and results can be sorted by these attributes. Access is governed by the bulk-gates.view and bulk-gates-own.view privileges, while bulk-settings-supplier-sms.complete is additionally required to include gate passwords in the export.