{"id":23699629,"url":"https://github.com/bzdvdn/comagic-dataapi-wrapper","last_synced_at":"2026-01-27T13:30:20.266Z","repository":{"id":62563788,"uuid":"203602599","full_name":"bzdvdn/comagic-dataapi-wrapper","owner":"bzdvdn","description":"Comagic DataAPI v2 client at python","archived":false,"fork":false,"pushed_at":"2019-11-18T09:04:00.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-30T13:03:59.348Z","etag":null,"topics":["comagic","dataapi","python","python3","wrapper"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bzdvdn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-21T14:34:47.000Z","updated_at":"2019-11-18T09:04:02.000Z","dependencies_parsed_at":"2022-11-03T15:45:43.740Z","dependency_job_id":null,"html_url":"https://github.com/bzdvdn/comagic-dataapi-wrapper","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bzdvdn%2Fcomagic-dataapi-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bzdvdn%2Fcomagic-dataapi-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bzdvdn%2Fcomagic-dataapi-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bzdvdn%2Fcomagic-dataapi-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bzdvdn","download_url":"https://codeload.github.com/bzdvdn/comagic-dataapi-wrapper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239774329,"owners_count":19694699,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comagic","dataapi","python","python3","wrapper"],"created_at":"2024-12-30T08:14:08.067Z","updated_at":"2026-01-27T13:30:20.201Z","avatar_url":"https://github.com/bzdvdn.png","language":"Python","readme":"# Comagic dataapi v2 wrapper\n\n# Installation\n\nInstall using `pip`...\n\n    pip install comagic-wrapper\n\n#Documentation\nhttps://www.comagic.ru/support/api/data-api/\n-\n\n# Usage\n\n```python\nfrom comagic import Comagic\nclient = Comagic(\"\u003clogin\u003e\", \"\u003cpassword\u003e\") # init comagic wrapper\n\nor\n\nclient = Comagic(token=\"\u003ctoken\u003e\")\n\n```\n# Customers\n```python\n# doc - https://www.comagic.ru/support/api/data-api/Partners/#get_customer_user\ncustomers = client.customer_users.get(limit=1000, offset=0, field=[], filter={}, sort=[])\n```\n\n# Sites\n```python\n# list of sites\n# doc - https://www.comagic.ru/support/api/data-api/site/get_sites/\nsites = client.sites.get(user_id='\u003cuser_id\u003e if needed')\n\n# create site\n# doc - https://www.comagic.ru/support/api/data-api/site/create_sites/\ndata = {\n   \"domain_name\": \"string\",\n   \"default_phone_number\": \"number\",\n   \"default_scenario_id\": \"number\",\n   \"user_id\": \"number\",\n   \"industry_id\": \"number\",\n   \"target_call_min_duration\": \"number\",\n   \"track_subdomains_enabled\": \"boolean\",\n   \"cookie_lifetime\": \"number\",\n   \"campaign_lifetime\": \"number\",\n   \"sales_enabled\": \"boolean\",\n   \"second_communication_period\": \"number\",\n   \"services_enabled\": \"boolean\",\n   \"replacement_dynamical_block_enabled\" : \"boolean\",\n   \"widget_link\" : {\n     \"enabled\": \"boolean\",\n     \"text\": \"string\",\n     \"url\": \"string\"\n   },\n   \"show_visitor_id\": {\n     \"enabled\": \"boolean\",\n     \"element_id_value\": \"string\",\n     \"message\": \"string\",\n     \"length_visitor_id\": \"number\"\n   }\n}\nsite = client.sites.create(user_id='\u003cuser_id\u003e if needed', **data)\n\n# delete\n# doc - https://www.comagic.ru/support/api/data-api/site/delete_sites/\ndeleted  = client.sites.delete(user_id='\u003cuser_id\u003e if needed', id = '\u003csite_id\u003e')\n\n# update site\n# doc - https://www.comagic.ru/support/api/data-api/site/update_sites/\nupdate_site = client.sites.update(user_id='\u003cuser_id\u003e if needed', **data)\n```\n\n# Site blocks\n```python\n# get site_block\n# doc - https://www.comagic.ru/support/api/data-api/site/get_site_blocks/\nsite_blocks = client.site_blocks.get(user_id='\u003cuser_id\u003e if needed', fields = [])\n\n# create site block\n# doc - https://www.comagic.ru/support/api/data-api/site/create_site_blocks/\nsite_block = client.site_blocks.create(site_id=\"number\", name= \"string\", user_id='\u003cuser_id\u003e if needed')\n\n# update site block\n# doc - https://www.comagic.ru/support/api/data-api/site/update_site_blocks/\nupdated_site_block = client.site_blocks.update(id='\u003cnumber\u003e', name= \"string\", user_id='\u003cuser_id\u003e if needed')\n\n# delete site block\n# doc - https://www.comagic.ru/support/api/data-api/site/delete_site_blocks/\ndeleted = client.site_blocks.delete(user_id='\u003cuser_id\u003e if needed', id= '\u003cid\u003e')\n```\n# Account\n```python\n# get account\n# doc - https://www.comagic.ru/support/api/data-api/Account/\naccount = client.account.get()\n```\n\n# Virtual Numbers\n```python\n# get virtual numbers\n# doc - https://www.comagic.ru/support/api/data-api/vn/get_virtual_numbers/\nnumbers = client.virtual_numbers.get(user_id='\u003cuser_id\u003e if needed', limit=10, offset=0, fields=[], sort=[])\n\n# get available virtual numbers\n# doc - https://www.comagic.ru/support/api/data-api/vn/get_available_virtual_numbers/\navailable_virtual_numbers = client.available_virtual_numbers.get(user_id='\u003cuser_id\u003e if needed', limit=10, offset=0\n, fields=[], sort=[])\n\n# enable virtual number\n# doc - https://www.comagic.ru/support/api/data-api/vn/enable_virtual_numbers/\nenable = client.virtual_numbers.enable(user_id='\u003cuser_id\u003e if needed', virtual_phone_number='number')\n\n# disable virtual number\n# doc - https://www.comagic.ru/support/api/data-api/vn/disable_virtual_numbers/\ndisable = client.virtual_numbers.disable(user_id='\u003cuser_id\u003e if needed', virtual_phone_number='number')\n```\n\n# Tags\n```python\n# doc - https://www.comagic.ru/support/api/data-api/Tags/\n\n# create tag\ntag = client.tags.create(user_id='\u003cuser_id\u003e if needed', name='\u003ctag_name\u003e')\n\n# update tag\nupdated_tag = client.tags.update(user_id='\u003cuser_id\u003e if needed', name='\u003ctag_name\u003e', id='\u003ctag_id\u003e')\n\n# delete tag\ndeleted_tag = client.tags.delete(user_id='\u003cuser_id\u003e if needed', id='\u003ctag_id\u003e')\n\n# get tags\ntag_list = client.tags.get(user_id='\u003cuser_id\u003e if needed', limit=10, offset=0, fields=[], sort=[])\n\n# set sales tag\nsale_tag = client.tag_sales.set(\n    user_id='\u003cuser_id\u003e if needed',\n    communication_id='\u003cid\u003e',\n    communication_type='\u003ctype\u003e',\n    date_time='2019-08-09',\n    transaction_value=123,\n    comment='\u003ccomment\u003e'\n)\n\n# set communication tag\ncommunication_tag = client.tag_communications.set(\n    user_id='\u003cuser_id\u003e if needed',\n    communication_id='\u003cid\u003e',\n    communication_type='\u003ctype\u003e',\n    tag_id='\u003ctag_id\u003e'\n)\n\n# unset communication tag\nunset_tag = client.tag_communications.unset(\n    user_id='\u003cuser_id\u003e if needed',\n    communication_id='\u003cid\u003e',\n    communication_type='\u003ctype\u003e',\n    tag_id='\u003ctag_id\u003e'\n)\n```\n# Campaigns\n```python\n# Doc - https://www.comagic.ru/support/api/data-api/Campaigns/\n\n# get campaigns\ncampaigns = client.campaigns.get(user_id='\u003cuser_id\u003e if needed', limit=10, offset=0, fields=[], sort=[])\n\n# delete campaign\ndeleted = client.campaigns.get(user_id='\u003cuser_id\u003e if needed', id='\u003ccampaign_id\u003e')\n\n# get campaign available phone numbers\nav_campaign_numbers = client.campaign_available_phone_numbers.get(user_id='\u003cuser_id\u003e if needed', limit=10, offset=0\n, fields=[], sort=[])\n\n# get campaign available redirection phone numbers\nredirect_campaign_numbers = client.campaign_available_redirection_phone_numbers.get(\n    user_id='\u003cuser_id\u003e if needed',\n    limit=10, offset=0, fields=[], sort=[])\n\n# create campaign\ncampaign = client.campaigns.create('\u003ccampaign params\u003e') # create kwargs params like in doc\n\n# update campaign\ncampaign = client.campaigns.update('\u003ccampaign params\u003e') # create kwargs params like in doc\n\n# get campaign weight parameter\ncampaign_weight = client.campaign_parameter_weights.get(user_id='\u003cuser_id\u003e if needed', limit=10, offset=0, fields=[], sort=[])\n\n# update campaign weight parameter\nupdate_weight_params = client.campaign_parameter_weights.update('\u003cweight params\u003e')\n``` \n# Reports\n```python\n# Doc - https://www.comagic.ru/support/api/data-api/Reports/\n\n# communications report\ncommunications_report = client.communications_report.get(\n    user_id='\u003cuser_id\u003e if needed',\n    date_from='2019-19-10',\n    date_to='2019-19-10',\n    limit=10000,\n    offset=0,\n    sort=[],\n    fields=[],\n)\n\n# call report\ncalls_report = client.call_report.get(\n    user_id='\u003cuser_id\u003e if needed',\n    date_from='2019-19-10',\n    date_to='2019-19-10',\n    limit=10000,\n    offset=0,\n    sort=[],\n    fields=[],\n)\n\n# CDR call report\ncall_legs_report = client.call_legs_report.get(\n    user_id='\u003cuser_id\u003e if needed',\n    date_from='2019-19-10',\n    date_to='2019-19-10',\n    limit=10000,\n    offset=0,\n    sort=[],\n    fields=[],\n)\n\n# goals report\ngoals_report = client.goals_report.get(\n    user_id='\u003cuser_id\u003e if needed',\n    date_from='2019-19-10',\n    date_to='2019-19-10',\n    limit=10000,\n    offset=0,\n    sort=[],\n    fields=[],\n)\n\n# chat report\nchat_report = client.chat_report.get(\n    user_id='\u003cuser_id\u003e if needed',\n    date_from='2019-19-10',\n    date_to='2019-19-10',\n    limit=10000,\n    offset=0,\n    sort=[],\n    fields=[],\n)\n\n# get chat messages\nmessages = client.chat_messages_report.get(\n    user_id='\u003cuser_id\u003e if needed',\n    chat_id = '\u003cchat_id\u003e',\n    limit=10000,\n    offset=0,\n    sort=[],\n    fields=[],\n)\n\n# offline messages report\noffline_messages_report = client.offline_messages_report.get(\n    user_id='\u003cuser_id\u003e if needed',\n    date_from='2019-19-10',\n    date_to='2019-19-10',\n    limit=10000,\n    offset=0,\n    sort=[],\n    fields=[],\n)\n\n# session report\nvisitor_sessions_report = client.visitor_sessions_report.get(\n    user_id='\u003cuser_id\u003e if needed',\n    date_from='2019-19-10',\n    date_to='2019-19-10',\n    limit=10000,\n    offset=0,\n    sort=[],\n    fields=[],\n)\n\n# financial_call_legs_report\nfinancial_call_legs_report = client.financial_call_legs_report.get(\n     user_id='\u003cuser_id\u003e if needed',\n     date_from='2019-19-10',\n     date_to='2019-19-10',\n     limit=10000,\n     offset=0,\n     sort=[],\n     fields=[],\n )\n```\n# TODO\n* more examples\n* support full methods\n* tests\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbzdvdn%2Fcomagic-dataapi-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbzdvdn%2Fcomagic-dataapi-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbzdvdn%2Fcomagic-dataapi-wrapper/lists"}