Create transfer config
Create a new transfer config
Authorization
x-api-key API key required for authentication.
Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.
In: header
Request Body
application/json
POST /v2/campaigns/transfer-configs Request body
TypeScript Definitions
Use the request body type in TypeScript.
Transfer config name
Routing config ID for inbound call routing
Appointment config used when this destination falls back to booking. Required when softphoneFallbackType is appointment_booking.
Auto-navigate the agent to this screen when they accept a transferred call
Call form the receiving agent sees on the 'call-form' screen for this destination. Optional override; falls back to the campaign form, then the client default.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.carecycle.ai/v2/campaigns/transfer-configs" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"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",
"softphoneHandoffStrategy": "wait-for-operator",
"softphoneFallbackPhoneNumber": "string",
"appointmentBookingEnabled": true,
"appointmentConfigId": "1c7d76df-b376-45c7-a6f4-7e4bd224ddc2",
"transferWaitingMessages": [
"string"
],
"screenBehavior": "call-form",
"callFormId": "ce7b9bca-896d-440b-961b-042f5bf12d2d"
}
}{
"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"
}
],
"failedRecords": [
{
"index": 0,
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"externalId": "string"
}
]
}{
"message": "string",
"code": "string",
"retryAfter": 0
}{
"message": "string",
"code": "string"
}