POST api/Reply_To_IVR_User_Enquiry?Use_Case={Use_Case}&Utterance={Utterance}&Session_ID={Session_ID}&Conversation_ID={Conversation_ID}

Reply to a user input

Request Information

URI Parameters

Name	Description	Type	Additional information
Use_Case	One of the following values: Generic Personal Assistant Services Telephone Directory Services Online Ordering Services This parameter cardinality will be 0 in the future when applying the automatic use-case identification.	string	Required
Utterance	Textual user utterance.	string	Required
Session_ID	Send empty string to indicate a new session, if not a new session then send Session_ID.	string	Default value is
Conversation_ID	Send empty string to indicate a new conversation, if not a new conversation then send Conversation_ID	string	Default value is

Body Parameters

None.

Response Information

Resource Description

Reply_To_IVR_User_Enquiry_Response

Name	Type	Additional information
Request_Type	string	None.
Request_Parameters	Reply_To_IVR_User_Enquiry_Request_Record	None.
Data	Reply_To_IVR_User_Enquiry_Response_Record	None.
Response_Tail	Response_Tail_Record	None.

Response Formats

application/json, text/json

Sample:

{
  "Request_Type": "sample string 1",
  "Request_Parameters": {
    "Session_ID": "sample string 1",
    "Conversation_ID": "sample string 2",
    "Use_Case": "sample string 3",
    "Utterance": "sample string 4"
  },
  "Data": {
    "Session_ID": "sample string 1",
    "Conversation_ID": "sample string 2",
    "Use_Case": "sample string 3",
    "Bot_Reply": "sample string 4",
    "Conversation_Fullfilled": true
  },
  "Response_Tail": {
    "Time_Stamp": "sample string 1",
    "Status": "sample string 2",
    "Build_Number": "sample string 3",
    "Execution_Time_In_Milliseconds": 4,
    "Errors_List": [
      {
        "Error_Time": "2026-06-27T18:28:55.8059197+00:00",
        "Error_Text": "sample string 2",
        "Error_Type": 0
      },
      {
        "Error_Time": "2026-06-27T18:28:55.8059197+00:00",
        "Error_Text": "sample string 2",
        "Error_Type": 0
      }
    ]
  }
}

application/xml, text/xml

Sample:

<Reply_To_IVR_User_Enquiry_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cognitive_Layer_API">
  <Data>
    <Bot_Reply>sample string 4</Bot_Reply>
    <Conversation_Fullfilled>true</Conversation_Fullfilled>
    <Conversation_ID>sample string 2</Conversation_ID>
    <Session_ID>sample string 1</Session_ID>
    <Use_Case>sample string 3</Use_Case>
  </Data>
  <Request_Parameters>
    <Conversation_ID>sample string 2</Conversation_ID>
    <Session_ID>sample string 1</Session_ID>
    <Use_Case>sample string 3</Use_Case>
    <Utterance>sample string 4</Utterance>
  </Request_Parameters>
  <Request_Type>sample string 1</Request_Type>
  <Response_Tail>
    <Build_Number>sample string 3</Build_Number>
    <Errors_List xmlns:d3p1="http://schemas.datacontract.org/2004/07/IA_Tools">
      <d3p1:IA_Error_Item>
        <d3p1:Error_Text>sample string 2</d3p1:Error_Text>
        <d3p1:Error_Time>2026-06-27T18:28:55.8059197+00:00</d3p1:Error_Time>
        <d3p1:Error_Type>Message</d3p1:Error_Type>
      </d3p1:IA_Error_Item>
      <d3p1:IA_Error_Item>
        <d3p1:Error_Text>sample string 2</d3p1:Error_Text>
        <d3p1:Error_Time>2026-06-27T18:28:55.8059197+00:00</d3p1:Error_Time>
        <d3p1:Error_Type>Message</d3p1:Error_Type>
      </d3p1:IA_Error_Item>
    </Errors_List>
    <Execution_Time_In_Milliseconds>4</Execution_Time_In_Milliseconds>
    <Status>sample string 2</Status>
    <Time_Stamp>sample string 1</Time_Stamp>
  </Response_Tail>
</Reply_To_IVR_User_Enquiry_Response>