Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Linked README.md to README for pypy

  • Loading branch information...
commit b722540f4c8e5708bc6523c9066ae7f7e4bb603f 1 parent dba5353
Matt Williamson authored August 14, 2012

Showing 1 changed file with 47 additions and 0 deletions. Show diff stats Hide diff stats

  1. 47  README
47  README
... ...
@@ -0,0 +1,47 @@
  1
+telapi-python
  2
+=============
  3
+
  4
+This library interacts with the [TelAPI](http://telapi.com) service. It allows you to use the REST API in a pythonic way to initiate and 
  5
+manage outbound calls and SMS messages as well as generate InboundXML to handle incoming calls and SMS messages.
  6
+
  7
+
  8
+Installation
  9
+------------
  10
+
  11
+Download the latest source from https://github.com/telapi/telapi-python/zipball/master or checkout the code, 
  12
+then `cd` into the resulting directory and run `python setup.py install`.
  13
+
  14
+
  15
+Protip
  16
+------
  17
+
  18
+Export the `TELAPI_ACCOUNT_SID` and `TELAPI_AUTH_TOKEN` variables in your environment,
  19
+such as ~/.profile and you won't have to pass your credentials in when intantiating the client.
  20
+
  21
+Account SID and auth token are both found in the [Dashboard](http://www.telapi.com/dashboard)
  22
+
  23
+```bash
  24
+export TELAPI_ACCOUNT_SID='ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  25
+export TELAPI_AUTH_TOKEN='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  26
+```
  27
+
  28
+
  29
+Quick Start
  30
+-----------
  31
+
  32
+Account SID and auth token are both found in the [Dashboard](http://www.telapi.com/dashboard)
  33
+
  34
+```python
  35
+from telapi import rest
  36
+
  37
+account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  38
+auth_token  = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  39
+client      = rest.Client(account_sid, auth_token)
  40
+account     = client.accounts[client.account_sid]
  41
+voice_url   = 'http://db.tt/YtLJgpa8'
  42
+
  43
+# Let's create a call that will dial someone and say "Hello"
  44
+account.calls.create(from_number="+15555555555", to_number="+15555555556", url=voice_url)
  45
+```
  46
+
  47
+

0 notes on commit b722540

Please sign in to comment.
Something went wrong with that request. Please try again.