Export campaign messages

Exports the per-recipient message rows of campaign {id} as a CSV file (application/octet-stream). Same filters as List campaign messages, plus an export mode.

Authentication: Authorization: Bearer <JWT>.

Path parameters

id (GUID, required) - the campaign whose messages are exported.

Body fields

pageNumber (integer, default 1) - 1-based page index; ignored for full exports (mode = All/Filtered).

pageSize (integer, 1-1000, default 20) - records per page; ignored for full exports.

status (string, optional) - filter by message/delivery status.

providerType (string, optional) - filter by channel/provider type.

provider (string, optional) - API-traffic channel selector (SMS | Viber | Whatsapp); ignored by the non-API endpoints.

search (string, optional) - free-text filter (e.g. recipient).

sortBy (string, optional) - sort field for the message rows.

sortDescending (boolean, default true) - true = descending, false = ascending.

mode (enum All | Selected | Filtered, default Filtered) - All = every message; Filtered = all messages matching the filters, without pagination; Selected = only the messages listed in ids.

ids (long[], optional) - message IDs to export. Required when mode = Selected.

Example request

curl --location 'https://api.veloconnect.me/api/v2/campaigns//messages/export' \ --header 'Content-Type: application/json' \ --data '{ "pageNumber": 0, "pageSize": 0, "status": "string", "providerType": "string", "search": "string", "sortBy": "string", "sortDescending": true, "mode": "All", "ids": [ 0 ] }'

Export campaign messages

Request

Responses