Send iMessages
Learn how to send iMessages via the API
Once your subscribers begin opting in to receive iMessages, you're ready to send iMessages to them. Mobile Text Alerts will automatically capture and record the inbound opt-in messages and internally flag your subscribers as iMessage enabled and opted-in. Remember, opt-ins are tied to a specific Sender Identity, so you must receive inbound consent from a subscriber on each Sender Identity you plan to use to send messages to them.
Send iMessages via the API
When sending iMessages via API, you need to specify a Sender Identity and Mobile Text Alerts will handle routing messages intelligently based on current subscriber status. For the subscribers included in a /send
call, the system will verify whether they are enabled for iMessage and then route messages through your Sender Identity. Graceful fallback to SMS is also supported.
After completing the necessary configuration and setup steps, you should have a Sender Identity attached to one of your existing outbound longcodes used for SMS/MMS. This structure enables minimal change necessary to start using the iMessage route and provides flexibility to manage Sender Identities like you currently manage longcodes.
Specify a Sender Identity with senderName
senderName
When calling the /send
endpoint of the API, include the senderName
in the request to directly specify the exact sender name to use without needing to include a longcodeId
.
The Sender Identity must be indicated with either senderName
or longcodeId
.
Specify a Sender Identity with longcodeId
longcodeId
When calling the /send
endpoint of the API, you can also include the longcodeId
in the request, this will be used as a fallback to senderName
. When a longcode has an associated iMessage Sender Identity, Mobile Text Alerts will use that identity for iMessage enabled recipients.
Create a request to the /send
endpoint with the Sender Identity
/send
endpoint with the Sender IdentitySee Send a Message to learn more about making a /send
call to the API.
Webhooks
When sending messages via the iMessage route, you will receive webhooks from Mobile Text Alerts just as you would for other messaging routes (such as SMS). For messages routed via iMessage, you will receive delivery-status
callbacks as the message's status changes through the process of sending.
For webhook calls for iMessage message-send
or message-reply
events, the payloads will include the senderName
field to identify the sender "in-scope" with sending that message when sent via iMessage. For message replies, this is the senderName
that the inbound reply was sent to.
When inbound messages are sent to your Sender Identities, Mobile Text Alerts will deliver message-reply
webhooks consistent with inbound SMS messages.
Click here for more information on configuring webhooks for your account.
Last updated
Was this helpful?