资料内容仅供您学习参考，如有不当之处，请联系改正或者删除企业开放API开发手册腾讯科技( 上海) 有限公司版权所有 侵权必究目 录1 文档目的和范围 32 整体说明 42.1 拓扑结构 42.2 文件存放位置 42.2.1 同一主机存放 42.3 存放位置说明 52.4 数据文件命名格式说明 52.4.1 文件命名总体规则 53 数据格式详细说明 73.1 文件总体格式说明 73.2 文件头格式说明 73.3 聊天记录格式说明 73.4 会话记录格式说明 83.5 好友资料格式说明 83.6 好友分组格式说明 94 数据获取工具使用说明 104.1 Server 104.2 getmsg 104.3 getsess 104.4 getfrnd 114.5 sendmsg 114.6 Test 115 配置说明 125.1 服务程序oapi_server配置 125.2 工具类程序oapi_tools_***配置 135.3 企业客户端自定义TAB配置 135.4 客户端内嵌页面制作规范 166 LOG文件说明 186.1 oapi_server日志文件 186.2 oapi_tools_***日志文件 187 程序部署说明 197.1 系统要求 198 FAQ 201 文档目的和范围本文档为企业开放API的工具包使用方法和定制开发操作说明。
2 整体说明企业开放的数据以文件方式提供腾讯公司提供获取文件的工具程序, 由各企业在需要时运行该工具程序从腾讯获取数据文件, 工具程序使用方法参加”4数据获取工具使用说明”2.1 拓扑结构获取数据的程序由daemon程序和tools程序组成, daemon程序经过TCP连接与腾讯服务器进行加密通讯tools程序向daemon程序发起各项取数据的请求, 拓扑结构如下图: 公网TCP加密传输内网TCP明文传输toolsdaemon腾讯服务器图2-1 拓扑图2.2 文件存放位置假设TOPDIR为用户指定的存放企业程序及数据的顶层目录2.2.1 同一主机存放假设所有内容位于同一台主机, 则各类文件存放位置如下: 图2-2 同一主机部署目录结构2.3 存放位置说明各目录说明如下: 目录名称目录下文件备注daemon运行与各企业接口机器上的取数据服务程序用于同腾讯公司服务器通讯, 需要有外网接口此目录下仅有Server一个程序文件tools具体获取各类数据文件的命令工具存放位置此目录下所有程序与上述daemon目录里的服务程序交互以获取数据, 此目录下有getmsg、 getsess、 getfrnd、 sendmsg、 Test等五个程序文件conf程序配置文件存放路径此目录下有server.ini和tools.ini文件, 配置文件格式参见”5配置文件说明”log程序运行产生的log文件存放于此此目录下为各程序运行产生的log文件, 每类文件每日产生一个, log文件格式说明参见”6 log文件说明”msg聊天消息记录文件存放目录此目录下为聊天消息记录文件, 每工号每日一个文件sess会话记录文件存放目录此目录下为会话记录文件, 每工号每日一个文件frnd好友资料文件存放目录此目录下为好友资料文件, 每日一个好友详细资料文件和一个好友分组信息文件表2-1 目录说明2.4 数据文件命名格式说明2.4.1 文件命名总体规则所有文件命名总体规则如下: TYPE主号起始日期终止日期后缀工号图2-3 命名总体规则各部分之间以下划线分割。
TYPE: 为M、 S、 F、 G之一M标识此文件为聊天消息记录文件; S标识此文件为会话记录文件; F标识此文件为好友资料文件; G标识此文件为好友分组信息文件主号: 为企业号码工号: 为企业的工号, 若工号为9999表示不特定工号起始日期: 数据起始日期, 日期格式为年月日以YYYYMMDD格式表示终止日期: 数据终止日期后缀: 各类数据文件后缀, 默认为”.dat”示例: 主号的1002工号 0808日的聊天记录文件文件名为 M__1002_ 0808_ 0808.dat主号的 0808日的好友分组信息文件文件名为 G__9999_ 0808_ 0808.dat3 数据格式详细说明本章节对各类数据格式进行详细说明3.1 文件总体格式说明1、 所有文件为纯文本格式; 2、 每个文件分为两大部分: 文件头和文件体文件头为单独一行内容, 是对本数据文件的总体说明之后内容全部为文件体, 文件体为多行内容, 每行是一个数据记录3、 文件内列分隔符为两个字节, 取值为0x02034、 文件内行分隔符为三个字节, 取值为0x0304045、 若非特别说明, 时间值均为1970-1-1 0:0:0至今的秒数6、 若非特别说明, 日期格式为年月日以YYYYMMDD格式表示7、 若非特别说明, 文件中所有字符编码集采用UTF-8编码8、 若非特别说明, 数据文件都是未经排序的3.2 文件头格式说明列编号数据备注1主号企业主号2工号此数据文件记录所属工号3起始日期此数据文件起始时间4终止日期此数据文件终止时间表3-1 文件头格式说明3.3 聊天记录格式说明文件名为”M_主号_工号_日期.dat”。
列编号数据备注1消息方向1-主动( 即企业发送消息) ; 2-被动( 即企业接收消息) 2对方ID和企业进行聊天的对方3时间消息发送时间4长度消息长度5内容消息内容6好友类型该好友的类型( 0普通用户, 1匿名用户) 表3-2 聊天消息记录文件格式3.4 会话记录格式说明文件名为”S_主号_工号_日期.dat”列编号数据备注1操作工号操作工号2对方ID发生会话的对方( 若会话为”5、 工号登录; 6、 工号退出”则此值为0) 3操作时间会话发生时间4操作类型会话数据类型( 1、 用户主动发起会话; 2、 用户发起会话接入; 3、 客服主动发起会话; 4、 关闭会话; 5、 工号登录; 6、 工号退出) 表3-2 会话记录文件格式下面以用户与主号的1002工号进行一次会话为例说明: 1、 T0时间1002工号登录; 2、 T1时间向发起会话; 3、 T2时间1002工号接入该用户开始会话; 4、 T3时间会话结束1002关闭会话; 5、 T4时间1002工号下班退出登录产生的会话记录文件名为S__1002_日期.dat, 文件体为如下5条记录: 1002 0 T0 51002 3614asdfaaff 01234ab T1 11002 3614asdfaaff 01234ab T2 21002 3614asdfaaff 01234ab T3 41002 0 T4 6产生的会话记录文件名为S__9999_日期.dat, 文件体为如下1条记录: 9999 3614asdfaaff 01234ab T1 1注: 1) 3614asdfaaff 01234ab假设为号码的Open ID2) 9999表示获取企业主号下所有会话记录, 当前只有用户主动发起会话记录, 包括被工号接入和未被工号接入的。
3.5 好友资料格式说明文件名为”F_主号_工号_起始日期_终止日期.dat”列编号数据备注1对方ID好友身份ID2系统分组用户所属系统分组( 3001好友, 3002陌生人, 3004黑名单, 3005匿名客户) 3分组列表该好友所属的分组ID列表( 最多8个, 多个工号间由英文字符逗号分割) 4好友类型该好友的类型( 0普通用户, 1匿名用户) 5修改时间简单资料最后修改时间6上次来访好友上次来访时间7创立工号加该好友的工号8最后访问时间最后访问时间9上次接入时间该好友上次被接入的时间10最后接入列表最后服务该好友的5个工号列表( 多个工号间由英文字符逗号分割) 11关系建立时间该好友与企业建立好友关系的时间12更新详细资料时间更新好友详细资料时间13关闭时间关闭会话时间14关闭case时间关闭case时间15备注对该好友的备注16备注姓名该好友备注的真实姓名17性别好友性别( 0未指定; 1男; 2女; 3保密) 18国家该好友所在国家名称19省份该好友所在省份名称20城市该好友所在城市名称21地址该好友所在位置地址22该好友的号码23Email该好友的email24公司该好友的公司名称表3-3 好友资料文件格式3.6 好友分组格式说明文件名为”G_主号_9999_起始日期_终止日期.dat”。
列编号数据备注1分组ID好友分组ID2分组名称好友分组名称4 数据获取工具使用说明本章节对获取数据的各程序使用方法进行说明当前腾讯提供的所有程序均为Linux版本( 内核2.6以上) 4.1 Server此工具用于和腾讯公司服务器进行加密通讯, 并对企业内部提供各种数据获取接口cd TOPDIR/prog/daemon./oapi_Server每次运行时提示输入企业号码及管理密码, 若为动态IP或变换了IP还将提示输入token码4.2 getmsg此工具用于获取聊天消息记录使用方法为: cd TOPDIR/prog/tools./oapi_tools_getmsg -k 1001取本企业的前一天1001工号的聊天记录若要指定工号请加参数: -k 工号若要指定日期请加参数: -d 日期4.3 getsess此工具用于获取会话记录使用方法为: cd TOPDIR/prog/tools./oapi_tools_getsess -k 1002取本企业的前一天1002工号的会话记录若要指定工号请加参数: -k 工号(注意: 这里约定用虚拟工号”9999”表示获取主号相关的会话信息)若要指定日期请加参数: -d 日期4.4 getfrnd此工具用于获取好友资料数据。
使用方法为: cd TOPDIR/prog/tools./oapi_tools_getfrnd默认取本企业的前一天资料有变化的好友的详细资料若要指定日期请加参数: -d 。