In order to use the Voximplant Python SDK, you need the following:
- A developer account. If you don't have one, sign up here.
- A private API key. There are 2 options to obtain it:
- Either generate it in the Voximplant Control panel
- Or call the CreateKey HTTP API method with the specified authentication parameters. You'll receive a response with the result field in it. Save the result value in a file (since we don't store the keys, save it securely on your side).
- Python 2.x or 3.x runtime with
pipandsetuptools>=18.5 installed
Go to your project folder and install the SDK using pip:
python -m pip install --user voximplant-apiclientThen import the SDK in your script
from voximplant.apiclient import VoximplantAPINext, specify the path to the JSON service account file either in the constructor or using the environment.
constructor:
api = VoximplantAPI("/path/to/credentials.json")env:
export VOXIMPLANT_CREDENTIALS=/path/to/credentials.jsonfrom voximplant.apiclient import VoximplantAPI, VoximplantException
if __name__ == "__main__":
api = VoximplantAPI("credentials.json")
# Start a scenario of the user 1
RULE_ID = 1
SCRIPT_CUSTOM_DATA = "mystr"
USER_ID = 1
try:
res = api.start_scenarios(RULE_ID, script_custom_data=SCRIPT_CUSTOM_DATA, user_id=USER_ID)
print(res)
except VoximplantException as e:
print("Error: {}".format(e.message))from voximplant.apiclient import VoximplantAPI, VoximplantException
if __name__ == "__main__":
api = VoximplantAPI("credentials.json")
# Send the SMS with the "Test message" text from the phone number 447443332211 to the phone number 447443332212
SOURCE = "447443332211"
DESTINATION = "447443332212"
SMS_BODY = "Test message"
try:
res = api.send_sms_message(SOURCE, DESTINATION, SMS_BODY)
print(res)
except VoximplantException as e:
print("Error: {}".format(e.message))from voximplant.apiclient import VoximplantAPI, VoximplantException
import pytz
import datetime
if __name__ == "__main__":
api = VoximplantAPI("credentials.json")
# Get the first call session history record from the 2012-01-01 00:00:00 UTC to the 2014-01-01 00:00:00 UTC
FROM_DATE = datetime.datetime(2012, 1, 1, 0, 0, 0, pytz.utc)
TO_DATE = datetime.datetime(2014, 1, 1, 0, 0, 0, pytz.utc)
COUNT = 1
try:
res = api.get_call_history(FROM_DATE, TO_DATE, count=COUNT)
print(res)
except VoximplantException as e:
print("Error: {}".format(e.message))