Information: For more information, visit the TeleSign website or the TeleSign Developer Portal.
Author: Telesign Corp.
TeleSign web services conform to the REST Web Service Design Model. Services are exposed as URI-addressable resources through the set of RESTful procedures in our TeleSign REST API.
The TeleSign Python SDK is a set of software development tools— a Python Library that wraps the TeleSign REST API, and it simplifies TeleSign application development in the Python programming language. The SDK software is packaged as a Python module called telesign.api, and is distributed as a Python Software Package using the Python Package Index (PyPI).
With just two classes, telesign.api abstracts much of the complexity of the TeleSign REST API.
| Python Class | Description |
|---|---|
| telesign.api.PhoneId | The PhoneId class exposes four services that each provide information about a specified phone number.
|
| telesign.api.Verify | The Verify class exposes three services for sending users a verification token (a three to five-digit number). You can use this mechanism to test whether you can reach users at the phone number they supplied, or you can have them use the token to authenticate themselves with your web application. In addition, this class also exposes a service that allows you to confirm the result of the authentication. You can use this verification factor in combination with username and password to provide two-factor authentication for higher security.
|
With Easy Install installed, simply type easy_install telesign at the command prompt. Alternatively, you can download the project source, and execute python setup.py install.
Here's a basic code example.
>>> from telesign.api import Verify
>>> phone_number = "13103409700"
>>> cust_id = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
>>> secret_key = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="
>>> verify = Verify(cust_id, secret_key) # Instantiate a Verify instance object,
>>> result = verify.call(phone_number, verify_code=1234) # and use it to call the "call" method.
>>> print result.data
{u'status': {u'updated_on': u'2015-04-23T21:28:06.837153', u'code': 103, u'description': u'Call in progress'}, u'errors': [], u'verify': {u'code_state': u'UNKNOWN', u'code_entered': u''}, u'sub_resource': u'call', u'reference_id': u'DGFDF6E11AB86303ASDFD425BE00000657', u'resource_uri': u'/v1/verify/DGFDF6E11AB86303ASDFD425BE00000657'}
For more examples, see the Documentation section below.
You will need a Customer ID and API Key in order to use TeleSign’s REST API. If you are already a customer and need an API Key, you can generate one in TelePortal. If you are not a customer and would like to get an API Key, please contact support@telesign.com.
You will need sphinx installed to generate the documentation. Documentation can be generated by running python setup.py doc. Generated documentation can be found in the doc/build/ directory.
Detailed documentation for TeleSign™ REST APIs is available in the Developer Portal.
The easiest way to run the tests is to install nose 1.3.6 (easy_install nose) and run nosetests or python setup.py test in the root of the distribution. Tests are located in the test/ directory.
For more information about the Phone Verify and PhoneID Standard services, please contact your TeleSign representative:
Email: support@telesign.com
Phone: +1 310 740 9700