华为云用户手册

  • 请求说明 消息头 表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}/requestagentconf 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/requestleaveagentconf 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "address": "88887946", "addressType": "6", "playMode": 2, "voicePath": "y:/conf/120/1136287.V3"} 响应参数 { "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字节。 3 playMode int False 放音模式。 2:播放指定文件音。 默认值为2。 4 voicePath String True 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名,例如: y:/conf/120/1136287.V3 最大长度为127个字符。
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/holdparticipant 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "destAgentNo": 2001} 响应参数 { "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 destAgentNo int True 待转移的目标座席工号。
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/releaseagentconf 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "address": "2002", "addressType": "9"} 响应参数 { "result": {}, "message": "success", "retcode": "0"}
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/applytoshiftpresident 其中,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字节。
  • 接口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-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "prolongTime": 100} 响应参数 { "result": { "applyedTime": 50 }, "message": "success", "retcode": "0"}
  • 响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下: 0:成功 非0:失败 3 result map 请参考表5 表5 实际增加的时间 序号 名称 参数类型 说明 3.1 applyedTime int 实际增加的时间。 单位:分钟。 取值范围:1~1440。 applyedTime时间有可能小于{prolongTime},原因是{prolongTime}加上会议已用时间大于1440分钟。
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/prolongtime 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 请求说明 消息头 表2 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 addressType String True 地址类型。 6:电话号码 9:座席工号 2 address String True 地址标识,即电话号码或者座席工号。 最大长度为24字节。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 prolongTime Integer True 会议延长的时间。 单位:分钟。 取值范围:1~1440。
  • 接口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}/batchaddparticipant 其中,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 批量邀请的与会者信息。 数组最大长度为120。 该对象的参数说明请参考表4。 2 beepTone boolean False 有用户加入会议时是否对该用户播放欢迎语。 默认值为false。 3 playMode int False 放音模式。 2:播放指定文件音。 默认值为2。 4 voicePath String False 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名,例如: y:/conf/120/1136287.V3 当“BeepTone”设置为“true”时,此参数必须设置并且playMode需要为2;当“BeepTone”设置为“false”时,此参数设置无效。 最大长度为127个字符。 5 caller String False 主叫号码。在VDN有号码限制的情况,需要号码在限制范围内。 最大长度为24个字符。 表4 与会者对象参数说明 序号 名称 参数类型 是否必选 说明 1.1 addressType String True 地址类型。 6:电话号码 9:座席工号 1.2 address String True 地址标识。 最大长度为24个字符。 1.3 deviceCallType int False 自定义的设备呼叫类型,详细见表3。 不填或者填null,使用默认值,默认值为0。 取值范围为0-255。 1.4 deviceType int False 自定义的设备类型,详细见表2。 不填或者填null,使用默认值,默认值为0。 取值范围为0-255。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "addresses": [ { "address": "2002", "addressType": "9", "deviceCallType": 1, "deviceType": 66 } ], "beepTone": false, "playMode": 2, "voicePath": "y:/conf/120/1136287.V3", "caller": "1111"} 响应参数 { "result": {}, "message": "success", "retcode": "0"}
  • 接口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个字符。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "addresses": [ { "address": "2002", "addressType": "9" }, { "address": "2001", "addressType": "9" } ]} 响应参数 { "message": "", "retcode": "0", "result": { "noExistParticipants": [] }}
  • 响应说明 表5 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 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-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "attribute": 3, "address": "88887744", "addressType": "6"} 响应参数 { "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 attribute int True 与会者属性。 1:只能听,不能说。 2:只能说,不能听。 3:既能听,也能说。 4:不能听,不能说。 2 addressType String True 地址类型。 6:电话号码 9:座席工号 3 address String True 地址标识,即电话号码或座席工号。 最大长度为24字节。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "playType": 0, "playMode": 2, "voicePath": "y:/conf/120/1136287.V3"} 响应参数 { "result": {}, "message": "success", "retcode": "0"}
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/changeparticipantmode 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": { "confIds": [ 355840 ] }, "message": "success", "retcode": "0"}
共100000条