Help Center/ Cognitive Engagement Center/ API Reference/ Chatbot Management Interface Reference/ Dedicated Interfaces for Silent Agents/ Reply Interface
Updated on 2023-09-27 GMT+08:00
View PDF

Reply Interface

Interface Method

POST

URL

https://IP:PORT/oifde/rest/api/flow/receiveDialogrecord

Request

Table 1 Parameters in the request body

Parameter

Type

Position

Mandatory

Description

tenantId

String

Body

Yes

Tenant ID.

callId

String

Body

Yes

Session ID.

agentId

String

Body

Yes

Agent ID.

nodeId

String

Body

Yes

ID of the diagram element node, which is transferred to a silent agent and then returned by the silent agent.

nodeIndex

Integer

Body

No

Execution position of the replied diagram element node, which is transferred to a silent agent and returned by the silent agent.

replyType

Integer

Body

No

Reply type. The default value is 0.

0: intention reply

1: content reply

replyIntentCode

String

Body

Yes

Intention code. When a silent agent replies with customized content (that is, replyType is set to 1) and the session is in the insertion state, this parameter has a fixed value of slientInsertReply.

replyIntentContent

String

Body

Yes

Reply returned by an agent. Reply content configured in the intention.

If the content is customized, directly enter the reply of the silent agent.

replyIntentName

String

Body

Yes

Intention name. For the content reply, the value is the same as that of replyIntentCode.

authToken

String

Body

Yes

Authentication token.

For details, see C3 OIAP Interface Authentication.

Response

Parameter

Type

Position

Mandatory

Description

errorCode

String

Body

No

Error code.

  • 0: success
  • Other values: failure

errorMsg

String

Body

No

Error description.

Example

  • Request
    { 
   "callId":"16064786965020f6fb86792bd25dbbb489426",
   "agentId":"10001",
   "nodeId":"node_action_97511fbc15d9b23074405ee736187a82c529",
   "nodeIndex":2,
   "replyType":0,
   "replyIntentCode":"car",
   "replyIntentContent": "Test vehicles",
   "replyIntentName":"SSQ test"
   "authToken": "t*****************************"
 }
  • Response
    { 
     "errorCode" : "0",
     "errorMsg" : "" 
 }