Sinch Python SDK for Conversation

The Sinch Conversation Python SDK allows you to quickly interact with the Conversatoin API from inside your Python applications. The fastest way to get started with the SDK is to check out our getting started guides. There you'll find all the instructions necessary to download, install, set up, and start using the SDK.

Syntax

When using the Python SDK, the code representing requests and queries sent to and responses received from the Conversation API are structured similarly to those that are sent and received using the Conversation API itself.

The code sample on the side of this page is an example of how to use the Python SDK to send a text message on the SMS channel of a Conversation API app. The Conversation API call that accomplishes the same task is displayed below for reference:

import requests
import base64

appId = "YOUR_app_id"
accessKey = "YOUR_key_id"
accessSecret = "YOUR_key_secret"
projectId = "YOUR_project_id"
channel = "SMS"
identity = "RECIPIENT_number"
sender = "YOUR_sms_sender"
url = "https://us.conversation.api.sinch.com/v1/projects/" + projectId + "/messages:send"

data = accessKey + ":" + accessSecret
encodedBytes = base64.b64encode(data.encode("utf-8"))
accessToken = str(encodedBytes, "utf-8")

payload = {
  "app_id": appId,
  "recipient": {
      "identified_by": {
          "channel_identities": [
            {
                "channel": channel,
                "identity": identity
            }  
            ]
      }
  },
  "message": {
      "text_message": {
          "text": "Text message from Sinch Conversation API."
      }
  },
  "channel_properties": {
    "SMS_SENDER": sender
  }  
}

headers = {
  "Content-Type": "application/json",
  "Authorization": "Basic " + accessToken
}

response = requests.post(url, json=payload, headers=headers)

data = response.json()
print(data)

This example highlights the following required to successfully make a Conversation API call using the Sinch Python SDK:

• Client initialization
• Conversation domain access
• Endpoint usage
• Field population

Client

When using the Sinch Python SDK, you initialize communication with the Sinch backend by initializing the Python SDK's main client class. This client allows you to access the the functionality of the Sinch Python SDK.

Initialization

To successfully initialize the Sinch client class, you must provide a valid access key ID and access key secret combination. You must also provide your Project ID. For example:

from sinch import SinchClient

sinch_client = SinchClient(
    key_id="YOUR_key_id",
    key_secret="YOUR_key_secret",
    project_id="YOUR_project_id"
)

Configuration

After intializing the client, you can modify the following Conversation properties using the configuration class:

You will mostly use the configuration class to detail the location of the server you'd like to interact with. For example:

sinch_client.configuration.conversation_region="us"

Conversation domain

from sinch import SinchClient

sinch_client = SinchClient(key_id="YOUR_key_id", key_secret="YOUR_key_secret",
project_id="YOUR_project_id")

from sinch.domains.conversation import Conversation

conversation_client = Conversation(sinch_client)

Endpoint categories

In the Sinch Python SDK, Conversation API endpoints are accessible through the client (either a general client or a Conversation-specific client). The naming convention of the endpoint's representation in the SDK matches the API:

• message
• app
• contact
• event
• transcoding
• capability
• template
• webhook
• conversation

For example:

conversation_response = sinch_client.conversation.message.send(
                    app_id="YOUR_app_ID",
                    recipient={
                        "identified_by" : {
                            "channel_identities" : [
                                {"identity":"RECIPIENT_number","channel" : "SMS"}
                            ]
                        }
                    },
                    message={
                        "text_message" : {
                            "text" : "Text message from Sinch Conversation API."
                        }
                    },
                    channel_properties={
                        "SMS_SENDER" : "YOUR_sms_sender"
                    }
                )

message endpoint category

app endpoint category

contact endpoint category

conversation endpoint category

event endpoint category

transcoding endpoint category

capability endpoint category

webhook endpoint category

template endpoint category

Request and query parameters

Requests and queries made using the Python SDK are similar to those made using the Conversation API. Many of the fields are named and structured similarly. In most cases, they are the same. For example, consider the representations of a Conversation API app ID below. One field is represented in JSON, and the other is using our Python SDK:

app_id = "{APP_ID}"

"app_id": "{APP_ID}"

conversation_response = sinch_client.conversation.message.get(
                    message_id="YOUR_message_id"
                    messages_source="CONVERSATION_SOURCE")

url = "https://us.conversation.api.sinch.com/v1/projects/" + project_id + "/messages/" + YOUR_message_id

payload = {
    "messages_source": "CONVERSATION_SOURCE"
}

Field name differences

Below is a table detailing field names present in the Conversation API and their modified counterparts in the Conversation API Python SDK:

Nested objects

When making calls directly to the API, we use JSON objects, including (in some cases) nested JSON objects. When using the Python SDK, we use dictionaries instead of nested JSON objects. For example, consider the message objects below. One is represented in JSON, the other as a Python dictionary:

message = {
    "text_message": {
        "text": "Text message from Sinch Conversation API."
    }
}

"message": {
    "text_message": {
        "text": "Text message from Sinch Conversation API."
    }
}    

recipient={
    "identified_by" : {
        "channel_identities" : [
            {"identity":"RECIPIENT_number","channel" : "SMS"}
        ]
    }
}

"recipient": {
    "identified_by": {
        "channel_identities": [
            {"identity":"RECIPIENT_number","channel" : "SMS"}  
        ]
    }
}

Responses

Response fields match the API responses. They are delivered as Python objects, with each top-level field represented as a property. Note that any nested objects normally returned by the Conversation API are returned as dictionaries by the Python SDK.