Home Assistant integration: ha-smsgateway

[Micka41]

Hi,

Thanks for SMS Gateway for Android — I've been using it as the SMS backbone of my Home Assistant setup, and I've turned that into a full integration that others may find useful.

Repository: https://github.com/Micka41/ha-smsgateway (MIT, installable through HACS)

What it does

• Sends SMS and MMS from Home Assistant, including attachments, subject, SIM slot and priority
• Receives SMS and MMS through webhooks, with attachments saved to disk
• Verifies the HMAC-SHA256 webhook signature, with a replay window on X-Timestamp
• Downloads MMS attachments through GET /inbox/{id}/attachments/{partId} when data is missing from the webhook
• Exposes /health checks as Home Assistant entities: battery, charging, connectivity, failed messages
• Registers and cleans up its own webhooks on the device

It targets Local Server mode and requires 1.74.1 or later, since it relies on mmsMessage.

A few documentation notes I ran into, in case they're useful:

1. The online docs still describe MMS as receive-only, while sending works fine on 1.74.1.
2. In mms:received, messageId carries the transactionId, and doesn't match the messageId of the corresponding mms:downloaded event — so the two can't be correlated by ID. I didn't find this documented.
3. The /health example for Local mode shows "version": "1.0.0", but the real endpoint returns the actual app version (1.74.1 here), which is great — the example just made me doubt it at first.
4. The bundled swagger.json lists http://localhost:3000/api as a server, whereas the Local Server serves the same paths at the root on port 8080.

If you think it would help your users, I'd be glad to see it mentioned in the docs or README — and I'm happy to adjust anything in how the project is presented.

Thanks again for the great work.

Mickaël

[capcom6]

Hello!

Thanks for sharing your project!

1. This is because the public server hasn't been updated yet. I only update the documentation once both the Android app and the server have been updated.
2. The field descriptions differ in the Supported Events section of the webhook documentation.
3. This is just an example; it demonstrates the response schema, not an actual data.
4. Thanks for pointing this out: I’ve updated the port in this pull request: [docs] fix default port in swagger #451

Some documentation issues have already been addressed in the upcoming documentation update: android-sms-gateway/docs-web#227. It would be great if you could take a moment to check it out.

I always welcome contributions to the project. Feel free to submit pull requests to any of the project's repositories.

Best Regards,
Aleksandr

[Micka41]

Thanks for the detailed answers, and for fixing the port in #451.

You're right about the messageId - it is covered in the Supported Events section, I missed it. And the context on the MMS docs makes sense.

I'll take a look at android-sms-gateway/docs-web#227 and leave any feedback there. Happy to contribute further as the Home Assistant integration evolves.

Mickaël