聊天

根据不同需求,嵌入Betalk聊天模块集成到你的web应用程序中,使用该文件中提到的简单的JavaScript调用。

1. 聊天页面(完整视图)

嵌入完整的聊天视图,包括聊天、待办事项、会议等选项,到你的应用程序中:

名称 描述
binder_id Binder ID 可选:如果发起聊天使用Binder ID或者加入同一个聊天)
binder_name Binder Name 可选:如果发起聊天使用Binder ID Binder Name
unique_id UNIQUE_ID(S)以逗号分隔的列表(,) 可选:如果发起聊天使用unique_ids
email 电子邮件(S)以逗号分隔的列表(,) 可选:如果发起聊天使用电子邮件地址
iframe True or false 默认为false。指定在 iframe启动时间轴或一个新的窗口
tagid4iframe iFrame ID 指定的iframe容器的ID – 适用前提IFRAME在选项设置为“真”
border True or false 默认值为true。如果使用的iframe标签里面没有周围的iframe边框指定“false”
scroll True or false 默认为false。如果周围使用的iframe标签添加滚动条内的iframe指定“true”
iframewidth iFrame的宽度 宽度聊天的iFrame的 – 仅适用,如果IFRAME在选项设置为“true”。默认设置为1024px。如果容器控制的宽度,请设置为100%。
iframeheight iFrame的高度 聊天的iFrame的高度 – 仅适用,如果IFRAME在选项设置为“true”。默认设置为768px。如果容器控制的高度,请设置为100%
autostart_meet True or false 默认为false。指定是否符合发起或抛出一个回调的SDK
invite_members True or false 默认为false。指定是否autostart_meet设置为“真”自动开始会议的时候邀请所有当前binder 的成员
autostart_note True or false 默认为false。指定是否注意要启动或抛出一个回调的SDK
extension  

下面是可与开始聊天API一起使用的扩展推荐
要显示或隐藏的邀请成员对话。默认为false。
{
    "show_dialogs": { "member_invite": true/false }
}
//要显示或隐藏共享对话框。默认值为true。
{
    "show_dialogs": { "share": true/false }
}
//要添加自己的CMS或存储库到添加文件选项。
{
    "menus":[{"add_page":[
        {
            "menu_name":"My CMS",
            "position":"bottom"
        }]
    }]
}
//监听器来处理自定义添加页面选项回调。
add_page: function(event) {
    if (event.action == "My CMS") {
     alert ("Clicked on My CMS for Binder Id: " + event.binder_id);
    }
}

Betalk开始通过侦听器处理聊天回调事件

事件 描述 属性
start_chat 触发聊天的成功的开始 SESSION_ID,binder_id
error 触发一个错误的情况下 ERROR_CODE,ERROR_MESSAGE
invite_member 触发邀请会员加入讨论组没有表显示“member_invite”对话框 binder_id
request_meet 触发请求启动的会议,而不autostart_meet binder_id
start_meet 触发成功的开始会议并autostart_meet session_key可以,SESSION_ID,binder_id
save_meet 触发会议保存与autostart_meet session_key可以,SESSION_ID,binder_id
invite_meet 点击邀请按钮时与autostart_meet session_key可以,SESSION_ID,binder_id
end_meet 出发会议结束与autostart_meet
exit_meet 当触发时,与会者离开会议autostart_meet
leave_binder 触发用户留下讨论组 SESSION_ID,binder_id
remove_binder_user 触发用户从讨论组得到除去 SESSION_ID,binder_id
request_note 触发请求启动笔记没有autostart_note SESSION_ID,binder_id,page_index
start_note 触发成功启动笔记autostart_note session_key可以,SESSION_ID
save_note 当用户关闭并保存笔记autostart_note destination_binder_id,share_url,DOWNLOAD_URL
cancel_note 触发用户关闭和不保存笔记autostart_note
share 触发选定的页面共享链接 SESSION_ID,binder_id,share_url,DOWNLOAD_URL
publish_feed 触发用户执行操作 SESSION_ID,binder_id,消息
receive_feed 触发其他讨论组用户进行的事件 SESSION_ID,binder_id,消息,标题,feed_unread_count
request_view_member 触发单击聊天用户的头像 SESSION_ID,binder_id,USER_ID,UNIQUE_ID
reach_limit 触发达到组织或用户的限制 SESSION_ID,参数error_code,类型和额外取决于“类型”属性:

  • board_history_max:达到最大的聊天记录信息; 属性:值,binder_id
  • user_cloud_max:达到用户的最大存储限制; 属性:值

