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.4.tar.gz (28.6 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.4-py3-none-any.whl (51.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: unlimited_messaging-0.1.4.tar.gz
  • Upload date:
  • Size: 28.6 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.4.tar.gz
Algorithm Hash digest
SHA256 8af1c1bcf67eac0214b6544d3d62efa052bff4799de63b32a1cc1679977f9405
MD5 f0d60bfcb8cf6fb675f7aafa597006a7
BLAKE2b-256 23a6bd8a01bd52002d41ec1143ee29b41e061253bce8a21593e887b38c54c1c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for unlimited_messaging-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2cb20789378056237bde8b17ce9fffccdcbdd874157bf5e6b04f594db651a1c1
MD5 7865f47d5cb5d851b2cc984280f6ebd5
BLAKE2b-256 2cb2eb3fa2cfe4e878172918b0448aca1a00c0b696e6eab46f6d37b659b58a17

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