清晰的api python。
crisp-api的Python项目详细描述
#python crisp api
crisp api python包装器。验证、发送消息、获取对话、从python代码访问代理帐户。
2018 crisp im sarl版权所有。《信息复制许可证》见《信息复制许可证》
***实施**:[Crisp平台-API~v1(https://docs.crisp.chat/api/v1/)参考版本:12/31/2017
***维护者**:[@valeriansaliansaliou(https://github.com/valeriansaliansaliou)
安装库:
``bash
pip-install-crisp-crisp-install-crisp-api
````
>
然后,导入它:
``python
from crisp-api import crisp
`````
使用"identifier"和"key"令牌构造一个新的经过身份验证的crisp客户端。
``python
client=crisp()
client.authenticate(identifier,key)
````
身份验证
要根据API进行身份验证,请使用[Crisp令牌生成实用程序](https://go.crisp.chat/account/token/)生成会话标识符和会话密钥**一次**。您将得到一个由2个值组成的令牌密钥对。
**将您的令牌密钥对值保留为私有,并将其安全存储以供长期使用。**
>然后,在创建后立即将身份验证参数添加到"client"实例:
``python
client=crisp()
ticate("13937834-F6CE-4556-AE4F-9e0c54faf038","eb6c362345521d7a6c35f5b29f3fa756e893f034ed551d84518961c5ff16dec")
客户机。authenticate(标识符,密钥)
API。不要生成太多的令牌,因为我们可能会使旧的令牌失效,从而为新的令牌腾出空间。**
\resource methods
实现了最有用的crisp api资源。**编程方法的名称是根据它们在[API引用](https://docs.crisp.chat/api/v1/)中的标签名称命名的*。
因此,在读取[API引用](https://docs.crisp.chat/api/v1/)时,可以直接在库中查找它们。
实例。例如,实例化"client=crisp()",然后调用例如:`client.website.list_conversations(website戥id,1)`。
调用将数据写入api的方法时(例如,使用"client.website.send戥message戥in戥conversation()`"发送消息,需要这样提交:
``python
website戥id="88972681-a00c-4b3b-a383-cab281636484"
会话id="session_9df2a21e-f113-41d4-8ed2-bad8b49cafd1"
client.website.send_message_in_conversation(
网站id,会话id,
{{
"type":"文本",
"内容":"此消息来自python crisp api!:)",
"from":"operator",
"origin":"chat"
}
")
`````
站点ID,数据)`
***检查会话是否存在**:`client.website.check\u conversation\u exists(website\u id,session\u id)`
**get a conversation**:`client.website.get\u conversation(website\u id,session\u id)`
**删除会话**:`client.website.remove\u conversation(website\u id,session\u id)`
**现有会话**:`client.website.initiate_conversation_with_existing_session(website_id,session_id)`
**get messages in conversation**:`client.website.get_messages_in_conversation(website_id,session_id,query)`
***更新会话中的消息**:`client.website.update_message_in_conversation(网站ID、会话ID、指纹、数据)`
**在会话中编写消息**:`client.website.compose_in_conversation(网站ID、会话ID、数据)`
**将消息标记为已在会话中读取**:`client.website.mark_messages_read_in_conVersation(网站ID,会话ID,数据)`
**mark messages as delivered in conversation**:`client.website.mark_messages_delivered_in_conversation(网站ID,会话ID,数据)`
**get conversation routing assign**:`client.website.get_conversation_routing assign(网站ID,会话ID)`
**assign conversation routing**:`client.website.assign_conversation_routing(网站ID,会话ID,数据)`
**get conversation metas**:`client.website.get_conversation_metas(网站ID,会话ID)`
**update conversation metas**:`client.website.update_conversation_metas(网站ID,会话ID,数据)`
**list conversation pages**:`client.website.list_conversati在"U"页上(网站ID、会话ID、页面编号)`
***列出对话事件**:`client.website.list\u对话事件(网站ID、会话ID、页面编号)`
***获取对话状态**:`client.website.get\u对话状态(网站ID、会话ID)`
***更改对话状态**:`client.website.change\u对话状态(webs站点ID,会话ID,数据)`
**get block status for conversation**:`client.website.get_block_status_for_conversation(website_id,session_id)`
**block incoming messages for conversation**:`client.website.block_incoming_messages_for_conversation(website_id,session_id,data)`
**request email cription for conversation**:`cl客户端。网站。请求电子邮件抄本(网站ID、会话ID、数据)`
**website people**
**get people statistics**:`client.website.get人脉统计(网站ID)`
**list people segments**:`client.website.list人脉段(网站ID、页码)`
**list people profiles**:`client.website.list人脉段(网站ID、页码)。列出用户配置文件(网站ID,页面编号)`
**add new people profile**:`client.website.add_new_people_profile(网站ID,数据)`
***检查用户配置文件是否存在**:`client.website.check_people_profile存在(网站ID,用户ID)`
**get people profile**:`client.website.get_people_profile(网站ID,用户ID)`
***保存人员配置文件**:`客户端.网站.保存人员配置文件(网站ID,人员ID,数据)`
**更新人员配置文件**:`客户端.网站.更新人员配置文件(网站ID,人员ID,数据)`
***删除人员配置文件**:`客户端.网站.删除人员配置文件(网站ID,人员ID)`
**列出人员对话**:`客户端.网站.列表用户对话(网站ID,用户ID,页面编号)`
+**添加用户事件**:`client.website.add用户事件(网站ID,用户ID,数据)`
+**列表用户事件**:`client.website.list用户事件(网站ID,用户ID,页面编号)`
+**获取用户数据**:`client.website.get用户数据(网站ID,用户ID,页面编号)`
+**获取用户数据**:`client.website.get用户数据(网站ID,用户ID)`
+**保存用户数据**:`客户端.网站.保存用户数据(网站id,用户id,数据)`
+**获取用户订阅状态**:`客户端.网站.获取用户订阅状态(网站id,用户id)`
+**更新用户订阅状态**:`客户端.网站.更新用户订阅状态(网站id,用户id,数据)`
**网站库**
**create website**:`client.website.create_website(data)`
**get a website**:`client.website.get_website(website_id)`
**delete a website**:`client.website.delete_website(website_id)`
**website batch**
**batch resolve items**:`client.website.batch_resolve_items(website_id,data)`
**batch read items**:`client.website.batch\u read\u items(website\u id,data)`
**batch remove items**:`client.website.batch\u remove\u items(website\u id,data)`
**website availability**
**get website availability status**:`client.website.get_website_availability_status(website_id)`
**website operator**
**list website operators**:`client.website.list_website_operators(website_id)`
**list last active website operatorORS**:`client.website.list_last_active_website_operators(website_id)`
**website settings**
**get website settings**:`client.website.get_website_settings(website_id)`
**update website settings**:`client.website.update_website_settings(website_id,data)`
**web网站访问者**
***计数访问者**:`客户端.网站.计数访问者(网站ID)`
***列表访问者**:`客户端.网站.列表访问者(网站ID,页面编号)`
crisp api python包装器。验证、发送消息、获取对话、从python代码访问代理帐户。
2018 crisp im sarl版权所有。《信息复制许可证》见《信息复制许可证》
***实施**:[Crisp平台-API~v1(https://docs.crisp.chat/api/v1/)参考版本:12/31/2017
***维护者**:[@valeriansaliansaliou(https://github.com/valeriansaliansaliou)
安装库:
``bash
pip-install-crisp-crisp-install-crisp-api
````
>
然后,导入它:
``python
from crisp-api import crisp
`````
使用"identifier"和"key"令牌构造一个新的经过身份验证的crisp客户端。
``python
client=crisp()
client.authenticate(identifier,key)
````
身份验证
要根据API进行身份验证,请使用[Crisp令牌生成实用程序](https://go.crisp.chat/account/token/)生成会话标识符和会话密钥**一次**。您将得到一个由2个值组成的令牌密钥对。
**将您的令牌密钥对值保留为私有,并将其安全存储以供长期使用。**
>然后,在创建后立即将身份验证参数添加到"client"实例:
``python
client=crisp()
ticate("13937834-F6CE-4556-AE4F-9e0c54faf038","eb6c362345521d7a6c35f5b29f3fa756e893f034ed551d84518961c5ff16dec")
客户机。authenticate(标识符,密钥)
API。不要生成太多的令牌,因为我们可能会使旧的令牌失效,从而为新的令牌腾出空间。**
\resource methods
实现了最有用的crisp api资源。**编程方法的名称是根据它们在[API引用](https://docs.crisp.chat/api/v1/)中的标签名称命名的*。
因此,在读取[API引用](https://docs.crisp.chat/api/v1/)时,可以直接在库中查找它们。
实例。例如,实例化"client=crisp()",然后调用例如:`client.website.list_conversations(website戥id,1)`。
调用将数据写入api的方法时(例如,使用"client.website.send戥message戥in戥conversation()`"发送消息,需要这样提交:
``python
website戥id="88972681-a00c-4b3b-a383-cab281636484"
会话id="session_9df2a21e-f113-41d4-8ed2-bad8b49cafd1"
client.website.send_message_in_conversation(
网站id,会话id,
{{
"type":"文本",
"内容":"此消息来自python crisp api!:)",
"from":"operator",
"origin":"chat"
}
")
`````
站点ID,数据)`
***检查会话是否存在**:`client.website.check\u conversation\u exists(website\u id,session\u id)`
**get a conversation**:`client.website.get\u conversation(website\u id,session\u id)`
**删除会话**:`client.website.remove\u conversation(website\u id,session\u id)`
**现有会话**:`client.website.initiate_conversation_with_existing_session(website_id,session_id)`
**get messages in conversation**:`client.website.get_messages_in_conversation(website_id,session_id,query)`
***更新会话中的消息**:`client.website.update_message_in_conversation(网站ID、会话ID、指纹、数据)`
**在会话中编写消息**:`client.website.compose_in_conversation(网站ID、会话ID、数据)`
**将消息标记为已在会话中读取**:`client.website.mark_messages_read_in_conVersation(网站ID,会话ID,数据)`
**mark messages as delivered in conversation**:`client.website.mark_messages_delivered_in_conversation(网站ID,会话ID,数据)`
**get conversation routing assign**:`client.website.get_conversation_routing assign(网站ID,会话ID)`
**assign conversation routing**:`client.website.assign_conversation_routing(网站ID,会话ID,数据)`
**get conversation metas**:`client.website.get_conversation_metas(网站ID,会话ID)`
**update conversation metas**:`client.website.update_conversation_metas(网站ID,会话ID,数据)`
**list conversation pages**:`client.website.list_conversati在"U"页上(网站ID、会话ID、页面编号)`
***列出对话事件**:`client.website.list\u对话事件(网站ID、会话ID、页面编号)`
***获取对话状态**:`client.website.get\u对话状态(网站ID、会话ID)`
***更改对话状态**:`client.website.change\u对话状态(webs站点ID,会话ID,数据)`
**get block status for conversation**:`client.website.get_block_status_for_conversation(website_id,session_id)`
**block incoming messages for conversation**:`client.website.block_incoming_messages_for_conversation(website_id,session_id,data)`
**request email cription for conversation**:`cl客户端。网站。请求电子邮件抄本(网站ID、会话ID、数据)`
**website people**
**get people statistics**:`client.website.get人脉统计(网站ID)`
**list people segments**:`client.website.list人脉段(网站ID、页码)`
**list people profiles**:`client.website.list人脉段(网站ID、页码)。列出用户配置文件(网站ID,页面编号)`
**add new people profile**:`client.website.add_new_people_profile(网站ID,数据)`
***检查用户配置文件是否存在**:`client.website.check_people_profile存在(网站ID,用户ID)`
**get people profile**:`client.website.get_people_profile(网站ID,用户ID)`
***保存人员配置文件**:`客户端.网站.保存人员配置文件(网站ID,人员ID,数据)`
**更新人员配置文件**:`客户端.网站.更新人员配置文件(网站ID,人员ID,数据)`
***删除人员配置文件**:`客户端.网站.删除人员配置文件(网站ID,人员ID)`
**列出人员对话**:`客户端.网站.列表用户对话(网站ID,用户ID,页面编号)`
+**添加用户事件**:`client.website.add用户事件(网站ID,用户ID,数据)`
+**列表用户事件**:`client.website.list用户事件(网站ID,用户ID,页面编号)`
+**获取用户数据**:`client.website.get用户数据(网站ID,用户ID,页面编号)`
+**获取用户数据**:`client.website.get用户数据(网站ID,用户ID)`
+**保存用户数据**:`客户端.网站.保存用户数据(网站id,用户id,数据)`
+**获取用户订阅状态**:`客户端.网站.获取用户订阅状态(网站id,用户id)`
+**更新用户订阅状态**:`客户端.网站.更新用户订阅状态(网站id,用户id,数据)`
**网站库**
**create website**:`client.website.create_website(data)`
**get a website**:`client.website.get_website(website_id)`
**delete a website**:`client.website.delete_website(website_id)`
**website batch**
**batch resolve items**:`client.website.batch_resolve_items(website_id,data)`
**batch read items**:`client.website.batch\u read\u items(website\u id,data)`
**batch remove items**:`client.website.batch\u remove\u items(website\u id,data)`
**website availability**
**get website availability status**:`client.website.get_website_availability_status(website_id)`
**website operator**
**list website operators**:`client.website.list_website_operators(website_id)`
**list last active website operatorORS**:`client.website.list_last_active_website_operators(website_id)`
**website settings**
**get website settings**:`client.website.get_website_settings(website_id)`
**update website settings**:`client.website.update_website_settings(website_id,data)`
**web网站访问者**
***计数访问者**:`客户端.网站.计数访问者(网站ID)`
***列表访问者**:`客户端.网站.列表访问者(网站ID,页面编号)`