careCycle
CampaignsTransfer configs

List transfer configs

List all transfer configs for the client

GET
/v2/campaigns/transfer-configs

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

Response Body

application/json

application/json

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/transfer-configs"
{
  "transferConfigs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
      "name": "string",
      "description": "string",
      "configuration": {
        "version": 2,
        "destination": {
          "type": "direct",
          "phoneNumber": "string",
          "externalHandoff": {
            "mode": "cold"
          }
        },
        "drafts": {
          "direct": {
            "type": "direct",
            "phoneNumber": "string",
            "externalHandoff": {
              "mode": "cold"
            }
          },
          "dynamic": {
            "type": "dynamic",
            "pingUrl": "string",
            "method": "GET",
            "timeout": 1,
            "headers": {
              "property1": "string",
              "property2": "string"
            },
            "body": {
              "property1": null,
              "property2": null
            },
            "transferNumberField": "string",
            "transferNumber": "string",
            "successConditions": [
              {
                "field": "string",
                "operator": "equals",
                "value": "string"
              }
            ],
            "fallback": {
              "type": "none"
            },
            "externalHandoff": {
              "mode": "cold"
            }
          },
          "sip": {
            "type": "sip",
            "uri": "string",
            "headers": {
              "property1": "string",
              "property2": "string"
            },
            "externalHandoff": {
              "mode": "cold"
            }
          },
          "softphone": {
            "type": "softphone",
            "routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
            "handoffStrategy": "wait-for-operator",
            "voiceAiFallback": {
              "type": "none"
            },
            "agentWorkspace": {
              "screenBehavior": "call-form",
              "callFormId": "ce7b9bca-896d-440b-961b-042f5bf12d2d"
            },
            "agentFirstHandling": {
              "callback": {
                "offerEnabled": true,
                "abandonOfferEnabled": true,
                "expiryMinutes": 15,
                "maxAttempts": 1,
                "retryDelayMinutes": 1,
                "closeBufferMinutes": 5,
                "offerMessage": "string",
                "confirmMessage": "string"
              },
              "primaryVoicemailGreeting": "string",
              "afterHoursVoicemailGreeting": "string"
            }
          }
        },
        "warmTransfer": {
          "mode": "wait-for-operator",
          "summaryPrompt": "string"
        }
      },
      "routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
      "appointmentConfigId": "1c7d76df-b376-45c7-a6f4-7e4bd224ddc2",
      "callFormId": "ce7b9bca-896d-440b-961b-042f5bf12d2d",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "routingConfig": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "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": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
            "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",
            "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
            "priority": -2147483648,
            "weight": -2147483648,
            "lastCallAt": "2019-08-24T14:15:22Z",
            "isActive": true,
            "skills": "string",
            "member": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "createdAt": "2019-08-24T14:15:22Z",
              "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
              "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
              "role": "string",
              "removedAt": "2019-08-24T14:15:22Z",
              "removedByUserId": "0ab9d7f1-8348-48e7-a45a-4e4f67bcb432",
              "removedReason": "string",
              "replacementMemberId": "901a8fdf-3dae-42cd-8a64-909f4c74e8b3",
              "filterData": "string",
              "user": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "name": "string",
                "email": "user@example.com"
              }
            }
          }
        ],
        "groups": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
            "name": "string",
            "description": "string",
            "routingType": "linear",
            "priority": -2147483648,
            "isActive": true,
            "agents": [
              {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
                "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",
                "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
                "priority": -2147483648,
                "weight": -2147483648,
                "lastCallAt": "2019-08-24T14:15:22Z",
                "isActive": true,
                "skills": "string",
                "member": {
                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                  "createdAt": "2019-08-24T14:15:22Z",
                  "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
                  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
                  "role": "string",
                  "removedAt": "2019-08-24T14:15:22Z",
                  "removedByUserId": "0ab9d7f1-8348-48e7-a45a-4e4f67bcb432",
                  "removedReason": "string",
                  "replacementMemberId": "901a8fdf-3dae-42cd-8a64-909f4c74e8b3",
                  "filterData": "string",
                  "user": {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "name": "string",
                    "email": "user@example.com"
                  }
                }
              }
            ]
          }
        ]
      },
      "readiness": {
        "ready": true,
        "issues": [
          {
            "section": "string",
            "message": "string"
          }
        ]
      },
      "compatibilityWarnings": [],
      "assignedCampaignCount": 0,
      "usedByCampaigns": [
        {
          "id": "string",
          "name": "string",
          "kind": "string",
          "status": "string"
        }
      ],
      "usedByReceptionist": true
    }
  ],
  "total": 0
}
{
  "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"
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "string"
}