Python

As an outcome of this guide, you will be able to check the message count and whether there are any characters left in the message. In the case of international communication, you can also review the original text and preview transliteration for mobiles not supporting that particular character set.

Prerequisites

• Infobip account

• Working Python 3 environment

Difficulty level

This guide assumes very basic knowledge of Python and basic familiarity with APIs.

Summary of the steps

• Install the Infobip API Python SDK.
• Import the SMS Channel and create an SMS Channel instance.
• Add credentials and SMS preview payload to your instance.
• Print the response to preview the message.

Install the Infobip API Python SDK

pip install infobip-api-python-sdk

Create an SMS Channel instance

You’ll use the instance to input your credentials and access its methods. In this guide, we will use the preview_sms_message method to add the SMS payload.

Step 1. Import the SMSChannel.

from infobip_channels.sms.channel import SMSChannel

Step 2. Create the SMSChannel instance and add your base_url and api_key that you can access either from your Infobip account or from the Infobip API landing page once you log in.

channel = SMSChannel.from_auth_params({
    "base_url": "<your_base_url>",
    "api_key": "<your_api_key>"
})

Step 3. Use the preview_sms_message method to add the SMS Preview payload.

Key points:

• We recommend you put the preview_sms_message method within a variable, so that you can print out the response.
• Use the transliteration field to add a language code or a NON_UNICODE value if you want to preview the fallback message phones that don’t support that particular character set will receive.
• Use the languageCode field to add a language code or set it to AUTODETECT to let the Infobip platform select the character set based on message content.

sms_preview = channel.preview_sms_message({
  "text": "Ni se imaginan la cara que puso Martín cuando le pasó lo que les voy a contar, que les aseguro que es la pura verdad. Una mañana mientras Martín iba a la escuela, sintió que algo saltaba dentro de su mochila, primero se paró quieto, muy quietito, y la mochi volvió a moverse. Sus ojos se abrieron cada vez más grandotes.",
  "languageCode": "ES",
  "transliteration": "NON_UNICODE"
})

Step 4. Print the response to preview your SMS.

print(sms_preview)

Once you run your code, you should see the following 200 OK response where you can preview your message and its variations. We chose to preview an excerpt from a Spanish children’s book and selected the appropriate character set (ES). Additionally, for those whose phones don’t support the Spanish character set, we chose a NON_UNICODE version to show on their devices.

{
    "originalText": "Ni se imaginan la cara que puso Martín cuando le pasó lo que les voy a contar, que les aseguro que es la pura verdad. Una mañana mientras Martín iba a la escuela, sintió que algo saltaba dentro de su mochila, primero se paró quieto, muy quietito, y la mochi volvió a moverse. Sus ojos se abrieron cada vez más grandotes.",
    "previews": [
        {
            "textPreview": "Ni se imaginan la cara que puso Martín cuando le pasó lo que les voy a contar, que les aseguro que es la pura verdad. Una mañana mientras Martín iba a la escuela, sintió que algo saltaba dentro de su mochila, primero se paró quieto, muy quietito, y la mochi volvió a moverse. Sus ojos se abrieron cada vez más grandotes.",
            "messageCount": 5,
            "charactersRemaining": 15,
            "configuration": {}
        },
        {
            "textPreview": "Ni se imaginan la cara que puso Martín cuando le pasó lo que les voy a contar, que les aseguro que es la pura verdad. Una mañana mientras Martín iba a la escuela, sintió que algo saltaba dentro de su mochila, primero se paró quieto, muy quietito, y la mochi volvió a moverse. Sus ojos se abrieron cada vez más grandotes.",
            "messageCount": 3,
            "charactersRemaining": 120,
            "configuration": {
                "language": {
                    "languageCode": "ES"
                }
            }
        },
        {
            "textPreview": "Ni se imaginan la cara que puso Martin cuando le paso lo que les voy a contar, que les aseguro que es la pura verdad. Una mañana mientras Martin iba a la escuela, sintio que algo saltaba dentro de su mochila, primero se paro quieto, muy quietito, y la mochi volvio a moverse. Sus ojos se abrieron cada vez mas grandotes.",
            "messageCount": 3,
            "charactersRemaining": 139,
            "configuration": {
                "transliteration": "NON_UNICODE"
            }
        }
    ]
}