{ "info": { "author": "Dayal Chand Aichara", "author_email": "dc.aichara@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Software Development :: Build Tools" ], "description": "# Chatwork API V2 Wrapper\n***\npychatworkAPI is a python package to access chatwork offline. It is based on [Chatwork API V2](http://download.chatwork.com/ChatWork_API_Documentation.pdf). \n\n***\n## Installation \n\n### PyPI\n```\npip install pychatworkAPI\n```\n### From Source (Github)\n\ngit clone https://github.com/dc-aichara/pychatworkAPI.git\n\ncd pychatworkAPI\n\npython3 setup.py install\n\n***\n\n## Usages\n\n```python\nfrom pychatworkAPI import Chatwork\n\nchatwork = Chatwork('Your Chatwork API Token')\n```\n### Basic usages\n```python\n\n>>> chatwork.get_me() # get your account information\n{'account_id': xxxxx, 'room_id': 1xxxxxxx, 'name': 'Aichara', 'chatwork_id': '', 'organization_id': xxxxx, 'organization_name': 'ABC Inc.', \n'department': '', 'title': '', 'url': '', 'intron': '', 'mail': '', 'tel_organization': '', 'tel_extension': '', 'tel_mobile': '', 'skype': '', 'facebook': '', 'twitter': '', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/xxxxx.rsz.jpg', 'login_mail': 'name@gmail.com'}\n\n\n>>> chatwork.get_my_status() # get your status\n{'unread_room_num': 0, 'mention_room_num': 0, 'mytask_room_num': 0, 'unread_num': 0, 'mention_num': 0, 'mytask_num': 0}\n\n\n>>> chatwork.get_my_tasks() # get list of tasks assigned to you\n[{'task_id': 139296044, 'room': {'room_id': 1xxxxx7, 'name': 'Group Name', 'icon_path': 'https://appdata.chatwork.com/icon/ico_xxx.png'},\n 'assigned_by_account': {'account_id': xxxxx, 'name': 'Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/xxxx/xxxx.rsz.jpg'}, 'message_id': '119629631860408724', 'body': 'Update Server', 'limit_time': 1685996399, 'status': 'open', 'limit_type': 'date'}]\n\n\n>>> chatwork.get_contacts() # get contacts list\n\n\n>>> chatwork.get_rooms() # get chat rooms list\n(b'[{\"room_id\":156655687,\"name\":\"\\\\u30de\\\\u30a4\\\\u30c1\\\\u30e3\\\\u30c3\\\\u30c8\",\"type\":\"my\",\"role\":\"member\",\"sticky\":true,\"unread_num\":0,\"mention_num\":0,\"mytask_num\":0,\"message_num\":4,\"file_num\":0,\"task_num\":0,\"icon_path\":\"https://appdata.chatwork.com/avatar/ico_default_violet.png\",\"last_update_time\":1563412308}]', [{'room_id': 156655687, 'name': '\u30de\u30a4\u30c1\u30e3\u30c3\u30c8', 'type': 'my', 'role': 'member', 'sticky': True, 'unread_num': 0, 'mention_num': 0, 'mytask_num': 0, 'message_num': 4, 'file_nu 'task_num': 0, 'icon_path': 'https://appdata.chatwork.com/avatar/ico_default_violet.png', 'last_update_time': 1563412308}])\n\n\n# chatwork.send_message(self, room_id, message)\n>>> chatwork.send_message(1987672538, 'test') # send message to a chat\n\n\n\n# chatwork.send_file(self, room_id, file_path, file_name, message)\n>>> chatwork.send_file(1987672538,'a.jpg', 'test.jpg', 'test') # send a file with message to a chat\n\n\n````\n\n### Chat Rooms\n\n- General Room Operations \n\n```python\n\n# chatwork.get_rooms_by_id(self, room_id) \n>>> chatwork.get_rooms_by_id(158013300) # get room details by room id\n{'room_id': 158013300, 'name': 'pychatworkAPI', 'type': 'group', 'role': 'admin', 'sticky': False, 'unread_num': 0, 'mention_num': 0, 'mytask_num': 2, 'message_num': 5, 'file_num': 0, 'task_num': 2, 'icon_path': 'https://appdata.chatwork.com/icon/ico_idea.png', 'description': 'A chat room to test pychatworkworkAPI', 'last_update_time': 1563419004}\n\n# chatwork.get_rooms_members(self, room_id)\n>>> chatwork.get_rooms_members(15xxxx38) # get room members information\n[{'account_id': xxxxxx, 'role': 'admin', 'name': 'Aichara', 'chatwork_id': '', \n'organization_id': xxxxx, 'organization_name': 'ABC Inc.', 'department': 'Data Analytics', \n'avatar_image_url': 'https://appdatwork.com/avatar//xxxxxx.rsz.jpg'}]\n\n# chatwork.create_new_room(self,description, members_member_ids, icon_preset, members_readonly_ids, members_admin_ids, name)\n>>> chatwork.create_new_room('Test', [12, 187, 78],'group',[12, 78],[187] , 'test1') # create a new chat room\n\n\n# chatwork.change_room_info(self, room_id, description, name, icon_preset)\n>>> chatwork.change_room_info(158013300, 'A chat room to test pychatworkAPI', 'pychatworkAPI', 'test') # Change chat's name, description and icon \n\n\n# chatwork.change_rooms_members(self, room_id, members_admin_ids, members_member_ids, members_readonly_ids)\n>>> chatwork.change_rooms_members(158013300, [4018276], [], []) # Change rooms members at once\n\n\n# chatwork.delete_rooms_by_id(self, room_id, action)\n>>> chatwork.delete_rooms_by_id(1xxxx96, 'leave') # leave or delete a chat room\n\n\n```\n\n- Rooms Messages\n\n\n```python\n\n# chatwork.get_rooms_messages(room_id)\n>>> chatwork.get_rooms_messages(15xxxx38) # get messages of a room\n[{'message_id': '11963102598912', 'account': {'account_id': xxxxx, 'name': 'Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/xxx.rsz.jpg'}, \n'body': '[info][title][dtext:chatroom_groupchat_created][/title][dtext:chatroom_chatname_is]test[dtext:chatroom_set]\\n\\n[dtext:chatroom_member_is][piconname:367][dtext:chatroom_added][/info]', 'send_time': 1561697609, 'update_time': 0}]\n\n>>> chatwork.get_rooms_message_information(room_id, message_id) # get specific message information from a chat room\n\n```\n\n- Room Tasks\n\n```python\n\n# chatwork.add_rooms_task(self, room_id, task_name, time_limit, account_ids)\n>>> chatwork.add_rooms_task(15xxx34, 'Update Server1',1685996399,123456) # assign a task to member of room\n{'task_ids': [139298115]}\n\n# chatwork.get_rooms_tasks(self, room_id)\n>>> chatwork.get_rooms_tasks(158013300) # Get list of the tasks of a chat\n[{'task_id': 141309041, 'account': {'account_id': 40276, 'name': 'Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/ico_default_violet.png'}, 'assigned_by_account': {'account_id': 40276, 'name': 'D C Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/ico_default_violet.png'}, 'message_id': '1203526775385116672', 'body': 'Hello', 'limit_time': 1563422400, 'status': 'open', 'limit_type': 'time'}, {'task_id': 141316537, 'account': {'account_id': 40276, 'name': 'Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/ico_default_violet.png'}, 'assigned_by_account': {'account_id': 40276, 'name': 'Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/ico_default_violet.png'}, 'message_id': '1203536253820076032', 'body': 'test2', 'limit_time': 1563418998, 'status': 'open', 'limit_type': 'date'}]\n\n# chatwork.get_rooms_task_information(self, room_id, task_id)\n>>> chatwork.get_rooms_task_information(1xxxxx7,139296044) # get task information by task id\n{'task_id': 139296044, 'account': {'account_id': 3xxxxxx, 'name': 'Dayal Chand Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/xxxx/xxxxx.rsz.jpg'}, 'assigned_by_account': {'account_id': xxxxxx, 'name': 'Dayal Chand Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/xxxx/xxxx.rsz.jpg'},\n 'message_id': '119629638789764', 'body': 'Update Server', 'limit_time': 1685996399, 'status': 'open', 'limit_type': 'date'}\n\n```\n- Room files\n\n```python\n\n# chatwork.get_rooms_files(self, room_id)\n>>> chatwork.get_rooms_files(1543544441325) # get information of files in a chat room\n[{'file_id': 456xx, 'message_id': '11876358888392320', 'filesize': 91571, 'filename': 'abc.png', 'upload_time': 1559627849, \n'account': {'account_id': xxxx, 'name': 'Dayal Chand Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/xxxx.rsz.jpg'}}, {'file_id': 37xxxx, 'message_id': '118763998741469696', 'filesize': 202409, 'filename': '2019-06-03.png', 'upload_time': 1559629010, 'account':\n {'account_id': xxxx, 'name': 'Dayal Chand Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/xxxx.rsz.jpg'}}]\n\n# chatwork.get_rooms_file_information(self, room_id, file_id)\n>>> chatwork.get_rooms_file_information(1543544441325,3851450 ) # get details of a file by file id in a chat room\n{'file_id': 3851450, 'message_id': '1193811580355072', 'filesize': 177560, 'filename': 'data.png', 'upload_time': 1561100416, 'account':\n {'account_id': xxxx, 'name': 'Dayal Chand Aichara', 'avatar_image_url': 'https://appdata.chatwork.com/avatar/xxxx.rsz.jpg'}, \n 'download_url': 'https://appdata.chatwork.com/uploadfile/xxxx/xxxxxx/1633a41e6e6f5f0ff95d7299ff5beabf.dat?response-content-type=&response-content-disposition=attachment%3Bfilename%2A%3DUTF-8%27%27price.png&Expires=1561699134&Signature=YzyVHZaO-ZKZDjCQTYpI7JhPd8OSMZaPIMhof25aTZOdCXI-AtkJiXP1KjfcWzAnx1A-hqy08NgdfoCjjpJJlu-IWtuAn3dbrEdbklPR-udQO4i9kFiy-fTF2yUcchbuwg7mpxrYlcobTA4FZ-ojt74gv8up3HOcqJw3EcVh1RTH8rpqYqQXxklpM0-G4aPlyJ3mNqvWOvZhB4ym0daiXXqw8lmm~cAw-ai~BQ7TRgxXj~E5kWuhxJpEiBT61odILnlwSNMVODRnr76UCjljl2OEaFnpPl5fKW3J2lo9Hmq15aK-wf7OfnfIrs~5zKCbfTmetlTL-fOy-kHacC6dCg__&Key-Pair-Id=XXXXXXXXXX'}\n\n\n```\n### Handling incoming requests\n\n```python\n\n>>> chatwork.get_incoming_requests() # get incoming requests to join chat rooms\n\n\n>>> chatwork.approve_incoming_requests(self, request_id) # approve incoming request by request id\n\n\n>>> chatwork.delete_incoming_requests(self, request_id) # delete incoming request by request it\n\n\n```\n\n***\n## How to reply or send message to specific person or all group members? \n\n```python\n# Reply to specific person in group \n# chatwork.send_message(room_id, \"[Reply aid=person's id] person'name \\n\" + \"message\")\n>>> chatwork.send_message(1598363, \"[Reply aid=4018276] Dayal \\n\" + \"Sure. Let's do this. \")\n\n\n# Send message to specific person \n# chatwork.send_message(room_id, '[to:person's id] person's name \\n' + 'message')\n>>> chatwork.send_message(1598363, '[To:4018276] Dayal \\n' + \"Hey! What's up ?\" )\n\n\n# Send message to all members of a chat\n# chatwork.send_message(room_id, \"[toall]\\n\" + \"message\")\n\n>>> chatwork.send_message(1598363, \"[toall]\\n\" + \"Meeting starts at 11:00 hours.\")\n\n\n# Note: If you don't know recipient's id, then you can just use [To] name and [Reply aid=0] name .\n\n```\n\n\n\n***\n\n## Message Decoration in Chatwork\n\n```python\n# Heading ---> [title] message [/title]\n\n# Horizontal line ---> [hr]\n\n>>> chatwork.send_message(15983632, \"[title] pychatworkAPI [/title][hr]\")\n\n\n# Code Style ---> [code] message [/code]\n\n>>> chatwork.send_message(15983632, \"[code] from pychatworkAPI import Chatwork [/code]\")\n\n\n# Box style ---> [info] message [/info]\n\n>>> chatwork.send_message(15983632, \"[info] Check out documentation here: https://pypi.org/project/pychatworkAPI/ [/info]\")\n\n\n```\n\n\n***\n\n\n## *Responses*\n\n> Successful\n\n> No content \n\n> Bad Request\n\n> Unauthorized\n\n> Unsuccessful (Check your inputs)\n\n> Too many requests (Request limit is 300/5 minutes)\n\n***\n## License \n[MIT](https://choosealicense.com/licenses/mit/) \u00a9 [Dayal Chand Aichara](https://github.com/dc-aichara)\n\n***\n\n### Note: \n\n1. Read [Chatwork API V2](http://download.chatwork.com/ChatWork_API_Documentation.pdf) documentation to learn more.
\n2. Ask your queries in [pychatworkAPI Chatwork](https://www.chatwork.com/g/05qdcee7td8lkt) group. \n\n\nCheck out [Webpage of pychatworkAPI](https://dc-aichara.github.io/pychatworkAPI/). \n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/dc-aichara/pychatworkAPI/archive/V-1.13.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/dc-aichara/pyChatwork", "keywords": "chatwork,chatwork-api", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pychatworkAPI", "package_url": "https://pypi.org/project/pychatworkAPI/", "platform": "", "project_url": "https://pypi.org/project/pychatworkAPI/", "project_urls": { "Download": "https://github.com/dc-aichara/pychatworkAPI/archive/V-1.13.tar.gz", "Homepage": "https://github.com/dc-aichara/pyChatwork" }, "release_url": "https://pypi.org/project/pychatworkAPI/1.13/", "requires_dist": [ "requests" ], "requires_python": "", "summary": "pychatworkAPI is a python package to access chatwork offline.", "version": "1.13" }, "last_serial": 5669567, "releases": { "1.1": [ { "comment_text": "", "digests": { "md5": "761789efa70b98ddfd8adac63533cc58", "sha256": "a5b3e765b014af00adba58f1651249b47bacc1ff91a85b7396db879c7ca381b7" }, "downloads": -1, "filename": "pychatworkAPI-1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "761789efa70b98ddfd8adac63533cc58", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6912, "upload_time": "2019-06-28T06:36:58", "url": "https://files.pythonhosted.org/packages/aa/23/6a8da49f50a45b981087ffd8fc9b331eadc1b27525756aad079c25e1add5/pychatworkAPI-1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b719fd74b1336a3c5f8bc5f0d3736cf1", "sha256": "48d8a7bac2078dfb665173f4d9bf2f8a8f0cb93ff417c78954dceb499950a608" }, "downloads": -1, "filename": "pychatworkAPI-1.1.tar.gz", "has_sig": false, "md5_digest": "b719fd74b1336a3c5f8bc5f0d3736cf1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5935, "upload_time": "2019-06-28T06:37:00", "url": "https://files.pythonhosted.org/packages/ce/f5/cb7381da1dd5c89ff1540e7d345cea1d80cabaa70cc1a15a9fd4b518b56c/pychatworkAPI-1.1.tar.gz" } ], "1.11": [ { "comment_text": "", "digests": { "md5": "d378fd994b0b45345a3a9ba778fe87e6", "sha256": "21abbff9504bcf2728c5d5884c12357c5800df4d7c5116aa53aa42e16e52fec4" }, "downloads": -1, "filename": "pychatworkAPI-1.11-py3-none-any.whl", "has_sig": false, "md5_digest": "d378fd994b0b45345a3a9ba778fe87e6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7001, "upload_time": "2019-07-01T06:36:29", "url": "https://files.pythonhosted.org/packages/e9/cf/edf1917b33517a60e79c799245866c5cb0d444a79204bed1b90311928a7f/pychatworkAPI-1.11-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "660f892cc1a862bea99b958377306100", "sha256": "556f9db4ac2e995589e7134fe5bd61de8cbdef244f703e49e32e7279ecc45ccc" }, "downloads": -1, "filename": "pychatworkAPI-1.11.tar.gz", "has_sig": false, "md5_digest": "660f892cc1a862bea99b958377306100", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6074, "upload_time": "2019-07-01T06:36:32", "url": "https://files.pythonhosted.org/packages/29/68/aa9ce994c4fe8e00902b3fe57ed8c74cedd8aba4e91d5bc609cf47888a59/pychatworkAPI-1.11.tar.gz" } ], "1.12": [ { "comment_text": "", "digests": { "md5": "258b894ccddc82b817128ecfc00280a9", "sha256": "6bab1823cc0c177224245b638b6732712f0e1d7e4d6a4bf7cb7781bc63118311" }, "downloads": -1, "filename": "pychatworkAPI-1.12-py3-none-any.whl", "has_sig": false, "md5_digest": "258b894ccddc82b817128ecfc00280a9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7861, "upload_time": "2019-07-18T03:34:45", "url": "https://files.pythonhosted.org/packages/b4/63/06c3445004a3d555e971e3ab454256ad19df93a46e33318705e2ec070453/pychatworkAPI-1.12-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dfd09660e85f07331c02cea7c63ec1f1", "sha256": "22510d53c67c6860cfc2546b4b62f039bfc71887b70212bedbd2e5f38d88782e" }, "downloads": -1, "filename": "pychatworkAPI-1.12.tar.gz", "has_sig": false, "md5_digest": "dfd09660e85f07331c02cea7c63ec1f1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7073, "upload_time": "2019-07-18T03:34:47", "url": "https://files.pythonhosted.org/packages/30/0b/13dd1a509db6bf3daf093485af75c39b3d5d79257aa2f1eabee5a118897a/pychatworkAPI-1.12.tar.gz" } ], "1.13": [ { "comment_text": "", "digests": { "md5": "e8982b80222b3da0e7ea8b3f379a5756", "sha256": "2df803f5954c18484414278273ae40eb9d805b14b1504c42ae04da4163414927" }, "downloads": -1, "filename": "pychatworkAPI-1.13-py3-none-any.whl", "has_sig": false, "md5_digest": "e8982b80222b3da0e7ea8b3f379a5756", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8405, "upload_time": "2019-08-13T01:54:52", "url": "https://files.pythonhosted.org/packages/b1/b2/f46abc010676fe58f68b41335acca1a9d620188cae4c42d300ccaeefcc9c/pychatworkAPI-1.13-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "57cdbbe79182333eaf2eacfab5437a8e", "sha256": "0ec115529806ae0e55ec17771bc87357f3cb595eb0ecff731cfcab7adb4f7d82" }, "downloads": -1, "filename": "pychatworkAPI-1.13.tar.gz", "has_sig": false, "md5_digest": "57cdbbe79182333eaf2eacfab5437a8e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7741, "upload_time": "2019-08-13T01:54:54", "url": "https://files.pythonhosted.org/packages/18/ac/cd1a9c05f90726194508be58fc9f19113597cd9b13516e391b6011955473/pychatworkAPI-1.13.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e8982b80222b3da0e7ea8b3f379a5756", "sha256": "2df803f5954c18484414278273ae40eb9d805b14b1504c42ae04da4163414927" }, "downloads": -1, "filename": "pychatworkAPI-1.13-py3-none-any.whl", "has_sig": false, "md5_digest": "e8982b80222b3da0e7ea8b3f379a5756", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8405, "upload_time": "2019-08-13T01:54:52", "url": "https://files.pythonhosted.org/packages/b1/b2/f46abc010676fe58f68b41335acca1a9d620188cae4c42d300ccaeefcc9c/pychatworkAPI-1.13-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "57cdbbe79182333eaf2eacfab5437a8e", "sha256": "0ec115529806ae0e55ec17771bc87357f3cb595eb0ecff731cfcab7adb4f7d82" }, "downloads": -1, "filename": "pychatworkAPI-1.13.tar.gz", "has_sig": false, "md5_digest": "57cdbbe79182333eaf2eacfab5437a8e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7741, "upload_time": "2019-08-13T01:54:54", "url": "https://files.pythonhosted.org/packages/18/ac/cd1a9c05f90726194508be58fc9f19113597cd9b13516e391b6011955473/pychatworkAPI-1.13.tar.gz" } ] }