Campaigns
Get campaign by ID
Get a specific campaign by ID for the authenticated client
Authorization
x-api-key x-api-key<token>
API key required for authentication.
Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.
In: header
Path Parameters
string
Campaign ID
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Formatuuid
Query Parameters
unknown
Include client information in response
Formatboolean (preprocessed)
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.carecycle.ai/v2/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"campaign": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"dialAfterhours": true,
"name": "string",
"templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
"templateName": "string",
"description": "string",
"status": "draft",
"sourceType": "string",
"enablePulse": true,
"pulseWorkflowId": "6cbf4411-f62a-452f-b47e-a87913280a83",
"maxConcurrentCalls": 1,
"suite": "receptionist",
"maxAttempts": -9007199254740991,
"smsCompanyName": "string",
"requiredVars": [],
"client": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"smsCompanyName": "string"
},
"hasInquiryCallback": true,
"customerStats": {
"total": 0,
"totalCalls": 0,
"todayCalls": 0,
"statusCounts": {
"expired": 0,
"failed": 0,
"pending": 0,
"completed": 0,
"exceeded_max_calls": 0,
"in_progress": 0,
"cancelled": 0,
"skipped": 0
}
},
"features": {
"transfers": false,
"appointments": false,
"inquiries": false,
"checkPlan": false
},
"transferConfig": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": null,
"updatedAt": null,
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"name": "string",
"routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
"type": "direct",
"warmTransfer": true,
"directPhoneNumber": "string",
"dynamicOptions": {
"pingUrl": "string",
"method": "GET",
"timeout": 0,
"headers": {
"property1": "string",
"property2": "string"
},
"body": {
"property1": null,
"property2": null
},
"transferNumberField": "string",
"transferNumber": "string",
"successConditions": [
{
"field": "string",
"operator": "equals",
"value": "string"
}
]
},
"sipUri": "string",
"sipHeaders": "string",
"warmSummaryPrompt": "string",
"warmMode": "wait-for-operator",
"softphoneFallbackType": "appointment_booking",
"softphoneFallbackPhoneNumber": "string",
"appointmentBookingEnabled": true,
"transferWaitingMessages": [
"string"
],
"routingConfig": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": null,
"updatedAt": null,
"name": "string",
"description": "string",
"routingType": "linear",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"fallbackBehavior": "voicemail",
"fallbackNumber": "string",
"maxRingPerAgent": -2147483648,
"maxWaitTime": -2147483648,
"tryCustomerAgentFirst": true,
"tryPreviousSoftphoneAgentFirst": true,
"customerAgentPriority": -2147483648,
"previousSoftphoneAgentPriority": -2147483648,
"stateBasedRouting": true,
"stateRoutingFallback": "fallback",
"agents": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": null,
"updatedAt": null,
"routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
"memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"priority": -2147483648,
"weight": -2147483648,
"lastCallAt": null,
"isActive": true,
"skills": "string",
"member": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": null,
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"role": "string",
"filterData": "string",
"user": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "user@example.com"
}
}
}
],
"groups": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": null,
"updatedAt": null,
"routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
"name": "string",
"description": "string",
"routingType": "linear",
"priority": -2147483648,
"isActive": true,
"agents": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": null,
"updatedAt": null,
"routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
"memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"priority": -2147483648,
"weight": -2147483648,
"lastCallAt": null,
"isActive": true,
"skills": "string",
"member": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": null,
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"role": "string",
"filterData": "string",
"user": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "user@example.com"
}
}
}
]
}
]
}
},
"transferConfigIds": [],
"callFormId": "ce7b9bca-896d-440b-961b-042f5bf12d2d",
"appointmentConfig": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": null,
"updatedAt": null,
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"name": "string",
"concurrentLimit": -2147483648,
"appointmentLength": -2147483648,
"appointmentSpacing": -2147483648,
"maxOptions": -2147483648,
"minDate": "string",
"maxDate": "string",
"minHours": -2147483648,
"preferredMode": "timezone",
"pulseWorkflowId": "6cbf4411-f62a-452f-b47e-a87913280a83",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
},
"campaignAutomations": []
},
"assistants": []
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "VALIDATION_ERROR",
"errors": [
{
"path": [
"string"
],
"message": "string",
"expected": "string",
"received": "string",
"code": "string"
}
]
}{
"message": "string",
"code": "string",
"retryAfter": 0
}{
"message": "string",
"code": "string"
}