Skip to content

Commit 16232f6

Browse files
author
Strahinja Trifunovic
committed
RI-4460 adding readme.rst to the right repo
1 parent 60cafa3 commit 16232f6

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

RELEASE.rst

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
.. image:: https://raw.github.com/TeleSign/python_telesign/master/python_banner.jpg
2+
:target: https://standard.telesign.com
3+
4+
.. image:: https://img.shields.io/travis/TeleSign/python_telesign.svg
5+
:target: https://travis-ci.org/TeleSign/python_telesign
6+
7+
.. image:: https://img.shields.io/codecov/c/github/TeleSign/python_telesign.svg
8+
:target: https://codecov.io/gh/TeleSign/python_telesign
9+
10+
.. image:: https://img.shields.io/pypi/v/telesign.svg
11+
:target: https://pypi.python.org/pypi/telesign
12+
13+
.. image:: https://img.shields.io/pypi/l/telesign.svg
14+
:target: https://github.com/TeleSign/python_telesign/blob/master/LICENSE
15+
16+
===================
17+
TeleSign Python SDK
18+
===================
19+
20+
TeleSign is a communications platform as a service (CPaaS) company, founded on security. Since 2005, TeleSign has
21+
been a trusted partner to the world’s leading websites and mobile applications, helping secure billions of end-user
22+
accounts. Today, TeleSign’s data-driven, cloud communications platform is changing the way businesses engage with
23+
customers and prevent fraud.
24+
25+
For more information about TeleSign, visit our `website <http://www.TeleSign.com>`_.
26+
27+
Documentation
28+
-------------
29+
30+
Code documentation is included in the SDK. Complete documentation, quick start guides and reference material
31+
for the TeleSign API is available within the `TeleSign Standard Documentation <https://standard.telesign.com/>`_.
32+
33+
Installation
34+
------------
35+
36+
To install the TeleSign Python SDK:
37+
38+
.. code-block:: bash
39+
40+
$ pip install telesign
41+
42+
Python **2.7+** is required for the TeleSign Python SDK.
43+
44+
Authentication
45+
--------------
46+
47+
You will need a Customer ID and API Key in order to use TeleSign’s API. If you already have an account you can retrieve
48+
them from your account dashboard within the `Portal <https://portal.telesign.com/login>`_. If you have not signed up
49+
yet, sign up `here <https://portal.telesign.com/signup>`_.
50+
51+
Dependencies
52+
------------
53+
54+
We make use of popular, feature-rich and well-tested open-source libraries to perform the underlying functionality of
55+
the SDK. These dependencies are managed by the community accepted package manager. If you are unable to add these
56+
additional third party dependencies to your project we have ensured that the SDK code is easy to read and can serve as
57+
sample code. We have also made sure that more complicated functions such as generate_telesign_headers can be easily
58+
extracted from the SDK and used 'as is' in your project.
59+
60+
Python Code Example: Messaging
61+
------------------------------
62+
63+
Here is a basic code example with the JSON response.
64+
65+
.. code-block:: python
66+
67+
from __future__ import print_function
68+
from telesign.messaging import MessagingClient
69+
70+
customer_id = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
71+
api_key = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
72+
73+
phone_number = "phone_number"
74+
message = "You're scheduled for a dentist appointment at 2:30PM."
75+
message_type = "ARN"
76+
77+
messaging_client = MessagingClient(customer_id, api_key)
78+
response = messaging_client.message(phone_number, message, message_type)
79+
80+
print(response.json)
81+
82+
.. code-block:: javascript
83+
84+
{'reference_id': 'DGFDF6E11AB86303ASDFD425BE00000657',
85+
'status': {'code': 103,
86+
'description': 'Call in progress',
87+
'updated_on': '2016-12-12T00:39:58.325559Z'}}
88+
89+
For more examples, see the `examples <https://github.com/TeleSign/python_telesign/tree/master/examples>`_ folder or
90+
visit the `TeleSign Standard Documentation <https://standard.telesign.com/>`_.

0 commit comments

Comments
 (0)