更新时间:2023-09-27 GMT+08:00

对话标识绑定新增接口

场景描述

该接口用于新增对话标识绑定。

接口方法

设置成“POST”。

URL

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

请求说明

表1 请求体参数

参数名称

数据类型

参数位置

必选/可选

描述

tenantId

String

body

True

租户ID

accessCode

String

body

False

接入标识,如果不传,则系统自动生成接入标识

  • 在Op场景下,如source参数没有值,或值为IVR时,本参数必填,且不超过20位字符。
  • 在SaaS场景下,如果createFlag有值,则使用系统生成的accessCode,本参数可不用填
  • 在SaaS场景下,如果createFlag没有值,则accessCode必填,且长度为9~24位字符。

domainId

int

body

False

领域ID

dialogType

int

body

True

对话类型

  • 1:语音导航
  • 2:智能外呼
  • 3:聊天机器人
  • 4:IVR流程

flowCode

String

body

True

流程编码

description

String

body

False

描述

description参数和createFlag参数中有一个必填。

在saas场景下将作为流程描述使用,需要确保全局唯一,长度不超过50位

authToken

String

body

True

认证token。

请参见C3 智能助手平台接口鉴权方式

source

String

body

False

发起对话识别的源设备。

  • IVR:来自IVR流程
  • OIFDE:表示来自ODFS配置的智能化流程
  • 不传,默认按照IVR处理

createFlag

String

body

False

是否创建。

description参数和createFlag参数中有一个必填。

  • createFlag=0,添加机器人场景,添加机器人与流程的绑定关系;
  • createFlag=1,导入流程涉及接入码导入,允许重名覆盖场景,在查询到绑定关系的情况下,先删除绑定关系,再添加绑定关系。

响应说明

参数名称

数据类型

参数位置

必选/可选

描述

errorCode

int

body

False

错误码

成功,不返回errorCode;

失败,参见常用错误码

errorMsg

String

body

False

错误描述

报文样例

  • 请求报文
{
   "tenantId": "tenant001",
   "accessCode": "10086" ,
   "domainId": 10001 ,
   "dialogType":1,
   "flowCode": "flowxxxxxx" ,
   "description": "" ,
   "authToken": "0dbe*******************b505de" 
}
  • 响应报文

    新增成功:

    无响应体报文。

    新增错误:

    {
        "errorCode" : 10000, // int, 错误码,成功通过状态码为200判断
        "errorMsg" : ""
    }