Need help with vonage-python-sdk?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Vonage
131 Stars 94 Forks Apache License 2.0 322 Commits 5 Opened issues

Description

Vonage Server SDK for Python. API support for SMS, Voice, Text-to-Speech, Numbers, Verify (2FA) and more.

Services available

!
?

Need anything else?

Contributors list

Vonage Server SDK for Python

Nexmo is now known as Vonage

PyPI version Build Status codecov Python versions supported Code style: black

This is the Python server SDK for Vonage's API. To use it you'll need a Vonage account. Sign up for free at vonage.com.

Installation

To install the Python client library using pip:

pip install vonage

To upgrade your installed client library using pip:

pip install vonage --upgrade

Alternatively, you can clone the repository via the command line:

git clone [email protected]:Vonage/vonage-python-sdk.git

or by opening it on GitHub desktop.

Usage

Begin by importing the

vonage
module:
import vonage

Then construct a client object with your key and secret:

client = vonage.Client(key=api_key, secret=api_secret)

For production, you can specify the

VONAGE_API_KEY
and
VONAGE_API_SECRET
environment variables instead of specifying the key and secret explicitly.

For newer endpoints that support JWT authentication such as the Voice API, you can also specify the

application_id
and
private_key
arguments:
client = vonage.Client(application_id=application_id, private_key=private_key)

To check signatures for incoming webhook requests, you'll also need to specify the

signature_secret
argument (or the
VONAGE_SIGNATURE_SECRET
environment variable).

SMS API

SMS Class

Creating an instance of the SMS class

To create an instance of the SMS class follow these steps:

  • Import the class
#Option 1
from vonage import Sms

#Option 2 from vonage.sms import Sms

#Option 3 import vonage #then you can use vonage.Sms() to create an instance

  • Create an instance
#Option 1 - pass key and secret to the constructor
sms = Sms(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)

#Option 2 - Create a client instance and then pass the client to the Sms instance client = Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET) sms = Sms(client)

Send an SMS

