Versions Compared

Version Old Version 1 New Version Current
Changes made by

Nathaniel Halbrooks

Merry Arpaia

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Please find below list of APIs supported by Broadcast module.

Add Broadcast Campaign

Adding a campaign to the Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "addCampaign": {
      "message": "Campaign created Successfully",
      "status": true,
      "id": "20"
    }
  }
}

Update Broadcast Campaign

Updating a campaign in the Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "updateCampaign": {
      "message": "Campaign updated Successfully",
      "status": true,
      "id": "20"
    }
  }
}

Delete Broadcast Campaign

Deleting a campaign from the Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "deleteCampaign": {
      "message": "Campaign deleted Successfully",
      "status": true
    }
  }
}

Fetch All Campaigns

Fetch all campaigns in the Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "fetchAllCampaigns": {
      "status": true,
      "message": "List of campaigns",
      "campaigns": [
        {
          "id": "1",
          "name": "campaign1",
          "email": "",
          "email_settings": "",
          "active": false,
          "dupes": "1",
          "time_start": "08:00:00",
          "time_finish": "17:00:00",
          "weekday_start": "0",
          "weekday_finish": "0",
          "date_start": "2022-08-05",
          "date_finish": "2023-08-05",
          "destination_person": "",
          "destination_machine": "",
          "callerid": "",
          "prefix": "",
          "concurrentcalls": "2",
          "active_groups": [
            "new test",
            "grpq"
          ]
        },
        {
          "id": "2",
          "name": "campaign2",
          "email": "testgro",
          "email_settings": "100-101",
          "active": false,
          "dupes": "2",
          "time_start": "00:00:01",
          "time_finish": "00:00:02",
          "weekday_start": "1",
          "weekday_finish": "2",
          "date_start": "0000-00-00",
          "date_finish": "0000-00-00",
          "destination_person": "101-abc",
          "destination_machine": "324-123",
          "callerid": "21",
          "prefix": null,
          "concurrentcalls": "2",
          "active_groups": [
            "new test"
          ]
        },
        {
          "id": "3",
          "name": "campaign3",
          "email": "testgro",
          "email_settings": "100-101",
          "active": true,
          "dupes": "2",
          "time_start": "00:00:01",
          "time_finish": "00:00:02",
          "weekday_start": "1",
          "weekday_finish": "2",
          "date_start": "0000-00-00",
          "date_finish": "0000-00-00",
          "destination_person": "101-abc",
          "destination_machine": "324-123",
          "callerid": "21",
          "prefix": null,
          "concurrentcalls": "2",
          "active_groups": []
        }
      ]
    }
  }
}

Start Campaign

Start a campaign in the Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "startCampaign": {
      "message": "Campaign Completed",
      "status": true
    }
  }
}

Stop Campaign

Stop(complete) a campaign in the Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "stopCampaign": {
      "message": "Campaign Completed",
      "status": true
    }
  }
}

Activate Campaign

Activate a campaign in the Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "activateCampaign": {
      "message": "Campaign activated succefully",
      "status": true
    }
  }
}

Deactivate Campaign

Deactivate a campaign in the Freepbx/PBXact system.

...