Skip to main content

Python wrapper for the Echo Mobile API

Project description

Why does this exist?

EchoMobile provide a great communications platform, but not much in terms of programmatic access. There is an API but that needs a lot of raw requests to get to working (it's a pain to say the least), so I decided to build this!!

Pre-requisites

  • An EchoMobile account, enterprise or otherwise
  • Python 3.6 or higher
  • See how to get the user credentials here

Installation

pip install pyforecho

Usage

from pyforecho import EchoMobile
if __name__ == "__main__":
	echo = EchoMobile(acc_id = 12345, eid = 6789, e_passw = "pass")
	echo.test_connection()
	client = echo.clients.lookup(phone = "254718953619")
	for a_client in echo.clients.get_all(since = 1604188800, group_name = "MYGROUP"):
		print(a_client)

The more detailed documentation - https://pyforecho.readthedocs.io/en/latest/

TODO

  • surveys.list_surveys() doesn't filter by project_name or project_id
  • /api/cms/project creates a new project instead of listing existing ones

Changelog

0.0.6 7th Dec 2020

Added

  • inbox.list_messages()
  • surveys.list_surveys()
  • surveys.get_survey_responses()

0.0.5 7th Dec 2020

Fixed

  • api.clients.create() to include the client's name in the payload

0.0.4 7th Dec 2020

Fixed

  • Exception Handling. Instead of throwing exceptions, bools are returned instead

0.0.3 7th Dec 2020

Added

  • Survey triggering
  • Utility to check if client is available for survey
  • Updating client custom field
  • Custom Exceptions

0.0.2 7th Dec 2020

Added

  • Sending bulk messages

0.0.1 23rd Nov 2020

Released

  • Bare bones version with only the ability to create, lookup and get all contacts

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyforecho-0.0.6.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

pyforecho-0.0.6-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file pyforecho-0.0.6.tar.gz.

File metadata

  • Download URL: pyforecho-0.0.6.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for pyforecho-0.0.6.tar.gz
Algorithm Hash digest
SHA256 3f24d726f47cd7aa3f08b84ffae13e82ed1462ccb73eb58bd5796cf807e9de9e
MD5 10c777046bdb5885b5861a3aade6a190
BLAKE2b-256 e3ff7c3b10d2412d11585ffdffade4aa96e59f5fbf847d2fa48926ad50708b74

See more details on using hashes here.

File details

Details for the file pyforecho-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: pyforecho-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for pyforecho-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 62e74fab787710cce9e62de858132d0a4a7656ec0948cdc3e23ca000bc519417
MD5 48379da906048cc1714113e22761709e
BLAKE2b-256 feb9de4e27c56d57bc435a7f758ce0f647b0ad3ffd10e3bcd11677d4dd717b4d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page