Get Campaign Endpoint

URL

Required Values

HTTP Methods

https://app.tingting.io/api/v1/campaign/

GET

Information of all of your campaigns are retrieved at this endpoint. The information includes the campaign id, name, user phones, services, description, mesage, status, category, voice, audio_file, bulk_file, etc. The id is to be used in the future to update, delete or begin the campaign.

Pagination (CustomPaginator)

Example: ?limit=10&offset=0

Filters (query params)

Status is matched exactly; use the stored values (e.g. “Completed” not “completed”).

Example: /api/v1/campaign/?limit=10&offset=0&status=Completed — page size 10, start at 0, only campaigns whose status is exactly “Completed”.

Here is an example of the result: The campaign ID is used to edit, delete, run and perform other campaign activities.

{
"count": 2,
"total_pages": 1,
"next": null,
"previous": null,
"results": [
    {
        "id": 858,
        "name": "rockabye",
        "services": "PHONE",
        "status": "Completed",
        "sms_message": "",
        "message": "नमस्ते तिङ्तिङ् मा स्वागत् छ ",
        "description": "",
        "schedule": null,
        "audio_file": null,
        "bulk_file": null,
        "category": "Text",
        "user_phone": [
            12
        ],
        "campaign_action_count": 4,
        "progress_percent": 100,
        "updated_at": "2025-07-07T11:38:24.219065+05:45",
        "credit_limit": null,
        "voice": {
            "id": 5,
            "voice_display_name": "Shreegya",
            "voice_internal_name": "np_shreegya",
            "is_premium": false
        },
        "draft": false,
        "failover_target": [],
        "length_factor": "1.00"
    },
    {
        "id": 1208,
        "name": "test",
        "services": "PHONE",
        "status": "Terminated",
        "sms_message": "",
        "message": "नमस्ते तिङ्तिङ् मा स्वागत् छ",
        "description": "",
        "schedule": null,
        "audio_file": null,
        "bulk_file": null,
        "category": "Text",
        "user_phone": [
            12
        ],
        "campaign_action_count": 1,
        "progress_percent": 100,
        "updated_at": "2025-07-04T12:07:44.384374+05:45",
        "credit_limit": null,
        "voice": {
            "id": 3,
            "voice_display_name": "Prashanna",
            "voice_internal_name": "np_prasanna",
            "is_premium": false
        },
        "draft": false,
        "failover_target": [],
        "length_factor": "1.00"
    }
    ]
}