Skip to content
This repository has been archived by the owner on Sep 27, 2024. It is now read-only.
/ py-iMessage Public archive
forked from Rolstenhouse/py-iMessage

python library to send iMessages

License

Notifications You must be signed in to change notification settings

Harwood/py-iMessage

 
 

Repository files navigation

No longer under active development.

py-imessage

License Downloads

py-imessage is a library to send iMessages from your Mac computer (it does not work on Windows/Linux). It was originally used to build an API for iMessages; however, Apple doesn't support third-parties using iMessage over a few hundred marketing messages per day.

Buy Me A Coffee

Installation

Run the following commands on the terminal

pip install py-imessage

# Disable system integrity protection in order to allow access to chat.db
csrutil disable

If running csrutil disable doesn't work. Try this stackoverflow post

Sample Usage

from py_imessage import imessage
import sleep

phone = "1234567890"

if not imessage.check_compatibility(phone):
    print("Not an iPhone")

guid = imessage.send(phone, "Hello World!")

# Let the recipient read the message
sleep(5)
resp = imessage.status(guid)

print(f'Message was read at {resp.get("date_read")}')

Documentation

Sending a message

Send a message to a new or an existing contact!

.send(phone, message)

Args

Phone | ten-digit phone number of string type format XXXXXXXXXXX i.e. "1234567890"

Response

Message | The message you plan to send. i.e. "Hi!"

Returns a string, the GUID
Type Description
string GUID unique to the message (used for checking on status)

Message status

Check whether a message you sent has been delivered and read (if read receipts turned on).

.status(guid)

Args

Guid | guid returned from sending a message

Response

Returns a dict, with following fields
Field Type Description Sample
guid string guid that was passed in to the function "3A146100-D269-4F35-BDB4-EB2FF7DBDF0F"
date_submitted datetime date message was submitted "Sun, 12 Apr 2020 05:46:48 GMT"
date_delivered datetime date message was delivered to recipient's phone "Sun, 12 Apr 2020 05:46:49 GMT"
date_read datetime date message was read on recipient's phone "Sun, 12 Apr 2020 05:47:38 GMT"

Checking iMessage compatibility

Check whether a phone number is registered to an iPhone or an Android device. NOTE: This method is exceptionally slow, so you should cache the response.

.check_compatibility(phone)

Args

Phone | ten-digit phone number of string type format XXXXXXXXXXX i.e. "1234567890"

Response

Returns a boolean, compatibility
Type Description
boolean Whether number supports receiving iMessages

Contributing

Please create an issue. Or feel free to add a PR!

About

python library to send iMessages

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 60.1%
  • JavaScript 39.9%