4号工具部分松弛API处理
nftl-slack-tools的Python项目详细描述
库：nftl slack tools
这是一个用于松弛api处理的工具。
提供api的源文档here
安装
pip install nftl-slack-tools
用法
fromnftl_slack_tools.clientimportSlackClientslack=SlackClient(slack_token='xoxp-...')channel=slack.get_channels_api().create('new_order')ifchannel:print('Yupi!')
接口
频道
正在处理通道类别的松弛api包装器
使用量
fromnftl_slack_tools.clientimportSlackClientslack=SlackClient(slack_token='xoxp-...')channels_api=slack.get_channels_api()
可用方法
列表（）
列出松弛组中的所有频道。 通道依赖于令牌，因此如果要列出用户，请使用用户令牌 而不是slackapi管理令牌
松弛API:channels.list
Args:
limit: optional page length ( default: 1000 )
cursor: optional message list cursor for pagination
token: optional auth token that will overwrite SlackApi token
Returns:
None if data is invalid or channels :py:class:`typing.Dict`
with two keys: channels (list of channels) and cursor for pagination
when success
创建（）
使用所需名称创建新频道
松弛api:channels.create
Args:
channel: channel name, can only contain lowercase letters, numbers,
hyphens, and underscores, and must be 21 characters or less
token: optional auth token that will overwrite SlackApi token
Returns:
None if data is invalid or channel info as :py:class:`typing.Dict`
when success
车载（）
邀请用户访问令牌作用域中的所有可用频道（常规频道除外）
松弛API:不可用
Args:
users_ids: :py:class:`typing.List` of slack user ids
cursor: pagination cursor for retry etc.
invite_token: optional auth token that will overwrite SlackApi token
used for channel invitation
Returns:
boolean success status
邀请（）
邀请用户加入频道
松弛api:channels.invite
Args:
channel: Slack channel id like CXJSD234G
user: Slack user id like UXS65F48
token: optional auth token that will overwrite SlackApi token
Returns:
None if data is invalid or channel info as :py:class:`typing.Dict`
when success
信息（）
按频道ID获取频道信息
松弛api:channels.info
Args:
channel_id: Slack channel id
token: optional auth token that will overwrite SlackApi token
Returns:
None if channel_id not found or channel info
as :py:class:`typing.Dict` when success
频道信息（）
按频道名称查找频道信息
松弛API:不可用
Args:
channel_name: Slack channel name
token: optional auth token that will overwrite SlackApi token
Returns:
None if channel_name is not found or channel info
as :py:class:`typing.Dict` when success
历史记录（）
从频道获取消息和事件的历史记录。
松弛api:channels.history
Args:
channel: Slack channel id like CXJSF234X
count: number of messages per page
latest: End of time range
token: optional auth token that will overwrite SlackApi token
Returns:
None if error occurred or number of removed messages
清除历史记录（）
频道历史清洗器 读取历史记录并逐个删除消息
松弛API:不可用
Args:
channel_name: Slack channel name
chat: Chat api handler
Returns:
Number of removed messages
组
处理组类别的松弛api包装器
使用量
fromnftl_slack_tools.clientimportSlackClientslack=SlackClient(slack_token='xoxp-...')channels_api=slack.get_groups_api()
可用方法
列表（）
列出松弛组中的所有组（也称为专用通道）。 组依赖于令牌，因此如果要列出用户，请使用用户令牌 而不是slackapi管理令牌
松弛API:groups.list
Args:
limit: optional page length ( default: 1000 )
cursor: optional message list cursor for pagination
token: optional auth token that will overwrite SlackApi token
Returns:
None if data is invalid or channels :py:class:`typing.Dict`
with two keys: groups (list of groups) and cursor for pagination
when success
创建（）
使用所需名称创建新组
松弛api:groups.create
Args:
group: group name, can only contain lowercase letters, numbers,
hyphens, and underscores, and must be 21 characters or less
token: optional auth token that will overwrite SlackApi token
Returns:
None if data is invalid or group info as :py:class:`typing.Dict`
when success
车载（）
邀请用户加入令牌作用域中可用的所有组（常规除外）
松弛API:不可用
Args:
users_ids: :py:class:`typing.List` of slack user ids
cursor: pagination cursor for retry etc.
invite_token: optional auth token that will overwrite SlackApi token
used for group invitation
Returns:
boolean success status
邀请（）
邀请用户加入组
松弛api:groups.invite
Args:
group: Slack group id like GXJSD234G
user: Slack user id like UXS65F48
token: optional auth token that will overwrite SlackApi token
Returns:
None if data is invalid or group info as :py:class:`typing.Dict`
when success
信息（）
按组ID获取组信息
松弛api:groups.info
Args:
group_id: Slack group id
token: optional auth token that will overwrite SlackApi token
Returns:
None if group_id not found or group info
as :py:class:`typing.Dict` when success
组信息（）
按组名查找组信息
松弛API:不可用
Args:
group_name: Slack channel name
token: optional auth token that will overwrite SlackApi token
Returns:
None if group_name is not found or channel info
as :py:class:`typing.Dict` when success
历史记录（）
从组中获取消息和事件的历史记录。
松弛api:groups.history
Args:
group: Slack group id like GXJSD234G
count: number of messages per page
latest: End of time range
token: optional auth token that will overwrite SlackApi token
Returns:
None if error occurred or number of removed messages
清除历史记录（）
组历史清洗器 读取历史记录并逐个删除消息
松弛API:不可用
Args:
group_name: Slack group name
chat: chat api handler
Returns:
Number of removed messages
用户
处理用户类别的松弛api包装器
使用量
fromnftl_slack_tools.clientimportSlackClientslack=SlackClient(slack_token='xoxp-...')users_api=slack.get_users_api()
可用方法
信息（）
获取有关用户的信息
松弛api:users.info
Args:
user: Slack user id like UXS65F48
locale: should response contain locale info
token: optional auth token that will overwrite SlackApi token
Returns:
None if data is invalid or user info as :py:class:`typing.Dict`
when success
验证名称（）
验证用户名字段
slack api：此方法没有文档记录
Args:
name: name to be validated
token: optional auth token that will overwrite SlackApi token
Returns:
None if data is invalid or boolean validity result
邀请（）
邀请用户进入工作区
slack api：此方法没有文档记录
Args:
email: account email,
firstname: account first name
lastname: account last name
channels: comma separated list of channels (id's) to be invited,
restricted: restrict to guest that can use multiple channels
token: optional auth token that will overwrite SlackApi token
Returns:
None if data is invalid or boolean validity result
聊天
正在处理聊天类别的Slack API包装器
使用量
fromnftl_slack_tools.clientimportSlackClientslack=SlackClient(slack_token='xoxp-...')chat_api=slack.get_chat_api()
可用方法
删除（）
删除消息
松弛api:chat.delete
Args:
channel: Slack channel id like CXJSD234G
ts: Message id
token: optional auth token that will overwrite SlackApi token
Returns:
boolean operation status
注册
正在处理注册类别的松弛API包装器
此类别没有记录在SLACK DOC中
使用量
fromnftl_slack_tools.clientimportSlackClientslack=SlackClient(slack_token='xoxp-...')chat_api=slack.get_signup_api()
可用方法
创建用户（）
使用邀请码创建用户
slack doc中没有记录此方法
Args:
code: invitation code
username: user name that wil be used fo real and display name
passwd: user password to be set
locale: locale for user
tos: TOS key to be accepted
token: optional auth token that will overwrite SlackApi token
Returns:
None if data is invalid or user info as :py:class:`typing.Dict`
when success
部署如何
可用here
欢迎加入QQ群-->： 979659372
