/v1/conversations/{id}/design (GET)

GET

/v1/conversations/{id}/design

curl --request GET \
  --url https://service.testing.nairon.cloud/v1/conversations/example/design \
  --header 'Authorization: Bearer <token>'

• Service API

Authorizations

• bearerAuth
• apiKeyHeader

Parameters

Path Parameters

id

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

Responses

200

Default Response

Media typeapplication/json

Any of:

object

object

schemaVersion

required

string

Allowed values: cd/1

entry

required

object

stepId

required

string

>= 1 characters

alternates

Array<string>

steps

required

object

key

additional properties

One of:

object

object

kind

required

string

Allowed values: greeting

name

string

introLine

string

persona

object

whoAmI

string

purpose

string

on

required

object

next

string

>= 1 characters

object

object

kind

required

string

Allowed values: talk

name

string

topic

required

string

knowledgeRefs

Array<string>

strict

boolean

on

required

object

done

string

>= 1 characters

offTopic

string

>= 1 characters

object

object

kind

required

string

Allowed values: route

name

string

ask

boolean

question

string

options

Array<object>

object

id

required

string

>= 1 characters

title

string

description

string

target

string

>= 1 characters

on

required

object

default

string

>= 1 characters

object

object

kind

required

string

Allowed values: collect

name

string

format

required

string

Allowed values: text number object

prompt

required

string

variable

string

>= 1 characters

on

required

object

answered

string

>= 1 characters

fallback

string

>= 1 characters

object

object

kind

required

string

Allowed values: keypad

name

string

prompt

required

string

variable

string

>= 1 characters

timeoutSeconds

integer

>= -9007199254740991 <= 9007199254740991

on

required

object

completed

string

>= 1 characters

timeout

string

>= 1 characters

object

object

kind

required

string

Allowed values: confirm

name

string

prompt

required

string

on

required

object

yes

string

>= 1 characters

no

string

>= 1 characters

object

object

kind

required

string

Allowed values: recordingConsent

name

string

prompt

required

string

on

required

object

consent

string

>= 1 characters

decline

string

>= 1 characters

object

object

kind

required

string

Allowed values: end

name

string

summarize

boolean

allowCancel

boolean

on

required

object

cancel

string

>= 1 characters

object

object

kind

required

string

Allowed values: transfer

name

string

target

required

object

type

required

string

Allowed values: internal phone

phoneNumber

string

timeoutSeconds

integer

>= -9007199254740991 <= 9007199254740991

on

required

object

timeout

string

>= 1 characters

object

object

kind

required

string

Allowed values: callback

name

string

schedule

string

Allowed values: slots asap

timeFrames

Array<object>

object

day

required

string

Allowed values: monday tuesday wednesday thursday friday saturday sunday

startTime

required

string

endTime

required

string

askForName

boolean

integrationRef

string

>= 1 characters

on

required

object

success

string

>= 1 characters

failure

string

>= 1 characters

knowledge

Array

One of:

object

object

id

required

string

>= 1 characters

kind

required

string

Allowed values: knowledgeBase

knowledgeBaseId

required

string

>= 1 characters

object

object

id

required

string

>= 1 characters

kind

required

string

Allowed values: text

text

required

string

variables

Array<object>

object

id

required

string

>= 1 characters

name

string

type

required

string

Allowed values: text number object

integrations

Array<object>

object

id

required

string

>= 1 characters

kind

required

string

Allowed values: crm calendar knowledge

integrationId

required

string

>= 1 characters

hooks

object

before

object

rootNodeId

string

>= 1 characters

entryPoints

object

key

additional properties

string

>= 1 characters

nodes

required

object

key

additional properties

object

id

required

string

>= 1 characters

name

string

next

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

webhook

object

url

required

string

headers

object

key

additional properties

string

secretHint

string

signatureHeader

string

payload

required

Array<object>

object

id

required

string

>= 1 characters

key

required

string

source

required

string

Allowed values: variable custom ai

systemVariable

string

variableId

string

>= 1 characters

value

string

aiPrompt

string

timeoutSeconds

integer

>= -9007199254740991 <= 9007199254740991

responseVariableId

string

>= 1 characters

responsePath

string

fetch

object

url

required

string

method

required

string

Allowed values: GET POST

query

object

key

