语音频道API

获取成员语音频道状态

GetChannelVoiceMemberStatus

接口

地址版本方式权限
/api/v2/channel/voice/member/statusv2POST通用权限-查看频道

描述

用于获取成员语音频道状态

提示

只对在语音频道上的成员有效

入参

字段类型必传说明
islandSourceIdstring群ID
dodoSourceIdstringDoDoID

出参

字段类型说明
statusint返回码
messagestring返回信息
dataobject返回数据

数据

字段类型说明
channelIdstring所在语音频道ID
spkStatusint语音输出状态(扬声器的状态),0:关闭,1:开启
micStatusint语音输入状态(麦的状态),0:关闭,1:开启
micSortStatusint麦序模式状态,1:在麦下,2:请求上麦,3:在麦上,自由模式时统一为在麦上

入参示例

{
    "islandSourceId": "10001",
    "dodoSourceId": "666666"
}

出参示例

{
    "data": {
        "channelId": "1000101",
        "micStatus": 1,
        "spkStatus": 1,
        "micSortStatus": 3
    },
    "status": 0,
    "message": "success"
}

移动语音频道成员

SetChannelVoiceMemberMove

接口

地址版本方式权限
/api/v2/channel/voice/member/movev2POST通用权限-查看频道、语音频道-移动成员

描述

用于将成员移动至指定语音频道

提示

只对在语音频道上的成员有效

入参

字段类型必传说明
islandSourceIdstring群ID
dodoSourceIdstringDoDoID
channelIdstring目标语音频道ID

出参

字段类型说明
statusint返回码
messagestring返回信息

入参示例

{
    "islandSourceId": "10001",
    "dodoSourceId": "666666",
    "channelId": "1000101"
}

出参示例

{
    "status": 0,
    "message": "success"
}

管理语音中的成员

SetChannelVoiceMemberEdit

接口

地址版本方式权限
/api/v2/channel/voice/member/editv2POST通用权限-查看频道、语音频道-管理语音

描述

用于管理语音频道中的成员

提示

只对在语音频道上的成员有效

入参

字段类型必传说明
channelIdstring语音频道ID
dodoSourceIdstringDoDoID
operateTypeint执行管理
0:下麦,自由模式:无作用;麦序模式:设置下麦或拒绝上麦
1:上麦,自由模式:无作用;麦序模式:同意上麦或邀请上麦
2:闭麦,自由模式:闭麦该成员;麦序模式:闭麦该成员
3:移出语音频道

出参

字段类型说明
statusint返回码
messagestring返回信息

入参示例

{
    "channelId": "1000101",
    "dodoSourceId": "666666",
    "operateType": 0
}

出参示例

{
    "status": 0,
    "message": "success"
}