Skip to main content

unlimited-messaging

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

PyPI version PyPI downloads PyPI total downloads Python versions License CI

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.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.send(
    recipient="+33612345678",
    text="Hello from the SDK!",
    sim_id="optional-sim-id",  # force a specific SIM
)

List messages

result = client.message.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)

Get a single message

msg = client.message.find_one("message-id")
print(msg.id, msg.status, msg.text)

List linked SIMs

sims = client.sim.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.send(
        recipient="+33612345678",
        text="Hello async!",
    )
    print(message.id, message.status)

asyncio.run(main())

API reference

Method Description
message.send Send a WhatsApp message
message.find_all List messages with pagination and filters
message.find_one Get a single message by ID
sim.get_linked_sims List linked SIMs

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

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.3.tar.gz (21.3 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.3-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: unlimited_messaging-0.1.3.tar.gz
  • Upload date:
  • Size: 21.3 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.3.tar.gz
Algorithm Hash digest
SHA256 68c62c3c38b6157ba3a0509df97aaae1dbb3b1eeb70daab1d42d3610458ebd92
MD5 405c8f2badc144ca9f9887b30026adcc
BLAKE2b-256 12fe219e4a05fe41c74e778a3e14eb42e245bf2a1ac3a74ab1e0867c4cafda0a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for unlimited_messaging-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 790db93e337cc7b75855b5eafa10fab7636c59bca0fe56346a0b453ce12b08ea
MD5 a2c3c51d9c53389413d1621dc80e6884
BLAKE2b-256 1f574c220cb96c6cc83337389a494f030bf79068c2e99e66a690ba7c22da5134

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