Skip to main content
GET
/
campaign
/
{campaignId}
Get campaign
curl --request GET \
  --url https://app2.freyavoice.ai/api/v2/campaign/{campaignId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "campaign": {
        "id": "<string>",
        "name": "<string>",
        "workspaceId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "assistantId": "<string>",
        "phoneNumberId": "<string>",
        "description": "<string>",
        "status": "draft",
        "startDate": "2023-12-25",
        "startTime": "<string>",
        "timezone": "UTC",
        "endTime": "<string>",
        "activeDays": [
          0,
          1,
          2,
          3,
          4,
          5,
          6
        ],
        "phoneNumber": "<string>",
        "callRetries": 0,
        "retryDelaySeconds": 300,
        "retryDelayMode": "fixed",
        "retryConditions": [
          "No Answer",
          "Busy",
          "Timeout",
          "Unreachable",
          "Network Error",
          "Resource Unavailable",
          "Service Unavailable",
          "voicemail"
        ],
        "endDate": "2023-12-25",
        "schedulingMode": "even",
        "callIntervalSeconds": 30,
        "maxConcurrency": 5,
        "webhookUrl": "<string>",
        "customers": [],
        "callIds": [],
        "roomNames": [],
        "events": [],
        "version": "v1"
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId
string<uuid>
required

Campaign ID

Minimum string length: 1

Query Parameters

workspaceId
string<uuid>
required

Workspace ID

Minimum string length: 1

Response

Campaign details

success
enum<boolean>
required
Available options:
true,
false
data
object
required