Call Flows

List existing call flows.

get

Returns a shallow list of call flows without the full node tree. Use the single resource endpoint to retrieve the complete call flow including all nodes and branches.

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Query parameters

start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0

max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of entities.

Default: 50

Responses

200

The call flows

application/json

idinteger · int64Optional

namestringOptional

get/call-flows

HTTPcURLJavaScriptPython

GET /api/call-flows HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

The call flows

[
  {
    "id": 1,
    "name": "text",
    "assignedNumber": {
      "id": 1,
      "name": "text",
      "phoneNumber": {
        "regionCode": "text",
        "number": "text"
      }
    },
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ]
  }
]

Create a new call flow.

post

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Body

application/json

idinteger · int64Optional

namestringRequired

languagestring · enumRequiredPossible values:

Responses

201

The newly created call flow

application/json

idinteger · int64Optional

namestringRequired

languagestring · enumRequiredPossible values:

post/call-flows

HTTPcURLJavaScriptPython

POST /api/call-flows HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 552

{
  "id": 1,
  "name": "text",
  "language": "de",
  "assignedNumber": {
    "id": 1,
    "name": "text",
    "phoneNumber": {
      "regionCode": "text",
      "number": "text"
    }
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "root": {
    "id": 1,
    "name": "text",
    "nodeType": "ROOT",
    "metadata": {
      "textMessage": "text",
      "customAudioUrl": "text",
      "language": "en",
      "aiVoiceModel": "emma"
    },
    "branches": [
      {
        "id": 1,
        "branchType": "BRANCH",
        "condition": "text",
        "target": {
          "id": 1,
          "name": "text",
          "nodeType": "ROOT",
          "metadata": {
            "textMessage": "text",
            "customAudioUrl": "text",
            "language": "en",
            "aiVoiceModel": "emma"
          },
          "branches": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

201

The newly created call flow

{
  "id": 1,
  "name": "text",
  "language": "de",
  "assignedNumber": {
    "id": 1,
    "name": "text",
    "phoneNumber": {
      "regionCode": "text",
      "number": "text"
    }
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "root": {
    "id": 1,
    "name": "text",
    "nodeType": "ROOT",
    "metadata": {
      "textMessage": "text",
      "customAudioUrl": "text",
      "language": "en",
      "aiVoiceModel": "emma"
    },
    "branches": [
      {
        "id": 1,
        "branchType": "BRANCH",
        "condition": "text",
        "target": {
          "id": 1,
          "name": "text",
          "nodeType": "ROOT",
          "metadata": {
            "textMessage": "text",
            "customAudioUrl": "text",
            "language": "en",
            "aiVoiceModel": "emma"
          },
          "branches": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

Get a specific call flow.

get

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Responses

200

The requested call flow

application/json

idinteger · int64Optional

namestringRequired

languagestring · enumRequiredPossible values:

get/call-flows/{id}

HTTPcURLJavaScriptPython

GET /api/call-flows/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

The requested call flow

{
  "id": 1,
  "name": "text",
  "language": "de",
  "assignedNumber": {
    "id": 1,
    "name": "text",
    "phoneNumber": {
      "regionCode": "text",
      "number": "text"
    }
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "root": {
    "id": 1,
    "name": "text",
    "nodeType": "ROOT",
    "metadata": {
      "textMessage": "text",
      "customAudioUrl": "text",
      "language": "en",
      "aiVoiceModel": "emma"
    },
    "branches": [
      {
        "id": 1,
        "branchType": "BRANCH",
        "condition": "text",
        "target": {
          "id": 1,
          "name": "text",
          "nodeType": "ROOT",
          "metadata": {
            "textMessage": "text",
            "customAudioUrl": "text",
            "language": "en",
            "aiVoiceModel": "emma"
          },
          "branches": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

Update a specific call flow.

put

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Body

application/json

idinteger · int64Optional

namestringRequired

languagestring · enumRequiredPossible values:

Responses

200

The updated call flow

application/json

idinteger · int64Optional

namestringRequired

languagestring · enumRequiredPossible values:

put/call-flows/{id}

HTTPcURLJavaScriptPython

PUT /api/call-flows/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 552

{
  "id": 1,
  "name": "text",
  "language": "de",
  "assignedNumber": {
    "id": 1,
    "name": "text",
    "phoneNumber": {
      "regionCode": "text",
      "number": "text"
    }
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "root": {
    "id": 1,
    "name": "text",
    "nodeType": "ROOT",
    "metadata": {
      "textMessage": "text",
      "customAudioUrl": "text",
      "language": "en",
      "aiVoiceModel": "emma"
    },
    "branches": [
      {
        "id": 1,
        "branchType": "BRANCH",
        "condition": "text",
        "target": {
          "id": 1,
          "name": "text",
          "nodeType": "ROOT",
          "metadata": {
            "textMessage": "text",
            "customAudioUrl": "text",
            "language": "en",
            "aiVoiceModel": "emma"
          },
          "branches": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

200

The updated call flow

{
  "id": 1,
  "name": "text",
  "language": "de",
  "assignedNumber": {
    "id": 1,
    "name": "text",
    "phoneNumber": {
      "regionCode": "text",
      "number": "text"
    }
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "root": {
    "id": 1,
    "name": "text",
    "nodeType": "ROOT",
    "metadata": {
      "textMessage": "text",
      "customAudioUrl": "text",
      "language": "en",
      "aiVoiceModel": "emma"
    },
    "branches": [
      {
        "id": 1,
        "branchType": "BRANCH",
        "condition": "text",
        "target": {
          "id": 1,
          "name": "text",
          "nodeType": "ROOT",
          "metadata": {
            "textMessage": "text",
            "customAudioUrl": "text",
            "language": "en",
            "aiVoiceModel": "emma"
          },
          "branches": [
            "[Circular Reference]"
          ]
        }
      }
    ]
  }
}

Delete a specific call flow.

delete

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Responses

204

Empty body delete response

delete/call-flows/{id}

HTTPcURLJavaScriptPython

DELETE /api/call-flows/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

204

Empty body delete response

No content