Zmiana stanu kampanii
PUT
/v1/accounts/{accountId}/campaigns/{campaignId}/stateAktywuje, wstrzymuje, wznawia lub anuluje kampanię.
Dozwolone zmiany to:
Draft→Active: aktywuje kampanię. Walidowane są wszystkie ustawienia, a kampania statyczna musi mieć numery, z wartościami wszystkich zmiennych używanych przez jej przepływy połączeń.Active→Paused: wstrzymuje kampanię.Paused→Active: wznawia kampanię.ActivelubPaused→Canceled: anuluje kampanię. Anulowanej kampanii nie można ponownie aktywować, ale można ją zduplikować.
Stan Finished jest ustawiany automatycznie przez SIP Caller i nie można go ustawić za pomocą tego endpointu. Pozostałe zmiany zwracają 409 Conflict. Wysłanie bieżącego stanu niczego nie zmienia. Więcej szczegółów znajdziesz na stronie Kampanie w podręczniku użytkownika.
Parametry ścieżki
accountIduuidWymagane
ID Twojego konta SIP Caller. Zobacz ID konta.
campaignIduuidWymagane
ID kampanii.
Treść żądania
Nowy stan jako ciąg JSON (w cudzysłowie), na przykład "Active". Możliwe wartości to Active, Paused i Canceled.
Zwraca
Zwraca zaktualizowany obiekt kampanii.
PUT
/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/state
cURL
curl -X PUT 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/state' \
-H 'Authorization: Bearer API_KEY_TOKEN' \
-H 'Content-Type: application/json' \
-d '"Active"'Odpowiedź
200 OK
{
"id": "01a0e2b4-5c1d-7f3a-9b2e-6d8c4a1f0e27",
"name": "Q4 Renewals",
"tagIds": [],
"state": "Active",
"activeStatus": "Running",
"runningPriority": "Normal",
"phoneSystemId": "0199817e-52e0-7079-9585-99a655c2acb3",
"extensionId": "93e5cdfc-6e42-4995-8263-9388a9047c29",
"dialer": {
"mode": "Predictive",
"intensity": 0
},
"startDate": "2026-10-01",
"endDate": null,
"holidayGroupId": null,
"timeZoneId": "America/New_York",
"workingTimes": {
"monday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"wednesday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"friday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"saturday": [],
"sunday": []
},
"numberProvisioning": "Dynamic",
"numberSelection": "Fifo",
"numberPriority": "RetryPending",
"callPrefix": "",
"ringTimeout": {
"value": 30,
"unit": "Seconds"
},
"maxAttempts": 3,
"retryIntervals": [
{
"value": 1,
"unit": "Hours"
},
{
"value": 1,
"unit": "Days"
}
],
"blackListIds": [
"01a0dedd-b9a2-729d-8e0a-4e3ad9197aea"
],
"callHandling": {
"$t": "Callflow",
"answerTypeDetector": {
"$t": "AmdAgent",
"amdAgentId": "019f9cef-4a91-7c97-b7cd-edbb06a5038d",
"unknownAnswerTreatment": "Human",
"messageForVoicemail": {
"$t": "OnFirstDetection",
"callflowId": "019f81ba-a149-731a-a6cb-b47146c5f90d",
"isCallRetryEnabled": true
}
},
"callflowId": "019f9cd5-e8cd-716b-a9a6-37c9db2f97a2",
"ttsVoiceId": "azu-en-US-AvaMultilingualNeural"
},
"webhookEndpointId": "019af0c3-62d6-70f2-84a1-5ab5671721bb",
"numbersCount": 1250,
"progress": {
"notContacted": 610,
"contacting": 12,
"success": 402,
"failure": 96,
"retryPending": 118,
"blacklisted": 12,
"deleted": 0
},
"varNames": [
"Customer Name",
"Due Balance"
],
"isArchived": false,
"interactionLabels": [
{
"id": "a6d5b2e5-6b3f-49d8-aaa3-bc7b4c693f05",
"label": "Renewal confirmation"
}
],
"createdAt": "2026-09-28T14:02:11.482",
"updatedAt": "2026-10-01T09:00:02.731",
"deletedAt": null,
"startedAt": "2026-10-01T09:00:04.118",
"endedAt": null
}