示例代码,嵌入聊天连接(使用 binder ID):

ar options = {
    binder_id: BINDER_ID,
    iframe: true,
    tagid4iframe: "container",
    iframewidth: "920px",
    iframeheight: "650px",
    autostart_meet: true,
    autostart_note: false,
    start_chat: function(event) {
        alert("Chat started session Id: " + event.session_id);
    },
    start_meet: function(event) {
        alert("Meet started session key: " + event.session_key + " session id: " + event.session_id);
    },
    end_meet: function(event) {
        alert("Meet end event");
    },
    invite_member: function(event) {
        alert("Invite member into binder Id: " + event.binder_id);
    },
    request_note: function(event) {
        alert("Note start request");
    },
    error: function(event) {
        alert("Chat error code: " + event.error_code + " error message: " + event.error_message);
    }
};
Betalk.chat(options);

示例代码,嵌入开始聊天(使用唯一的用户ID):

var options = {
    unique_id: "unique_id_02,unique_id_03",
    iframe: true,
    tagid4iframe: "container",
    iframewidth: "820px",
    iframeheight: "450px",
    autostart_meet: true,
    autostart_note: false,
    start_chat: function(event) {
        alert("Chat started session Id: " + event.session_id);
    },
    invite_meet: function(event) {
        alert("Meet invite");
    },
    start_meet: function(event) {
        alert("Meet started session key: " + event.session_key + " session id: " + event.session_id);
    },
    end_meet: function(event) {
        alert("Meet end event");
    },
    invite_member: function(event) {
        alert("Invite member into binder Id: " + event.binder_id);
    },
    request_note: function(event) {
        alert("Note start request");
    },
    error: function(event) {
        alert("Chat error code: " + event.error_code + " error message: " + event.error_message);
    }
};
Betalk.chat(options);

 

2. 查看聊天

仅嵌入聊天层(而不是网页,待办事项等)到应用程序

可选参数,包括在Betalk.chatView()API请求:

名称 描述
binder_id Binder ID 可选:如果使用的Binder ID启动chatView(或加入了同一个聊天)
UNIQUE_ID UNIQUE_ID(S)以逗号分隔的列表(,) 可选:如果启动使用unique_ids列表聊天
email 电子邮件(S)以逗号分隔的列表(,) 可选:如果启动使用的电子邮件地址列表中的聊天
IFRAME True or false 默认为false。指定要启动chatView在iframe或在一个新的窗口
tagid4iframe iFrame的ID 指定的iframe容器的ID – 适用前提IFRAME在选项设置为“真”
border True or false 默认值为true。如果使用的iframe标签里面没有周围的iframe边框指定“假”
scroll True or false 默认为false。如果周围使用的iframe标签添加滚动条内的iframe指定“真”
iframewidth iFrame的宽度 宽度聊天的iFrame的 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为850像素。如果容器控制的宽度,请设置为100%
iframeheight iFrame的高度 聊天的iFrame的高度 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为500px的。如果容器控制的高度,请设置为100%
autostart_note True or false 默认为false。指定是否注意要启动或抛出一个回调的SDK

Betalk开始通过侦听器处理chatView回调事件

事件 描述 属性
start_chat 触发成功启动chatView SESSION_ID,binder_id
error 触发一个错误 ERROR_CODE,ERROR_MESSAGE
request_note 触发请求启动笔记autostart_note SESSION_ID,binder_id,page_index
start_note 触发成功启动笔记autostart_note session_key可以,SESSION_ID
save_note 当触发用户关闭并保存笔记autostart_note destination_binder_id,share_url,DOWNLOAD_URL
cancel_note 当触发用户关闭并不能挽救注意到autostart_note
share 触发共享链接,选定的页面 SESSION_ID,binder_id,share_url,DOWNLOAD_URL
publish_feed 触发用户执行操作 SESSION_ID,binder_id,消息
receive_feed 触发其他讨论组用户进行的事件 SESSION_ID,binder_id,消息,标题,feed_unread_count
request_view_member 触发单击聊天用户的头像 SESSION_ID,binder_id,USER_ID,UNIQUE_ID
reach_limit 触发达到组织或用户的限制 SESSION_ID,参数error_code,类型和额外取决于“类型”属性

  • board_history_max:达到最大的聊天记录信息; 属性:值,binder_id
  • user_cloud_max:达到用户的最大存储限制; 属性:值

示例代码,在一个div开始chatview

