Get Campaign

GEThttps://api.voxia.ai/campaigns/{campaignId}

Authorization

apiKey

Path parameters

campaignId*string

Id of the campaign as a string ObjectId value.

Response

default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('https://api.voxia.ai/campaigns/{campaignId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

{
  "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
}