🐍 Crisp API Python Wrapper
Switch branches/tags
Nothing to show
Clone or download
valeriansaliou v1.1.0
Signed-off-by: Valerian Saliou <valerian@valeriansaliou.name>
Latest commit 496ccf1 Aug 15, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
crisp_api
examples v1.1.0 Aug 15, 2018
.gitignore Initialize Jan 3, 2018
AUTHORS Initialize Jan 3, 2018
LICENSE Initialize Jan 3, 2018
MANIFEST.in Initialize Jan 3, 2018
README.md
setup.py v1.1.0 Aug 15, 2018

README.md

python-crisp-api

The Crisp API Python wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your Python code.

Copyright 2018 Crisp IM SARL. See LICENSE for copying information.

Usage

Install the library:

pip install crisp-api

Then, import it:

from crisp_api import Crisp

Construct a new authenticated Crisp client with your identifier and key tokens.

client = Crisp()

client.authenticate(identifier, key)

Then, your client is ready to be consumed!

Authentication

To authenticate against the API, generate your session identifier and session key once using the following cURL request in your terminal (replace YOUR_ACCOUNT_EMAIL and YOUR_ACCOUNT_PASSWORD):

curl -H "Content-Type: application/json" -X POST -d '{"email":"YOUR_ACCOUNT_EMAIL","password":"YOUR_ACCOUNT_PASSWORD"}' https://api.crisp.chat/v1/user/session/login

If authentication succeeds, you will get a JSON response containing your authentication keys: identifier and key. Keep those 2 values private, and store them safely for long-term use.

Then, add authentication parameters to your client instance right after you create it:

client = Crisp()

# Authenticate to API (identifier, key)
# eg. client.authenticate("13937834-f6ce-4556-ae4f-9e0c54faf038", "eb6c3623245521d7a6c35f5b29f3fa756e893f034ed551d84518961c5ff16dec")
client.authenticate(identifier, key)

# Now, you can use authenticated API sections.

πŸ”΄ Important: Be sure to login once, and re-use the same authentication keys (same identifier + key) in all your subsequent requests to the API. Do not generate new tokens from your code for every new request to the API (you will be heavily rate-limited; that will induce HTTP failures for some of your API calls).

Resource Methods

Most useful available Crisp API resources are implemented. Programmatic methods names are named after their label name in the API Reference.

Thus, it is straightforward to look for them in the library while reading the API Reference.

In the following method prototypes, crisp is to be replaced with your Crisp API instance. For example, instanciate client = Crisp() and then call eg: client.user.check_session_validity().

When calling a method that writes data to the API (eg. send a message with: client.website.send_message_in_conversation()), you need to submit it this way:

website_id = "88972681-a00c-4b3b-a383-cab281636484"
session_id = "session_9df2a21e-f113-41d4-8ed2-bad8b49cafd1"

client.website.send_message_in_conversation(
  website_id, session_id,

  {
    "type": "text",
    "content": "This message was sent from python-crisp-api! :)",
    "from": "operator",
    "origin": "chat"
  }
)

Website

  • Website Conversations

    • List Conversations: client.website.list_conversations(website_id, page_number)
  • Website Conversation

    • Create A New Conversation: client.website.create_new_conversation(website_id, data)
    • Check If Conversation Exists: client.website.check_conversation_exists(website_id, session_id)
    • Get A Conversation: client.website.get_conversation(website_id, session_id)
    • Remove A Conversation: client.website.remove_conversation(website_id, session_id)
    • Initiate A Conversation With Existing Session: 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)
    • Send A Message In Conversation: client.website.send_message_in_conversation(website_id, session_id, query)
    • Update A Message In Conversation: client.website.update_message_in_conversation(website_id, session_id, fingerprint, data)
    • Compose A Message In Conversation: client.website.compose_message_in_conversation(website_id, session_id, data)
    • Mark Messages As Read In Conversation: client.website.mark_messages_read_in_conversation(website_id, session_id, data)
    • Mark Messages As Delivered In Conversation: client.website.mark_messages_delivered_in_conversation(website_id, session_id, data)
    • Get Conversation Routing Assign: client.website.get_conversation_routing_assign(website_id, session_id)
    • Assign Conversation Routing: client.website.assign_conversation_routing(website_id, session_id, data)
    • Get Conversation Metas: client.website.get_conversation_metas(website_id, session_id)
    • Update Conversation Metas: client.website.update_conversation_metas(website_id, session_id, data)
    • List Conversation Pages: client.website.list_conversation_pages(website_id, session_id, page_number)
    • List Conversation Events: client.website.list_conversation_events(website_id, session_id, page_number)
    • Get Conversation State: client.website.get_conversation_state(website_id, session_id)
    • Change Conversation State: client.website.change_conversation_state(website_id, session_id, data)
    • 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 Transcript For Conversation: client.website.request_email_transcript_for_conversation(website_id, session_id, data)
  • Website People

    • Get People Statistics: client.website.get_people_statistics(website_id)
    • List People Segments: client.website.list_people_segments(website_id, page_number)
    • List People Profiles: client.website.list_people_profiles(website_id, page_number)
    • Add New People Profile: client.website.add_new_people_profile(website_id, data)
    • Check If People Profile Exists: client.website.check_people_profile_exists(website_id, people_id)
    • Get People Profile: client.website.get_people_profile(website_id, people_id)
    • Save People Profile: client.website.save_people_profile(website_id, people_id, data)
    • Update People Profile: client.website.update_people_profile(website_id, people_id, data)
    • Remove People Profile: client.website.remove_people_profile(website_id, people_id)
    • List People Conversations: client.website.list_people_conversations(website_id, people_id, page_number)
    • Add A People Event: client.website.add_people_event(website_id, people_id, data)
    • List People Events: client.website.list_people_events(website_id, people_id, page_number)
    • Get People Data: client.website.get_people_data(website_id, people_id)
    • Save People Data: client.website.save_people_data(website_id, people_id, data)
    • Get People Subscription Status: client.website.get_people_subscription_status(website_id, people_id)
    • Update People Subscription Status: client.website.update_people_subscription_status(website_id, people_id, data)
  • Website Base

    • 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_read_items(website_id, data)
    • Batch Remove Items: client.website.batch_remove_items(website_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 Operators: 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)
  • Website Visitors

    • Count Visitors: client.website.count_visitors(website_id)
    • List Visitors: client.website.list_visitors(website_id, page_number)

Bucket

  • Bucket URL
    • Generate Bucket URL: client.bucket.generate_bucket_url(data)

User

  • User Session
    • Check Session Validity: client.user.check_session_validity()
    • Create A New Session: client.user.create_new_session(data)
    • Destroy A Session: client.user.destroy_session()