Check whether a phone number supports iMessage
Checks whether the given number or email can receive iMessages using an agent owned by the caller’s account only (never agents from other tenants).
Authentication
X-App-Idstring
Your MessageBlue App ID, sent in clear on every request. It is paired with request signing: each request is also signed with your App Secret (see the Authentication tag). The App Secret itself is NEVER transmitted — it is only the HMAC signing key.
Request
This endpoint expects an object.
to
E.164 phone number to check for iMessage capability.
agent
Optional agent iMessage number to run the check. Must be owned by the caller's account. If omitted, uses any online agent owned by the account.
force
If true, skip the fast lookup and use the fallback detection method only.
Response
Check completed
ok
data
Endpoint-specific payload wrapped in a standard success envelope.
meta
Errors
400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error
504
Gateway Timeout Error