from vonage import Sms
sms = Sms(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
sms.send_message({
            "from": VONAGE_BRAND_NAME,
            "to": TO_NUMBER,
            "text": "A text message sent using the Vonage SMS API",
})

Send SMS with unicode

sms.send_message({
    'from': VONAGE_BRAND_NAME,
    'to': TO_NUMBER,
    'text': 'こんにちは世界',
    'type': 'unicode',
})

Submit SMS Conversion

from vonage import Client, Sms
client = Client(key=VONAGE_API_KEY, secret=VONAGE_SECRET)
sms = Sms(client)
response = sms.send_message({
    'from': VONAGE_BRAND_NAME,
    'to': TO_NUMBER,
    'text': 'Hi from Vonage'
})
sms.submit_sms_conversion(response['message-id'])

Voice API

Make a call

from vonage import Client, Voice
client = Client(application_id=APPLICATION_ID, private_key=PRIVATE_KEY)
voice = Voice(client)
voice.create_call({
  'to': [{'type': 'phone', 'number': '14843331234'}],
  'from': {'type': 'phone', 'number': '14843335555'},
  'answer_url': ['https://example.com/answer']
})

Retrieve a list of calls

from vonage import Client, Voice
client = Client(application_id=APPLICATION_ID, private_key=PRIVATE_KEY)
voice = Voice(client)
voice.get_calls()

Retrieve a single call

from vonage import Client, Voice
client = Client(application_id=APPLICATION_ID, private_key=PRIVATE_KEY)
voice = Voice(client)
voice.get_call(uuid)

Update a call

from vonage import Client, Voice
client = Client(application_id=APPLICATION_ID, private_key=PRIVATE_KEY)
voice = Voice(client)
response = voice.create_call({
  'to': [{'type': 'phone', 'number': '14843331234'}],
  'from': {'type': 'phone', 'number': '14843335555'},
  'answer_url': ['https://example.com/answer']
})
voice.update_call(response['uuid'], action='hangup')

Stream audio to a call

from vonage import Client, Voice
client = Client(application_id=APPLICATION_ID, private_key=PRIVATE_KEY)
voice = Voice(client)
stream_url = 'https://nexmo-community.github.io/ncco-examples/assets/voice_api_audio_streaming.mp3'
response = voice.create_call({
  'to': [{'type': 'phone', 'number': '14843331234'}],
  'from': {'type': 'phone', 'number': '14843335555'},
  'answer_url': ['https://example.com/answer']
})
voice.send_audio(response['uuid'],stream_url=[stream_url])

Stop streaming audio to a call

from vonage import Client, Voice
client = Client(application_id='0d4884d1-eae8-4f18-a46a-6fb14d5fdaa6', private_key='./private.key')
voice = Voice(client)
stream_url = 'https://nexmo-community.github.io/ncco-examples/assets/voice_api_audio_streaming.mp3'
response = voice.create_call({
  'to': [{'type': 'phone', 'number': '14843331234'}],
  'from': {'type': 'phone', 'number': '14843335555'},
  'answer_url': ['https://example.com/answer']
})
voice.send_audio(response['uuid'],stream_url=[stream_url])
voice.stop_audio(response['uuid'])

Send a synthesized speech message to a call

from vonage import Client, Voice
client = Client(application_id=APPLICATION_ID, private_key=PRIVATE_KEY)
voice = Voice(client)
response = voice.create_call({
  'to': [{'type': 'phone', 'number': '14843331234'}],
  'from': {'type': 'phone', 'number': '14843335555'},
  'answer_url': ['https://example.com/answer']
})
voice.send_speech(response['uuid'], text='Hello from vonage')

Stop sending a synthesized speech message to a call

from vonage import Client, Voice
client = Client(application_id=APPLICATION_ID, private_key=APPLICATION_ID)
voice = Voice(client)
response = voice.create_call({
  'to': [{'type': 'phone', 'number': '14843331234'}],
  'from': {'type': 'phone', 'number': '14843335555'},
  'answer_url': ['https://example.com/answer']
})
voice.send_speech(response['uuid'], text='Hello from vonage')
voice.stop_speech(response['uuid'])

Send DTMF tones to a call

from vonage import Client, Voice
client = Client(application_id=APPLICATION_ID, private_key=PRIVATE_KEY)
voice = Voice(client)
response = voice.create_call({
  'to': [{'type': 'phone', 'number': '14843331234'}],
  'from': {'type': 'phone', 'number': '14843335555'},
  'answer_url': ['https://example.com/answer']
})
voice.send_dtmf(response['uuid'], digits='1234')

Get recording

response = client.get_recording(RECORDING_URL)

Verify API

Verify Class

Creating an instance of the class

To create an instance of the Verify class, Just follow the next steps: ​

  • Import the class from module (3 different ways)
#First way
from vonage import Verify
​
#Second way
from vonage.verify import Verify
​
#Third valid way
import vonage #then you can use vonage.Verify() to create an instance
  • Create the instance
#First way - pass key and secret to the constructor
verify = Verify(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
​
#Second way - Create a client instance and then pass the client to the Verify contructor
client = Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
verify = Verify(client)

Search for a Verification request

client = Client(key='API_KEY', secret='API_SECRET')

verify = Verify(client) response = verify.search('69e2626cbc23451fbbc02f627a959677')

if response is not None: print(response['status'])

Send verification code

client = Client(key='API_KEY', secret='API_SECRET')

verify = Verify(client) response = verify.request(number=RECIPIENT_NUMBER, brand='AcmeInc')

if response["status"] == "0": print("Started verification request_id is %s" % (response["request_id"])) else: print("Error: %s" % response["error_text"])

Send verification code with workflow

client = Client(key='API_KEY', secret='API_SECRET')

verify = Verify(client) response = verify.request(number=RECIPIENT_NUMBER, brand='AcmeInc', workflow_id=1)

if response["status"] == "0": print("Started verification request_id is %s" % (response["request_id"])) else: print("Error: %s" % response["error_text"])

Check verification code

client = Client(key='API_KEY', secret='API_SECRET')

verify = Verify(client) response = verify.check(REQUEST_ID, code=CODE)

if response["status"] == "0": print("Verification successful, event_id is %s" % (response["event_id"])) else: print("Error: %s" % response["error_text"])

Cancel Verification Request

client = Client(key='API_KEY', secret='API_SECRET')

verify = Verify(client) response = verify.cancel(REQUEST_ID)

if response["status"] == "0": print("Cancellation successful") else: print("Error: %s" % response["error_text"])

Trigger next verification proccess

client = Client(key='API_KEY', secret='API_SECRET')

verify = Verify(client) response = verify.trigger_next_event(REQUEST_ID)

if response["status"] == "0": print("Next verification stage triggered") else: print("Error: %s" % response["error_text"])

Send payment authentication code

client = Client(key='API_KEY', secret='API_SECRET')

verify = Verify(client) response = verify.psd2(number=RECIPIENT_NUMBER, payee=PAYEE, amount=AMOUNT)

if response["status"] == "0": print("Started PSD2 verification request_id is %s" % (response["request_id"])) else: print("Error: %s" % response["error_text"])

Send payment authentication code with workflow

client = Client(key='API_KEY', secret='API_SECRET')

verify = Verify(client) verify.psd2(number=RECIPIENT_NUMBER, payee=PAYEE, amount=AMOUNT, workflow_id: WORKFLOW_ID)

if response["status"] == "0": print("Started PSD2 verification request_id is %s" % (response["request_id"])) else: print("Error: %s" % response["error_text"])

Number Insight API

Basic Number Insight

client.get_basic_number_insight(number='447700900000')

Docs: https://developer.nexmo.com/api/number-insight#getNumberInsightBasic

Standard Number Insight

client.get_standard_number_insight(number='447700900000')

Docs: https://developer.nexmo.com/api/number-insight#getNumberInsightStandard

Advanced Number Insight

client.get_advanced_number_insight(number='447700900000')

Docs: https://developer.nexmo.com/api/number-insight#getNumberInsightAdvanced

Managing Secrets

An API is provided to allow you to rotate your API secrets. You can create a new secret (up to a maximum of two secrets) and delete the existing one once all applications have been updated.

List Secrets

secrets = client.list_secrets(API_KEY)

Create A New Secret

Create a new secret (the created dates will help you know which is which):

client.create_secret(API_KEY, 'awes0meNewSekret!!;');

Delete A Secret

Delete the old secret (any application still using these credentials will stop working):

client.delete_secret(API_KEY, 'my-secret-id')

Application API

Create an application

response = client.application_v2.create_application({name='Example App', type='voice'})

Docs: https://developer.nexmo.com/api/application.v2#createApplication

Retrieve a list of applications

response = client.application_v2.list_applications()

Docs: https://developer.nexmo.com/api/application.v2#listApplication

Retrieve a single application

response = client.application_v2.get_application(uuid)

Docs: https://developer.nexmo.com/api/application.v2#getApplication

Update an application

response = client.application_v2.update_application(uuid, answer_method='POST')

Docs: https://developer.nexmo.com/api/application.v2#updateApplication

Delete an application

response = client.application_v2.delete_application(uuid)

Docs: https://developer.nexmo.com/api/application.v2#deleteApplication

Validate webhook signatures

client = vonage.Client(signature_secret='secret')

if client.check_signature(request.query):

valid signature

else:

invalid signature

Docs: https://developer.nexmo.com/concepts/guides/signing-messages

Note: you'll need to contact suppo[email protected] to enable message signing on your account before you can validate webhook signatures.

JWT parameters

By default, the library generates short-lived tokens for JWT authentication.

Use the auth method to specify parameters for a longer life token or to specify a different token identifier:

client.auth(nbf=nbf, exp=exp, jti=jti)

Overriding API Attributes

In order to rewrite/get the value of variables used across all the Vonage classes Python uses

Call by Object Reference
that allows you to create a single client for Sms/Voice Classes. This means that if you make a change on a client instance this will be available for the Sms class.

An example using setters/getters with

Object references
:
from vonage import Client, Sms

#Defines the client client = Client(key='YOUR_API_KEY', secret='YOUR_API_SECRET') print(client.host()) # using getter for host -- value returned: rest.nexmo.com

#Define the sms instance sms = Sms(client)

#Change the value in client client.host('mio.nexmo.com') #Change host to mio.nexmo.com - this change will be available for sms

Overriding API Host / Host Attributes

These attributes are private in the client class and the only way to access them is using the getters/setters we provide.

from vonage import Client

client = Client(key='YOUR_API_KEY', secret='YOUR_API_SECRET') print(client.host()) # return rest.nexmo.com client.host('mio.nexmo.com') # rewrites the host value to mio.nexmo.com print(client.api_host()) # returns api.vonage.com client.api_host('myapi.vonage.com') # rewrite the value of api_host

Frequently Asked Questions

Dropping support for Python 2.7

Back in 2014 when Guido van Rossum, Python's creator and principal author, made the announcement, January 1, 2020 seemed pretty far away. Python 2.7’s sunset has happened, after which there’ll be absolutely no more support from the core Python team. Many utilized projects pledge to drop Python 2 support in or before 2020. (Official statement here).

Just because 2.7 isn’t going to be maintained past 2020 doesn’t mean your applications or libraries suddenly stop working but as of this moment we won't give official support for upcoming releases. Please read the official "Porting Python 2 Code to Python 3" guide. Please also read the Python 3 Statement Practicalities for advice on sunsetting your Python 2 code.

Supported APIs

The following is a list of Vonage APIs and whether the Python SDK provides support for them:

| API | API Release Status | Supported? | | --------------------- | :------------------: | :--------: | | Account API | General Availability | ✅ | | Alerts API | General Availability | ✅ | | Application API | General Availability | ✅ | | Audit API | Beta | ❌ | | Conversation API | Beta | ❌ | | Dispatch API | Beta | ❌ | | External Accounts API | Beta | ❌ | | Media API | Beta | ❌ | | Messages API | Beta | ❌ | | Number Insight API | General Availability | ✅ | | Number Management API | General Availability | ✅ | | Pricing API | General Availability | ✅ | | Redact API | General Availability | ✅ | | Reports API | Beta | ❌ | | SMS API | General Availability | ✅ | | Verify API | General Availability | ✅ | | Voice API | General Availability | ✅ |

asyncio Support

asyncio is a library to write concurrent code using the async/await syntax.

We don't currently support asyncio in the Python SDK but we are planning to do so in upcoming releases.

Contributing

We :heart: contributions! But if you plan to work on something big or controversial, please contact us first!

We recommend working on

vonage-python-sdk
with a virtualenv. The following command will install all the Python dependencies you need to run the tests:
make install

The tests are all written with pytest. You run them with:

make test

License

This library is released under the Apache License.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.