CDR Models Schema

Dialog Start Object

Field	Type	Description
`app`	object	Application’s data
`asr`	object	deepASR’s instance data
`channel`	string	The channel from which the DIALOG was initiated. The type of channel (IVR, Facebook, Alexa etc..)
`connection_id`	string	The session id of IVR
`destination_uri`	string	The number that was dialed for an incoming call
`device_type`	string	The type of the device that originated the call (landline or mobile)
`diamant`	object	DiaManT’s instance data
`direction`	string	The direction of call (inbound or outbound)
`flow`	object	Flow’s data
`group`	string	The common ID of the orchestrator Dialog and the Flow Dialogs
`hashed_origin_uri`	string	The phone number that originated the call hashed
`id`	string	Dialog’s ID
`incoming_attached_data`	map<string, string>	The KVPs of incoming attached data
`message_type`	string	Object’s type identifier. `dialog_start` for dialog start object
`origin_uri`	string	The phone number that originated the call
`test_flag`	boolean	Flag that indicates if the dialog is for testing purposes
`time`	integer	Dialog’s start time

Example JSON

JSON

{
    "message_type" : "dialog_start",
    "id" : "0914D425259F0CD31DBFE2E72D3785E0",
    "group": "78977ae3796d73ce0df345f43df8df075daa54a6.1683276326110.63abf63debd946c4bbd4592bc3d800b",
    "time" : 1683820113249,
    "origin_uri" : "12345678901",
    "hashed_origin_uri" : "",
    "destination_uri" : "123-456-789",
    "connection_id" : "undefined",
    "channel" : "omIVR",
    "device_type" : "mobile",
    "direction" : "inbound",
    "test_flag" : false,
    "incoming_attached_data": {
        "key_1": "value_1",
        "key_2": "value_2",
        "key_3": "value_3"
    },
    "asr": {
        "mrcp_session_id": "4CF7F72AF04614A4A0FAE63F1A18D20C"
    },
    "diamant": {
        "id": "aws-dev-m-1",
        "version": "10.0.0",
        "region": "aws-us-east-1"
    },
   
    "flow": {
        "id": "4981c99e-6c51-4bd6-9b68-d3c09791d754.Bank3_Test.Banking2.MiniApps.ocp-qa",
        "account_id": "4981c99e-6c51-4bd6-9b68-d3c09791d75",
        "name": "Bank3_Test",
        "type": "Banking2",
        "diamant_app_name": "MiniApps",
        "uuid": "ocp",
        "organization": "ocp",
        "parent_name": "ocp-qa@SND_Card_Payment",
        "parent_id": "ae08b5a59e6a414d83a2556e9bdf160e2e5f97d1.1683276326800.f9e88de990224be7adb50558503bf374",
        "parent_step": 7,
        "root_step": 11,
        "path": ["ocp-qa@SND_banking2_flow_DEVAws",
                "ocp-qa@SND_Card_Payment"
]],
        "path_app_ids": [
            "4981c99e-6c51-4bd6-9b68-d3c09791d75.SND_banking2_flow_DEVAws.Flow.ocp-qa@SND_banking2_flow_DEVAws.ocp-qa",
            "c556e602-a7b5-41cc-86d3-c6f95586339d.SND_Card_Payment.Flow.ocp-qa@SND_Card_Payment.ocp-qa"
        ],
        "reportable": false,
        "reporting_type": ""
    },

    "app": {
        "name": "2011659",
        "version": "200101"
    }
}

app

Field	Type	Description
`name`	string	Application name
`version`	integer	Application version

asr

Field	Type	Description
`mrcp_session_id`	string	MRCP session id

diamant

Field	Type	Description
`id`	string	DiamManT name
`region`	string	DiaManT region
`version`	string	DiaManT version

flow

