Metadata-Version: 1.1
Name: ringcloud_pyapi
Version: 0.1.2
Summary: RingCloud API Client
Home-page: https://bitbucket.org/ringcloud/ringcloud_pyapi
Author: Mikhail Baranov
Author-email: devel@ringcloud.ru
License: MIT
Description: ringcloud_pyapi 0.1.1
        =====================
        
        Библиотека предназначена для работы с REST API компании RingCloud.
        
        * Документация по REST API: https://api.ringcloud.ru/docs
        
        Установка
        ---------
        
        .. code-block:: bash
        
            $ pip install ringcloud_pyapi
        
        Авторизация
        -----------
        
        .. code-block:: python
        
            from ringcloud_pyapi import *
        
            api_key = "YOUR_API_KEY"
            password = "YOUR_API_PASSWORD"
        
            rc = RingCloud(api_key, password)
        
        
        Функции API
        ===========
        
        Состояние баланса
        -----------------
        
        .. code-block:: python
        
            print (rc.get_account_balance()) #1500.00
        
        
        Получение информации из базы по номеру телефона
        -----------------------------------------------
        
        .. code-block:: python
        
            print (rc.get_phone_number_info('+79101000000'))
        
        
        Получение списка каналов для аккаунта
        -------------------------------------
        
        .. code-block:: python
        
            print (rc.get_channels())
        
        
        Отображение данных о текущем вызове по имени канала
        ---------------------------------------------------
        
        .. code-block:: python
        
            print (rc.get_channel_info('channel/exampleChannelName'))
        
        
        Оригинация вызова
        -----------------
        
        Для оригинации вызова необходимо передать имя пользователя, от которого совершается звонок,
        и номер телефона, на который нужно позвонить.
        
        .. code-block:: python
        
            user = 111111
            phone = 79101234567
        
            print (rc.originate(user, phone))
        
        
        Получение информации о текущих вызовах (для аккаунта)
        -----------------------------------------------------
        
        .. code-block:: python
        
            print (rc.get_active_calls())
        
        
        Получение информации о завершенных вызовах
        ------------------------------------------
        
        .. code-block:: python
        
            print (rc.get_complete_calls(num=410, days=5))
        
        
        Получение списка сотрудников
        ----------------------------
        
        .. code-block:: python
        
            print (rc.get_users())
        
        
        Получение информации о конкретном сотруднике
        --------------------------------------------
        
        .. code-block:: python
        
            print (rc.get_user_info(user))
        
        
        Создание сотрудника
        -------------------
        
        .. code-block:: python
        
            print rc.create_user(password, num, email) # 111111
        
        
        Изменение пароля сотрудника
        ---------------------------
        
        .. code-block:: python
        
            rc.update_user_password(user, new_password)
        
        
        Изменение email сотрудника
        --------------------------
        
        .. code-block:: python
        
            rc.update_user_email(user, new_email)
        
        
        Изменение внутреннего номера сотрудника
        ---------------------------------------
        
        .. code-block:: python
        
            rc.update_user_extension(user, new_num)
        
        
        Включение VoiceMail Box
        -----------------------
        
        .. code-block:: python
        
            rc.enable_user_voice_mail_box(user)
        
        
        Выключение VoiceMail Box
        ------------------------
        
        .. code-block:: python
        
            rc.disable_user_voice_mail_box(user)
        
        
        Получение списка записей разговоров для конкретного пользователя
        ----------------------------------------------------------------
        
        .. code-block:: python
        
            print (rc.get_user_records(user))
        
        
        Загрузка записи разговора
        -------------------------
        
        .. code-block:: python
        
            rc.download_record(user, filename, you_local_path)
        
Keywords: ringcloud,rest,api
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: Russian
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
