Skip to content

Commit 0785056

Browse files
committed
client/mms: add docstring to create_mms method
1 parent 1deec65 commit 0785056

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

messagebird/client.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,22 @@ def message_delete(self, id):
112112
self.request_plain_text('messages/' + str(id), 'DELETE')
113113

114114
def mms_create(self, originator, recipients, body, mediaUrls, subject = None, reference = None, scheduledDatetime = None):
115-
""" Send bulk mms. """
115+
''' Send bulk mms.
116+
117+
Args:
118+
originator(str): name of the originator
119+
recipients(str/list(str)): comma seperated numbers or list of numbers in E164 format
120+
body(str) : text message body
121+
mediaUrl(str) : list of URL's of attachments of the MMS message.
122+
subject(str) : utf-encoded subject
123+
reference(str) : client reference text
124+
scheduledDatetime(str) : scheduled date time in RFC3339 format
125+
Raises:
126+
ErrorException: On api returning errors
127+
128+
Returns:
129+
MMS: On success an MMS instance instantiated with succcess response
130+
'''
116131
if isinstance(recipients,list):
117132
recipients = ','.join(recipients)
118133
if isinstance(mediaUrls,str):

0 commit comments

Comments
 (0)