华为云用户手册

  • 续费相关的功能 NLP折扣套餐包续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费 资源即将到期时,已经购买NLP套餐包的客户,可执行手动续费操作,以延长资源包的有效期。 自动续费 开通自动续费后,系统将在资源到期前自动续费,无需客户再手动操作。 在NLP套餐包生命周期的不同阶段,您可以根据需要选择一种方式进行续费,具体如图1所示。 图1 NLP套餐包生命周期 NLP套餐包从购买到到期前,处于正常运行阶段,资源状态为“使用中”。 到期后,资源状态变为“已过期”。 到期未续费时,NLP套餐包首先会进入宽限期,宽限期到期后仍未续费,资源状态变为“冻结”。 超过宽限期仍未续费将进入保留期,如果保留期内仍未续费,资源将自动失效。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 在NLP套餐包到期前均可开通自动续费,到期前7日凌晨3:00首次尝试自动续费,如果扣款失败,每天凌晨3:00尝试一次,直至NLP套餐包到期或者续费成功。到期前7日自动续费扣款是系统默认配置,您也可以根据需要修改此扣款日。
  • 变更计费模式概述 在开通自然语言处理API后,如果发现当前计费模式无法满足业务需求,您可以变更计费模式。支持变更计费模式的NLP计费项如表1所示。 表1 支持变更计费模式的NLP计费项 计费项 变更说明 自然语言处理基础版API 变更NLP的计费模式会同时变更基础版API的计费模式。 将NLP的计费模式从按需计费转为折扣套餐包的计费模式,可以让您享受一定程度的价格优惠。 自然语言处理领域版API 变更NLP的计费模式会同时变更领域版API的计费模式。 将NLP的计费模式从按需计费转为折扣套餐包的计费模式,可以让您享受一定程度的价格优惠。 自然语言处理定制版API 不支持变更计费模式。 文档翻译 不支持变更计费模式。 文本翻译 不支持变更计费模式。 基础套餐包 基础套餐包支持到期后转为按需计费。 领域套餐包 领域套餐包支持到期后转为按需计费。 父主题: 变更计费模式
  • 成本优化 成本控制 企业可以在成本中心的“预算管理”页面创建精细粒度的预算来管理成本和使用量,在实际或预测超过预算阈值时,自动发送通知给指定消息接收人。企业还可以创建预算报告,定期将指定预算进展通知给指定消息接收人。 例如企业需要创建一个NLP服务的按需成本预算,每月预算金额为2000元,当预测金额高于预算金额的80%时发送预算告警。那么,创建的预算如下: 图1 预算基本信息 图2 设置成本范围 图3 设置提醒 计费模式优化 不同类型的业务对资源使用周期有不同的要求,为每一类业务确定合适的计费模式,灵活组合以达到最优效果。 针对长期稳定的成熟业务,使用折扣套餐包计费模式。 针对不能中断的短期、突增或不可预测的业务,使用按需计费模式。
  • 成本分配 成本管理的基础是树立成本责任制,让各部门、各业务团队、各责任人参与进来,为各自消耗云服务产生的成本负责。企业可以通过成本分配的方式,将云上成本分组,归集到特定的团队或项目业务中,让各责任组织及时了解各自的成本情况。 华为云成本中心支持通过多种不同的方式对成本进行归集和重新分配,您可以根据需要选择合适的分配工具。 通过关联帐号进行成本分配 企业主客户可以使用关联帐号对子客户的成本进行归集,从而对子帐号进行财务管理。详细介绍请参见通过关联账号维度查看成本分配。 使用成本单元进行成本分配 企业可以使用成本中心的“成本单元”来拆分公共成本。公共成本是指多个部门共享的计算、网络、存储或资源包产生的云成本,或无法直接通过企业项目、成本标签分配的云成本。这些成本不能直接归属于单一所有者,因此不能直接归属到某一类别。使用拆分规则,可以在各团队或业务部门之间公平地分配这些成本。详细介绍请参见使用成本单元查看成本分配。
  • 折扣套餐包资源 对于折扣套餐包计费模式的资源,例如基础套餐包和领域套餐包,用户在购买时会一次性付费,服务将在到期后自动转为按需计费。 如果在计费周期内不再使用折扣套餐包资源,您可以执行退订操作,系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的帐户。详细的退订规则请参见云服务退订规则概览。 如果您已开启“自动续费”功能,为避免继续产生费用,请在自动续费扣款日(默认为到期前7日)之前关闭自动续费。
  • 场景示例:核对资源用量是否与实际相符 假设用户在2023/07/25 10:10:05开通了诗歌生成的API,在2023/07/25 10:13:30、2023/07/25 10:16:45和2023/07/25 11:20:11分别调用了一次诗歌生成的API。 自然语言处理API流水账单 按需计费自然语言处理API按调用次数计费,每日结算一次费用,您可以在流水账单中核对每一个计费周期的信息是否和实际相符,具体如表1所示。 表1 自然语言处理API流水账单 产品类型 自然语言处理 NLP 产品 自然语言处理API 计费模式 按需 消费时间 2023/07/25 10:10:05 ~ 2023/07/25 11:20:11时段计费系统将生成1笔流水账单,对应如下计费周期: 2023/07/25 10:00:00 ~ 2023/07/25 12:00:00 官网价 官网价=调用量 * 单价 本例中,在计费周期内自然语言处理API的调用量为3次,单价可在自然语言处理价格详情中查询,以0.012元/次为例,那么官网价=0.012 * 3 = 0.036元。 优惠金额 用户使用云服务享受折扣优惠如商务折扣、伙伴授予折扣以及促销优惠等减免的金额。基于官网价的优惠金额。 抹零金额 按需计费等模式中,结算出账时实际只扣费到最小货币单位分,分以后不扣费直接抹去的金额。 本例中,抹零金额为:0.006 元 应付金额 应付金额=官网价-优惠金额-抹零金额 本例中,假设优惠金额为0,那么应付金额=0.036 - 0 - 0.006 = 0.03元 自然语言处理API明细账单 明细账单可以通过多维度展示客户账单的详细信息。一般通过设置统计维度为“按使用量”,统计周期为“按账期”来统计资源在某个月份的总开销,建议您核对表2所示的信息是否和实际相符。 表2 自然语言处理API明细账单 产品类型 自然语言处理 NLP 产品 自然语言处理API 计费模式 按需 资源名称/ID 自然语言处理API的名称和ID 例如:custom,0f4bca096d80f3212f31c002eab9931d--poem 规格 自然语言处理定制版API 使用量类型 按需计费NLP的使用量类型为“数量” 单价 按需计费模式为简单定价(使用量*单价)时提供单价信息,其他的定价如阶梯定价等不提供单价。 按需计费NLP的诗歌生成属于简单定价,您可以在自然语言处理价格详情中查询单价。 单价单位 在自然语言处理价格详情中查询到的单价单位:元/次 使用量 按产品定价单位显示使用量,自然语言处理API的单价单位为元/次,因此使用量以次为单位。本例中,2023/07/25 10:10:05 ~ 2023/07/25 11:20:11时段总计使用量为3次。 使用量单位 次 官网价 官网价=使用量*单价 本例中,使用量为3次,单价可在自然语言处理价格详情中查询,以0.012元/次为例,那么官网价=3 * 0.012 = 0.036元。 优惠金额 用户使用云服务享受折扣优惠如商务折扣、伙伴授予折扣以及促销优惠等减免的金额。基于官网价的优惠金额。 应付金额 用户使用云服务享受折扣优惠后需要支付的费用金额。
  • 在费用中心续费 登录管理控制台。 单击“控制台”页面上方“费用”,在下拉菜单中选择“续费管理”。 进入“续费管理”页面。 自定义查询条件。 可在“手动续费项”、“自动续费项”、“到期转按需项”、“到期不续费项”页签查询全部待续费资源,对资源进行手动续费的操作。 所有需手动续费的资源都可归置到“手动续费项”页签,具体操作请参见如何恢复为手动续费。 手动续费资源。 单个续费:在资源页面找到需要续费的资源,单击操作列的“续费”。 批量续费:在资源页面勾选需要续费的资源,单击列表左上角的“批量续费”。 选择NLP折扣套餐包的续费时长,判断是否勾选“统一到期日”,将NLP折扣套餐包到期时间统一到某个月的某一天(详细介绍请参见统一折扣套餐包资源的到期日)。确认费用后单击“去支付”。 进入支付页面,选择支付方式,确认付款,支付订单后即可完成续费。
  • 消息样例 场景描述:分配工单 URL:https://域名/service/AICC__Case/1.0.0/openapi/case/transfer 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "id":"c6m800000142lp0xsJlI", "ownerId":"10gg0000012IpiXMqxzk", "creatorId": "10gg0000013wbIvo3zbk" } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"resCode": "0","resMsg": "成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 id string 20 True 工单id 2 ownerId string 20 True 工单的责任人,工单自动分配时可以不填写,创建工单接口中根据分配逻辑自动分配责任人 3 creatorId string 20 True 操作处理人id 如果分配工单涉及的工单类别使用了自定义的工单模板,则工单模板上扩展的字段可继续在请求消息体中继续往后添加。
  • 消息样例 场景描述:修改工单状态 URL:https://域名/service/AICC__Case/1.0.0/openapi/status/update 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "id": "c6m80000013uPdSDTGbY","status": "Completed","creatorId":"10gg000000sLj1ytR70C" } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"resCode": "0","resMsg": "成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 id string 20 True 工单id,长度为20 2 creatorId string 20 True 操作处理人id 3 status string - True 工单状态 dataType : SingleSelect 枚举值: 0.Completed(默认值) 其他值业务自定义
  • 消息样例 场景描述:创建任务 URL:https://域名/service/AICC__Case/1.0.0/openapi/task 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "taskInfo":{ "title": "test002", "description": "test001", "type": "Case", "ownerId": "10gg00000148QvgpaLAm", "relateId": "c6m80000014iXKHqDw3c", "dueDate": "2023-07-08 00:00:00", "contactId": "ciIy0000013y7cC8T2rA", "priority": "Low", "creatorId": "10gg00000148QvgpaLAm" } } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: { "resCode": "0", "resMsg": "成功", "result": {"taskId":"ccqG0000014iXvGKONQO"} }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 taskInfo TaskInfo - True 任务详情信息,该对象的参数说明请参见表3 表3 TaskInfo任务详情参数说明 序号 名称 参数类型 长度(字节) 是否必选 说明 1 title string 128 True 任务标题 2 description string 20000 False 任务描述 3 type string - False 任务关联类型 取值: Case 4 relateId string 20 False 如果关联任务类型有值,这里也必须有值 5 ownerId string 20 True 处理人id 6 contactId string 20 False 联系人id 7 creatorId string 20 True 创建人id 8 priority string 128 False 优先级 取值: Critical High Medium Low 9 dueDate DateTime - False 期望完成时间,格式为YYYY-MM-DD HH:mm:ss 10 attachment string 255 False 任务附件
  • 消息样例 场景描述:查询工单详情 URL:https://域名/service/AICC__Case/1.0.0/openapi/case/{id} 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: {"id": "c6m800000149ndrHRVNQ"} 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"resCode": "0", "resMsg": "成功", "result": [ { "caseInfo": { "AICC__IsCanced__CST": false, "AICC__IsSuspend__CST": false, "AICC__Origin__CST.name": "Email", "AICC__Priority__CST.name": "Critical", "AICC__Reason__CST.name": "", "AICC__State__CST.name": "Processing", "AICC__Status__CST.name": "y", "AICC__Type__CST.__objectType": "AICC__CaseType__CST", "AICC__Type__CST.name": "", "AICC__test1__CST": null, "attachment": "", "caseNo": "000000000000000000000000035013", "closedDate": null, "contactId": "ciIy0000012YLAA4Dulc", "contactPhone": null, "createdDate": "2023-06-16 16:25:22", "creatorId": "10gd000000rDybBRYkuu", "creatorName": "ServiceCloud", "description": "test", "dueDate": "2023-06-30 00:00:00", "extternalNo": null, "id": "c6m800000149ndrHRVNQ", "isUpgraded": false, "origin": "Email", "ownerId": "10gg000000sGyLvwHvOK", "ownerName": "ServiceCloud", "parentId": null, "priority": "Critical", "reason": null, "state": "Processing", "status": "y", "stayDate": null, "suspendAccumulatedTime": null, "suspendDate": null, "title": "test", "type": "cvmC00000149NzxF1ePA" }, "caseTrace": [ { "createdDate": "2023-06-16 16:25:22", "creatorId": "10gd000000rDybBRYkuu", "creatorName": "ServiceCloud", "description": null, "from": null, "fromName": null, "relatedId": null, "title": null, "toAddress": null, "type": "CreateCase" } ], "customerInfo": { "customerInfo": { "address": { "addressLine1": null, "addressLine2": null, "addressLine3": null, "addressLine4": null, "addressLine5": null, "addtionalAddress": "test", "area": null, "block": null, "buildingNo": null, "city": null, "country": null, "defaultBillingAddress": false, "defaultShippingAddress": false, "firstName": null, "id": "cw8O0000012YLAA6D6g4", "label": null, "lastName": null, "middleName": null, "phoneNumber1": null, "phoneNumber2": null, "province": null, "roomNo": null, "street": null, "subjectId": "ciIy0000012YLAA4Dulc", "title": null, "town": null, "zip": null }, "age": null, "bindAccount": [], "birthDay": null, "cellPhone1": "555555", "cellPhone2": null, "cellPhone3": null, "channel": null, "createdDate": "2023-04-17 18:13:53", "customFied": null, "customerName": "test5", "description": null, "email": "yh5@huawei.com", "email1": null, "email2": null, "fax": null, "firstName": null, "gender": "male", "id": "ciIy0000012YLAA4Dulc", "lastModifiedDate": "2023-04-17 18:14:51", "lastName": null, "level": null, "middleName": null, "name": null, "nickName": null, "organization": { "description": null, "email": null, "fax": null, "fixedPhone": null, "id": "cBbs0000012YLAA3eiVU", "industry": null, "logo": null, "organizationName": "test", "scale": null, "summary": null, "website": null }, "organizationId": "cBbs0000012YLAA3eiVU", "phone": null, "phone1": null, "phone2": null, "phone3": null, "picture": null, "remark": null, "status": null, "title": null, "userId": null, "website": null } }, "isFollower": false, "tasks": [] } ]}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 id string 20 True 工单id 如果查询工单详情涉及的工单类别使用了自定义的工单模板,则工单模板上扩展的字段可继续在请求消息体中继续往后添加。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 caseInfo object True 工单基本信息,该对象的参数说明请参见表4 caseInfo参数说明 2 caseTrace CaseTrace[] False 工单轨迹,该对象的参数说明请参见表5 CaseTrace参数说明 3 customerInfo object False 工单联系人信息,根据id调用联系人查询接口,参见表6 4 tasks object[] False 任务信息,该对象的参数说明请参见表4 5 isFollower boolean True 是否关注 表4 caseInfo参数说明 序号 名称 参数类型 是否必选 说明 1 id string True 工单id 2 caseNo string True 工单编号 3 status string True 工单当前流程节点 dataType : SingleSelect 枚举值: 0.Completed(默认值) 其他值业务自定义 4 title string False 工单标题 5 priority string False 优先级 dataType : SingleSelect 枚举值: Critical High Medium Low 6 parentId string False 父工单id 7 ownerId string True 处理人id 8 origin string True 优先级 dataType : SingleSelect 枚举值: Voice Whatsapp webchat Email 9 isUpgraded Boolean True 工单是否升级 10 extternalNo string True 外部工单编号 11 dueDate Datetime False 期望完成时间,时间格式为YYYY-MM-DD HH:mm:ss 12 description string True 工单描述 13 creatorId string True 工单处理者id 14 createdDate Datetime True 创建时间,时间格式为YYYY-MM-DD HH:mm:ss 15 contactId string False 联系人id 16 reason string True 工单原因分类 17 contactPhone string False 联系人电话 18 state string True 任务状态 dataType : SingleSelect 枚举值: Completed Pending Processing 19 stayDate string True 工单当前状态停留时间,时间格式为YYYY-MM-DD HH:mm:ss 20 suspendAccumulatedTime int True 工单停留时长,单位分钟,范围1~1439999 21 suspendDate string True 工单暂停时间,时间格式为YYYY-MM-DD HH:mm:ss 22 type string True 工单类型id,关联CaseType表 23 closedDate Datetime False 关闭时间 24 attachment string False 工单附件 25 creatorName string True 创建者名 26 ownerName string True 处理者名 表5 CaseTrace参数说明 序号 名称 参数类型 是否必选 说明 1 creatorId string True 工单处理者id 2 creatorName string True 工单处理者名称 3 type string True 处理类型: dataType : SingleSelect 枚举值: Iternal Email SMS CreateTask Social CreateCase 4 relatedId string False 关联记录id 5 title string False 标题 6 description string False 处理描述 7 from string False 发送人id 8 fromName string False 发送人姓名 9 toAddress string False 接收人地址 10 createdDate string False 轨迹处理时间 11 attachment string False 轨迹附件
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 caseInfo Object True 工单信息,参见表3 表3 caseInfo参数说明 序号 名称 参数类型 长度(字节) 是否必选 说明 1 id string 20 True 工单id,不支持修改 2 title string 128 True 工单标题 3 description string 20000 True 工单描述 4 ownerId string - False 优先级,Low/Medium/High/Critical 5 priority string - False 工单来源,Voice/Whatsapp/webchat/Email 6 dueDate DateTime - False 期望完成时间,格式为YYYY-MM-DD HH:mm:ss 7 contactId string 20 False 工单对应的联系人 8 creatorId string 20 False 创建人id 9 contactPhone string 20 False 联系人电话 11 attachment string - False 工单附件 如果修改工单涉及的工单类别使用了自定义的工单模板,则工单模板上扩展的字段可继续在请求消息体中继续往后添加。
  • 消息样例 场景描述:修改工单 URL:https://域名/service/AICC__Case/1.0.0/openapi/case/modify 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "caseInfo":{ "id":"c6m800000142mS63Voa8", "title":"testOpenApi11", "description":"test111", "dueDate":"2023-06-20 00:00:00", "ownerId":"10gg0000012IpiXMqxzk", "contactId":"ciIy0000013w9aru7cDQ", "creatorId": "10gg0000013wljxK5XX6", "contactPhone": "15151515152" } } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: { "resCode": "0","resMsg": "成功" }
  • 消息样例 场景描述:关闭工单 URL:https://域名/service/AICC__Case/1.0.0/openapi/close 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "caseId":"c6m80000013ka3K1K556","creatorId":"10gg000000sLj1ytR70C"} 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"resCode": "0","resMsg": "成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 caseId string 20 True 工单id 2 creatorId string 20 True 操作处理人id
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 taskList TaskList[] True 任务信息,该对象的参数说明请参见表4 2 count number True 符合条件的总数 表4 Tasklist参数说明 序号 名称 参数类型 是否必选 说明 1 taskId string True 任务id 2 taskNo string True 任务No 3 title string True 任务标题 4 ownerId string True 处理人id 5 priority string False 优先级 dataType : SingleSelect 枚举值: Critical High Medium Low 6 dueDate Datetime False 期望完成时间,时间格式为YYYY-MM-DD HH:mm:ss 7 status string True 任务状态 8 description string False 任务描述 9 creatorName string True 创建人名 10 ownerName string False 处理人名 11 creatorId string True 创建人id
  • 消息样例 场景描述:查询任务列表 URL:https://域名/service/AICC__Case/1.0.0/openapi/task/list 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "limit": 1,"start": 0 } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: { "resCode": "0", "resMsg": "成功", "result": { "count": 1, "taskList": [ { "closedDate": null, "contactId": "ciIy0000013y7cC8T2rA", "createdDate": "2023-07-07T06:51:35.000Z", "creatorId": "10gg00000148QvgpaLAm", "creatorName": "liuhuqiong001", "description": "test001", "dueDate": "2023-07-08 00:00:00", "id": "ccqG0000014iXvGKONQO", "ownerId": "10gg00000148QvgpaLAm", "ownerName": "liuhuqiong001", "priority": "Low", "relateId": "c6m80000014iXKHqDw3c", "status": "Pending", "stayDate": null, "taskId": "ccqG0000014iXvGKONQO", "taskNo": "000000000000000000000000001002", "title": "show0612", "type": "Case" } ] } }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 title string 128 False 任务名称模糊查询 2 status string 128 False 任务状态 dataType : SingleSelect 枚举值: Completed Pending Processing 3 priority string 128 False 优先级 dataType : SingleSelect 枚举值: Critical High Medium Low 4 ownerId string 20 False 任务的责任人id 5 type string - False 关联类型: 取值: Case 6 relateId string 20 False 如果关联任务类型有值,这里也必须有值 7 start number - True 起始行数。(min:0) 8 limit number - True 本次查询要求返回的行数(min:1,max:100) 9 classification string 128 False 任务分类类型 (Todo;Processed;Created) 10 contactId string 20 False 联系人id 11 creatorId string 20 True 创建人id 12 startTime string - False 创建开始时间, 格式为YYYY-MM-DD HH:mm:ss 13 endTime string - False 创建结束时间, 格式为YYYY-MM-DD HH:mm:ss
  • 消息样例 场景描述:处理任务状态。 URL:https://域名/service/AICC__Case/1.0.0/openapi/task/process 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "taskId": "ccqG0000014iXvGKONQO", "processInfo": { "type": "Iternal", "title": "test0707", "description": "test0707" }, "creatorId":"10gg00000148QvgpaLAm" } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"resCode": "0","resMsg": "成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 taskId string 20 True 任务 id 2 creatorId string 20 True 操作处理人 3 processInfo ProcessInfo - True 处理信息,该对象的参数说明请参见表3 表3 ProcessInfo参数说明 序号 名称 参数类型 长度(字节) 是否必选 说明 1 type string - True 处理类型 取值: Iternal 2 title string 128 True 标题。 3 description string 20000 True 处理描述。 4 attachment string 255 False 附件大小不能超过5M,数量不超过5个,支持jpg 、png 、pdf 、jpeg 、gif、doc、docx格式
  • 消息样例 场景描述:工单处理 URL:https://域名/service/AICC__Case/1.0.0/openapi/case/process 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "caseId": "c6m80000013ByxfHLVxo", "creatorId": "10gg000000sLj1ytR70C", "processInfo": { "type": "Iternal", "title": "123", "description": "456", "attachment": "" } } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"resCode": "0","resMsg": "成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 caseId string 20 True 工单id 2 processInfo ProcessInfo - True 处理信息,该对象的参数说明请参见表3 ProcessInfo参数说明 3 creatorId string 20 True 创建人id 表3 ProcessInfo参数说明 序号 名称 参数类型 长度(字节) 是否必选 说明 1 type string - True 处理类型: dataType : SingleSelect 枚举值: 0.Iternal 1.Email 2.SMS 2 title string 128 True 标题 3 description string 20000 True 处理描述 4 from string 20 False 发送人id 5 fromName string 80 False 发送人姓名 6 toAddress string 2000 False 接收人地址 7 creatorId string 20 False 操作处理人id 如果工单处理涉及的工单类别使用了自定义的工单模板,则工单模板上扩展的字段可继续在请求消息体中继续往后添加。
  • 消息样例 场景描述:分配任务 URL:https://域名/service/AICC__Case/1.0.0/openapi/task/transfer 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "id": "ccqG0000014iXvGKONQO", "ownerId": "10gg00000148QvgpaLAm", "creatorId": "10gg00000148QvgpaLAm" } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"resCode": "0","resMsg": "成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 id string 20 True 任务id 2 ownerId string 20 True 被分配人id 3 creatorId string 20 True 创建人id
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,access-token获取参见鉴权配置机机接口(SaaS集成) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 caseInfo Object True 工单信息,该对象的参数说明请参见表3 caseInfo列出来的字段只是任意工单都需要的一些标准字段,其他字段是可以根据工单对应的模板动态扩展。 表3 caseInfo参数说明 序号 名称 参数类型 长度(字节) 是否必选 说明 1 title string 128 True 工单标题 2 description string 20000 True 工单描述 3 type string 20 True 工单类型,工单类型id 4 ownerId string 20 False 工单的责任人,工单自动分配时可以不填写,创建工单接口中根据分配逻辑自动分配责任人 5 isAtuoAssigned boolean - True 是否自动分配 6 priority string - False 优先级,Low/Medium/High/Critical 7 origin string - False 工单来源,Voice/Whatapp/webchat/Email 8 dueDate DateTime - False 期望完成时间,格式为YYYY-MM-DD HH:mm:ss 9 contactId string 20 True 工单对应的联系人 10 attachment string - False 附件大小不能超过5M,数量不超过5个,支持jpg 、png 、pdf 、jpeg 、gif、doc、docx格式 11 creatorId string 20 False 创建人 12 contactPhone string 20 False 联系人电话 13 beId string 20 False CRM客户较多,beId用于区分客户大区 如果创建工单涉及的工单类别使用了自定义的工单模板,则工单模板上扩展的字段可继续在请求消息体中继续往后添加。
共100000条