服务端
服务端API文档

创建会议

更新时间: 2022/08/19 09:11:32

创建会议

  • 主席:会议主持者,发起会议的第一个人,主席只能是坐席或者坐席手机在线,不能直接填写手机号
  • 主席接通之后,才会拉其他人入会
  • 主席挂断,会议才会结束
  • 如果主席是websdk终端方式登陆的,需要websdk适配呼入流程,如果主席是坐席手机在线,不需要websdk参与

URL

  • 请求方法:POST
  • URL:http://voip-host/api/v1/voip/cti/app/conference/create

请求参数

参数名称 类型 是否必选 示例 描述
appId string 必填 eca23f68c66d4acfceee77c200200359 应用ID。
callId string 必填 eca23f68c66d4acfceee77c200200666 会话ID。
channel uuid 必填 1222220 会议成员通道ID,全局唯一,当前作为主席通道id。
seatId string 必填 266080 创建会议的坐席ID,坐席登陆的时候与分机号绑定的坐席id,可查看坐席登陆接口。
didNumber string 选填 05715669535 呼出使用中继did号码,如果传入的didNumber为空,则随机选一个,一个app对应多个didNumber。
members list 选填 "members": [{...}] 加入会议的成员,可以是坐席,可以是坐席手机在线,可以是手机。
  • members
参数名称 类型 是否必选 示例 描述
phone string 选填 15700084133 members的属性:第三方会议成员为用户(用户号码),callee和phone必填一个,两个都填,使用callee。
seatId string 选填 0055 members的属性:第三方会议成员为用户(用户号码),seatId和phone必填一个,两个都填,使用seatId。创建会议的坐席ID,坐席登陆的时候与分机号绑定的坐席id,可查看坐席登陆接口。
didNumber string 选填 05715669535 members的属性:呼出使用中继did号码,如果传入的didNumber为空,则会随机选取。
channel uuid 必填 1222220 members的属性:会议成员通道ID,全局唯一。

返回参数

参数名称 类型 示例 描述
code int 0 状态码。
message string OK 请求成功或者失败描述信息。
data string {"tenant":"cleverdj", . . . } 查询到的数据信息,json格式返回。
appId string eca23f68c66d4acfceee77c200200359 应用ID。
callId string eca23f68c66d4acfceee77c200200666 会话ID。
chairmanChannel string 1baa8818-24c2-49c8-9cf0-7c7fbe5a7992 主席通道id。
conferenceId Long 3604423801 会议ID。

示例

请求示例

{
    "callId": "fdsafgasg3q4523tfg34rt3t524t",
   
    "appId": "eca23f68c66d4acfceee77c200200359",
    "seatId": "05",
    "didNumber": "02131069484",
    "channel": "eca23f68c66d4acfceee77c21111111",
	
	 "members": [
        {
            "seatId": "26000058965656",
            "didNumber": "02131069484",
            "channel": "eca23f68c66d4acfceee722222222"
        },
        {
            "phone": "13989899879",
            "didNumber": "02131069484",
            "channel": "eca23f68c66d4acfceee7333333333"
        }
    ]
}

正常返回示例

{
    "code": 0,
    "message": "OK",
    "data": {
        "appId": "eca23f68c66d4acfceee77c200200359",
        "callId": "fdsafgasg3q4523tfg34rt3t524t",
        "chairmanChannel": "eca23f68c66d4acfceee77c21111111",
        "conferenceId": 3604424980
    }
}

错误码

  • body 中的错误码(code)

    该接口在 HTTP Body 中返回错误码(code),错误码列表请参考业务错误码

此文档是否对你有帮助?
有帮助
去反馈
  • 创建会议
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 错误码