AfricasTalkingGateway-Python/AfricasTalkingGateway.py at master · boscoMW/AfricasTalkingGateway-Python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
import urllib
import urllib2
import json

class AfricasTalkingGatewayException(Exception):
    pass

class AfricasTalkingGateway:

    def __init__(self, username_, apiKey_):
	self.username = username_
	self.apiKey   = apiKey_

        self.SMSURLString   = "https://api.africastalking.com/version1/messaging"
	self.VoiceURLString = "https://voice.africastalking.com/call"

    def sendMessage(self, to_, message_, from_ = None, bulkSMSMode_ = 1, enqueue_ = 0, keyword_ = None, linkId_ = None):

	'''
	 The optional from_ parameter should be populated with the value of a shortcode or alphanumeric that is
	 registered with us

         The optional bulkSMSMode_ parameter will be used by the Mobile Service Provider to determine who gets billed for a
	 message sent using a Mobile-Terminated ShortCode. The default value is 1 (which means that
	 you, the sender, gets charged). This parameter will be ignored for messages sent using
	 alphanumerics or Mobile-Originated shortcodes.

         The optional enqueue_ parameter is useful when sending a lot of messages at once where speed is of the essence

         The optional keyword_ is used to specify which subscription product to use to send messages for premium rated short codes

         The optional linkId_ parameter is pecified when responding to an on-demand content request on a premium rated short code

         '''

        if len(to_) == 0 or len(message_) == 0:
            raise AfricasTalkingGatewayException("Please provide both to_ and message_ parameters")

	values = {'username' : self.username,
		  'to'       : to_,
		  'message'  : message_ }

	if not from_ is None :
	    values["from"]        = from_
	    values["bulkSMSMode"] = bulkSMSMode_

        if enqueue_ > 0:
            values["enqueue"] = enqueue_

        if not keyword_ is None:
            values["keyword"] = keyword_

        if not linkId_ is None:
            values["linkId"] = linkId_

	headers = {'Accept' : 'application/json',
		   'apikey' : self.apiKey }

	try:
            data     = urllib.urlencode(values)
            request  = urllib2.Request(self.SMSURLString, data, headers=headers)
            response = urllib2.urlopen(request)
            the_page = response.read()

        except urllib2.HTTPError as e:
            the_page = e.read()
            decoded  = json.loads(the_page)
            raise AfricasTalkingGatewayException(decoded['SMSMessageData']['Message'])

        else:
            decoded  = json.loads(the_page)
            recipients = decoded['SMSMessageData']['Recipients']
            return recipients

    def fetchMessages(self, lastReceivedId_):

	url     = "%s?username=%s&lastReceivedId=%s" % (self.SMSURLString, self.username, lastReceivedId_)
	headers = {'Accept' : 'application/json',
		   'apikey' : self.apiKey }

        try:
            request  = urllib2.Request(url, headers=headers)
            response = urllib2.urlopen(request)
            the_page = response.read()

        except urllib2.HTTPError as e:

            the_page = e.read()
            decoded  = json.loads(the_page)
            raise AfricasTalkingGatewayException(decoded['SMSMessageData']['Message'])

        else:

            decoded  = json.loads(the_page)
            messages = decoded['SMSMessageData']['Messages']

            return messages

    def call(self, from_, to_):
	values = {'username' : self.username,
		  'from'     : from_,
                  'to'       : to_ }

	headers = {'Accept' : 'application/json',
                   'apikey' : self.apiKey }

        try:
            data     = urllib.urlencode(values)
            request  = urllib2.Request(self.VoiceURLString, data, headers=headers)
            response = urllib2.urlopen(request)

        except urllib2.HTTPError as e:

            the_page = e.read()
            decoded  = json.loads(the_page)
            raise AfricasTalkingGatewayException(decoded['ErrorMessage'])