additional properties

string

headers

object

key

additional properties

string

body

Array<object>

object

id

required

string

>= 1 characters

key

required

string

source

required

string

Allowed values: variable custom ai

systemVariable

string

variableId

string

>= 1 characters

value

string

aiPrompt

string

responseFormat

string

Allowed values: json text

responseMappings

required

Array<object>

object

id

required

string

>= 1 characters

variableId

required

string

>= 1 characters

path

string

transform

string

Allowed values: auto text number boolean json

defaultValue

string

condition

One of:

object

object

mode

required

string

Allowed values: logic

branches

required

Array<object>

object

id

required

string

>= 1 characters

label

required

string

predicate

required

object

variable

required

object

systemVariable

string

variableId

string

>= 1 characters

operator

required

string

Allowed values: eq neq exists not_exists gt lt contains

value

string

next

required

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

else

required

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

object

object

mode

required

string

Allowed values: ai

prompt

required

string

branches

required

Array<object>

object

id

required

string

>= 1 characters

label

required

string

description

required

string

next

required

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

else

required

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

setVariable

object

variableId

required

string

>= 1 characters

value

required

string

sendSms

object

to

required

object

systemVariable

string

variableId

string

>= 1 characters

literalString

string

message

required

string

crmLookup

object

integrationRef

required

string

>= 1 characters

matchBy

required

Array<string>

Allowed values: phone email

phoneSource

object

systemVariable

string

variableId

string

>= 1 characters

emailSource

object

systemVariable

string

variableId

string

>= 1 characters

fieldMappings

required

Array<object>

object

id

required

string

>= 1 characters

field

required

string

variableId

required

string

>= 1 characters

defaultValue

string

includePrimaryDeal

boolean

onNotFound

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

crmWrite

object

integrationRef

required

string

>= 1 characters

contactIdSource

required

object

systemVariable

string

variableId

string

>= 1 characters

createContactIfMissing

boolean

operations

required

Array<string>

Allowed values: log_call create_note update_contact

logCall

object

subjectTemplate

string

includeTranscript

required

boolean

includeSummary

required

boolean

includeRecordingUrl

required

boolean

createNote

object

bodyTemplate

required

string

updateContact

object

propertyMappings

required

Array<object>

object

id

required

string

>= 1 characters

property

required

string

propertyLabel

string

source

required

string

Allowed values: variable custom ai

systemVariable

string

variableId

string

>= 1 characters

value

string

aiPrompt

string

after

object

entryPoints

object

key

additional properties

string

>= 1 characters

prematureHangupNodeId

string

>= 1 characters

nodes

required

object

key

additional properties

object

id

required

string

>= 1 characters

name

string

next

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

webhook

object

url

required

string

headers

object

key

additional properties

string

secretHint

string

signatureHeader

string

payload

required

Array<object>

object

id

required

string

>= 1 characters

key

required

string

source

required

string

Allowed values: variable custom ai

systemVariable

string

variableId

string

>= 1 characters

value

string

aiPrompt

string

timeoutSeconds

integer

>= -9007199254740991 <= 9007199254740991

responseVariableId

string

>= 1 characters

responsePath

string

fetch

object

url

required

string

method

required

string

Allowed values: GET POST

query

object

key

additional properties

string

headers

object

key

additional properties

string

body

Array<object>

object

id

required

string

>= 1 characters

key

required

string

source

required

string

Allowed values: variable custom ai

systemVariable

string

variableId

string

>= 1 characters

value

string

aiPrompt

string

responseFormat

string

Allowed values: json text

responseMappings

required

Array<object>

object

id

required

string

>= 1 characters

variableId

required

string

>= 1 characters

path

string

transform

string

Allowed values: auto text number boolean json

defaultValue

string

condition

One of:

object

object

mode

required

string

Allowed values: logic

branches

required

Array<object>

object

id

required

string

>= 1 characters

label

required

string

predicate

required

object

variable

required

object

systemVariable

string

variableId

string

>= 1 characters

operator

required

string

Allowed values: eq neq exists not_exists gt lt contains

value

string

next

required

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

else

required

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

object

object

mode

required

string

Allowed values: ai

prompt

required

string

branches

required

Array<object>

object

id

required

string

>= 1 characters

label

required

string

description

required

string

next

required

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

