IVR流程开发指南
博域通讯 BYIPCC2.0 IVR 流程开发指南 (禁止擅自复制) 保密级别：机密保密级别：机密 博域通讯基于三汇博域通讯基于三汇 SPBXSPBX 系列软交换架构多媒体交换机的系列软交换架构多媒体交换机的 IPIP 呼叫中心平台产品呼叫中心平台产品 BYIPCC2.0BYIPCC2.0 IVRIVR 流程开发指南流程开发指南 版本号：版本号：2.0.22.0.2 版 权 声 明 2002-2017 深圳市博域信源通讯有限公司 版权所有,保留一切权利。 非经本公司书面许可，任何单位或个人不得擅自摘抄、复制本文档的部分或全部内容，并不得 以任何形式的传播。 深圳市博域信源通讯有限公司保留对此文件进行修改而不另行通知之权利。 深圳市博域信源通讯有限公司承诺所提供的信息为正确且可靠, 但并不保证本文件绝无错误。 本文档中可能涉及的其他公司的商标或注册商标或产品，其版权归相关公司所有。若因贵公司 使用本公司之文件或产品, 而需要第三方之产品、专利或者著作等与其配合时，则应由贵公司 负责取得第三方同意及授权。关于上述同意及授权，非属本公司应为保证之责任。 目录 版权所有 深圳市博域信源通讯有限公司 http:/ 第 i 页 目 录 第第 1 章章 关于本指南关于本指南 1 1.1 关于我们 1 1.2 本手册安排 1 1.3 预期读者 1 1.4 联系我们 1 第第 2 章章 IVR 流程开发概述流程开发概述 3 2.1 基本流程开发的一般步骤 3 2.1.1确定需求，设计流程 3 2.1.2建立IVR工程 3 2.1.3准备资源 3 2.1.4使用流程设计器实现流程 3 2.1.5调试流程 3 2.2 为开发外挂动态库 4 2.3 为用户组件开发属性编辑插件 4 2.4 IVR 流程的部署 4 2.4.1配置IVR服务器 4 2.4.2配置远程服务器 4 第第 3 章章 呼出型呼出型 IVR 流程的开发流程的开发 5 3.1 呼出型 IVR 流程概述 5 3.2 呼出型 IVR 的示意图 6 3.3 呼出数据接口规范 7 3.3.1Open函数 7 3.3.2First和Next函数 7 3.3.3WriteState函数 10 3.3.4Close函数 12 3.4 呼出型 IVR 的配置 12 第第 4 章章 IVR 外挂动态库的开发外挂动态库的开发 13 4.1 外挂动态库概述 13 目录 版权所有 深圳市博域信源通讯有限公司 http:/ 第 ii 页 4.1.1外挂动态库函数的类型 13 4.2 预定义函数 13 4.2.1IVR引擎调用预定义函数的时机 13 4.2.2动态库初始化函数规范 14 4.2.3动态库释放函数规范 15 4.2.4呼入事件函数规范 15 4.2.5进入流程事件函数规范 16 4.2.6退出流程事件函数规范 17 4.2.7传真页变化事件函数规范 17 4.3 自定义函数 18 4.3.1自定义函数规范 18 4.3.2内存回收函数(释放为返回字符串分配的内存) 19 4.4 外挂动态库调用 IVR 引擎的输出函数 20 第第 5 章章 为设计器开发属性编辑插件为设计器开发属性编辑插件 21 5.1 属性编辑插件概述 21 5.2 开发属性编辑插件 22 5.3 插件开发规范 24 5.3.1SupportProc 24 5.3.2AddEditorProc 25 5.3.3ExecuteProc 26 5.3.4GetEditTextProc 29 5.3.5SetEditTextProc 29 5.3.6GetParamProc 30 5.3.7SetParamProc 31 第第 6 章章 多语言版本使用多语言版本使用 33 6.1 支持的语言版本 33 6.2 各语言版及多种声音的语音路径规则 33 6.3 在语音提示中可以添加各种语言的路径 34 第第 7 章章 使用使用 IVR 远程应用服务器远程应用服务器 35 目录 版权所有 深圳市博域信源通讯有限公司 http:/ 第 iii 页 7.1 编写用户动态库 35 7.2 写动态库配置文件 35 7.2.1配置文件的命名规则 35 7.2.2配置文件的内容 35 7.2.3动态库接口定义项格式 35 7.3 发布 36 第 1 章 关于本指南 版权所有 深圳市博域信源通讯有限公司 http:/ 第 1 页 第第 1 章章 关于本关于本指南指南 欢迎使用深圳市博域信源通讯有限公司的 IP 软交换呼叫中心平台产品 BYIPCC2.0。本指南是应用 IP 软交换呼叫中心平台产品 BYIPCC2.0 进行 IVR 应用 开发的指导性描述。 1.11.1 关于我们关于我们 深圳市博域信源通讯有限公司是一家专业的计算机电话集成(CTI)的开发商，为国 内外客户提供专业的 CTI 软、硬件产品和各类解决方案。 1.21.2 本手册安排本手册安排 章节章节内容内容 第 1 章说明本文档的背景、编排及预期读者。 第 2 章IVR 开发概述，介绍了 IVR 开发的一般步骤。 第 3 章呼出型 IVR 开发指南。 第 4 章提供了外挂动态库的规范及开发指南。 第 5 章介绍了如何为设计器开发属性编辑插件。 第 6 章介绍了了如何开发多语言版本。 第 7 章介绍了如何使用 IVR 远程服务器。 1.31.3 预期读者预期读者 本手册的阅读对象为 BYIPCC 呼叫中心平台的开发人员。阅读者应具有一定的通 信和 CTI 的知识背景，并且熟悉 WINDOWS 操作系统和相关编程工具。 1.41.4 联系我们联系我们 如果您在使用中碰到问题或有任何建议，请联系我们。 第 1 章 关于本指南 版权所有 深圳市博域信源通讯有限公司 http:/ 第 2 页 深圳市博域信源通讯有限公司 电话：0755-86064201，86172837 网址：http:/ 电子邮件： 第 2 章 IVR 流程开发概述 版权所有 深圳市博域信源通讯有限公司 http:/ 第 3 页 第第 2 章章 IVR 流程开发概述流程开发概述 2.12.1 基本流程开发的一般步骤基本流程开发的一般步骤 2.1.12.1.1确定需求，设计流程确定需求，设计流程 根据业务确定流程需求，使用绘图工具，如 ，等编写出直观的流程需求文档。流程设计者能通过文档在设 计器中加入对应的组件来实现流程。对于一个复杂的 IVR 应用，设计者应合理规 划，将整个应用分解成几个功能相对独立的子流程。 2.1.22.1.2建立建立 IVRIVR 工程工程 IVR V6.2 引入了 IVR 工程概念。工程对应 IVR 应用，可以包含一个多个流程,多 个流程之间可以相互独立，根据不同场合执行不同的流程（通过配置） ；也可以相 互调用。 BYIPCC IVR V6 流程设计器使用手册详细描述了建立工程的方法。 2.1.32.1.3准备资源准备资源 准备好流程中要用到的语音资源。建议使用 6 流程设计器的“流程语音” 工具管理流程所使用的语音。在开发同时，可以通过“流程语音”文件，进行语音 文件的录制。如果流程中提供传真索取功能,准备好备索取传真文件。 为调试和运行流程,须将这些资源复制到 IVR 引擎指定的目录下。 2.1.42.1.4使用流程设计器实现流程使用流程设计器实现流程 有关使用流程设计器（FlowDesigner）实现流程的详细说明，请参考IVR 流程设计器使用手册.doc 。 2.1.52.1.5调试流程调试流程 BYIPCC IVR 开发平台提供 IVR 模拟器，允许开发者在没有硬件环境时通过键盘 和声卡模拟流程的运行。 开发平台提供还 IVR 监视器，直观显示了 IVR 流程每个步骤的执行过程。 第 2 章 IVR 流程开发概述 版权所有 深圳市博域信源通讯有限公司 http:/ 第 4 页 2.22.2 为开发外挂动态库为开发外挂动态库 在 BYIPCC IVR V6 设计器包容了大多数的组件,基本满足了一般流程的开发。对于 复杂的业务逻辑，开发者可以通过开发自己的用户动态库实现更灵活、高效的 IVR 应用。 2.32.3 为用户组件开发属性编辑插件为用户组件开发属性编辑插件 从 IVR 流程设计器 V4.6 开始，支持开发者定义自己的组件，这些组件可以和系统 基本组件一样被加入到流程中，在设计器中可以为这些组件的实例编辑通用和自定 义的属性，对一些非基本类型的属性，开发者可以通过开发属性编辑插件来实现。 2.42.4 IVRIVR 流程的部署流程的部署 在流程开发完毕后，就可以部署这个流程。流程部署的过程包括： 2.4.12.4.1配置配置 IVRIVR 服务器服务器 IVR 服务器配置的详细说明，请参考IVR 流程配置手册 。 2.4.22.4.2配置远程服务器配置远程服务器 IVR 服务器配置的详细说明，请参考IVR 流程配置手册 。 第 3 章 呼出型 IVR 流程的开发 版权所有 深圳市博域信源通讯有限公司 http:/ 第 5 页 第第 3 章章 呼出型呼出型 IVR 流程的开发流程的开发 3.13.1 呼出型呼出型 IVRIVR 流程概述流程概述 和呼入型 IVR 流程不同，呼出型 IVR 流程一般根据配置定时触发。要实现一个呼 出型 IVR 应用，至少需要： 按照规范，完成一个数据接口动态库，用于获取呼出号码并回写呼出结果。 使用设计器设计一个流程，该流程的设计方法和呼入流程类似。 配置 IVR 流程,定义呼出使用的并发数,使用的线路资源和执行时间等。 提示 i 在 BYIPCC IVR 文档中，通常会使用“通知”、 “自动通知”来命名呼出型 IVR 应用。 IVR 引擎调用数据接口完成数据呼出的初始化、取呼出数据、写呼出结果、关闭等。 当所有数据完成后，结束呼出。 第 3 章 呼出型 IVR 流程的开发 版权所有 深圳市博域信源通讯有限公司 http:/ 第 6 页 3.23.2 呼出型呼出型 IVRIVR 的示意图的示意图 下图使 IVR 引擎执行一个呼出任务的典型过程。 IVR 引擎初始化 调用 Open 函数 返回值为 True? 调用 First 函数 返回值为 True? 根据取得的电话号码启动呼叫 调用 WriteState 函数 若对方摘机则进入通知流程 调用 Next 函数 调用 Close 函数 否 否 是 是 到达通知启动时间? 第 3 章 呼出型 IVR 流程的开发 版权所有 深圳市博域信源通讯有限公司 http:/ 第 7 页 3.33.3 呼出数据接口规范呼出数据接口规范 BYIPCC IVR 通过 WINDOWS 动态库实现呼出数据接口。开发呼出数据接口动态 是实现呼出型 IVR 的关键。呼出数据接口动态库中必须实现下文描述的五个函数， 这些函数的名称开发者可以任意指定。IVR 引擎在合适的时机调用这些函数，获取 通知数据，报告通知状态等。 3.3.13.3.1OpenOpen 函数函数 Open 函数用于初始化呼出数据。 原型原型原型原型 int _stdcall (int InformNo); 参数参数参数参数 InformNo 通知信道号。 返回返回返回返回值值值值 返回 0 0 表示初始化失败；返回一个非非 0 0 的整数表示初始化成功。 说说说说明明明明 本函数在通知任务触发时调用，用户可以在此完成初始化代码，如连接数据库，打 开记录集形成一个通知列表等。 参数通知项号（InformNo）传递的值是多个通知任务的唯一标识，若通知数为 4， 那么通知项号的可能值为：0，1，2，3。 3.3.23.3.2FirstFirst 和和 NextNext 函数函数 取第一个(First)或下一条（Next）外呼数据,包括呼叫目标信息和呼叫成功后执行的 IVR 流程名称。这是两个在不同时机调用的具有相同原型的函数。 原型原型原型原型 int _stdcall ( int InformNo, char* InformCode, char* FlowN
