修改与会者属性
前置条件
- 座席已签入
- 当前座席是会议主席
场景描述
修改与会者通道属性,只有主席才有权限修改与会者通道属性。
接口方法
设置成“POST”。该接口仅支持POST方法,不支持GET、PUT和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/agentconf/{agentid}/changeparticipantmode
其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。
序号 |
参数名 |
数据类型 |
选取原则 |
说明 |
---|---|---|---|---|
1 |
agentid |
string |
True |
座席的工号,取值范围:101~59999。 |
日志中的方法名
changeParticipantMode
请求说明
- 消息头
表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字节。
响应说明
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
message |
string |
描述
说明:
当出现错误提示“Unknown ERROR._*****”时,*****表示CTI错误结果码,详情请参见表2。 |
2 |
retcode |
string |
错误码。取值如下: 0:成功 非0:失败 |
3 |
result |
object |
预留字段 |
触发事件
修改与会者属性值为1或3时,会收到以下事件。
- 与会者变更事件(AgentConf_ParticipantChanged)
修改与会者属性值为2或4是,不会收到任何事件。
错误结果码
- 000-002
- 100-006
- 100-007
- 101-001
- 101-002
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
{ "attribute": 3, "address": "88887744", "addressType": "6" }
- 响应参数
{ "result": {}, "message": "success", "retcode": "0" }