We are now open for everyone. Get Started.
q)status=COMPLETED&status=FAILED).| Parameter | Type | Description |
|---|---|---|
status | enum | Campaign state: PENDING, PROCESSING, COMPLETED, FAILED. |
channel_type | enum | Primary channel: SMS, WHATSAPP. |
tag_id | uuid | Filter campaigns targeting specific audience tags. |
remitter_id | uuid | Filter by the assigned Sender ID (Remitter). |
created_at__ge | datetime | Filter by creation date (ISO 8601). |
created_at__le | datetime | Filter by creation date (ISO 8601). |
page and size (default 30, max 200).created_at or updated_at in asc or desc order.curl --location --request GET 'https://dev.api.ziett.co/c/v1/campaigns?q=&size=30&page=1&order=desc&order_by=created_at&error_code=&status=&trigger_source=&channel_type=&tag_id=&sms_remitter_id=&created_at__ge=&created_at__le=' \
--header 'X-API-KEY: <api-key>'{
"entries": [
{
"id": "string",
"updated_at": "2019-08-24T14:15:22.123Z",
"created_at": "2019-08-24T14:15:22.123Z",
"name": "string",
"status": "DRAFT",
"organization_id": "string",
"billing_account_id": "string",
"trigger_source": "API_CLIENT",
"file_metadata_id": "string",
"channel_type": "SMS",
"sms_remitter_id": "string",
"sms_remitter": {
"name": "Ziett"
},
"content": "string",
"total_estimated_recipients": 0,
"scheduled_at": "2019-08-24T14:15:22.123Z",
"processed_at": "2019-08-24T14:15:22.123Z",
"completed_at": "2019-08-24T14:15:22.123Z",
"error_code": "SYSTEM_DISPATCH_ERROR",
"status_note": "string",
"data": {
"reason_of_pause": "string"
}
}
],
"total": 0,
"page": 1,
"size": 1,
"pages": 0
}