Field	Type	Description
`id`	string	Flow’s id
`account_id`	string	The Account id that Flow belongs to
`type`	string	Flow’s type
`diamant_app_name`	string	The DiaManT’s application name that Flow belongs to
`uuid`	string	Flow’s unique identifier
`organization`	string	The Organization that Flow belongs to
`parent_name`	string	Flow’s parent Application name
`parent_id`	string	Flow’s parent Dialog Id
`parent_step`	integer	Flow’s parent Dialog step
`root_step`	integer	Flow’s root Dialog step
`path`	array	The path from the root to the Flow that is currently active
`path_app_ids`	array	The path i from the root to the Flow that is currently active
`reportable`	boolean	Flag to indicate if the current flow is eligible for reporting
`reporting_type`	string	The reporting type of the Flow (SelfService, Authentication etc)
`name`	string	Flow’s name

Dialog End Object

Field	Type	Description
`agent-request`	integer	Total number of agent requests
`app`	object	Application’s data
`asr`	object	deepASR’s instance data
`channel`	string	The channel from which the DIALOG was initiated. The type of channel (IVR, Facebook, Alexa etc..)
`connection_id`	string	The session id of IVR
`destination_uri`	string	The number that was dialed for an incoming call
`device_type`	string	The type of the device that originated the call (landline or mobile)
`diamant`	object	DiaManT’s instance data
`direction`	object	The direction of call (inbound or outbound)
`duration`	integer	Dialog’s duration. Cannot be null, initial value is 0.
`end_type`	string	Dialog’s end type (TRANSFER, FAR_HUP, NEAR_HUP, SYSTEM_ERROR, ERROR_SESSION_TIMEOUT, TEARDOWN)
`events`	string	Comma separated list of dialog events.
`exit-attached-data`	map<string, string>	The KVPs of outgoing attached data
`exit_point`	string	The extension number in case of transfer
`exported`	boolean	default value is false. Cannot be null
`flow`	object	Flow’s data
`group`	string	The common ID of the orchestrator Dialog and the Flow Dialogs
`hashed_origin_uri`	string	The phone number that originated the call hashed
`id`	string	Dialog’s Id
`kvps`	array<object>	aggregated list of KVP events
`locale`	string	Dialog’s locale. The language locale that was active at the end of the dialog and is final after selection (prompts, asr grammars, nlu engine).
`message_type`	string	Object’s type identifier. dialog_end for dialog end object
`metrics`	string
`no_inputs`	integer	Total number of no inputs. Initial value is 0.
`no_matches`	integer	Total number of no matches. Initial value is 0.
`rejections`	integer	Total number of low confidence rejections. Initial value is 0.
`same_states`	integer	Total number of same states. Initial value is 0.
`steps_num`	integer	Total number of steps. Initial value is 0.
`origin_uri`	string	The phone number that originated the call
`test_flag`	boolean	Flag that indicates if the dialog is for testing purposes. Default value is `false`.
`time`	integer	Dialog’s start time
`transfer_reason`	string	The reason of transferring the call to an Agent

Example JSON

JSON

