Add Campaign Endpoint
==============

+--------------------------------------------------------------------+--------------------------------------------------------------------------------+----------------+
| URL                                                                | Required Values                                                                | HTTP Methods   |
+====================================================================+================================================================================+================+
| https://app.tingting.io/api/v1/campaign/create/                    | name, services, user_phone, message, sms_message, description, schedule, voice |     POST       |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------+----------------+

To add a campaign, you’ll need to access the campaign endpoint using the HTTP POST method. The required inputs for 
creating a campaign include the name of the campaign, the services offered by the campaign, phone number through
which the campaign will be executed, the message to be sent, the SMS message is needed for SMS service and 
PHONE & SMS service only, the description of the campaign, schedule of the campaign and voice assistance for the campaign.

Furthermore, you can also add available tags to your message using variables and passing it inside curly braces.

Sample Tags:

Message: “नमस्कार, {tags_name}, हजुर {tags_age} वर्षको हुनुहुन्छ र हजुरको सालारी {tags_salary} छ |”



Sample Input:

.. code-block:: json

    {
        "name" : "example test campaign",
        "services" : "PHONE",
        "user_phone" : [3],                   
        "message" : "नमस्ते तिङ्तिङ् मा स्वागत् छ",
        "sms_message" : "नमस्ते तिङ्तिङ् मा स्वागत् छ",
        "description" : "Test message",
        "schedule" : "2025-07-08",         
    }

Sample Output:

.. code-block:: json

    {
        "id": 79,
        "name": "example test campaign",
        "services": "PHONE",
        "status": "Not Started",
        "sms_message": "नमस्ते तिङ्तिङ् मा स्वागत् छ ",
        "message": "नमस्ते तिङ्तिङ् मा स्वागत् छ ",
        "description": "Test message",
        "schedule": "2025-07-08T00:00:00+05:45",
        "audio_file": null,
        "bulk_file": null,
        "category": "",
        "user_phone": [
            3
        ],
        "progress_percent": 0,
        "updated_at": "2025-07-07T13:13:16.286224+05:45",
        "credit_limit": 100,
        "voice": null,
        "draft": false,
        "failover_target": [],
        "length_factor": "1.00",
        "main_audit": "4770",
        "voice" : 3
    }



**Add Voice Assistance Endpoint**

+------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------+
| URL                                                                                | Required Values                                                   | HTTP Methods   |
+====================================================================================+===================================================================+================+
| https://app.tingting.io/api/v1/campaign/create/<campaign_id>/message/              | Campaign ID, voice, category, length_factor, message, sms_message |     PATCH      |
+------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------+

Note that the <contact_id> in the URL should be replaced with the ID of the contact you want to add the details of.

Sample Input:

..  code-block:: json

    {
        "voice" : 3,
        "category" : "Text"
    }

As message, sms_message is already provided above so no need to provide here. length_factor default value is 1 and draft value is false.

Sample Output:

.. code-block:: json

    {
        "voice": 3,
        "sms_message": "नमस्ते तिङ्तिङ् मा स्वागत् छ",
        "message": "नमस्ते तिङ्तिङ् मा स्वागत् छ",
        "category": "Text",
        "draft": false,
        "length_factor": "1.00"
    }


**Add Contact(s) in Campaign Endpoint**

+---------------------------------------------------------------------------------+--------------------+----------------+
| URL                                                                             | Required Values    | HTTP Methods   |
+=================================================================================+====================+================+
| https://app.tingting.io/api/v1/campaign/<campaign_id>/add-contact/              | Campaign ID        |     POST       |
+---------------------------------------------------------------------------------+--------------------+----------------+

The body can be passed in two formats:

**Single contact** — object with ``number`` and optional ``other_variables``:

.. code-block:: json

    {
        "number" : 9823561098,
        "other_variables" : {
            "age" : 23,
            "name" : "Rajesh",
            "salary" : 50000
        }
    }

Sample output:

.. code-block:: json

    {
        "message": "New Contact added"
    }

**Array of contacts** — object with a ``contacts`` array; each item has ``number`` and optional ``other_variables``:

Sample request body:

.. code-block:: json

    {
        "contacts": [
            { "number": "9841234567", "other_variables": {} },
            { "number": "9841234568" },
            { "number": "9841234569", "other_variables": { "name": "Jane" } }
        ]
    }

Sample output:

.. code-block:: json

    {
        "created": 3,
        "skipped": 0,
        "contacts": [
            {
                "id": 9801692,
                "updated_at": "Jan. 27, 2026, 05:19 PM",
                "created_at": "2026-01-27T17:19:46.911153+05:45",
                "deleted_at": null,
                "number": "1231231234",
                "status": "not started",
                "other_variables": {
                    "name": "Jane",
                    "age": "22"
                },
                "credit_consumed": 0,
                "credit_consumed_SMS": 0,
                "duration": "",
                "playback": "",
                "uuid": "50dbe25c-034c-4c2e-93e8-c9dfeaa4532f",
                "failover_sms_sent": false,
                "campaing": 3278
            },
            {
                "id": 9801693,
                "updated_at": "Jan. 27, 2026, 05:19 PM",
                "created_at": "2026-01-27T17:19:46.922063+05:45",
                "deleted_at": null,
                "number": "1231231232",
                "status": "not started",
                "other_variables": {},
                "credit_consumed": 0,
                "credit_consumed_SMS": 0,
                "duration": "",
                "playback": "",
                "uuid": "e6f697c3-9ff6-4532-a38e-9aa413b6d29c",
                "failover_sms_sent": false,
                "campaing": 3278
            },
            {
                "id": 9801694,
                "updated_at": "Jan. 27, 2026, 05:19 PM",
                "created_at": "2026-01-27T17:19:46.930727+05:45",
                "deleted_at": null,
                "number": "1231231231",
                "status": "not started",
                "other_variables": {
                    "name": "Jane"
                },
                "credit_consumed": 0,
                "credit_consumed_SMS": 0,
                "duration": "",
                "playback": "",
                "uuid": "eb25a16e-0805-42b4-83be-85256c7cc391",
                "failover_sms_sent": false,
                "campaing": 3278
            }
        ],
        "errors": null
    }

**Add Bulk Contact in Campaign Endpoint**

+-----------------------------------------------------------------------------------+--------------------+----------------+
| URL                                                                               | Required Values    | HTTP Methods   |
+===================================================================================+====================+================+
| https://app.tingting.io/api/v1/campaign/create/<campaign_id>/detail/              | Campaign ID        |     PATCH      |
+-----------------------------------------------------------------------------------+--------------------+----------------+

Sample Input To Add Bulk Contact:

.. code-block:: json

    {
        "bulk_file" : "numbers.xlsx"
    }

Sample Output for Bulk Contact:

.. code-block:: json

    {
        "error_list": [],
        "samples": [
            {
                "column": "numbers",
                "sample": [
                    "9801356897",
                    "9812345698",
                    "9745610235"
                ]
            },
            {
                "column": "name",
                "sample": [
                    "अद्वैत",
                    "आशिष",
                    "शिखर"
                ]
            },
            {
                "column": "age",
                "sample": [
                    20,
                    21,
                    21
                ]
            },
            {
                "column": "salary",
                "sample": [
                    "एक लाख",
                    "दुइ लाख",
                    "तिन लाख"
                ]
            }
        ],
        "total_validated_rows": 3
    }