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

Interface for Adding Dialog ID Binding Relationships

Description

This interface is used to add dialog ID binding.

Interface Method

POST

URL

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

Request

Table 1 Parameters in the request body

Parameter

Type

Position

Mandatory

Description

tenantId

String

Body

Yes

Tenant ID.

accessCode

String

Body

No

Access ID. If this parameter is not passed, the system automatically generates an access ID.

  • In the OP scenario, if source is left empty or set to IVR, this parameter is mandatory, and the value can contain a maximum of 20 characters.
  • In the SaaS scenario, if createFlag is not empty, the access code generated by the system is used, and this parameter is optional.
  • In the SaaS scenario, if createFlag is empty, this parameter is mandatory, and the value is a string of 9 to 24 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

Yes

Flow code.

description

String

Body

No

Description.

Either description or createFlag must be set.

The value is used as the flow description in the SaaS scenario. It must be globally unique and can contain a maximum of 50 characters.

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
  • If this parameter is not set, the IVR is used by default.

createFlag

String

Body

No

Creation flag.

Either description or createFlag must be set.

  • 0: In the scenario where a chatbot is added, add the binding relationship between the chatbot and flow.
  • 1: In the scenario where flows (duplicate names are allowed) and access codes are imported, if the binding relationship is found, delete the binding relationship, and then add the binding relationship.

Response

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" ,
   "domainId": 10001 ,
   "dialogType":1,
   "flowCode": "flowxxxxxx" ,
   "description": "" ,
   "authToken": "0dbe*******************b505de" 
}
  • Response

    Addition succeeded:

    No response body.

    Addition failed:

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