{
    "message_type" : "dialog_end",
    "id" : "02dcb1c0fc10b5531546f37c3844684b38b29e44.1683820113249.65dd7a5110d045e28ba47a5891ef928a",
    "group": "02dcb1c0fc10b5531546f37c3844684b38b29e44.1683820113249.65dd7a5110d045e28ba47a5891ef928a",
    "time" : 1683820113249,
    "origin_uri" : "12345678901",
    "hashed_origin_uri" : "",
    "destination_uri" : "123-456-789",
    "connection_id" : "sip:1683820112738:0DE14D29-95D9-4E63-882F-421BC934588D",
    "channel" : "omIVR",
    "device_type" : "voip",
    "direction" : "en-US",
    "steps_num" : 4,
    "no_inputs" : 1,
    "no_matches" : 0,
    "rejections" : 0,
    "same_states" : 0,
    "agent_requests" : 0,
    "duration" : 14445,
    "end_type" : "FAR_HUP",
    "exit_point" : "0080012345",
    "transfer_reason": "",
    "events": "Intent:Online_Banking",
    "locale": "fr-FR",
    "test_flag" : false,
    "exit-attached-data": {
        "key_1": "appId",
        "key_2": "sessionId",
        "key_3": "testMode"
    },
    "asr": {
        "mrcp_session_id": "4CF7F72AF04614A4A0FAE63F1A18D20C"
    },
    "diamant": {
        "id": "aws-staging-m-5",
        "version": "10.0.0",
        "region": "aws-us-east-1"
    },
   
    "flow": {
        "id": "3919ca0c-7299-4600-914d-1ce2022983a1.DateTest_One.Date.MiniApps.ocp-qa",
        "account_id": "3919ca0c-7299-4600-914d-1ce2022983a1",
        "name": "DateTest_One",
        "type": "Date",
        "diamant_app_name": "MiniApps",
        "uuid": "ocp-qa",
        "organization": "ocp",
        "parent_name":"ocp-qa@SND_Card_Payment" ,
        "parent_id": "ae08b5a59e6a414d83a2556e9bdf160e2e5f97d1.1683276326800.f9e88de990224be7adb50558503bf374",
        "parent_step": 2,
        "root_step": 1,
        "path": ["ocp-qa@SND_banking2_flow_DEVAws",
                "ocp-qa@SND_Card_Payment"
            ],
        "path_app_ids": ["4981c99e-6c51-4bd6-9b68-d3c09791d75.SND_banking2_flow_DEVAws.Flow.ocp-qa@SND_banking2_flow_DEVAws.ocp-qa",
            "c556e602-a7b5-41cc-86d3-c6f95586339d.SND_Card_Payment.Flow.ocp-qa@SND_Card_Payment.ocp-qa"
        ],
        "reportable": false,
        "reporting_type": ""
    },
    "app": {
        "name": "2011659",
        "version": 2011261
    },
    "kvps": [
        {
            "step": 1,
            "key": "appId",
            "value":"sip:1683820112738:0DE14D29-95D9-4E63-882F-421BC934588D"
        }
    ]
}

asr

Field	Type	Description
`mrcp_session_id`	string	MRCP session id

flow

Field	Type	Description
`id`	string	Flow’s id
`name`	string	Flow’s name
`account_id`	string	The Account id that Flow belongs to
`type`	string	Flow’s type
`diamant_app_name`	string	The DiaManT’s application name that Flow belongs to
`uuid`	string	Flow’s unique identifier
`organization`	string	The Organization that Flow belongs to
`parent_name`	string	Flow’s parent Application name
`parent_id`	string	Flow’s parent Dialog Id
`parent_step`	integer	Flow’s parent Dialog step
`root_step`	integer	Flow’s root Dialog step
`path`	array	The path from the root to the Flow that is currently active
`path_app_ids`	array	The path i from the root to the Flow that is currently active
`reportable`	boolean	Flag to indicate if the current flow is eligible for reporting
`reporting_type`	string	The reporting type of the Flow (SelfService, Authentication etc)

diamant

Field	Type	Description
`id`	string	DiaManT’s name
`region`	string	The DiaMant’s region
`version`	string	DiaManT’s version

app

Field	Type	Description
`name`	string	Application’s name
`version`	integer	Application’s version

kvps

Field	Type	Description
`key`	string	Session key
`step`	integer	Session step
`value`	string

Dialog Step Object

Field	Type	Description
`action`	object	Dialog’s current action
`app`	object	Application data
`asr`	object	deepASR’s step data
`channel`	string	The channel from which the DIALOG was initiated. The type of channel (IVR, Facebook, Alexa, etc..)
`bio`	object
`diamant`	object	DiaManT’s instance data
`dialog_time`	integer	Dialog’s start time
`events`	list<object>	list of step’s dialog events
`flow`	object	Flow data
`group`	string	The common ID of the orchestrator Dialog and the Flow Dialogs
`id`	string	Dialog’s Id
`input_modality`	string	Step’s input mode (speech, DTMF, text)
`kvps`	map<string, string>	Step’s KVPs data
`locale`	string	Step’s locale.
`message_type`	string	Object’s type identifier. dialog_step for dialog step object
`nlu`	object	deepNLU’s step data
`number`	integer	Step’s number
`original_utterance`	string	User’s original utterance in case of autocorrect
`previous_action`	object	Dialog’s previous action
`security`	object	Step’s security data
`target`	object	Dialog’s current target
`test_flag`	boolean	Flag that indicates that the dialog is for testing purposes
`time`	integer	Step’s timestamp
`transcription`	string	User’s utterance
`voice_id`	string
`WS`	list<object>	Web service data

