Skip to main content

Python SDK for the Unlimited Messaging API

Project description

unlimited-messaging

Official Python client for the Unlimited Messaging API — send and receive WhatsApp messages programmatically.

Installation

pip install unlimited-messaging

Quick start

import os
from unlimited_messaging import UnlimitedMessagingApi

client = UnlimitedMessagingApi(
    token=os.environ["API_TOKEN"],
)

# Send a WhatsApp message
message = client.message.message_controller_send(
    recipient="+33612345678",
    text="Hello!",
)

print(message.id, message.status)

Authentication

Get your API token from the dashboard and pass it as the token argument.

client = UnlimitedMessagingApi(token="your_api_token")

Examples

Send a message

message = client.message.message_controller_send(
    recipient="+33612345678",
    text="Hello from the SDK!",
    sim_id="optional-sim-id",  # force a specific SIM
)

List messages

result = client.message.message_controller_find_all(
    page=1,
    limit=20,
    status="DELIVERED",   # PENDING | SENDING | SENT | DELIVERED | READ | FAILED
    search="keyword",
)

print(f"{result.total} messages")
for msg in result.data:
    print(msg.id, msg.status, msg.text)

List linked SIMs

sims = client.sim.sim_controller_get_linked_sims()

for sim in sims:
    print(sim.id, sim.phone_number)

Async support

import asyncio
from unlimited_messaging import AsyncUnlimitedMessagingApi

client = AsyncUnlimitedMessagingApi(token="your_api_token")

async def main():
    message = await client.message.message_controller_send(
        recipient="+33612345678",
        text="Hello async!",
    )
    print(message.id, message.status)

asyncio.run(main())

API reference

Method Description
message.message_controller_send Send a WhatsApp message
message.message_controller_find_all List messages with pagination and filters
sim.sim_controller_get_linked_sims List linked SIMs

Official documentation: docs.unlimitedmessaging.app Full OpenAPI spec: openapi.yaml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unlimited_messaging-0.1.1.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unlimited_messaging-0.1.1-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

Details for the file unlimited_messaging-0.1.1.tar.gz.

File metadata

  • Download URL: unlimited_messaging-0.1.1.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for unlimited_messaging-0.1.1.tar.gz
Algorithm Hash digest
SHA256 60691e557e59f40630f2027d7b2fd3d1481ad7e7b7a3bb6f274dc9a74ad1ab9b
MD5 e08fad481f3c21c447b01c7b3d873ba0
BLAKE2b-256 c0284028be1d021507daa1d50af2cc530eec06051dced47129987cc1573a7592

See more details on using hashes here.

File details

Details for the file unlimited_messaging-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for unlimited_messaging-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f79e6f8425721a389d7447f7a06bafcf0b91b6d81092f7e88b32e21f535725a9
MD5 84afb83377bc8845d9bb8ea84e958537
BLAKE2b-256 72771a1a40b7a9bf707c32767984753bf535d6e3671acca4a25d5cd9a548fb12

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page