华为云用户手册

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 playType int False 放音类型。 0：播放会议前景音。 1：播放会议背景音。 默认值为0。 2 playMode int False 放音模式。 2：播放指定文件音。 默认值2。 3 voicePath String True 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名，例如： y:/conf/120/1136287.V3 最大长度为127个字符。

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/playvoicetoconf 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result map 只有失败时，才返回该参数。请参考表5 表5 停止放音失败原因 序号 名称 参数类型 说明 3.1 errorReason int 停止放音失败时透传排队机侧返回的失败原因码。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "addressType": "9", "address": "2002" } 响应参数 { "result": {}, "message": "success", "retcode": "0" }

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/stopvoicetoparticipant 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 addressType String True 地址类型。 6：电话号码 9：座席工号 2 address String True 地址标识。 最大长度为24字节。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "confIds": [ 1029888, 1029889 ] } 响应参数 { "message": "", "retcode": "0", "result": { "confs": [ { "confId": 1029888, "confState": 0, "startTime": 1475745454000, "applyConfTime": 60, "confHaveBeenTime": 29, "addresses": [ { "addressType": "6", "address": "70005", "deviceCallType": 0, "deviceType": 0, "channelAttrib": 3, "channelState": 0, "role": 0, "enterTime": 1475745464000 }, { "addressType": "9", "address": "153", "deviceCallType": 0, "deviceType": 6, "channelAttrib": 3, "channelState": 0, "role": 1, "enterTime": 1475745454000 } ] } ] } }

响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result array 请参考表5 表5 会议信息 序号 名称 参数类型 说明 3.1 confId long 会议id 3.2 confState int 会议状态。 0：正常会议通话。 1：会场放音 3.3 startTime long 会议开始时间，时间戳（毫秒） 3.4 applyConfTime int 申请会议时长，单位分钟 3.5 confHaveBeenTime int 会议已进行时长，单位分钟 3.6 addresses array 与会者列表，请参考表6 表6 与会者信息 序号 名称 参数类型 说明 3.6.1 addressType String 3地址类型。 6：电话号码 9：座席工号 3.6.2 address String 地址标识。 3.6.3 deviceCallType int 自定义的设备呼叫类型，详细见表3。 3.6.4 deviceType int 自定义的设备类型，详细见表2。 3.6.5 channelAttrib int 会议属性。 1：只听。 2：只说。 3：听说。 3.6.6 channelState int 会议通道状态。 0：正常会议通话中。 1：保持。 2：放音。 3.6.7 role int 会议角色。 0：与会者。 1：主席。 3.6.8 enterTime long 加入会议的时间，时间戳（毫秒）

请求说明 消息头 表2 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 confIds array True 会议ID数组。 数组最大长度为20。

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/queryconfinfos 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/batchremoveparticipant 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 addresses array True 批量删除的与会者信息。 数组最大长度为30。 该对象的参数说明请参考表4。 表4 AgentConfAddressExParam对象 序号 名称 参数类型 是否必选 说明 1.1 addressType String True 地址类型。 6：电话号码 9：座席工号 1.2 address String True 地址标识。 最大长度为24个字符。

响应说明 表5 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result map 请参考表6 表6 不存在的与会者列表参数说明 序号 名称 参数类型 说明 3.1 noExistParticipants array 请参考表7 表7 与会者参数说明 序号 名称 参数类型 说明 3.1.1 addressType string 地址类型 3.1.2 address string 地址标识

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "addresses": [ { "address": "2002", "addressType": "9" }, { "address": "2001", "addressType": "9" } ] } 响应参数 { "message": "", "retcode": "0", "result": { "noExistParticipants": [] } }

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/rejectagentconf 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/releaseagentconf 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result map 只有失败时，才返回该参数。请参考表4 表4 停止放音失败原因 序号 名称 参数类型 说明 3.1 errorReason int 停止放音失败时透传排队机侧返回的失败原因码。

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/stopvoicetoconf 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/unholdparticipant 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "address": "2002", "addressType": "9" } 响应参数 { "result": {}, "message": "success", "retcode": "0" }

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 addressType String True 地址类型。 6：电话号码 9：座席工号 2 address String True 地址标识，即电话号码或者座席工号。 最大长度为24字节。

触发事件 通话中（AgentState_Busy） 物理话机振铃（AgentOther_PhoneAlerting） 物理话机摘机（AgentOther_PhoneOffhook） 自己加入会议（AgentConf_SelfJoinResult） 会议申请成功（AgentConf_RequestSuccess） 会议申请失败（AgentConf_RequestFailed） 会议结束前提示时长：会议超时提醒事件（AgentConf_Timeout）

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "memberNum": 4, "confCallerNo": "10000", "time": 50, "promptTime": 5, "beepTone": true, "playMode": 2, "voicePath": "y:/conf/120/1136287.V3" } 响应参数 { "result": {}, "message": "success", "retcode": "0" }