else

required

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

setVariable

object

variableId

required

string

>= 1 characters

value

required

string

sendSms

object

to

required

object

systemVariable

string

variableId

string

>= 1 characters

literalString

string

message

required

string

crmLookup

object

integrationRef

required

string

>= 1 characters

matchBy

required

Array<string>

Allowed values: phone email

phoneSource

object

systemVariable

string

variableId

string

>= 1 characters

emailSource

object

systemVariable

string

variableId

string

>= 1 characters

fieldMappings

required

Array<object>

object

id

required

string

>= 1 characters

field

required

string

variableId

required

string

>= 1 characters

defaultValue

string

includePrimaryDeal

boolean

onNotFound

object

hookNode

string

>= 1 characters

step

string

>= 1 characters

end

boolean

crmWrite

object

integrationRef

required

string

>= 1 characters

contactIdSource

required

object

systemVariable

string

variableId

string

>= 1 characters

createContactIfMissing

boolean

operations

required

Array<string>

Allowed values: log_call create_note update_contact

logCall

object

subjectTemplate

string

includeTranscript

required

boolean

includeSummary

required

boolean

includeRecordingUrl

required

boolean

createNote

object

bodyTemplate

required

string

updateContact

object

propertyMappings

required

Array<object>

object

id

required

string

>= 1 characters

property

required

string

propertyLabel

string

source

required

string

Allowed values: variable custom ai

systemVariable

string

variableId

string

>= 1 characters

value

string

aiPrompt

string

compliance

object

aiDisclosure

object

key

additional properties

object

status

required

string

Allowed values: approved rejected

checkedText

required

string

reason

string

layout

object

key

additional properties

object

x

required

number

y

required

number

object

object

design

required

object

kind

required

string

Allowed values: simple

agentSimpleUrl

required

string

Example

{
  "schemaVersion": "cd/1",
  "steps": {
    "additionalProperty": {
      "kind": "greeting"
    }
  },
  "knowledge": [
    {
      "kind": "knowledgeBase"
    }
  ],
  "variables": [
    {
      "type": "text"
    }
  ],
  "integrations": [
    {
      "kind": "crm"
    }
  ],
  "hooks": {
    "before": {
      "nodes": {
        "additionalProperty": {
          "next": {
            "end": true
          },
          "webhook": {
            "payload": [
              {
                "source": "variable"
              }
            ]
          },
          "fetch": {
            "method": "GET",
            "body": [
              {
                "source": "variable"
              }
            ],
            "responseFormat": "json",
            "responseMappings": [
              {
                "transform": "auto"
              }
            ]
          },
          "condition": {
            "mode": "logic",
            "branches": [
              {
                "predicate": {
                  "operator": "eq"
                },
                "next": {
                  "end": true
                }
              }
            ],
            "else": {
              "end": true
            }
          },
          "crmLookup": {
            "matchBy": [
              "phone"
            ],
            "onNotFound": {
              "end": true
            }
          },
          "crmWrite": {
            "operations": [
              "log_call"
            ],
            "updateContact": {
              "propertyMappings": [
                {
                  "source": "variable"
                }
              ]
            }
          }
        }
      }
    },
    "after": {
      "nodes": {
        "additionalProperty": {
          "next": {
            "end": true
          },
          "webhook": {
            "payload": [
              {
                "source": "variable"
              }
            ]
          },
          "fetch": {
            "method": "GET",
            "body": [
              {
                "source": "variable"
              }
            ],
            "responseFormat": "json",
            "responseMappings": [
              {
                "transform": "auto"
              }
            ]
          },
          "condition": {
            "mode": "logic",
            "branches": [
              {
                "predicate": {
                  "operator": "eq"
                },
                "next": {
                  "end": true
                }
              }
            ],
            "else": {
              "end": true
            }
          },
          "crmLookup": {
            "matchBy": [
              "phone"
            ],
            "onNotFound": {
              "end": true
            }
          },
          "crmWrite": {
            "operations": [
              "log_call"
            ],
            "updateContact": {
              "propertyMappings": [
                {
                  "source": "variable"
                }
              ]
            }
          }
        }
      }
    }
  },
  "compliance": {
    "aiDisclosure": {
      "additionalProperty": {
        "status": "approved"
      }
    }
  }
}