Example JSON

JSON

{
    "message_type" : "dialog_step",
    "id" : "0914D425259F0CD31DBFE2E72D3785E0",
    "group": "78977ae3796d73ce0df345f43df8df075daa54a6.1683276326110.63abf63debd946c4bbd4592bc3d800b",
    "time" : 1683820113249,
    "number" : 2,
    "dialog_time" : 0,
    "original_utterance" : "I want my balance",
    "transcription" : "I want my balance",
    "channel" : "chat",
    "input_modality" : "dtmf",
    "target" : {
        "name": "Banking",
        "status": "Defined",
        "flow_targets”: [.....]
    },
    "action" : {
        "name": "AnnounceIntent",
        "type": "Ask",
        "subtype": "",
        "pre_action": "Reaction: WelcomeMessageEN",
        "tag": "",
        "prompt": "So, please tell me, how may I help you"
 ,
        "prompt_duration": 2300,
        "timeout": 2500,
        "fields_to_elicit": [
            {
                "name": "intent",
                "type": "Banking"
            }
        ],
        "prompts": [
            {
                "content": "So, please tell me, how may I help you today?;",
                "prompt-urls": [],
                "weighted": []
            }
        ],
        "data_models": [
            {
                "type": "",
                "subtype": "",
                "direction": "",
                "template_name": "",
                "subtitle": "",
                "fallback": "",
                "image": {
                    "label": "",
                    "url": ""
                },
                "interactive_option": {
                    "label": "",
                    "url": "",
                    "image": {
                        "label": "",
                        "url": ""
                    },
                    "semantics": {
                        "key_1": "value_1",
                        "key_2": "value_2",
                        "key_3": "value_3"
                    }
                },
                "entries": [
                    {
                        "header": "",
                        "details": "",
                        "coordinates": "",
                        "image": {
                            "label": "",
                            "url": ""
                        },
                        "interactive_option": {
                            "label": "",
                            "url": "",
                            "image": {
                                "label": "",
                                "url": ""
                            },
                            "semantics": {
                                "key_1": "value_1",
                                "key_2": "value_2",
                                "key_3": "value_3"
                            }
                        }
                    }
                ]
            }
        ]
    },
   
    "previous_action" : {},
   
    "nlu": {
        "result_count": 2,
        "work-flow-id": "",
        "nlu-app": "",
        "result_type": "Recognition",
        "semantic-interpretation": [
            {
                "intent": {
                    "name": "Balance-Inquairy",
                    "status": "Defined",
                    "group": "",
                    "confidence": 100
                },
                "confidence": 99,
                "utterance": "I want to know my balance",
                "entities": [
                    {
                        "name": "",
                        "sensitivity-level": "",
                        "instances": [
                            {
                                "begin": 0,
                                "end": 0,
                                "confidence": 0,
                                "value": "",
                                "covered_text": "",
                                "features": {
                                    "name_1": "value_1",
                                    "name_2": "value_2"
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    },

    "locale": "en-US",
    "test_flag" : false,

    "events": [
        {
            "index": 1,
            "active_intent": "Balance-Inquiry",
            "task_id": "123abc45-12ab-0a00-aa12-1122aa11abc1",
            "intent_group": "Banking",
            "log": {
                "name": "Account_Balance",
                "task": "selfServe",
                "status": "initiated",
                "exit_reason": "Agent Asked",
                "comment": "[AS]",
                "event": "Intent"
            }
        }
    ],

    "WS": {
        "name": "",
        "date": 0,
        "uri": "",
        "method": "",
        "latency": 0
    },

    "security": {
        "is_encrypted": false,
        "sensitivity": "envelope",
        "encrypted_key": "aaa9530be937c8a2819ba6ee3ca24361a11be0489e88fe853a926f709b9549f6"
    },

    "bio": {
        "verification-score": "",
        "verification-result": "",
        "search-result": ""
    },

    "asr": {
        "speech_start": "1300",
        "speech_duration": "4500",
        "rec_start": "3000",
        "barge-in": "",
        "grammar": "demo_generic",
        "audio": {
            "name": ""
        }
    },

    "diamant": {
        "id": "aws-staging-m-1",
        "version": "10.0.0",
        "region": "aws-us-east-1"
    },
   
    "flow": {
        "id": "d9a46db1-8b56-4cf3-b13d-edec6ac51667.Test_Announcements.Announcement.MiniApps.ocp-qa",
        "account_id": "d9a46db1-8b56-4cf3-b13d-edec6ac51664",
        "name": "Test_Announcements",
        "type": "Banking",
        "diamant_app_name": "MiniApps",
        "uuid": "ocp",
        "organization": "ocp",
        "parent_name": "ocp-qa@SND_Transfer_Flow",
        "parent_id": "4c00859146cb0ba8531f2df1602603f31d4c9a0d.1683803585870.9e48fd9193664ab0adf2a0f8119f5d5c",
        "parent_step": 2,
        "root_step": 4,
        "path": ["ocp-qa@SND_Card_P",
                "ocp-qa@SND_Transfer_Flow"
            ],
        "path_app_ids": [[
                "ocp-qa@SND_Card_P",
                "e6d966c0-069e-4ff2-9120-00b6b9ec09b.SND_Transfer_Flow.Flow.ocp-qa@SND_Transfer_Flow.ocp-qa"
            ],],
        "reportable": false,
        "reporting_type": ""
    },

    "app": {
        "name": "201126",
        "version": "200101"
    }
}

action

Field	Type	Description
`data_models`	object	List of data models
`fields_to_elicit`	list<object>	The list of fields to elicit of current action
`name`	string	The name of the current action
`pre_action`	string	The reaction of current action
`prompt`	string	System’s full prompt
`prompt_duration`	integer	The duration of the prompt in ms
`type`	string	The type of current action
`subtype`	string	The subtype of current action
`tag`	string	The tag of current action
`timeout`	integer	no input timeout allowed on this action
`prompts`	object	System’s prompt separated by the utterance

fields_to_elicit

Field	Type	Description
`name`	string	The name of the field to elicit
`type`	string	The type of the field to elicit

prompts

Field	Type	Description
`content`	string	Prompt’s content
`prompt-urls`	list<string>	List of Prompt’s URLs
`weighted`	list<string>	List of Prompt’s weights in case of weighted prompt

previous_action

See action

nlu

Field	Type	Description
`result_count`	integer	Number of n-best results interpretation
`work-flow-id`	string	NLU’s workflow id
`result_type`	string	Semantic interpretation result type (Recognition, no match)
`nlu-app`	string	NLU rule-based model
`semantic-interpretation`	object	NLU result

semantic-interpretation

Field	Type	Description
`intent`	object	intent result
`confidence`	float	n-best confidence
`utterance`	string	n-best utterance
`entities`	list<object>	list of objects returned from NLU
`word_confidences`	string	Confidence score of ASR, 0 > 1

intent

Field	Type	Description
`confidence`	float	intent’s confidence
`name`	object	intent’s name
`status`	float	intent’s status (Defined, Fulfilled, etc..)
`group`	string	intent’s group for reporting purposes

entities

Field	Type	Description
`name`	object	intent’s name
`sensitivity-level`	string	entity’s sensitivity level
`instances`	list<object>	list of entity’s instances

instances

Field	Type	Description
`value`	string	entity’s value
`covered_text`	string	entity’s covered text
`begin`	integer	begin index
`end`	integer	end index
`confidence`	float	entity’s confidence
`features`	map<string,string>	entity’s features

target

Field	Type	Description
`name`	string	current target name
`status`	string	current target status (INACTIVE, INITIATED, PARTIALLY_COMPLETED, COMPLETED)
`flow_target`	array	list of targets

WS

Field	Type	Description
`date`	integer	Web Service date invocation
`name`	string	Web Service name
`uri`	string	Web Service URI
`method`	string	Web Service method
`latency`	integer	Web Service time elapsed

asr

Field	Type	Description
`speech_start`	integer	Time duration after the system prompt has ended and user started speaking or timeout occurred. Default value is 0.
`speech_duration`	integer	Total speech duration. Default value is 0.
`rec_start`	integer	Time difference between system prompt start and rec start. Default value is 0.
`barge-in`	string	True if user barged-in, false otherwise
`grammar`	integer	deepASR’s grammar used for recognition
`audio`	object	Audio’s name/location

bio

Field	Type	Description
search-result	string	The bio search result
`verification-result`	string	The verification result
`verification-score`	string	The verification score 0 > 100

events

Field	Type	Description
`index`	integer	The order of the event in the step
`active_intent`	string	Dialog’s active intent
`intent_group`	string	Dialog’s intent group
`task_id`	string	Dialog’s current task id
`log`	object	Log’s details

log

Field	Type	Description
`name`	string	Log’s name
`task`	string	Log’s specific task that occurs by the system during this step. For example: authentication task during the authentication process.
`status`	string	Log’s status of the Self Service/ Authentication at this dialog step. Every Task that is initiated must be completed or failed by the system.
`exit_reason`	string	Log’s exit reason which detects that the system is exiting its current state.
`comment`	string	Log’s comment which is specific for this dialog step. Example value: [AS] when a Self Service Intent is requested.
`event`	string	Log’s event string

security

Field	Type	Description
`is_encrypted`	boolean	True if step’s data is encrypted
`sensitivity`	string	Step’s sensitivity level (Full, EnvelopeEncryption etc)
`encrypted_key`	string	Data’s encryption key in case of Envelope encryption

data_models

Field	Type	Description
`type`	string	The data model’s main structure type `plain`, `list`, `table`
`subtype`	string	The data model’s subtype
`template_name`	string	Specific graphic template to be used. Some templates may not be supported for all channels. `generic`, `bullets`, `grid`, `carousel`, `quick_replies`, `comparison_carousel`, `pois_carousel`
`title`	string	Data model title
`subtitle`	string	Data model subtitle
`direction`	string	Template’s direction (vertical, horizontal)
`fallback`	string	Prompt that will be used in the case that the visual element cannot be rendered
`image`	object	Template’s image
`interactive_option`	object	Interactive options can be used for defining buttons and clickable URL links. Nested elements for each InteractiveOption are: URL, Label, Semantics, Image
`entries`	list<object>	List of options/items.
`open_content`	map<string,string>	Template specific list of KVPs representing message content; each template may specify its own content requirements to replace standard structured elements

image

Field	Type	Description
`label`	string	Image’s title/label
`url`	string	Image’s URL

interactive_option

Field	Type	Description
`label`	string	Image’s title/label
`url`	string	Image’s URL
`image`	object	Options’s image
`semantics`	map<string,string>	List of semantics

entries

Field	string	Description
`header`	string	Title of entry
`details`	string	Text of entry
`coordinates`	string	Used for points of interest (pois_carousel) data model template
`image`	object	Template’s image
`interactive_option`	object	Interactive options can be used for defining buttons and clickable URL links. Nested elements for each InteractiveOption are: URL, Label, Semantics, Image

Appendix

Please view the following documents for more information:

Types of OCP miniApps for more information.
Fail Exit Reason page.
Dialog Events Review page.