场景描述 座席调用该接口申请一个座席会议，调用成功后则需要等待后续的异步事件，申请成功后，申请会议的座席会成为会议主席。申请会议的座席接收到AgentConf_SelfJoinResult事件，表明申请会议的座席自身已加入到会议中，但还需要继续等待AgentConf_RequestSuccess事件后，座席才能进行会议主席相关的操作。在收到AgentConf_RequestSuccess事件前，座席调用会议相关的接口操作时，平台会直接返回失败。 当前座席处于空闲或者通话状态，处于通话状态时当前呼叫必须处于一个稳定状态，否则申请座席会议会失败，例如：在通话过程中进行放音、静音、保持呼叫、挂起转，则申请座席会议会返回失败。 三方通话过程中如果存在两个座席，被叫座席不允许发起座席会议。 与会者类型仅支持座席工号或电话号码。 电话会议方数小于等于vdn中设置的“并发语音最大呼叫数”。

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/requestagentconf 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 memberNum int True 会场能够容纳的与会人数。 取值范围：1～120。 2 confCallerNo String False 会议外呼用户时显示的主叫号码。 最大长度为24字节。 不输入参数时，平台默认使用VDN配置台基本信息的系统主叫号码。在VDN有号码限制的情况，需要号码在限制范围内。 3 time int False 会议申请时长。 单位：分钟。 取值范围：4～1440。 默认值为60。 4 promptTime int False 会议结束前提示时长。 可选参数。 单位：分钟。 取值范围：3～1440。 默认值为3。 如果大于等于会议申请时长，按照申请时长-1计算。 5 beepTone boolean False 有用户加入、退出会议时是否播放提示音。 默认值为false。 6 playMode int False 2：播放指定文件音，默认值为2。 7 voicePath String False 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名，例如： y:/conf/120/1136287.V3 当“BeepTone”设置为“true”时，此参数必须设置并且playMode需要为2；当“BeepTone”设置为“false”时，此参数设置无效。 最大长度为127。

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/requestleaveagentconf 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

创建移动云 RocketMQ版事件源 登录事件网格控制台。 在左侧导航栏选择“事件流”，进入“事件流”页面。 单击“创建事件流”，进入“创建事件流”页面。 图1 创建事件流 单击“事件源”，弹出“配置事件源”对话框。 图2 配置事件源 参考表1，填写事件源的配置信息。 表1 移动云 RocketMQ版参数说明 参数名称 说明 事件提供方 选择移动云 RocketMQ版。 实例ID 请输入实例ID。 Group ID 请输入Group ID。 Topic 请输入Topic。 Tag 请输入Tag。 说明： 表示订阅指定Topic下的Tags 1. * 表示订阅所有消息。 2. TagA || TagB || TagC 表示订阅TagA或TagB或TagC的消息。 开启保存消息轨迹 请选择是否开启保存消息轨迹。 启用鉴权认证 请选择是否启用鉴权认证 Access Key（启用鉴权认证） 请输入Access Key。 Secret Key（启用鉴权认证） 请输入Secret Key。 订阅方式 请选择集群或广播。 接入点类型 请选择公网或私网。 地址 请输入地址。 客户端SDK 请输入客户端SDK上传到OBS的地址。 说明： 客户端SDK上传到OBS的地址获取方式可参考常见问题。 消费超时时间（毫秒） 请输入1000到900000之间的整数 消息类型 请选择普通消息。 消费线程数 请输入20到64之间的整数。 批量消费最大消息数 请输入1到32之间的整数。 批量消费最大等待时长（秒） 请输入0到450之间的整数。 单击“下一步”，进入规则配置页面，规则配置可参考过滤规则参数说明。 图3 规则配置 单击“下一步”完成规则配置，您可以参考路由到函数工作流，继续配置事件流的事件目标。 事件源配置为移动云 RocketMQ版时，配置事件目标为 FunctionGraph（函数计算）时，执行方式可选择为“同步”或“异步”。 当事件源和事件目标都配置完成后，单击“保存”，完成事件流的创建。 MQ采集函数首次启动分钟级后生效。 广播模式下不支持失败重试，即消费失败后，失败消息不再重试，消费者继续消费新的消息。

