Skip to main content

Sends and receives messages between seed services and Vumi HTTP API

Channel configuration

Concurrency Limiter Fields:

  • concurrency_limit: A value of 0 disables concurrency limiter

  • message_delay: Seconds to wait before retrying a waiting message

  • message_timeout: Seconds until we assume a message has finished

Configuration:

JSON field containing the following data:

Generic API:

  • HTTP_API_URL: http://example.com/

  • HTTP_API_AUTH: (‘username’, ‘password’)

  • HTTP_API_FROM: +4321

  • OVERRIDE_PAYLOAD: {‘new_key’: ‘key_from_original_payload’}

  • STRIP_FILEPATH: True/False - True when voice files are hosted where the API is.

Original Payload:

{
    "to": "+27820000000",
    "from": "1444",
    "content": "Hey, this is a message!",
    "channel_data": {
        "voice": {
            "speech_url": "http://sbm.com/hello.mp3"
        }
    }
}

Example of OVERRIDE_PAYLOAD:

{
    "to_msisdn": "to",
    "from_number": "from",
    "text": "content",
    "filename": "channel_data.voice.speech_url"
}

Will generate this payload:

{
    "to_msisdn": "+27820000000",
    "from_number": "1444",
    "text": "Hey, this is a message!",
    "filename": "http://sbm.com/hello.mp3"
}

Junebug:

  • JUNEBUG_API_URL: http://example.com/

  • JUNEBUG_API_AUTH: (‘username’, ‘password’)

  • JUNEBUG_API_FROM: +4321

Vumi:

  • VUMI_CONVERSATION_KEY: conv-key

  • VUMI_ACCOUNT_KEY: account-key

  • VUMI_ACCOUNT_TOKEN: account-token

  • VUMI_API_URL: http://example.com/

WhatsApp:

  • API_URL: Root URL for WhatsApp API

  • API_TOKEN: Token for accessing the API

  • HSM_NAMESPACE: (optional) HSM namespace if outbounds are to be sent as HSMs

  • HSM_ELEMENT_NAME: (optional) HSM element name if outbounds are to be sent as HSMs

  • HMAC_SECRET: (optional) The HMAC secret key for receiving event and inbound webhooks

Metadata

Release files for seed-message-sender 0.10.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for seed-message-sender 0.10.11
File Size Uploaded
seed-message-sender-0.10.11.tar.gz 57.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for seed-message-sender 0.10.11
File Interpreter ABI Platform
seed_message_sender-0.10.11-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 134.6 kB

Release files / seed-message-sender-0.10.11.tar.gz

Download URL seed-message-sender-0.10.11.tar.gz
Size 57.2 kB
Tags Source
SHA-256 checksum
How to use checksums
21db9bf621d5dca525fa54ba849542c17a02dc1b9a80dfc4091986dc76e9cb9c
BLAKE2b-256 checksum
How to use checksums
57f0760c5c05fa545edb590f7514a8a67dfba85f43f6fcc55ba6691527ba54c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.7

Release files / seed_message_sender-0.10.11-py2.py3-none-any.whl

Download URL seed_message_sender-0.10.11-py2.py3-none-any.whl
Size 77.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
2d2c7172bd6b37f35f149e63ab9b3e7a71b2c509bb542bf3272193d948c289bc
BLAKE2b-256 checksum
How to use checksums
4dd24d243a9c27992e140ad9db92ad93f2fa086a42457c1eb80f5f1c1058a222
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.7
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page