Package: infobip-api-python-client
Infobip API Python ClientThis is a Python package for Infobip API and you can use it as a dependency to addInfobip APIsto your application.
To use the package you'll need an Infobip account. If you don't already have one, you can create afree trialaccounthere.We useOpenAPI Generatorto generate the package code from the OpenAPI specification.Table of contents:API documentationGeneral InfoInstallationQuickstartAsk for helpAPI documentationInfobip API Documentation can be foundhere.General InfoForinfobip-api-python-clientversioning we useSemantic Versioningscheme.Published underMIT License.Python 3.6 is minimum supported version by this library.InstallationPull the library by using the following command:pipinstallinfobip-api-python-clientQuickstartBefore initializing the client first thing you need to do is to set configuration and authentication.ConfigurationLet's first set the configuration. For that you will need your specific URL.
To see your base URL, log in to theInfobip API Resourcehub with your Infobip credentials.frominfobip_api_client.api_clientimportApiClient,Configurationclient_config=Configuration(host="<YOUR_BASE_URL>",api_key={"APIKeyHeader":"<YOUR_API_KEY>"},api_key_prefix={"APIKeyHeader":"<YOUR_API_PREFIX>"},)Initialize the ClientWith configuration set up you can initialize the API client.api_client=ApiClient(client_config)Now you are ready use the API.Send an SMSHere's a basic example of sending the SMS message.sms_request=SmsAdvancedTextualRequest(messages=[SmsTextualMessage(destinations=[SmsDestination(to="41793026727",),],_from="InfoSMS",text="This is a dummy SMS message sent using Python library",)])api_instance=SendSmsApi(api_client)api_response:SmsResponse=api_instance.send_sms_message(sms_advanced_textual_request=sms_request)pprint(api_response)To make your code more robust send the message in try block and handle theApiExceptionin catch block.frominfobip_api_client.exceptionsimportApiExceptiontry:api_response:SmsResponse=api_instance.send_sms_message(sms_advanced_textual_request=sms_request)exceptApiExceptionasex:print("Error occurred while trying to send SMS message.")In case of failure you can inspect theApiExceptionfor more information.try:api_response:SmsResponse=api_instance.send_sms_message(sms_advanced_binary_request=sms_advanced_binary_request)exceptApiExceptionasex:print("Error occurred while trying to send SMS message.")print("Error status:%s\n"%ex.status)print("Error headers:%s\n"%ex.headers)print("Error body:%s\n"%ex.body)Additionally, from the successful response (SmsResponseobject) you can pull out thebulk_idandmessage_id(s) and use them to fetch a delivery report for given message or bulk.
Bulk ID will be received only when you send a message to more than one destination address or multiple messages in a single request.bulk_id=api_response.bulk_idmessage_id=api_response.messages[0].message_idReceive sent SMS reportFor each SMS that you send out, we can send you a message delivery report in real time. All you need to do is specify your endpoint when sending SMS innotify_urlfield ofSmsTextualMessage, or subscribe for reports by contacting our support team.
e.g.https://{yourDomain}/delivery-reportsExample of webhook implementation using Flask:@app.route("/api/delivery-reports",methods=["POST"])defdelivery_report():delivery_result=SmsDeliveryResult(results=request.json["results"])forresultindelivery_results.results:print("message{0}sent at{1}".format(result.message_id,result.sent_at))If you prefer to use your own serializer, please pay attention to the supporteddate format.Fetching delivery reportsIf you are for any reason unable to receive real time delivery reports on your endpoint, you can usemessage_idorbulk_idto fetch them.
Each request will return a batch of delivery reports. Please be aware that these can be retrieved only once.api_response=api_instance.get_outbound_sms_message_delivery_reports(bulk_id=bulk_id,message_id=message_id,limit=2)print(api_response)Unicode & SMS previewInfobip API supports Unicode characters and automatically detects encoding. Unicode and non-standard GSM characters use additional space, avoid unpleasant surprises and check how different message configurations will affect your message text, number of characters and message parts.sms_preview_request=SmsPreviewRequest(text="Let's see how many characters will remain unused in this message.")api_response=api_instance.preview_sms_message(sms_preview_request=sms_preview_request)Receive incoming SMSIf you want to receive SMS messages from your subscribers we can have them delivered to you in real time. When you buy and configure a number capable of receiving SMS, specify your endpoint as explainedhere.
e.g.https://{yourDomain}/incoming-sms.Example of webhook implementation using Flask:@app.route("/api/incoming-sms",methods=["POST"])defincoming_sms():message_results=SmsInboundMessageResult(message_count=request.json["message_count"],pending_message_count=request.json["pending_message_count"],results=request.json["results"])forresultinmessage_results.results:print("message text:{0}".format(result.clean_text))Two-Factor Authentication (2FA)For 2FA quick start guide please checkthese examples.Ask for helpFeel free to open issues on the repository for any issue or feature request. As per pull requests, for details check theCONTRIBUTINGfilerelated to it - in short, we will not merge any pull requests, this code is auto-generated.If it's something that requires our imminent attention feel free to contact us @support@infobip.com.