操作步骤 登录事件网格控制台。 在左侧导航栏选择“事件路由”，进入“事件路由”页面。 图1 事件路由页面 单击“创建事件路由任务”，进入创建详情页。 配置“任务基本配置”。 图2 任务基本配置 表1 任务基本配置参数说明 参数 说明 任务名称 请输入任务名称 计费模式 请选择计费模式为包年包月或按需计费。 描述 请输入对本任务的描述。 配置“源端和目标端配置”。 当源端和目标端均为Kafka时： 图3 源端和目标端配置 源端类型：Kafka 目标端类型：Kafka 规格（QPS）：选择为2000、5000、9000、15000或＞20000。 表2 源端目标端配置参数说明 参数 说明 配置类型 请选择“Kafka地址”或“实例名称”。 选择为“Kafka地址”类型时，请配置以下参数： Kafka地址 请输入Kafka地址。 说明： 支持配置多个地址以逗号分隔，例如：192.168.0.1:111,192.168.0.2:222。 虚拟私有云 请选择虚拟私有云。 子网 请选择子网。 安全协议 请选择安全协议为“SASL_SSL”、“SASL_PLAINTEXT”或“PLAINTEXT”。 认证机制 请选择认证机制为“SCRAM-SHA-512”或“PLAIN”。 用户名 请输入用户名。 密码 请输入密码。 选择为“实例名称”类型时，请配置以下参数： 实例名称 请选择Kafka实例。 接入方式 请选择“密文接入”或“明文接入”。 安全协议 默认为“SASL_SSL”。 认证机制 请选择认证机制为“SCRAM-SHA-512”或“PLAIN”。 用户名 请输入用户名。 密码 请输入密码。 配置“任务对象配置”。 图4 任务对象配置 表3 任务对象配置参数说明 参数 说明 Topics 选择“正则表达式”或“输入/选择”。 说明： 当选择“正则表达式”时需在下方输入表达式。 同步消费进度 请选择是否打开。 说明： 打开后会将消息消费进度同步到目标Kafka。 副本数 请配置副本数。 说明： 自动创建的Topic副本数，不能超过目标端Kafka的Broker数量。 启动偏移量 请选择为“最早”或“最新”。 压缩算法 请选择压缩算法为“none”、“gzip”、“snappy”、“lz4”或“zstd”。 Topic映射 请输入要映射的源端Topic和目标端Topic名称，单击“保存”。 说明： 无论源端和目标端是不是选同一个实例，只要是同一个集群，就要添加Topic映射。 Topic映射的名称不能相同。 完成参数配置后单击“立即购买”，完成事件路由创建，创建成功后可在事件路由页面查看任务状态。 事件路由任务创建完成后默认为“未启用”状态，需要单击“启用”按钮，待状态显示为“运行中”时，任务正式启用。 图5 启用事件路由 事件路由公测期间免费。 如果源端kafka和目标端kafka在不同vpc里，但是他们的broker地址存在重叠，这种情况任务也会失败，规避方式是让用户用一个新的vpc打通其中一个kafka的网络，保障源端和目标端的地址不重叠。 创建任务成功后，会生成mm2开头的Topic，此为运行任务资源所需，请勿删除，若删除此任务后，则Topic可删除。

SSL证书过期了怎么办？ SSL证书存在有效期限制。证书过期之后，将无法继续使用，您需要在证书到期前进行续费。 在华为云SSL证书管理中购买的，已签发且即将到期的付费SSL证书支持续费操作。证书续费详细操作请参见续费SSL证书。 SCM会在证书到期前30天提醒您证书即将到期。 已签发的证书，系统还会在证书到期前两个月、一个月、一周、三天、一天和到期时，发送邮件和短信提醒用户。 上传的证书需要配置到期提醒后，才会发送邮件和短信提醒用户，具体配置操作请参见如何配置SSL证书到期提醒？。上传的证书过期后，如您需要继续使用，请重新购买并上传，上传证书操作具体请参考上传已有SSL证书。 重新购买或续费证书成功后（重新购买、手动续费时您需要重新提交证书审核申请），您将获得一张新的证书，您需要在您的服务器上安装新证书来替换即将过期的证书，或在对应的云产品中替换新的证书。 新证书签发后即可替换，替换过程不会影响业务。 如果您未开通自动续费，证书到期前您需预留3-10个工作日重新购买或手动续费，如果您已开通自动续费，请注意查收验证提醒的短信通知，您收到验证通知后请提前3-10个工作日配合完成相关的验证操作，以免证书审核还未完成之前现有证书已经过期。 证书续费后，新旧证书有效期说明如下： 续费证书信息不变 在证书信息不变情况下，新申请的证书的到期时间=原证书到期时间+新申购证书的有效期。最多累加30天，如果您未开通自动续费，建议您提前30天开始申请证书。 示例：您的原有证书到期时间是2019年10月1号，您于2019年8月31号申请同品牌、同类型SSL证书，有效期为1年。新证书于2019年9月1号签发，签发有效期将为2019年9月1号~2020年9月30号。 此条规则由证书签发CA制定、解释和澄清，如有疑问，华为云将配合您与CA机构进行沟通和协商。 手动续费过程中修改了新证书信息（如域名、证书类型或公司名称等不同于旧证书） 新旧证书有效期分别计算。 新签发证书不影响之前旧证书，旧证书到期前均可使用，两张证书均可使用。 安装国际标准证书详细操作，您可以参考表 安装SSL证书操作示例。 表1 安装SSL证书操作示例 服务器类型 操作示例 Tomcat 在Tomcat服务器上安装SSL证书 Nginx 在Nginx服务器上安装SSL证书 Apache 在Apache服务器上安装SSL证书 IIS 在IIS服务器上安装SSL证书 Weblogic 在Weblogic服务器上安装SSL证书 Resin 在Resin服务器上安装SSL证书 在其他云产品中使用证书操作请参见如何将SSL证书应用到华为云产品？。 父主题： 证书有效期