云服务器内容精选

  • 响应示例 状态码: 200 请求成功 { "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "message" : "Error message", "total" : 41, "limit" : 2, "offset" : 1, "success" : true, "data" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "流程名称", "description" : "描述", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "edit_role" : "编辑者", "use_role" : "使用者", "approve_role" : "审批者", "enabled" : true, "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "current_approval_version_id" : "v2", "current_rejected_versoin_id" : "v1", "aop_type" : "EASE;缓解", "engine_type" : "public_engine", "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" } ] }
  • URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/workflows 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id workspace_id 是 String 工作空间id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量 limit 否 Integer 数据量 order 否 String 排序顺序,asc:升序,desc:降序 sortby 否 String 排序字段,create_time:创建时间,category:类型分类名称 enabled 否 Boolean 是否启用 last_version 否 Boolean 最新版本号 name 否 String 流程名称 description 否 String 流程描述 dataclass_id 否 String 数据类ID dataclass_name 否 String 数据类名称 aop_type 否 String 流程类型
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为:request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 code String 返回码 total Integer 数据总条数 offset Integer 当前页大小 limit Integer 当前页码 message String 请求ID success Boolean 是否成功 data Array of AopWorkflowInfo objects 流程信息列表 表6 AopWorkflowInfo 参数 参数类型 描述 id String 流程ID name String 流程名称 description String 描述 project_id String 租户ID owner_id String 所有者ID creator_id String 创建者ID edit_role String 编辑角色 use_role String 是用角色 approve_role String 审核人 enabled Boolean 是否已启用 workspace_id String 工作空间ID version_id String 流程版本ID current_approval_version_id String 当前待审核版本号 current_rejected_versoin_id String 当前拒绝的版本号 aop_type String aop的类型有以下的值 NORMAL, 通用 SURVEY, 调查 HEMOSTASIS,止血 EASE;缓解 engine_type String 引擎的类型分为共享版和专项版 dataclass_id String 数据类的ID 状态码: 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为:request_uuid-timestamp-hostname 表8 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述
  • 了解流程触发方式 在AstroFlow中,一条流程由1个触发器和N个动作节点组成。其中,触发器(触发节点)是工作流能否启动的开关,满足了触发器的条件才能启动流程。动作节点是流程中自动执行的操作,流程中需要进行的数据操作、通知、审批等任务都需要对应的动作节点来完成。 在AstroFlow中,您可以创建事件触发、定时触发和表单触发三种类型的流程。 事件触发:服务器接收到指定URL请求时,触发流程。 图2 事件触发 定时触发:按照设定的时间周期,循环触发流程。 图3 定时器触发 表单触发:通过指定的表单事件,触发流程。 图4 表单触发
  • 流程编辑器功能介绍 AstroFlow流程编辑器支持流程可视化编排,配置简单易上手,流畅的操作体验,丰富的流程节点,可以对接Astro官方连接器或企业自定义连接器,一站式创建业务全流程。 图1 初识流程编辑器 表1 应用开发界面功能说明 区域 说明 工程能力区 工程能力区用于对流程进行集中管理,支持创建新版本流程、调试流程和发布流程等。 创建新版本:发布后的流程,不支持再次编辑,但支持以当前版本的流程为模板,创建一个新版本的流程。如何创建一个新版本,请参见创建流程新版本。 版本管理:用于集中管理流程中的版本,如下线或删除流程中某个版本,详细介绍请参见管理流程。 导出图片:将流程以图片(PNG格式)的形式,导出到本地,详情请参见将流程以图片的形式导出。 配置:用于对流程进行个性化的配置,详情介绍请参见流程全局配置。 切换纵向/横向布局:单击该按钮,可调整节点布局。流程设计页面默认为纵向布局,单击“切换横向布局”,可将页面调整为横向布局,效果如图3所示。 校验:流程设计完成后,单击该按钮,可对流程中参数的规则和合法性进行校验。 启动调试:测试流程是否按照预期的效果执行。“触发方式”设置为“事件触发”时,才会显示该按钮。如何进行流程调试,请参见创建事件触发流程。 发布:流程校验成功后,单击该按钮可发布流程。流程发布后,满足触发条件时,流程即可自动执行。 节点选择区 动作节点是流程中自动执行的操作,流程中需要进行的数据操作、通知、审批等任务都需要对应的动作节点来完成。节点功能及使用场景介绍,请参见流程节点详解。 流程设计区 通过拖拉拽的方式将需要的流程节点拖拽到流程工作区内,也可以根据需要设置不同的逻辑流程,并可以设置不同的分支节点或审批节点,同时也支持表达式的计算和发送邮件通知等功能,以满足不同场景的使用需求。如何进行流程设计,请参见创建事件触发流程、创建定时触发流程和创建表单触发流程。 说明: 设计流程时,流程中节点个数不能超过50个节点。其中,添加一次分支节点按照分支开始、分支条件(默认2个分支)、分支结束计算4个节点,若有分支增加另行计算。 节点信息编辑器 对流程中的节点进行属性设置,定制出个性化的流程。节点属性详细介绍,请参见流程节点详解。
  • 报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "callId": "1647265024-xxxx", "beginTime": 1647265028000, "endTime": 1647265029000 } 响应参数: { "returnCode": "0", "satisfactionEvaluations": { "channel": "audio", "evaluationValue": "5", "evaluationTime": 1647265028000 }, "description": " query Success" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 结果返回码,0表示查询成功,-1表示查询失败,description表示失败具体原因 1.2 description string True 结果返回描述 1.3 satisfactionEvaluations object True 满意度评价 1.3.1 evaluationValue string False 满意度评价,为满意度等级配置的字典key值。 “1”表示“很不满意”, “2”表示“不满意”, “3”表示“一般”, “4”表示“满意”, “5”表示“很满意” “-1”表示“超时未回复”,指用户收到满意度评价后,评价超时, “-2”表示“评价错误”指用户回复的满意度,不在满意度配置的按键值中。 1.3.2 channel string False 渠道: audio表示音频渠道,MSG表示短信,WEB表示网页文字交谈渠道 1.3.3 evaluationTime number False 评价时间,毫秒级别Timestamp时间戳类型 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestBody object True 请求入参 1.1 callId string True 通话标识callId 1.2 beginTime number True 评价开始时间,毫秒级别Timestamp时间戳类型 1.3 endTime number True 评价结束时间,毫秒级别Timestamp时间戳类型
  • 响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 0,成功,其他为失败 1.2 description string True 描述。 1.3 fileId string False 上传后的语音文件后生成的id,用于关联云客服的录音 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值
  • 报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "locale" : "zh_CN", "voiceType" : "0", "fileType" : "wav", "callBackUrl" : "http://10.130.40.194:18133/upload", "fileInfo" : "UklGRjJ+AABXQVZFZm10IBIAAAAGAAEAQB8AAEAfAAABAAgAAABkYXRhAH4AANXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1" } 响应参数: { "returnCode": "0", "description": "File uploaded successfully.", "fileId": "1182733043937561608" } 回调URL样例报文: //请求参数 { "fileUrl": "Y:/IVR/147/voice/0/nPqV9vU3_1666706957559.wav", "fileId": "1323606152730207249", "status": "2", "comment": "审核通过" } //响应参数 { "returnCode": "0" }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 2 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 body object False - 1.1 fileInfo string True Base64编码后的录音文件信息,限制8MB。上传文件大小会相应增加上传时间 1.2 locale string True 录音文件的语种,zh_CN(中文)、en_US(英文)、pt_BR(葡萄牙语)、th_TH(泰语) 1.3 voiceType string True 语音类型,比如0 是IVR,1提示音,2故障音,3语音通知 1.4 fileType string True 文件类型,支持wav格式和MP3格式 wav格式和MP3格式均会使用ffmpeg工具转码为平台所支持的音频文件格式(A-law压缩算法、单声道、采样位数:8bit、采样频率:8000HZ),转换后音质可能会有影响,音频文件数据可能会丢失,建议使用符合平台支持的音频文件格式。 1.5 callBackUrl string False 回调URL,系统审核后,系统会通过这个url返回审核的结果信息。 回调URL为客户自定义接口,用于接收系统审核结果信息,其中请求参数与响应参数可参考表3。 回调URL已通过系统管理员加入IVR语音上传回调的地址白名单中。 URL格式参考如下:https://support.huaweicloud.com/productdesc-cec/cec_01_0001.html 1.6 voiceFileName string False IVR语音名称,长度不能超过50字符,只能包含中文、大小写字母,数字。 表3 回调URL参数说明 序号 名称 参数类型 是否必选 说明 请求参数 1.5.1 fileUrl string True 审核文件地址,文件地址全称,包括文件后缀。 1.5.2 fileId string True 审核文件ID,具体值可参考表4中的fileId字段设置。 1.5.3 status string True 文件审核状态,取值范围: 2:审核通过。 3:审核不通过。 1.5.4 comment string False 审核状态备注。 响应参数 1.5.5 returnCode string True 响应代码,取值范围: 0:审核结果接收成功。 其他:审核结果接收失败。 说明: 审核结果接收失败后会重复调用回调接口继续返回文件上传审核结果,超过6次后同一文件的上传审核结果不再继续响应。
  • 报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 响应参数: { "result": [ { "isLoad": 1, "accessCode": "90500", "maxCallNum": null, "description": "异常处理", "id": 1, "flowFileName": "defaultIVR.GSL", "flowType": 1 }, { "isLoad": 1, "accessCode": "90501", "maxCallNum": null, "description": "1015", "id": 2, "flowFileName": "defaultIVR.GSL", "flowType": 1 } ], "retCode": "0", "message": "success" }
  • 响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 result array[object] False IVR信息 1.1.1 isLoad number False 流程是否加载 0:否 1:是 1.1.2 accessCode string False 流程接入码 1.1.3 maxCallNum integer False 流程最大并发呼叫数 1.1.4 description string False 流程描述 1.1.5 id number False 流程编号 1.1.6 flowFileName string False 流程文件名 1.1.7 flowType number False 流程类型 0:未明确的业务类型 1:GSL业务文件类型 2:VoiceXML业务文件类型 3:第三方IVR的业务类型 4:CCIVR支持的VXML流程 5:CCXMLL流程 6:WaitScript流程 1.2 retCode string False 返回码 0:成功 其他:失败 1.3 message string False 返回信息 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "name":"ctest1", "scene":"3", "volume":0, "speed":50, "voicename":"cn_kefuman_cn", "callBackUrl" : "http://10.134.227.74:18133/upload", "voicecontent":{ "language":"zh_CN", "textcontent":"测试" } } 响应参数: { "returnCode": "0", "description": "The file is uploaded successfully.", "templateId": "1249756280719641601" } 回调URL样例报文: //请求参数 { "fileUrl": "Y:/IVR/147/voice/0/nPqV9vU3_1666706957559.wav", "fileId": "1323606152730207249", "status": "2", "comment": "审核通过" } //响应参数 { "returnCode": "0" }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 2 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestBody object False - 1.1 name string True 文字转语音 模板文件名称,支持填写中文,数字,大小写英文字母。长度不超过50字符。 1.2 scene string False 使用场景。 取值范围:3,表示语音通知 1.3 speed number False 转成语音的播放语速,取值范围[-200,500],若不填则默认值:0 1.4 volume number False 转成语音的播放音量,取值范围[0,100],若不填则默认值:50 1.5 voicename string False 转成语音的播放音色,取值范围: cn_kefuman_common,表示客服曼 cn_chengshuxing_common,表示成熟型 cn_roumeiqian_common,表示柔美倩 cn_ziranzhen_common,表示自然真 cn_tianmeiru_common,表示甜美茹 若不填则给默认值:cn_kefuman_common 1.6 voicecontent object True 需要转为语音的文本内容。 1.6.1 textcontent string True 文本内容,最大长度500字节。 具体模板内容由固定文本和变量组成。模板采用UTF-8编码格式,汉字和中文符号为3个字节,字母、数字和英文符号为1个字节。 模板内容不能以变量开头。 模板内容长度不超过500字节。 单个变量长度不超过32字节(如果单个变量长度超过32字节,建议拆分成多变量)。 支持的变量格式有: ${TXT_数字}:表示变量为定义相应长度的字符串,数字表示该字符串的最大长度,如${TXT_9}表示最大长度为9字节的字符串。 ${NUM_数字}:表示变量只能为数字(0~9)的组合,数字表示该变量的最大个数,如${NUM_6}表示最大6个数字的组合。 ${DATE}表示变量为日期,格式要求为“YYYY/MM/DD”,其中,“YYYY”代表年,“MM”代表月,“DD”代表日,如2022/07/16。 ${TIME}表示变量为时间,支持两种格式,一种格式精确到分钟,格式为“HH:MM”,“HH”代表时,“MM”代表分,如14:30;另一种格式精确到秒,格式为“HH:MM:SS”,“HH”代表时,“MM”代表分,“SS”代表秒,如:14:30:30。 模板样例: 样例一:尊敬的${TXT_8}您的初始密码为${NUM_6}。 样例二:请于${DATE},${TIME}前领取您的快递。 说明: ${DATE}和${TIME}必须用逗号隔开。 1.6.2 language string True 语种。 zh_CN(中文) en_US(英文) pt_BR(葡萄牙语) th_TH(泰语) 1.7 callBackUrl string False 回调URL,系统审核后,系统会通过这个url返回审核的结果信息 回调URL为客户自定义接口,用于接收系统审核结果信息,其中请求参数与相应参数可参考表3。 回调URL已通过系统管理员加入IVR语音上传回调的地址白名单中。 表3 回调URL参数说明 序号 名称 参数类型 是否必选 说明 请求参数 1.7.1 fileUrl string True 审核文件地址,文件地址全称,包括文件后缀。 1.7.2 fileId string True 审核文件ID,具体值可参考表4中的templateId字段设置。 1.7.3 status string True 文件审核状态,取值范围: 2:审核通过。 3:审核不通过。 1.7.4 comment string False 审核状态备注。 响应参数 1.7.5 returnCode string True 响应代码,取值范围: 0:审核结果接收成功。 其他:审核结果接收失败。 说明: 审核结果接收失败后会重复调用回调接口继续返回文件上传审核结果,超过6次后同一文件的上传审核结果不再继续响应。