会议

1. 获取会议列表

根据{user_id}获取会议列表

GET / {user_id} /meets

URL参数

名称 类型 描述
starts Stirng 可选:会议开始和预定时间,按UTC时区ISO-8601格式“YYYY-MM-DDTHH:MM:SSZ”。默认为当前时间。
days Number 可选:从开始到会议的天数,最多为30天。默认值是30天。

请求:

GET /me/meets?days=5

响应:

{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "meets": [
            {
                "topic": "Scheduled Meet",
                "session_key": "226653428",
                "binder_id": "BGgkHVCJJ5CXrmHUByCTD90",
                "status": "SESSION_SCHEDULED",
                "starts": null,
                "ends": null,
                "scheduled_starts": "2015-03-23T19:30:00Z",
                "scheduled_ends": "2015-03-23T20:30:00Z",
                "invitees": [
                    {
                        "email": "joe@test.com",
                        "name": "Joe Smith",
                        "host": true,
                        "unique_id": "",
                        "status": "INVITED"
                    },
                    {
                        "email": "john@test.com",
                        "name": "John Doe",
                        "host": false,
                        "unique_id": "",
                        "status": "DENIED/REMOVED"
                    }
                ],
                "participants": null,
                "total_participants": 0,
                "total_invitees": 2
            }
        ]   
    }
}

2. 获取会议信息

根据{session_key}获取会议信息

GET /meets/ {session_key}

请求:

GET /meets/226653428

响应进行中会议:

{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "topic": "AA's Meet",
        "session_key": "598561162",
        "binder_id": "BGgkHVCJJ5CXrmHUByCTD90",
        "status": "SESSION_STARTED",
        "starts": "2015-08-28T22:50:32Z",
        "ends": null,
        "scheduled_starts": null,
        "scheduled_ends": null,
         "invitees": [
             {
                  "email": "joe@test.com",
                  "name": "Joe Smith",
                  "host": false,
                  "unique_id": "",
                  "status": "INVITED"
             },
             {
                  "email": "",
                  "name": "Tester",
                  "host": false,
                  "unique_id": "tester1",
                  "status": "ACCEPTED/ADDED"
             }
         ],
        "participants": [
            {
                "name": "AA BB",
                "email": "",
                "starts": "2015-08-28T22:50:32Z",
                "host": true,
                "unique_id": "test",
                "roster_id": "btweb-95352c64-2024-4c62-9414-fcab7a08f773"
            },
            {
                "name": "Test33",
                "email": "",
                "starts": "2015-08-28T23:08:36Z",
                "host": false,
                "unique_id": "tester2",
                "roster_id": "btweb-3fe1eec0-7f57-4f00-a923-25534a2ea658"
            }
        ],
        "total_participants": 2,
        "total_invitees": 2   
     }
}

响应已结束会议:

{
    "code": "RESPONSE_SUCCESS",
    "data": {
         "topic": "Meet",
         "session_key": "627792853",
         "binder_id": "BOOE6hA90Yk7QdtihJl3zUB",
         "status": "SESSION_ENDED",
         "starts": "2015-12-05T02:30:32Z",
         "ends": "2015-12-05T02:33:24Z",
         "scheduled_starts": null,
         "scheduled_ends": null,
         "invitees": null,
         "participants": [
             {
                  "name": "aaa bbb",
                  "email": "",
                  "starts": "2015-12-05T02:30:32Z",
                  "host": true,
                  "unique_id": "test",
                  "roster_id": "btweb-8c560f22-8636-4b67-b3ef-5501b4476898"
             }
         ],
         "total_participants": 1,
         "total_invitees": 0,
         "desktopshares": [
             {
                  "roster_id": "btweb-8c560f22-8636-4b67-b3ef-5501b4476898",
                  "starts": "2015-12-05T02:32:04Z",
                  "ends": "2015-12-05T02:32:43Z"
             }
         ]
     }
}

3. 邀请用户加入会议

通过电子邮件地址或unique_id邀请用户加入会议。

POST /meets/ inviteuser

JSON 参数

名称 类型 描述
session_key String 会议ID,通过回调事件启动会议SDK 或 会议日程api。
SESSION_ID String 可选:会议会话ID,使用回调事件启动会议SDK。
email String 被邀请的用户电子邮件地址。
UNIQUE_ID String 被邀请的unique_id。
org_id String 可选:org_id + unique_id邀请另一个组织用户。
message String 可选:在电子邮件邀请函发送可选的消息。
email_off boolean 可选:是否关闭发送电子邮件。默认为false。
notification_off boolean 可选:是否要关闭推送通知。默认为false。

请求:

POST /meets/inviteuser

{
    "session_key": "441363470",
    "users": [
    {
        "user": {
            "email": "test@gmail.com"
        }
    },
    {
        "user": {
            "unique_id": "xa12233425343"
        }
    },
    {
        "user": {
            "unique_id": "A453224",
            "org_id": "PTHpzIJ4jGx1upvgjWZa4S1"
        }
    }
    ],
    "message" : "Please join the Meet"
}

响应:

{
    "code": "RESPONSE_SUCCESS"
}

4.  从预约会议删除用户

从预约会议删除一个用户。

POST /meets/ removeuser

JSON 参数

名称 类型 描述
session_key String 会议ID,调用预约会议API。
email String 在预约会议现有用户的电子邮件地址。
UNIQUE_ID String 预约会议现有用户的unique_id。
org_id String 可选:org_id + unique_id删除另一个组织用户。
suppress_feed boolean 可选:是否关闭订阅。默认为false。

使用电子邮件请求:

POST /meets/removeuser
{
    "session_key": "441363470",
    "email": "joe@test.com"
}

