Help Center/ Cognitive Engagement Center/ API Reference/ Chatbot Management Interface Reference/ Dialog ID Binding Interfaces/ Interface for Modifying Dialog ID Binding Relationships
Updated on 2023-09-27 GMT+08:00
View PDF

Interface for Modifying Dialog ID Binding Relationships

Description

This interface is used to modify dialog ID binding.

Interface Method

POST

URL

https://IP:PORT/oifde/rest/api/updatenavigationinfo

Request

Table 1 Parameters in the request body

Parameter

Type

Position

Mandatory

Description

tenantId

String

Body

Yes

Tenant ID.

accessId

String

Body

Yes

Internal sequence number of a dialog ID binding relationship.

accessCode

String

Body

No

Access ID.

The value can contain a maximum of 20 characters.

domainId

Integer

Body

No

Domain ID.

dialogType

Integer

Body

Yes

Dialog type.

  • 1: voice navigation
  • 2: intelligent outbound call
  • 3: chatbot
  • 4: IVR flow

flowCode

String

Body

No

Flow code.

description

String

Body

Yes

Description.

authToken

String

Body

Yes

Authentication token.

For details, see C3 OIAP Interface Authentication.

source

String

Body

No

Source device that initiates a dialog.

  • IVR: IVR flow
  • OIFDE: intelligent flow configured by the ODFS

Response

Table 2 Parameters in the response body

Parameter

Type

Position

Mandatory

Description

errorCode

Integer

Body

No

Error code.

If the operation is successful, no error code is returned.

If the operation fails, see Common Error Codes.

errorMsg

String

Body

No

Error description.

Example

  • Request 
    {
   "tenantId": "tenant001",
   "accessCode": "10086",
   "accessId": "100001" ,
   "domainId": 10001 ,
   "dialogType":1, 
   "flowCode": "flowxxxxxx" ,
   "description": "" ,
   "authToken": "0dbe11*******************b505de" 
}
  • Response

    Modification succeeded:

    No response body.

    Modification failed:

    {
    "errorCode" : 100000, // Error code, which is an integer. The status code 200 indicates success.
    "errorMsg" : ""
}