from defs import Client
# replace with credentials. I recommend doing Credentials.twilio_get_sid, etc.
client = Client("your_number", "account_sid", "auth_token")You also need to update the client used in defs.py. This is the client used when using any methods in the Message class. If your program uses multiple clients, it is inadvisable to use the message class, because it only uses the client defined here. For most use cases, this will not be a problem.
import twilio.rest
# twilio.rest.Client() is different that Client()
twilio_client = twilio.rest.Client("twilio_sid", "twilio_auth")After these two things are done, you are pretty much ready to start using and modifying the code.
from defs import Client
# Methods
client = Client("number", "sid", "auth") # details above
# E.164 formatted number. (123)-456-7890 would be +11234567890
client.send_sms("Hello World!", "+11234567890") # send sms
client.send_mms("Hello World!", "+11234567890", "media_url") # send mms - media url can be website or local file
client.send_multiple_mms("Hello World!", "+11234567890", ['/file/name', 'https://example.com']) # up to 10
# returns list of class Messages, details below
client.get_unread_messages("optional number")
# marks all unread messages as read
client.mark_all_read() # you can specify how far back to go if you want, see below
# marks a message as read. message_sid explained below
client.mark_as_read("message_sid")
# asks user a question and returns response. if not answered within
# timeout time, default is returned.
user_response = client.ask("Enter prompt,", message_object, timeout=60, default="Hello", advanced=False)
# same as above, but with async
user_response = await client.async_ask("Enter prompt,", message_object, timeout=60, default="Hello", advanced=False)
# setting advanced to True will return message object instead of string. useful for advanced projects
# examples below
# properties
print(client.number) # client assigned phone number
print(client.sid) # client assigned account sid
print(client.auth) # client assigned auth token| syntax | Description | Type |
|---|---|---|
| client.number | The number assigned to the client | string (E.164 format) |
| client.sid | The sid key assigned to the client | string |
| client.auth | The auth token assigned to the client | string |
| syntax | Description | # of args | Returns | Details |
|---|---|---|---|---|
| INITIALIZATION | Creates initial Client object | 3 | Client object | |
| client.send_sms() | Sends sms | 2 | None | |
| client.send_sms() | Sends mms | 3 | None | |
| client.get_unread_messages() | Gets all unread messages | 1 (optional, default is 20) | list (contains Message objects) | |
| client.mark_all_read() | Marks all messages as read | 1 (optional, default is 200) | None | |
| client.mark_as_read() | Marks message as read | 1 | None | |
| client.ask() | Send sms to number specified in message obj, returns response | 5 (3 optional) | string if advanced == False, Message object if True | |
| client.async_ask() | Send sms to number specified in message obj, returns response | 5 (3 optional) | string if advanced == False, Message object if True | Asynchronous |
from defs import Client
client = Client("your_number", "account_sid", "auth_token")
messages = client.get_unread_messages()
for msg in messages:
# properties
print(msg.content) # body of message
print(msg.number) # number of who sent the message
print(msg.message_type) # returns either "sms" or "mms"
print(msg.sid) # returns the SID of that specific message
print(msg.message_to) # returns number of the one who received message
print(msg.account_auth) # returns account auth of client that handled message
print(msg.account_sid) # returns account sid of client that handled message
# methods
# sends a sms or mms message to the number that sent the message
msg.send_sms("Hello World!")
msg.send_mms("hello World!", "url_of_media") # local or webpage
msg.send_multiple_mms("Hello World!", ['/file/name', 'https://example.com']) # up to 10
msg.mark_as_read() # mark message as read
# these are the same as above, except you don't need to enter message object
user_response = msg.ask("Enter prompt")
user_response = await msg.ask("Enter prompt")
# these are only for MMS messages
# downloads the media. DO NOT include extension, like .png or .jpg
msg.MMS_mv("file_name")
# a list - first element is raw data, second element is mime-type
msg.MMS_raw_data()| syntax | Description | Type |
|---|---|---|
| msg.content | The content of the message | string |
| msg.number | Number that sent the message | string (E.164 format) |
| msg.message_type | Returns either "sms" or "sms" | string |
| msg.sid | The unique ID of the message | string |
| msg.message_to | Who the message was sent to | string (E.164 format) |
| msg.account_auth | The auth key of the client that handles the message | string |
| msg.account_sid | The sid token of the client that handles the message | string |
| syntax | Description | # of args | Returns | Details |
|---|---|---|---|---|
| msg.send_sms() | Sends sms to the number that sent message | 1 | None | |
| msg.send_mms() | Sends mms to the number that sent message | 2 | None | |
| msg.mark_as_read() | Marks message as read | None | None | |
| msg.ask() | Send a question to number that sent message | 4 (3 of which are optional) | string if advanced == False, Message object if True | |
| msg.async_ask() | Send a question to number that sent message (async) | 4 (3 of which are optional) | string if advanced == False, Message object if True | Asynchronous |
| msg.MMS_mv() | Downloads file to file path | 1 | None | Only for MMS |
| msg.MMS_raw_data() | Returns raw data of file | None | list (contains MIME-type followed by data |
You can either have the credentials hardcoded in, rely on environment variables, or use the following method. This method involves you putting your credentials in functions that are contained in credentials.py. For example, your twilio sid will go in twilio_get_sid.
def twilio_get_number():
my_number = "" # number goes here
return my_number
def twilio_get_sid():
account_sid = "" # sid
return account_sid
def twilio_get_auth():
auth_token = "" #auth
return auth_tokenA sample program is supplied in main.py. You can also use this code to help you get started:
from defs import Client
client = Client("number", "sid", "auth")
messages = client.get_unread_messages()
for msg in messages:
# if messages starts with !
if msg.content[0] == "!":
# if message is !help
if msg.content == "!help":
msg.send_sms("Help command activated.")
# if message is !test
elif msg.content == "!test":
msg.send_sms("Program is running.")
The following code shows you how to make a program using message.ask().
from defs import Client
client = Client("number", "sid", "auth")
messages = client.get_unread_messages()
for msg in messages:
# if messages starts with !
if msg.content[0] == "!":
# if message is !help
if msg.content == "!help":
msg.send_sms("Current commands: !help, !test")
# if message is !test
elif msg.content == "!test":
user_response = msg.ask("Respond with 1 or 2.")
if user_response == "1":
msg.send_sms("Apple")
elif user_response == "2":
msg.send_sms("Banana")
else:
msg.send_sms("Invalid number!")