使用UNIQUE_ID 请求:

POST /meets/removeuser
{
    "session_key": "441363470",
    "unique_id": "fhas211nsjkaswd"
}

响应:

{
    "code": "RESPONSE_SUCCESS"
}

5. 预约会议

安排未来进行的会议

POST/meets/schedule

JSON参数

名称 类型 描述
name String 会议主题。
starts String 格式为ISO-8601 “YYYY-MM-DDTHH:MM:SSZ”与UTC时区。如果选择了这个,不需要设置“START_TIME”和“END_TIME”。
ends String 可选 :格式为ISO-8601 “YYYY-MM-DDTHH:MM:SSZ”与UTC时区,结束时间必须大于开始。如果没有设置,则默认为一小时。
start_time Number 起自1970年1月1日以毫秒为单位计算。如果选择了这个,不需要设置“START_TIME”和“END_TIME”。
end_time Number 可选:自1970年1月1日以毫秒为单位计算的会议的结束时间,必须大于START_TIME。如果没有设置,默认为一小时。
agenda String 可选:预约会议。
auto_recording Boolean 可选:会议开始时自动录制。默认为false。
join_before_minutes Number 可选:与会者被允许在主持人前加入会议的时间。最大为30分钟。
record_multiple_video_channel Boolean 可选:多个频道同时录制会议。默认为false。

请求:

POST /meets/schedule
{
    "name": "Project Meeting",
    "start_time": 1340839882787,
    "end_time": 1342813061602,
    "agenda" : "Project planning and review"
}

响应:

{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "schedule_binder_id": "B7U3ze39oO08PYO70973lX6",
        "binder_name": "Project Meeting",
        "revision": 3,
        "session_key": "540334434",
        "startmeet_url": "https://www.Betalk.com/540334434",
        "scheduled_starts": "2014-03-21T09:30:00Z",
        "scheduled_ends": "2014-03-21T10:30:00Z",
        "created_time": 1355782091405,
        "updated_time": 1355782091405
    }
}

6. 更新会议

根据{session_key}更新。

POST /meets/ {session_key}

JSON 参数

名称 类型 描述
name String 会议主题。
starts String 格式为ISO-8601 “YYYY-MM-DDTHH:MM:SSZ”与UTC时区。如果选择了这个,不需要设置“START_TIME”和“END_TIME”。
ends String 可选 :格式为ISO-8601 “YYYY-MM-DDTHH:MM:SSZ”与UTC时区,结束时间必须大于开始。如果没有设置,则默认为一小时。
start_time Number 起自1970年1月1日以毫秒为单位计算。如果选择了这个,不需要设置“START_TIME”和“END_TIME”。
end_time Number 可选:自1970年1月1日以毫秒为单位计算的会议的结束时间,必须大于START_TIME。如果没有设置,默认为一小时。
agenda String 可选:预约会议。
auto_recording Boolean 可选:会议开始时自动录制。默认为false。
join_before_minutes Number 可选:与会者被允许在主持人前加入会议的时间。最大为30分钟。
record_multiple_video_channel Boolean 可选:多个频道同时录制会议。默认为false。

请求:

POST /meets/540334434
{
    "name": "Updated Project Meeting",
    "starts": "2014-03-21T09:30:00Z",
    "ends": "2014-03-21T10:30:00Z",
    "agenda" : "Updated Project planning and review"
}

响应:

{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "schedule_binder_id": "B7U3ze39oO08PYO70973lX6",
        "binder_name": "Updated Project Meeting",
        "revision": 7,
        "session_key": "540334434",
        "startmeet_url": "https://www.betalk.com/540334434",
        "scheduled_starts": "2014-03-21T09:30:00Z",
        "scheduled_ends": "2014-03-21T10:30:00Z",
        "created_time": 1355782091405,
        "updated_time": 1355782091405
    }
}

7.  删除会议

根据{session_key}删除会议

DELETE /meets/ {session_key}

请求:

DELETE /meets/540334434

响应:

{
    "code": "RESPONSE_SUCCESS"
}

8. 获取会议录制列表

根据{user_id}获取会议录制

GET / {user_id} /meets/recordings

请求:

GET /me/meets/recordings

响应:

{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "counts": 1,
        "recordings": [
        {
            "content_type": "video/mp4",
            "content_length": 1636101,
            "playback_url": "https://www.betalk.com/board/BWzTpoV84WTFlKaicYvQ92L/458",
            "download_url": "https://www.betalk.com/board/BWzTpoV84WTFlKaicYvQ92L/458?d=1",
            "created_time": 1398824151995
        }
        ]
    }
}

9. 获取会议录制

GET/meets/recordings/ {session_key}

请求:

GET /meets/recordings/540334434

响应:

{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "counts": 1,
        "recordings": [
        {
            "content_type": "video/mp4",
            "content_length": 1636101,
            "playback_url": "https://www.betalk.com/board/BWzTpoV84WTFlKaicYvQ92L/458",
            "download_url": "https://www.betalk.com/board/BWzTpoV84WTFlKaicYvQ92L/458?d=1",
            "created_time": 1398824151995
        }
        ]
    }
}

10. 获得会议状态

根据{session_key}得到状态。状态值SESSION_STARTED,SESSION_SCHEDULED,SESSION_ENDED,或SESSION_DELETED。

GET /meets/status/ {session_key}

请求:

GET /meets/status/540334434

响应:

{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "status": "SESSION_STARTED"
    }
}

11. 下载会议日历ICS文件

根据{session_key}下载安排的会议日历ICS文件。

GET /meets/ downloadICS / {session_key}

请求:

GET /meets/downloadICS/540334434

响应:

#ICS file