curl --request PATCH \
--url https://api.cozmox.ai/campaign/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"assistantId": "<string>",
"workflowId": "<string>",
"phoneNumberId": "<string>",
"schedulePlan": {
"earliestAt": "2023-11-07T05:31:56Z",
"latestAt": "2023-11-07T05:31:56Z"
},
"status": "ended"
}
'{
"status": "scheduled",
"name": "Q2 Sales Campaign",
"phoneNumberId": "<string>",
"customers": [
{
"numberE164CheckEnabled": true,
"extension": null,
"assistantOverrides": {
"transcriber": {
"provider": "assembly-ai",
"language": "en",
"confidenceThreshold": 0.4,
"enableUniversalStreamingApi": false,
"formatTurns": false,
"endOfTurnConfidenceThreshold": 0.7,
"minEndOfTurnSilenceWhenConfident": 160,
"wordFinalizationMaxWaitTime": 160,
"maxTurnSilence": 400,
"realtimeUrl": "<string>",
"wordBoost": [
"<string>"
],
"endUtteranceSilenceThreshold": 123,
"disablePartialTranscripts": true,
"fallbackPlan": {
"transcribers": [
{
"provider": "assembly-ai",
"language": "en",
"confidenceThreshold": 0.4,
"enableUniversalStreamingApi": false,
"formatTurns": false,
"endOfTurnConfidenceThreshold": 0.7,
"minEndOfTurnSilenceWhenConfident": 160,
"wordFinalizationMaxWaitTime": 160,
"maxTurnSilence": 400,
"realtimeUrl": "<string>",
"wordBoost": [
"<string>"
],
"endUtteranceSilenceThreshold": 123,
"disablePartialTranscripts": true
}
]
}
},
"model": {
"model": "claude-3-opus-20240229",
"provider": "anthropic",
"messages": [
{
"content": "<string>",
"role": "assistant"
}
],
"tools": [
{
"type": "apiRequest",
"method": "POST",
"url": "<string>",
"messages": [
{
"type": "request-start",
"contents": [
"<unknown>"
],
"blocking": false,
"content": "<string>",
"conditions": [
{
"operator": "eq",
"param": "<string>",
"value": "<string>"
}
]
}
],
"timeoutSeconds": 20,
"name": "<string>",
"description": "<string>",
"body": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"pattern": "<string>",
"format": "date-time",
"required": [
"<string>"
],
"enum": [
"<string>"
],
"title": "<string>"
},
"headers": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"pattern": "<string>",
"format": "date-time",
"required": [
"<string>"
],
"enum": [
"<string>"
],
"title": "<string>"
},
"backoffPlan": {
"type": "fixed",
"maxRetries": 0,
"baseDelaySeconds": 1
},
"variableExtractionPlan": {
"schema": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"pattern": "<string>",
"format": "date-time",
"required": [
"<string>"
],
"enum": [
"<string>"
],
"title": "<string>"
},
"aliases": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"function": {
"name": "<string>",
"strict": false,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
}
}
],
"toolIds": [
"<string>"
],
"knowledgeBase": {
"provider": "custom-knowledge-base",
"server": {
"timeoutSeconds": 20,
"url": "<string>",
"headers": {},
"backoffPlan": {
"type": "fixed",
"maxRetries": 0,
"baseDelaySeconds": 1
}
}
},
"knowledgeBaseId": "<string>",
"thinking": {
"type": "enabled",
"budgetTokens": 50512
},
"temperature": 1,
"maxTokens": 5025,
"emotionRecognitionEnabled": true,
"numFastTurns": 1
},
"voice": {
"provider": "azure",
"voiceId": "andrew",
"cachingEnabled": true,
"chunkPlan": {
"enabled": true,
"minCharacters": 30,
"punctuationBoundaries": [
"。",
",",
".",
"!",
"?",
";",
"،",
"۔",
"।",
"॥",
"|",
"||",
",",
":"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"type": "exact",
"key": "<string>",
"value": "<string>",
"replaceAllEnabled": false
}
],
"formattersEnabled": "markdown"
}
},
"speed": 1.25,
"fallbackPlan": {
"voices": [
{
"provider": "azure",
"voiceId": "andrew",
"cachingEnabled": true,
"speed": 1.25,
"chunkPlan": {
"enabled": true,
"minCharacters": 30,
"punctuationBoundaries": [
"。",
",",
".",
"!",
"?",
";",
"،",
"۔",
"।",
"॥",
"|",
"||",
",",
":"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"type": "exact",
"key": "<string>",
"value": "<string>",
"replaceAllEnabled": false
}
],
"formattersEnabled": "markdown"
}
}
}
]
}
},
"firstMessage": "Hello! How can I help you today?",
"firstMessageInterruptionsEnabled": false,
"firstMessageMode": "assistant-speaks-first",
"voicemailDetection": {
"provider": "google",
"beepMaxAwaitSeconds": 30,
"backoffPlan": {
"startAtSeconds": 5,
"frequencySeconds": 5,
"maxRetries": 6
}
},
"clientMessages": [
"conversation-update",
"function-call",
"hang",
"model-output",
"speech-update",
"status-update",
"transfer-update",
"transcript",
"tool-calls",
"user-interrupted",
"voice-input",
"workflow.node.started"
],
"serverMessages": [
"conversation-update",
"end-of-call-report",
"function-call",
"hang",
"speech-update",
"status-update",
"tool-calls",
"transfer-destination-request",
"user-interrupted"
],
"silenceTimeoutSeconds": 30,
"maxDurationSeconds": 600,
"backgroundSound": "office",
"backgroundDenoisingEnabled": false,
"modelOutputInMessagesEnabled": false,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 60,
"record": false,
"recordingChannels": "mono"
}
],
"observabilityPlan": {
"provider": "langfuse",
"tags": [
"<string>"
],
"metadata": {}
},
"credentials": [
{
"provider": "anthropic",
"apiKey": "<string>",
"name": "<string>"
}
],
"hooks": [
{
"on": "call.ending",
"do": [
{
"type": "transfer",
"destination": {
"type": "number",
"number": "<string>",
"message": "<string>",
"numberE164CheckEnabled": true,
"extension": "<string>",
"callerId": "<string>",
"transferPlan": {
"mode": "blind-transfer",
"message": "<string>",
"timeout": 60,
"sipVerb": "refer",
"holdAudioUrl": "<string>",
"transferCompleteAudioUrl": "<string>",
"twiml": "<string>",
"summaryPlan": {
"messages": [
{}
],
"enabled": true,
"timeoutSeconds": 30.5
},
"sipHeadersInReferToEnabled": true,
"fallbackPlan": {
"message": "<string>",
"endCallEnabled": true
}
},
"description": "<string>"
}
}
],
"filters": [
{
"type": "oneOf",
"key": "<string>",
"oneOf": [
"<string>"
]
}
]
}
],
"variableValues": {},
"name": "<string>",
"voicemailMessage": "<string>",
"endCallMessage": "<string>",
"endCallPhrases": [
"<string>"
],
"compliancePlan": {
"hipaaEnabled": {
"hipaaEnabled": false
},
"pciEnabled": {
"pciEnabled": false
}
},
"metadata": {},
"backgroundSpeechDenoisingPlan": {
"smartDenoisingPlan": {
"enabled": false
},
"fourierDenoisingPlan": {
"enabled": false,
"mediaDetectionEnabled": true,
"staticThreshold": -35,
"baselineOffsetDb": -15,
"windowSizeMs": 3000,
"baselinePercentile": 85
}
},
"analysisPlan": {
"minMessagesThreshold": 1,
"summaryPlan": {
"messages": [
{}
],
"enabled": true,
"timeoutSeconds": 30.5
},
"structuredDataPlan": {
"messages": [
{}
],
"enabled": true,
"schema": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"pattern": "<string>",
"format": "date-time",
"required": [
"<string>"
],
"enum": [
"<string>"
],
"title": "<string>"
},
"timeoutSeconds": 30.5
},
"structuredDataMultiPlan": [
{
"key": "<string>",
"plan": {
"messages": [
{}
],
"enabled": true,
"schema": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"pattern": "<string>",
"format": "date-time",
"required": [
"<string>"
],
"enum": [
"<string>"
],
"title": "<string>"
},
"timeoutSeconds": 30.5
}
}
],
"successEvaluationPlan": {
"rubric": "NumericScale",
"messages": [
{}
],
"enabled": true,
"timeoutSeconds": 30.5
}
},
"artifactPlan": {
"recordingEnabled": true,
"recordingFormat": "wav;l16",
"videoRecordingEnabled": false,
"pcapEnabled": true,
"pcapS3PathPrefix": "/pcaps",
"transcriptPlan": {
"enabled": true,
"assistantName": "<string>",
"userName": "<string>"
},
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": [
"<string>"
],
"idleMessageMaxSpokenCount": 5.5,
"idleMessageResetCountOnUserSpeechEnabled": true,
"idleTimeoutSeconds": 32.5,
"silenceTimeoutMessage": "<string>"
},
"startSpeakingPlan": {
"waitSeconds": 0.4,
"smartEndpointingEnabled": false,
"smartEndpointingPlan": {
"provider": "cozmox"
},
"customEndpointingRules": [
{
"type": "assistant",
"regex": "<string>",
"timeoutSeconds": 7.5,
"regexOptions": [
{
"type": "ignore-case",
"enabled": true
}
]
}
],
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 0.1,
"onNoPunctuationSeconds": 1.5,
"onNumberSeconds": 0.5
}
},
"stopSpeakingPlan": {
"numWords": 0,
"voiceSeconds": 0.2,
"backoffSeconds": 1,
"acknowledgementPhrases": [
"i understand",
"i see",
"i got it",
"i hear you",
"im listening",
"im with you",
"right",
"okay",
"ok",
"sure",
"alright",
"got it",
"understood",
"yeah",
"yes",
"uh-huh",
"mm-hmm",
"gotcha",
"mhmm",
"ah",
"yeah okay",
"yeah sure"
],
"interruptionPhrases": [
"stop",
"shut",
"up",
"enough",
"quiet",
"silence",
"but",
"dont",
"not",
"no",
"hold",
"wait",
"cut",
"pause",
"nope",
"nah",
"nevermind",
"never",
"bad",
"actually"
]
},
"monitorPlan": {
"listenEnabled": false,
"listenAuthenticationEnabled": false,
"controlEnabled": false,
"controlAuthenticationEnabled": false
},
"credentialIds": [
"<string>"
],
"server": {
"timeoutSeconds": 20,
"url": "<string>",
"headers": {},
"backoffPlan": {
"type": "fixed",
"maxRetries": 0,
"baseDelaySeconds": 1
}
},
"keypadInputPlan": {
"enabled": true,
"timeoutSeconds": 5,
"delimiters": "#"
}
},
"number": "<string>",
"sipUri": "<string>",
"name": "<string>",
"email": "<string>",
"externalId": "<string>"
}
],
"id": "<string>",
"orgId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"calls": {},
"callsCounterScheduled": 123,
"callsCounterQueued": 123,
"callsCounterInProgress": 123,
"callsCounterEndedVoicemail": 123,
"callsCounterEnded": 123,
"endedReason": "campaign.scheduled.ended-by-user",
"assistantId": "<string>",
"workflowId": "<string>",
"schedulePlan": {
"earliestAt": "2023-11-07T05:31:56Z",
"latestAt": "2023-11-07T05:31:56Z"
}
}curl --request PATCH \
--url https://api.cozmox.ai/campaign/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"assistantId": "<string>",
"workflowId": "<string>",
"phoneNumberId": "<string>",
"schedulePlan": {
"earliestAt": "2023-11-07T05:31:56Z",
"latestAt": "2023-11-07T05:31:56Z"
},
"status": "ended"
}
'{
"status": "scheduled",
"name": "Q2 Sales Campaign",
"phoneNumberId": "<string>",
"customers": [
{
"numberE164CheckEnabled": true,
"extension": null,
"assistantOverrides": {
"transcriber": {
"provider": "assembly-ai",
"language": "en",
"confidenceThreshold": 0.4,
"enableUniversalStreamingApi": false,
"formatTurns": false,
"endOfTurnConfidenceThreshold": 0.7,
"minEndOfTurnSilenceWhenConfident": 160,
"wordFinalizationMaxWaitTime": 160,
"maxTurnSilence": 400,
"realtimeUrl": "<string>",
"wordBoost": [
"<string>"
],
"endUtteranceSilenceThreshold": 123,
"disablePartialTranscripts": true,
"fallbackPlan": {
"transcribers": [
{
"provider": "assembly-ai",
"language": "en",
"confidenceThreshold": 0.4,
"enableUniversalStreamingApi": false,
"formatTurns": false,
"endOfTurnConfidenceThreshold": 0.7,
"minEndOfTurnSilenceWhenConfident": 160,
"wordFinalizationMaxWaitTime": 160,
"maxTurnSilence": 400,
"realtimeUrl": "<string>",
"wordBoost": [
"<string>"
],
"endUtteranceSilenceThreshold": 123,
"disablePartialTranscripts": true
}
]
}
},
"model": {
"model": "claude-3-opus-20240229",
"provider": "anthropic",
"messages": [
{
"content": "<string>",
"role": "assistant"
}
],
"tools": [
{
"type": "apiRequest",
"method": "POST",
"url": "<string>",
"messages": [
{
"type": "request-start",
"contents": [
"<unknown>"
],
"blocking": false,
"content": "<string>",
"conditions": [
{
"operator": "eq",
"param": "<string>",
"value": "<string>"
}
]
}
],
"timeoutSeconds": 20,
"name": "<string>",
"description": "<string>",
"body": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"pattern": "<string>",
"format": "date-time",
"required": [
"<string>"
],
"enum": [
"<string>"
],
"title": "<string>"
},
"headers": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"pattern": "<string>",
"format": "date-time",
"required": [
"<string>"
],
"enum": [
"<string>"
],
"title": "<string>"
},
"backoffPlan": {
"type": "fixed",
"maxRetries": 0,
"baseDelaySeconds": 1
},
"variableExtractionPlan": {
"schema": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"pattern": "<string>",
"format": "date-time",
"required": [
"<string>"
],
"enum": [
"<string>"
],
"title": "<string>"
},
"aliases": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"function": {
"name": "<string>",
"strict": false,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
}
}
],
"toolIds": [
"<string>"
],
"knowledgeBase": {
"provider": "custom-knowledge-base",
"server": {
"timeoutSeconds": 20,
"url": "<string>",
"headers": {},
"backoffPlan": {
"type": "fixed",
"maxRetries": 0,
"baseDelaySeconds": 1
}
}
},
"knowledgeBaseId": "<string>",
"thinking": {
"type": "enabled",
"budgetTokens": 50512
},
"temperature": 1,
"maxTokens": 5025,
"emotionRecognitionEnabled": true,
"numFastTurns": 1
},
"voice": {
"provider": "azure",
"voiceId": "andrew",
"cachingEnabled": true,
"chunkPlan": {
"enabled": true,
"minCharacters": 30,
"punctuationBoundaries": [
"。",
",",
".",
"!",
"?",
";",
"،",
"۔",
"।",
"॥",
"|",
"||",
",",
":"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"type": "exact",
"key": "<string>",
"value": "<string>",
"replaceAllEnabled": false
}
],
"formattersEnabled": "markdown"
}
},
"speed": 1.25,
"fallbackPlan": {
"voices": [
{
"provider": "azure",
"voiceId": "andrew",
"cachingEnabled": true,
"speed": 1.25,
"chunkPlan": {
"enabled": true,
"minCharacters": 30,
"punctuationBoundaries": [
"。",
",",
".",
"!",
"?",
";",
"،",
"۔",
"।",
"॥",
"|",
"||",
",",
":"
],
"formatPlan": {
"enabled": true,
"numberToDigitsCutoff": 2025,
"replacements": [
{
"type": "exact",
"key": "<string>",
"value": "<string>",
"replaceAllEnabled": false
}
],
"formattersEnabled": "markdown"
}
}
}
]
}
},
"firstMessage": "Hello! How can I help you today?",
"firstMessageInterruptionsEnabled": false,
"firstMessageMode": "assistant-speaks-first",
"voicemailDetection": {
"provider": "google",
"beepMaxAwaitSeconds": 30,
"backoffPlan": {
"startAtSeconds": 5,
"frequencySeconds": 5,
"maxRetries": 6
}
},
"clientMessages": [
"conversation-update",
"function-call",
"hang",
"model-output",
"speech-update",
"status-update",
"transfer-update",
"transcript",
"tool-calls",
"user-interrupted",
"voice-input",
"workflow.node.started"
],
"serverMessages": [
"conversation-update",
"end-of-call-report",
"function-call",
"hang",
"speech-update",
"status-update",
"tool-calls",
"transfer-destination-request",
"user-interrupted"
],
"silenceTimeoutSeconds": 30,
"maxDurationSeconds": 600,
"backgroundSound": "office",
"backgroundDenoisingEnabled": false,
"modelOutputInMessagesEnabled": false,
"transportConfigurations": [
{
"provider": "twilio",
"timeout": 60,
"record": false,
"recordingChannels": "mono"
}
],
"observabilityPlan": {
"provider": "langfuse",
"tags": [
"<string>"
],
"metadata": {}
},
"credentials": [
{
"provider": "anthropic",
"apiKey": "<string>",
"name": "<string>"
}
],
"hooks": [
{
"on": "call.ending",
"do": [
{
"type": "transfer",
"destination": {
"type": "number",
"number": "<string>",
"message": "<string>",
"numberE164CheckEnabled": true,
"extension": "<string>",
"callerId": "<string>",
"transferPlan": {
"mode": "blind-transfer",
"message": "<string>",
"timeout": 60,
"sipVerb": "refer",
"holdAudioUrl": "<string>",
"transferCompleteAudioUrl": "<string>",
"twiml": "<string>",
"summaryPlan": {
"messages": [
{}
],
"enabled": true,
"timeoutSeconds": 30.5
},
"sipHeadersInReferToEnabled": true,
"fallbackPlan": {
"message": "<string>",
"endCallEnabled": true
}
},
"description": "<string>"
}
}
],
"filters": [
{
"type": "oneOf",
"key": "<string>",
"oneOf": [
"<string>"
]
}
]
}
],
"variableValues": {},
"name": "<string>",
"voicemailMessage": "<string>",
"endCallMessage": "<string>",
"endCallPhrases": [
"<string>"
],
"compliancePlan": {
"hipaaEnabled": {
"hipaaEnabled": false
},
"pciEnabled": {
"pciEnabled": false
}
},
"metadata": {},
"backgroundSpeechDenoisingPlan": {
"smartDenoisingPlan": {
"enabled": false
},
"fourierDenoisingPlan": {
"enabled": false,
"mediaDetectionEnabled": true,
"staticThreshold": -35,
"baselineOffsetDb": -15,
"windowSizeMs": 3000,
"baselinePercentile": 85
}
},
"analysisPlan": {
"minMessagesThreshold": 1,
"summaryPlan": {
"messages": [
{}
],
"enabled": true,
"timeoutSeconds": 30.5
},
"structuredDataPlan": {
"messages": [
{}
],
"enabled": true,
"schema": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"pattern": "<string>",
"format": "date-time",
"required": [
"<string>"
],
"enum": [
"<string>"
],
"title": "<string>"
},
"timeoutSeconds": 30.5
},
"structuredDataMultiPlan": [
{
"key": "<string>",
"plan": {
"messages": [
{}
],
"enabled": true,
"schema": {
"type": "string",
"items": {},
"properties": {},
"description": "<string>",
"pattern": "<string>",
"format": "date-time",
"required": [
"<string>"
],
"enum": [
"<string>"
],
"title": "<string>"
},
"timeoutSeconds": 30.5
}
}
],
"successEvaluationPlan": {
"rubric": "NumericScale",
"messages": [
{}
],
"enabled": true,
"timeoutSeconds": 30.5
}
},
"artifactPlan": {
"recordingEnabled": true,
"recordingFormat": "wav;l16",
"videoRecordingEnabled": false,
"pcapEnabled": true,
"pcapS3PathPrefix": "/pcaps",
"transcriptPlan": {
"enabled": true,
"assistantName": "<string>",
"userName": "<string>"
},
"recordingPath": "<string>"
},
"messagePlan": {
"idleMessages": [
"<string>"
],
"idleMessageMaxSpokenCount": 5.5,
"idleMessageResetCountOnUserSpeechEnabled": true,
"idleTimeoutSeconds": 32.5,
"silenceTimeoutMessage": "<string>"
},
"startSpeakingPlan": {
"waitSeconds": 0.4,
"smartEndpointingEnabled": false,
"smartEndpointingPlan": {
"provider": "cozmox"
},
"customEndpointingRules": [
{
"type": "assistant",
"regex": "<string>",
"timeoutSeconds": 7.5,
"regexOptions": [
{
"type": "ignore-case",
"enabled": true
}
]
}
],
"transcriptionEndpointingPlan": {
"onPunctuationSeconds": 0.1,
"onNoPunctuationSeconds": 1.5,
"onNumberSeconds": 0.5
}
},
"stopSpeakingPlan": {
"numWords": 0,
"voiceSeconds": 0.2,
"backoffSeconds": 1,
"acknowledgementPhrases": [
"i understand",
"i see",
"i got it",
"i hear you",
"im listening",
"im with you",
"right",
"okay",
"ok",
"sure",
"alright",
"got it",
"understood",
"yeah",
"yes",
"uh-huh",
"mm-hmm",
"gotcha",
"mhmm",
"ah",
"yeah okay",
"yeah sure"
],
"interruptionPhrases": [
"stop",
"shut",
"up",
"enough",
"quiet",
"silence",
"but",
"dont",
"not",
"no",
"hold",
"wait",
"cut",
"pause",
"nope",
"nah",
"nevermind",
"never",
"bad",
"actually"
]
},
"monitorPlan": {
"listenEnabled": false,
"listenAuthenticationEnabled": false,
"controlEnabled": false,
"controlAuthenticationEnabled": false
},
"credentialIds": [
"<string>"
],
"server": {
"timeoutSeconds": 20,
"url": "<string>",
"headers": {},
"backoffPlan": {
"type": "fixed",
"maxRetries": 0,
"baseDelaySeconds": 1
}
},
"keypadInputPlan": {
"enabled": true,
"timeoutSeconds": 5,
"delimiters": "#"
}
},
"number": "<string>",
"sipUri": "<string>",
"name": "<string>",
"email": "<string>",
"externalId": "<string>"
}
],
"id": "<string>",
"orgId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"calls": {},
"callsCounterScheduled": 123,
"callsCounterQueued": 123,
"callsCounterInProgress": 123,
"callsCounterEndedVoicemail": 123,
"callsCounterEnded": 123,
"endedReason": "campaign.scheduled.ended-by-user",
"assistantId": "<string>",
"workflowId": "<string>",
"schedulePlan": {
"earliestAt": "2023-11-07T05:31:56Z",
"latestAt": "2023-11-07T05:31:56Z"
}
}This is the name of the campaign. This is just for your own reference.
This is the assistant ID that will be used for the campaign calls. Can only be updated if campaign is not in progress or has ended.
This is the workflow ID that will be used for the campaign calls. Can only be updated if campaign is not in progress or has ended.
This is the phone number ID that will be used for the campaign calls. Can only be updated if campaign is not in progress or has ended.
This is the schedule plan for the campaign. Can only be updated if campaign is not in progress or has ended.
Show child attributes
This is the status of the campaign. Can only be updated to 'ended' if you want to end the campaign. When set to 'ended', it will delete all scheduled calls. Calls in progress will be allowed to complete.
ended This is the status of the campaign.
scheduled, in-progress, ended This is the name of the campaign. This is just for your own reference.
"Q2 Sales Campaign"
This is the phone number ID that will be used for the campaign calls.
These are the customers that will be called in the campaign.
Show child attributes
This is the unique identifier for the campaign.
This is the unique identifier for the org that this campaign belongs to.
This is the ISO 8601 date-time string of when the campaign was created.
This is the ISO 8601 date-time string of when the campaign was last updated.
This is a map of call IDs to campaign call details.
This is the number of calls that have been scheduled.
This is the number of calls that have been queued.
This is the number of calls that have been in progress.
This is the number of calls whose ended reason is 'voicemail'.
This is the number of calls that have ended.
This is the explanation for how the campaign ended.
campaign.scheduled.ended-by-user, campaign.in-progress.ended-by-user, campaign.ended.success This is the assistant ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both.
This is the workflow ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both.
This is the schedule plan for the campaign.
Show child attributes