> For the complete documentation index, see [llms.txt](https://docs.ilert.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ilert.com/developer-docs/rest-api/api-reference/call-flows.md).
# Call Flows
## List existing call flows.
> 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.
```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.9-r.4"},"tags":[{"name":"Call Flows"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user more info.","name":"Authorization","in":"header"}},"schemas":{"CallFlowListItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"assignedNumber":{"$ref":"#/components/schemas/CallFlowNumber"},"teams":{"type":"array","items":{"$ref":"#/components/schemas/TeamRel"}},"managedBy":{"$ref":"#/components/schemas/ManagedBy"}}},"CallFlowNumber":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}}},"PhoneNumber":{"type":"object","properties":{"regionCode":{"type":"string"},"number":{"type":"string"}}},"TeamRel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"ManagedBy":{"type":"object","readOnly":true,"description":"Present when this entity is managed outside of the ilert web app, for example through Terraform, Pulumi or the API. Read-only.","properties":{"type":{"type":"string","enum":["API","TERRAFORM","PULUMI","ILERT"]},"source":{"type":"string","description":"Identifier of the system managing this entity."}}}}},"paths":{"/call-flows":{"get":{"tags":["Call Flows"],"summary":"List existing call flows.","description":"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.","parameters":[{"name":"start-index","in":"query","description":"an integer specifying the starting point (beginning with 0) when paging through a list of entities","schema":{"type":"integer","format":"int32","default":0}},{"name":"max-results","in":"query","description":"the maximum number of results when paging through a list of entities.","schema":{"maximum":100,"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"The call flows","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowListItem"}}}}}}}}}}
```
## POST /call-flows
> Create a new call flow.
```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.9-r.4"},"tags":[{"name":"Call Flows"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user more info.","name":"Authorization","in":"header"}},"schemas":{"CallFlow":{"type":"object","required":["name","language","root"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"language":{"type":"string","enum":["de","en"]},"assignedNumber":{"$ref":"#/components/schemas/CallFlowNumber"},"teams":{"type":"array","items":{"$ref":"#/components/schemas/TeamRel"}},"root":{"$ref":"#/components/schemas/CallFlowNode"},"managedBy":{"$ref":"#/components/schemas/ManagedBy"}}},"CallFlowNumber":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}}},"PhoneNumber":{"type":"object","properties":{"regionCode":{"type":"string"},"number":{"type":"string"}}},"TeamRel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"CallFlowNode":{"type":"object","required":["nodeType"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"nodeType":{"type":"string","enum":["ROOT","IVR_MENU","AUDIO_MESSAGE","SUPPORT_HOURS","ROUTE_CALL","PARALLEL_ROUTE_CALL","VOICEMAIL","PIN_CODE","CREATE_ALERT","BLOCK_NUMBERS","AGENTIC","DEFINE_BRANCHES"]},"metadata":{"$ref":"#/components/schemas/CallFlowNodeMetadata"},"branches":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowBranch"}}}},"CallFlowNodeMetadata":{"oneOf":[{"$ref":"#/components/schemas/CallFlowNodeMetadataAudioMessage"},{"$ref":"#/components/schemas/CallFlowNodeMetadataIvrMenu"},{"$ref":"#/components/schemas/CallFlowNodeMetadataVoicemail"},{"$ref":"#/components/schemas/CallFlowNodeMetadataPinCode"},{"$ref":"#/components/schemas/CallFlowNodeMetadataSupportHours"},{"$ref":"#/components/schemas/CallFlowNodeMetadataRouteCall"},{"$ref":"#/components/schemas/CallFlowNodeMetadataCreateAlert"},{"$ref":"#/components/schemas/CallFlowNodeMetadataBlockNumbers"},{"$ref":"#/components/schemas/CallFlowNodeMetadataAgentic"},{"$ref":"#/components/schemas/CallFlowNodeMetadataDefineBranches"}]},"CallFlowNodeMetadataAudioMessage":{"type":"object","properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]}}},"CallFlowNodeMetadataIvrMenu":{"type":"object","required":["enabledOptions"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"enabledOptions":{"type":"array","items":{"type":"string"}},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"retries":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataVoicemail":{"type":"object","properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"disableTranscription":{"type":"boolean"}}},"CallFlowNodeMetadataPinCode":{"type":"object","required":["codes"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"codes":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataCode"}},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"retries":{"type":"integer","format":"int64"},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]}}},"CallFlowNodeMetadataCode":{"type":"object","required":["label"],"properties":{"code":{"type":"integer","format":"int64"},"label":{"type":"string"}}},"CallFlowNodeMetadataSupportHours":{"type":"object","required":["supportHoursId"],"properties":{"supportHoursId":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataRouteCall":{"type":"object","required":["targets"],"properties":{"holdAudioUrl":{"type":"string"},"targets":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataCallTarget"}},"callStyle":{"type":"string","enum":["ORDERED","RANDOM","PARALLEL"]},"retries":{"type":"integer","format":"int64"},"callTimeoutSec":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataCallTarget":{"type":"object","required":["target","type"],"properties":{"target":{"type":"string"},"type":{"type":"string","enum":["USER","ON_CALL_SCHEDULE","NUMBER"]}}},"CallFlowNodeMetadataCreateAlert":{"type":"object","required":["alertSourceId"],"properties":{"alertSourceId":{"type":"integer","format":"int64"},"acceptAlertOnAnswer":{"type":"boolean"}}},"CallFlowNodeMetadataBlockNumbers":{"type":"object","required":["blacklist"],"properties":{"blacklist":{"type":"array","items":{"type":"string"}}}},"CallFlowNodeMetadataAgentic":{"type":"object","required":["textMessage","intents"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"intents":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataIntent"}},"gathers":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataGather"}},"enrichment":{"$ref":"#/components/schemas/CallFlowNodeMetadataEnrichment"}}},"CallFlowNodeMetadataIntent":{"type":"object","properties":{"type":{"type":"string","enum":["INCIDENT","SYSTEM_OUTAGE","SECURITY_BREACH","TECHNICAL_SUPPORT","INQUIRY"]},"label":{"type":"string"},"description":{"type":"string"}}},"CallFlowNodeMetadataGather":{"type":"object","properties":{"type":{"type":"string","enum":["CALLER_NAME","CONTACT_NUMBER","EMAIL","INCIDENT","AFFECTED_SERVICES"]},"label":{"type":"string"},"varType":{"type":"string","enum":["NUMBER","DATE","BOOLEAN","STRING"]},"required":{"type":"boolean"},"question":{"type":"string"}}},"CallFlowNodeMetadataEnrichment":{"type":"object","properties":{"enabled":{"type":"boolean"},"informationTypes":{"type":"array","items":{"type":"string","enum":["INCIDENT","MAINTENANCE","SERVICE_STATUS"]}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataEnrichmentSource"}}}},"CallFlowNodeMetadataEnrichmentSource":{"type":"object","required":["id","type"],"properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["STATUS_PAGE","SERVICE"]}}},"CallFlowNodeMetadataDefineBranches":{"type":"object","required":["definitions"],"properties":{"definitions":{"type":"array","minItems":1,"maxItems":8,"description":"Evaluated in order. The name of the first definition whose conditions match is stored as `matchingBranchName` (empty if none match). Route on it with branches of condition `context.matchingBranchName == ''`, plus an optional CATCH_ALL branch.","items":{"type":"object","required":["branchName","conditions"],"properties":{"branchName":{"type":"string","description":"Unique within the node. Must not contain `'` or `\\`."},"conditions":{"type":"string","description":"ICL expression evaluated against the call session, e.g. `context.fromCountry in [\"DE\", \"AT\"]`. Available session fields include `from`, `to`, `fromCountry`, `fromState`, `fromCity`, `fromZip`, `forwardedFrom`, `stirVerstat` and values written by earlier nodes such as `ivrChoice`. Location fields are derived from the caller's phone number and are absent when the caller is anonymous."}}}}}},"CallFlowBranch":{"type":"object","required":["branchType"],"properties":{"id":{"type":"integer","format":"int64"},"branchType":{"type":"string","enum":["BRANCH","CATCH_ALL","ANSWERED"]},"condition":{"type":"string"},"target":{"$ref":"#/components/schemas/CallFlowNode"}}},"ManagedBy":{"type":"object","readOnly":true,"description":"Present when this entity is managed outside of the ilert web app, for example through Terraform, Pulumi or the API. Read-only.","properties":{"type":{"type":"string","enum":["API","TERRAFORM","PULUMI","ILERT"]},"source":{"type":"string","description":"Identifier of the system managing this entity."}}}}},"paths":{"/call-flows":{"post":{"tags":["Call Flows"],"summary":"Create a new call flow.","requestBody":{"description":"the call flow","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallFlow"}}},"required":true},"responses":{"201":{"description":"The newly created call flow","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallFlow"}}}}}}}}}
```
## GET /call-flows/{id}
> Get a specific call flow.
```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.9-r.4"},"tags":[{"name":"Call Flows"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user more info.","name":"Authorization","in":"header"}},"schemas":{"CallFlow":{"type":"object","required":["name","language","root"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"language":{"type":"string","enum":["de","en"]},"assignedNumber":{"$ref":"#/components/schemas/CallFlowNumber"},"teams":{"type":"array","items":{"$ref":"#/components/schemas/TeamRel"}},"root":{"$ref":"#/components/schemas/CallFlowNode"},"managedBy":{"$ref":"#/components/schemas/ManagedBy"}}},"CallFlowNumber":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}}},"PhoneNumber":{"type":"object","properties":{"regionCode":{"type":"string"},"number":{"type":"string"}}},"TeamRel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"CallFlowNode":{"type":"object","required":["nodeType"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"nodeType":{"type":"string","enum":["ROOT","IVR_MENU","AUDIO_MESSAGE","SUPPORT_HOURS","ROUTE_CALL","PARALLEL_ROUTE_CALL","VOICEMAIL","PIN_CODE","CREATE_ALERT","BLOCK_NUMBERS","AGENTIC","DEFINE_BRANCHES"]},"metadata":{"$ref":"#/components/schemas/CallFlowNodeMetadata"},"branches":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowBranch"}}}},"CallFlowNodeMetadata":{"oneOf":[{"$ref":"#/components/schemas/CallFlowNodeMetadataAudioMessage"},{"$ref":"#/components/schemas/CallFlowNodeMetadataIvrMenu"},{"$ref":"#/components/schemas/CallFlowNodeMetadataVoicemail"},{"$ref":"#/components/schemas/CallFlowNodeMetadataPinCode"},{"$ref":"#/components/schemas/CallFlowNodeMetadataSupportHours"},{"$ref":"#/components/schemas/CallFlowNodeMetadataRouteCall"},{"$ref":"#/components/schemas/CallFlowNodeMetadataCreateAlert"},{"$ref":"#/components/schemas/CallFlowNodeMetadataBlockNumbers"},{"$ref":"#/components/schemas/CallFlowNodeMetadataAgentic"},{"$ref":"#/components/schemas/CallFlowNodeMetadataDefineBranches"}]},"CallFlowNodeMetadataAudioMessage":{"type":"object","properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]}}},"CallFlowNodeMetadataIvrMenu":{"type":"object","required":["enabledOptions"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"enabledOptions":{"type":"array","items":{"type":"string"}},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"retries":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataVoicemail":{"type":"object","properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"disableTranscription":{"type":"boolean"}}},"CallFlowNodeMetadataPinCode":{"type":"object","required":["codes"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"codes":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataCode"}},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"retries":{"type":"integer","format":"int64"},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]}}},"CallFlowNodeMetadataCode":{"type":"object","required":["label"],"properties":{"code":{"type":"integer","format":"int64"},"label":{"type":"string"}}},"CallFlowNodeMetadataSupportHours":{"type":"object","required":["supportHoursId"],"properties":{"supportHoursId":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataRouteCall":{"type":"object","required":["targets"],"properties":{"holdAudioUrl":{"type":"string"},"targets":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataCallTarget"}},"callStyle":{"type":"string","enum":["ORDERED","RANDOM","PARALLEL"]},"retries":{"type":"integer","format":"int64"},"callTimeoutSec":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataCallTarget":{"type":"object","required":["target","type"],"properties":{"target":{"type":"string"},"type":{"type":"string","enum":["USER","ON_CALL_SCHEDULE","NUMBER"]}}},"CallFlowNodeMetadataCreateAlert":{"type":"object","required":["alertSourceId"],"properties":{"alertSourceId":{"type":"integer","format":"int64"},"acceptAlertOnAnswer":{"type":"boolean"}}},"CallFlowNodeMetadataBlockNumbers":{"type":"object","required":["blacklist"],"properties":{"blacklist":{"type":"array","items":{"type":"string"}}}},"CallFlowNodeMetadataAgentic":{"type":"object","required":["textMessage","intents"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"intents":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataIntent"}},"gathers":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataGather"}},"enrichment":{"$ref":"#/components/schemas/CallFlowNodeMetadataEnrichment"}}},"CallFlowNodeMetadataIntent":{"type":"object","properties":{"type":{"type":"string","enum":["INCIDENT","SYSTEM_OUTAGE","SECURITY_BREACH","TECHNICAL_SUPPORT","INQUIRY"]},"label":{"type":"string"},"description":{"type":"string"}}},"CallFlowNodeMetadataGather":{"type":"object","properties":{"type":{"type":"string","enum":["CALLER_NAME","CONTACT_NUMBER","EMAIL","INCIDENT","AFFECTED_SERVICES"]},"label":{"type":"string"},"varType":{"type":"string","enum":["NUMBER","DATE","BOOLEAN","STRING"]},"required":{"type":"boolean"},"question":{"type":"string"}}},"CallFlowNodeMetadataEnrichment":{"type":"object","properties":{"enabled":{"type":"boolean"},"informationTypes":{"type":"array","items":{"type":"string","enum":["INCIDENT","MAINTENANCE","SERVICE_STATUS"]}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataEnrichmentSource"}}}},"CallFlowNodeMetadataEnrichmentSource":{"type":"object","required":["id","type"],"properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["STATUS_PAGE","SERVICE"]}}},"CallFlowNodeMetadataDefineBranches":{"type":"object","required":["definitions"],"properties":{"definitions":{"type":"array","minItems":1,"maxItems":8,"description":"Evaluated in order. The name of the first definition whose conditions match is stored as `matchingBranchName` (empty if none match). Route on it with branches of condition `context.matchingBranchName == ''`, plus an optional CATCH_ALL branch.","items":{"type":"object","required":["branchName","conditions"],"properties":{"branchName":{"type":"string","description":"Unique within the node. Must not contain `'` or `\\`."},"conditions":{"type":"string","description":"ICL expression evaluated against the call session, e.g. `context.fromCountry in [\"DE\", \"AT\"]`. Available session fields include `from`, `to`, `fromCountry`, `fromState`, `fromCity`, `fromZip`, `forwardedFrom`, `stirVerstat` and values written by earlier nodes such as `ivrChoice`. Location fields are derived from the caller's phone number and are absent when the caller is anonymous."}}}}}},"CallFlowBranch":{"type":"object","required":["branchType"],"properties":{"id":{"type":"integer","format":"int64"},"branchType":{"type":"string","enum":["BRANCH","CATCH_ALL","ANSWERED"]},"condition":{"type":"string"},"target":{"$ref":"#/components/schemas/CallFlowNode"}}},"ManagedBy":{"type":"object","readOnly":true,"description":"Present when this entity is managed outside of the ilert web app, for example through Terraform, Pulumi or the API. Read-only.","properties":{"type":{"type":"string","enum":["API","TERRAFORM","PULUMI","ILERT"]},"source":{"type":"string","description":"Identifier of the system managing this entity."}}}}},"paths":{"/call-flows/{id}":{"get":{"tags":["Call Flows"],"summary":"Get a specific call flow.","parameters":[{"name":"id","in":"path","description":"entity ID","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"The requested call flow","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallFlow"}}}}}}}}}
```
## PUT /call-flows/{id}
> Update a specific call flow.
```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.9-r.4"},"tags":[{"name":"Call Flows"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user more info.","name":"Authorization","in":"header"}},"schemas":{"CallFlow":{"type":"object","required":["name","language","root"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"language":{"type":"string","enum":["de","en"]},"assignedNumber":{"$ref":"#/components/schemas/CallFlowNumber"},"teams":{"type":"array","items":{"$ref":"#/components/schemas/TeamRel"}},"root":{"$ref":"#/components/schemas/CallFlowNode"},"managedBy":{"$ref":"#/components/schemas/ManagedBy"}}},"CallFlowNumber":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}}},"PhoneNumber":{"type":"object","properties":{"regionCode":{"type":"string"},"number":{"type":"string"}}},"TeamRel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"CallFlowNode":{"type":"object","required":["nodeType"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"nodeType":{"type":"string","enum":["ROOT","IVR_MENU","AUDIO_MESSAGE","SUPPORT_HOURS","ROUTE_CALL","PARALLEL_ROUTE_CALL","VOICEMAIL","PIN_CODE","CREATE_ALERT","BLOCK_NUMBERS","AGENTIC","DEFINE_BRANCHES"]},"metadata":{"$ref":"#/components/schemas/CallFlowNodeMetadata"},"branches":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowBranch"}}}},"CallFlowNodeMetadata":{"oneOf":[{"$ref":"#/components/schemas/CallFlowNodeMetadataAudioMessage"},{"$ref":"#/components/schemas/CallFlowNodeMetadataIvrMenu"},{"$ref":"#/components/schemas/CallFlowNodeMetadataVoicemail"},{"$ref":"#/components/schemas/CallFlowNodeMetadataPinCode"},{"$ref":"#/components/schemas/CallFlowNodeMetadataSupportHours"},{"$ref":"#/components/schemas/CallFlowNodeMetadataRouteCall"},{"$ref":"#/components/schemas/CallFlowNodeMetadataCreateAlert"},{"$ref":"#/components/schemas/CallFlowNodeMetadataBlockNumbers"},{"$ref":"#/components/schemas/CallFlowNodeMetadataAgentic"},{"$ref":"#/components/schemas/CallFlowNodeMetadataDefineBranches"}]},"CallFlowNodeMetadataAudioMessage":{"type":"object","properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]}}},"CallFlowNodeMetadataIvrMenu":{"type":"object","required":["enabledOptions"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"enabledOptions":{"type":"array","items":{"type":"string"}},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"retries":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataVoicemail":{"type":"object","properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"disableTranscription":{"type":"boolean"}}},"CallFlowNodeMetadataPinCode":{"type":"object","required":["codes"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"codes":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataCode"}},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"retries":{"type":"integer","format":"int64"},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]}}},"CallFlowNodeMetadataCode":{"type":"object","required":["label"],"properties":{"code":{"type":"integer","format":"int64"},"label":{"type":"string"}}},"CallFlowNodeMetadataSupportHours":{"type":"object","required":["supportHoursId"],"properties":{"supportHoursId":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataRouteCall":{"type":"object","required":["targets"],"properties":{"holdAudioUrl":{"type":"string"},"targets":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataCallTarget"}},"callStyle":{"type":"string","enum":["ORDERED","RANDOM","PARALLEL"]},"retries":{"type":"integer","format":"int64"},"callTimeoutSec":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataCallTarget":{"type":"object","required":["target","type"],"properties":{"target":{"type":"string"},"type":{"type":"string","enum":["USER","ON_CALL_SCHEDULE","NUMBER"]}}},"CallFlowNodeMetadataCreateAlert":{"type":"object","required":["alertSourceId"],"properties":{"alertSourceId":{"type":"integer","format":"int64"},"acceptAlertOnAnswer":{"type":"boolean"}}},"CallFlowNodeMetadataBlockNumbers":{"type":"object","required":["blacklist"],"properties":{"blacklist":{"type":"array","items":{"type":"string"}}}},"CallFlowNodeMetadataAgentic":{"type":"object","required":["textMessage","intents"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"intents":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataIntent"}},"gathers":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataGather"}},"enrichment":{"$ref":"#/components/schemas/CallFlowNodeMetadataEnrichment"}}},"CallFlowNodeMetadataIntent":{"type":"object","properties":{"type":{"type":"string","enum":["INCIDENT","SYSTEM_OUTAGE","SECURITY_BREACH","TECHNICAL_SUPPORT","INQUIRY"]},"label":{"type":"string"},"description":{"type":"string"}}},"CallFlowNodeMetadataGather":{"type":"object","properties":{"type":{"type":"string","enum":["CALLER_NAME","CONTACT_NUMBER","EMAIL","INCIDENT","AFFECTED_SERVICES"]},"label":{"type":"string"},"varType":{"type":"string","enum":["NUMBER","DATE","BOOLEAN","STRING"]},"required":{"type":"boolean"},"question":{"type":"string"}}},"CallFlowNodeMetadataEnrichment":{"type":"object","properties":{"enabled":{"type":"boolean"},"informationTypes":{"type":"array","items":{"type":"string","enum":["INCIDENT","MAINTENANCE","SERVICE_STATUS"]}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataEnrichmentSource"}}}},"CallFlowNodeMetadataEnrichmentSource":{"type":"object","required":["id","type"],"properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["STATUS_PAGE","SERVICE"]}}},"CallFlowNodeMetadataDefineBranches":{"type":"object","required":["definitions"],"properties":{"definitions":{"type":"array","minItems":1,"maxItems":8,"description":"Evaluated in order. The name of the first definition whose conditions match is stored as `matchingBranchName` (empty if none match). Route on it with branches of condition `context.matchingBranchName == ''`, plus an optional CATCH_ALL branch.","items":{"type":"object","required":["branchName","conditions"],"properties":{"branchName":{"type":"string","description":"Unique within the node. Must not contain `'` or `\\`."},"conditions":{"type":"string","description":"ICL expression evaluated against the call session, e.g. `context.fromCountry in [\"DE\", \"AT\"]`. Available session fields include `from`, `to`, `fromCountry`, `fromState`, `fromCity`, `fromZip`, `forwardedFrom`, `stirVerstat` and values written by earlier nodes such as `ivrChoice`. Location fields are derived from the caller's phone number and are absent when the caller is anonymous."}}}}}},"CallFlowBranch":{"type":"object","required":["branchType"],"properties":{"id":{"type":"integer","format":"int64"},"branchType":{"type":"string","enum":["BRANCH","CATCH_ALL","ANSWERED"]},"condition":{"type":"string"},"target":{"$ref":"#/components/schemas/CallFlowNode"}}},"ManagedBy":{"type":"object","readOnly":true,"description":"Present when this entity is managed outside of the ilert web app, for example through Terraform, Pulumi or the API. Read-only.","properties":{"type":{"type":"string","enum":["API","TERRAFORM","PULUMI","ILERT"]},"source":{"type":"string","description":"Identifier of the system managing this entity."}}}}},"paths":{"/call-flows/{id}":{"put":{"tags":["Call Flows"],"summary":"Update a specific call flow.","parameters":[{"name":"id","in":"path","description":"entity ID","required":true,"schema":{"type":"number"}}],"requestBody":{"description":"the call flow","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallFlow"}}},"required":true},"responses":{"200":{"description":"The updated call flow","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallFlow"}}}}}}}}}
```
## DELETE /call-flows/{id}
> Delete a specific call flow.
```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.9-r.4"},"tags":[{"name":"Call Flows"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user more info.","name":"Authorization","in":"header"}}},"paths":{"/call-flows/{id}":{"delete":{"tags":["Call Flows"],"summary":"Delete a specific call flow.","parameters":[{"name":"id","in":"path","description":"entity ID","required":true,"schema":{"type":"number"}}],"responses":{"204":{"description":"Empty body delete response","content":{}}}}}}}
```
## GET /call-flows/name/{name}
> Get the call flow with the specified name.
```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.9-r.4"},"tags":[{"name":"Call Flows"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user more info.","name":"Authorization","in":"header"}},"schemas":{"CallFlow":{"type":"object","required":["name","language","root"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"language":{"type":"string","enum":["de","en"]},"assignedNumber":{"$ref":"#/components/schemas/CallFlowNumber"},"teams":{"type":"array","items":{"$ref":"#/components/schemas/TeamRel"}},"root":{"$ref":"#/components/schemas/CallFlowNode"},"managedBy":{"$ref":"#/components/schemas/ManagedBy"}}},"CallFlowNumber":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"}}},"PhoneNumber":{"type":"object","properties":{"regionCode":{"type":"string"},"number":{"type":"string"}}},"TeamRel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"CallFlowNode":{"type":"object","required":["nodeType"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"nodeType":{"type":"string","enum":["ROOT","IVR_MENU","AUDIO_MESSAGE","SUPPORT_HOURS","ROUTE_CALL","PARALLEL_ROUTE_CALL","VOICEMAIL","PIN_CODE","CREATE_ALERT","BLOCK_NUMBERS","AGENTIC","DEFINE_BRANCHES"]},"metadata":{"$ref":"#/components/schemas/CallFlowNodeMetadata"},"branches":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowBranch"}}}},"CallFlowNodeMetadata":{"oneOf":[{"$ref":"#/components/schemas/CallFlowNodeMetadataAudioMessage"},{"$ref":"#/components/schemas/CallFlowNodeMetadataIvrMenu"},{"$ref":"#/components/schemas/CallFlowNodeMetadataVoicemail"},{"$ref":"#/components/schemas/CallFlowNodeMetadataPinCode"},{"$ref":"#/components/schemas/CallFlowNodeMetadataSupportHours"},{"$ref":"#/components/schemas/CallFlowNodeMetadataRouteCall"},{"$ref":"#/components/schemas/CallFlowNodeMetadataCreateAlert"},{"$ref":"#/components/schemas/CallFlowNodeMetadataBlockNumbers"},{"$ref":"#/components/schemas/CallFlowNodeMetadataAgentic"},{"$ref":"#/components/schemas/CallFlowNodeMetadataDefineBranches"}]},"CallFlowNodeMetadataAudioMessage":{"type":"object","properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]}}},"CallFlowNodeMetadataIvrMenu":{"type":"object","required":["enabledOptions"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"enabledOptions":{"type":"array","items":{"type":"string"}},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"retries":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataVoicemail":{"type":"object","properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"disableTranscription":{"type":"boolean"}}},"CallFlowNodeMetadataPinCode":{"type":"object","required":["codes"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"codes":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataCode"}},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"retries":{"type":"integer","format":"int64"},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]}}},"CallFlowNodeMetadataCode":{"type":"object","required":["label"],"properties":{"code":{"type":"integer","format":"int64"},"label":{"type":"string"}}},"CallFlowNodeMetadataSupportHours":{"type":"object","required":["supportHoursId"],"properties":{"supportHoursId":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataRouteCall":{"type":"object","required":["targets"],"properties":{"holdAudioUrl":{"type":"string"},"targets":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataCallTarget"}},"callStyle":{"type":"string","enum":["ORDERED","RANDOM","PARALLEL"]},"retries":{"type":"integer","format":"int64"},"callTimeoutSec":{"type":"integer","format":"int64"}}},"CallFlowNodeMetadataCallTarget":{"type":"object","required":["target","type"],"properties":{"target":{"type":"string"},"type":{"type":"string","enum":["USER","ON_CALL_SCHEDULE","NUMBER"]}}},"CallFlowNodeMetadataCreateAlert":{"type":"object","required":["alertSourceId"],"properties":{"alertSourceId":{"type":"integer","format":"int64"},"acceptAlertOnAnswer":{"type":"boolean"}}},"CallFlowNodeMetadataBlockNumbers":{"type":"object","required":["blacklist"],"properties":{"blacklist":{"type":"array","items":{"type":"string"}}}},"CallFlowNodeMetadataAgentic":{"type":"object","required":["textMessage","intents"],"properties":{"textMessage":{"type":"string"},"customAudioUrl":{"type":"string"},"language":{"type":"string","enum":["en","de","fr","es","nl","ru","it"]},"aiVoiceModel":{"type":"string","enum":["emma","liam","isabelle","gordon","ivy","ellen"]},"intents":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataIntent"}},"gathers":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataGather"}},"enrichment":{"$ref":"#/components/schemas/CallFlowNodeMetadataEnrichment"}}},"CallFlowNodeMetadataIntent":{"type":"object","properties":{"type":{"type":"string","enum":["INCIDENT","SYSTEM_OUTAGE","SECURITY_BREACH","TECHNICAL_SUPPORT","INQUIRY"]},"label":{"type":"string"},"description":{"type":"string"}}},"CallFlowNodeMetadataGather":{"type":"object","properties":{"type":{"type":"string","enum":["CALLER_NAME","CONTACT_NUMBER","EMAIL","INCIDENT","AFFECTED_SERVICES"]},"label":{"type":"string"},"varType":{"type":"string","enum":["NUMBER","DATE","BOOLEAN","STRING"]},"required":{"type":"boolean"},"question":{"type":"string"}}},"CallFlowNodeMetadataEnrichment":{"type":"object","properties":{"enabled":{"type":"boolean"},"informationTypes":{"type":"array","items":{"type":"string","enum":["INCIDENT","MAINTENANCE","SERVICE_STATUS"]}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowNodeMetadataEnrichmentSource"}}}},"CallFlowNodeMetadataEnrichmentSource":{"type":"object","required":["id","type"],"properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["STATUS_PAGE","SERVICE"]}}},"CallFlowNodeMetadataDefineBranches":{"type":"object","required":["definitions"],"properties":{"definitions":{"type":"array","minItems":1,"maxItems":8,"description":"Evaluated in order. The name of the first definition whose conditions match is stored as `matchingBranchName` (empty if none match). Route on it with branches of condition `context.matchingBranchName == ''`, plus an optional CATCH_ALL branch.","items":{"type":"object","required":["branchName","conditions"],"properties":{"branchName":{"type":"string","description":"Unique within the node. Must not contain `'` or `\\`."},"conditions":{"type":"string","description":"ICL expression evaluated against the call session, e.g. `context.fromCountry in [\"DE\", \"AT\"]`. Available session fields include `from`, `to`, `fromCountry`, `fromState`, `fromCity`, `fromZip`, `forwardedFrom`, `stirVerstat` and values written by earlier nodes such as `ivrChoice`. Location fields are derived from the caller's phone number and are absent when the caller is anonymous."}}}}}},"CallFlowBranch":{"type":"object","required":["branchType"],"properties":{"id":{"type":"integer","format":"int64"},"branchType":{"type":"string","enum":["BRANCH","CATCH_ALL","ANSWERED"]},"condition":{"type":"string"},"target":{"$ref":"#/components/schemas/CallFlowNode"}}},"ManagedBy":{"type":"object","readOnly":true,"description":"Present when this entity is managed outside of the ilert web app, for example through Terraform, Pulumi or the API. Read-only.","properties":{"type":{"type":"string","enum":["API","TERRAFORM","PULUMI","ILERT"]},"source":{"type":"string","description":"Identifier of the system managing this entity."}}}}},"paths":{"/call-flows/name/{name}":{"get":{"tags":["Call Flows"],"summary":"Get the call flow with the specified name.","parameters":[{"name":"name","in":"path","description":"unique name of the call flow","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested call flow","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallFlow"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.ilert.com/developer-docs/rest-api/api-reference/call-flows.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.