Get Organization Campaigns

Get all campaigns by organisation id.

Get all campaigns by organisation id. Returns an array of CampaignPublicDto. Supports pagination.

GEThttps://api.voxia.ai/campaigns
Authorization
Query parameters
Response
Body
id*string

The id of the campaign. string representation of a ObjectId.

name*string

The name of the campaign.

active*boolean

The status of the campaign.

startedAt*string

The date and time the campaign started in ISO string format..

finishedAt*string

The date and time the campaign finished in ISO string format.

callParams*all of

The call parameters of the campaign.

organizationId*string

The id of the organization. string representation of a ObjectId.

companyInfo*string

The company info.

incomingPhoneNumberstring

The incoming phone number of the campaign.

webhookUrl*string

The webhook url of the campaign.

slackUrl*string

The slack notifications url of the campaign.

isIncoming*boolean

Boolean value defines if the campaign is incoming or outgoing. True if the campaign is incoming, false if the campaign is outgoing.

Request
const response = await fetch('https://api.voxia.ai/campaigns?organizationId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "id": "text",
    "name": "text",
    "active": false,
    "startedAt": "text",
    "finishedAt": "text",
    "callParams": {
      "phonesFrom": [
        "text"
      ],
      "timezone": "text",
      "daysOfWeek": [
        "text"
      ],
      "language": "text",
      "approvedCountries": [
        "text"
      ]
    },
    "organizationId": "text",
    "companyInfo": "text",
    "incomingPhoneNumber": "text",
    "webhookUrl": "text",
    "slackUrl": "text",
    "isIncoming": false
  }
]

Last updated