BatchMonitor-Example-External.py

# BatchMonitor-Example.py
# tested in python 2.7.13
# implements Phone Number Monitor using Batch Automation and Media Storage at
# https://developer.syniverse.com
# this script will subscribe the phone numbers in the file phonenumbers.txt
# so you will receive notifications for changes to these numbers.
# these changes include porting, deactivation and disconnect events.
# More details are available in the Phone Number Verification section
# of the SDC documentation pages.
# Once complete the output file confirms what events the number was subscribed to.
# This can also be checked by going to
# https://developer.syniverse.com/index.html#!/ess/topic-subscriptions
# where you will see a list of all the subscriptions.

# uses one non-standard Python Library -> Requests
# see http://docs.python-requests.org/en/master/
# also uses zlib to decompress the output file (output files are compressed using gzip)

# this file uses the scrub and monitor job which supports a couple of extra features
# compared to previous monitor job. These are
# 1) phone numbers will be checked for validity before they are registered for monitoring.
# validity check is
#   a) has to be valid US number
#   b) last event for the number must be NONE or PORTED or DEACTIVATED with a deactivation_date
#   after the opt in date provided in the input file (if no opt in date is provided then this
#   skipped
# 2) an optional customer specified reference_id can be provided for each phone number. If provided
# then this will be included in the output file.

import zlib
import time
import requests

# this will be your access token
access_token = '[Your-Access-Token-Here]'

# this is the name of the file containing the list of phone numbers.
input_file_name = "phonenumbers.txt"
# in this example it contains the following
# +18132633923,,
# +18135041457,20170515-010101 Z,
# +1813955176020170515-010101 Z,TestRef123
# i.e. full phone number including leading + and international code
# I have only included 3 numbers, but it can contain up to 5 million
# the only difference to the below code would be that you have to wait
# for over an hour.
# there are two additional optional fields optin date/time and customer specified reference

# this is the delivery configuration.
delivery_configuration_id = "[your-delivery-config-here]"
# this defines the end point that notifications about the subscribed phone numbers should be sent to.
# This should have already been provisioned at the Syniverse Developer Community portal at
# https://developer.syniverse.com/index.html#!/ess/delivery-configurations.
# for example the delivery configuration id I used was 
# delivery_configuration_id = "676"

print '### Starting Engines ###\n'

## Step 1: We will create the input file in Media Storage
print 'Creating file in Media Storage'

create_file_url = 'https://api.syniverse.com/mediastorage/v1/files'

create_file_payload = {'fileName': '', 'fileTag': '', 'fileFolder': '', 'appName': '', 'expire_time': '',
                       'checksum': '', 'file_fullsize': '2000000'}

create_file_headers = {'Authorization': 'Bearer ' + access_token, 'Content-Type': 'application/json'}

create_file_response = requests.post(create_file_url, json=create_file_payload, headers=create_file_headers)

print 'create file response status code: ' + str(create_file_response.status_code)
print 'mss create response body: ' + create_file_response.text

## Step 2: We will upload the input file to Media Storage
print '\nUploading input file to Media Storage'

# get the file_id, company id from the create file response
file_id = create_file_response.json()['file_id']
company_id = create_file_response.json()['company-id']

# the URL to use in the request also comes from the create file response
upload_uri = create_file_response.json()['file_uri']

upload_headers = {'Authorization': 'Bearer ' + access_token, 'Content-Type': 'application/octet-stream',
                  'int-companyid': company_id}

upload_data = open(input_file_name, 'rb').read()

upload_file_response = requests.post(upload_uri, data=upload_data, headers=upload_headers)

print 'upload response status code: ' + str(upload_file_response.status_code)
print 'upload response: ' + upload_file_response.text

## Step 3: Schedule the batch job in Batch Automation
print '\nScheduling the Number Monitoring batch job in Batch Automation'

schedule_job_url = 'https://api.syniverse.com/aba/v1/schedules'

schedule_job_headers = {'Authorization': 'Bearer ' + access_token, 'Content-Type': 'application/json'}

schedule_job_payload = {"schedule": { "jobId" : "NIS-Scrub-Monitor-fs1-v1", "name" : "NISScrubMonitor", "inputFileId" : file_id,
                                       "fileRetentionDays" : 30, "scheduleRetentionDays" : 30,
                                       "outputFileNamingExpression" : "DS1-NIS-Scrub-Monitor-output.txt",
                                       "outputFileFolder" : "/opt/apps/aba/output",
                                       "jobRuntimeContext" : {
                                           "subscribeevents": "all",
                                           "subscribedestinationid": delivery_configuration_id
                                       }
                                      }
                        }

schedule_job_response = requests.post(schedule_job_url, json=schedule_job_payload,
                                       headers=schedule_job_headers)

print 'Scheduling response status code: ' + str(schedule_job_response.status_code)
print 'Scheduling response: ' + schedule_job_response.text

## Step 4: Wait for job to complete.
# this approach keeps it simple.
# An exercise for the reader would be to either
# 1) implement a loop that checks for when the job is complete
# 2) implement the callback url so details are only received once the job is complete

print '\nWaiting 20s for job to complete'
time.sleep(20)

## Step 5: Get batch job execution details (hoping that job has completed)
print '\nRetrieving batch job execution details'

# we get the schedule id from the response when we scheduled the batch job
# the response is nested json so we need two keys
schedule_id = schedule_job_response.json()['schedule']['id']

# we create the URL to retrieve the batch job execution details
check_execution_url = '/'.join(['https://api.syniverse.com/aba/v1/schedules', schedule_id, 'executions'])

check_execution_headers = {'Authorization': 'Bearer ' + access_token}

check_execution_response = requests.get(check_execution_url, headers=check_execution_headers)

print 'Get batch job details status code: ' + str(check_execution_response.status_code)
print 'Get batch job details response: ' + check_execution_response.text

## Step 6: We download the results from Media Storage
print '\nDownloading the Output file'

# In this simple example we trust that
# 1) the job is complete
# 2) it was successful
# 3) we only download the output file

# We get the output file URI from the execution details response.
# the JSON response include both nested JSON and a list
output_file_uri = check_execution_response.json()['executions'][0]['outputFileURI']

download_output_headers ={'Authorization': 'Bearer ' + access_token, 'int-companyid': company_id}

download_output_response = requests.get(output_file_uri, headers=download_output_headers)

output_data = zlib.decompress(download_output_response.content, zlib.MAX_WBITS|32)

print 'Download output status code: ' + str(download_output_response.status_code)
print 'Download output response: \n' + output_data

## Step 7: Delete Input File
print ('\nDeleting Input File in Media Storage')

delete_input_file_headers = {'Authorization': 'Bearer ' + access_token, 'Content-Type': 'application/json'}

delete_input_file_response = requests.delete(create_file_url + file_id, headers=delete_input_file_headers)

print ('Delete Input File status code: ' + str(delete_input_file_response.status_code))
print ('Delete Input File response: ' + delete_input_file_response.text)


## Step 8: Delete Output File
print ('\nDeleting Output File in Media Storage')

output_file_id = check_execution_response.json()['executions'][0]['outputFileId']

delete_output_file_headers = {'Authorization': 'Bearer ' + access_token, 'Content-Type': 'application/json'}

delete_output_file_response = requests.delete(create_file_url + output_file_id, headers=delete_output_file_headers)

print ('Delete Output File status code: ' + str(delete_output_file_response.status_code))
print ('Delete Output File response: ' + delete_output_file_response.text)