var options = {
    binder_id: BINDER_ID,
    iframe: true,
    tagid4iframe: "container",
    autostart_note: false,
    start_chat: function(event) {
        alert("ChatView started session Id: " + event.session_id);
    },
    request_note: function(event) {
        alert("Note start request");
    },
    error: function(event) {
        alert("ChatView error code: " + event.error_code + " error message: " + event.error_message);
    }
};
Betalk.chatView(options);

3. 页面查看

仅在应用程序中嵌入聊天模块的页面层:

可选参数,包含Betalk.pageView()API请求:

名称 描述
binder_id 讨论组ID 讨论组ID的浏览量
PAGE_ID 网页ID 可选:而不是显示在讨论组页面的缩略图,可以显示指定的页面
IFRAME True or false 默认为false。指定要启动浏览量在iframe或在一个新的窗口
tagid4iframe iFrame的ID 指定的iframe容器的ID – 适用前提IFRAME在选项设置为“真”
border True or false 默认值为true。如果使用的iframe标签里面没有周围的iframe边框指定“假”
scroll True or false 默认为false。如果周围使用的iframe标签添加滚动条内的iframe指定“真”
iframewidth iFrame的宽度 宽度聊天的iFrame的 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为850像素。如果容器控制的宽度,请设置为100%。
iframeheight iFrame的高度 聊天的iFrame的高度 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为500px的。如果容器控制的高度,请设置为100%

Betalk开始通过侦听器处理浏览量回调事件

事件 描述 属性
start_page 触发浏览量的成功的开始 SESSION_ID,binder_id
Eroro 触发一个错误的情况下 ERROR_CODE,ERROR_MESSAGE
share 触发共享链接,选定的页面 SESSION_ID,binder_id,share_url,DOWNLOAD_URL
publish_feed 触发用户执行操作 SESSION_ID,binder_id,消息
receive_feed 触发其他粘合剂用户进行的事件 SESSION_ID,binder_id,消息,标题,feed_unread_count
reach_limit 触发达到组织或用户的限制 SESSION_ID,参数error_code,类型和额外取决于“类型”属性

  • user_cloud_max:达到用户的最大存储限制; 属性:值

示例代码,在DIV中启动pageview

var options = {
    binder_id: BINDER_ID,
    iframe: true,
    tagid4iframe: "container",
    start_page: function(event) {
        alert("PageView started session Id: " + event.session_id);
    },
    share: function(event) {
        alert("Share session Id: " + event.session_id + " binder Id: " + event.binder_id + " page Ids: " + event.page_id);
    },        
    error: function(event) {
        alert("PageView error code: " + event.error_code + " error message: " + event.error_message);
    }
};
Betalk.pageView(options);

 4. 待办事项页面

仅嵌入聊天模块的待办事项页面层到你的应用程序中,

可选参数,包含etalk.todoView()API请求:

名称 描述
binder_id 活页夹ID 启动与粘合剂ID的todoView
IFRAME True or false 默认为false。指定要启动todoView在iframe或在一个新的窗口
tagid4iframe iFrame的ID 指定的iframe容器的ID – 适用前提IFRAME在选项设置为“true”
border True or false 默认值为true。如果使用的iframe标签里面没有周围的iframe边框指定“false”
scroll True or false 默认为false。如果周围使用的iframe标签添加滚动条内的iframe指定“true”
iframewidth iFrame的宽度 宽度聊天的iFrame的 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为850像素。如果容器控制的宽度,请设置为100%
iframeheight iFrame的高度 聊天的iFrame的高度 – 仅适用,如果IFRAME在选项设置为“真”。默认设置为500px的。如果容器控制的高度,请设置为100%。

Betalk开始通过侦听器处理todoView回调事件

事件 描述 属性
start_todo 触发todoView的成功的开始 SESSION_ID,binder_id
Error 触发一个错误的情况下 ERROR_CODE,ERROR_MESSAGE
publish_feed 触发用户执行操作 SESSION_ID,binder_id,消息
receive_feed 触发其他粘合剂用户进行的事件 SESSION_ID,binder_id,消息,标题,feed_unread_count
reach_limit 触发达到组织或用户的限制 SESSION_ID,参数error_code,类型和额外取决于“类型”属性

  • user_cloud_max:达到用户的最大存储限制; 属性:值

示例代码,在DIV中启动todoView:

var options = {
    binder_id: BINDER_ID,
    iframe: true,
    tagid4iframe: "container",
    start_todo: function(event) {
        alert("TodoView started session Id: " + event.session_id);
    },
    error: function(event) {
        alert("Todo error code: " + event.error_code + " error message: " + event.error_message);
    }
};
Betalk.todoView(options);