Check messaging capabilities

See if a phone number or email can get iMessage, RCS, or WhatsApp, without sending anything. Needs comms_read. You don't need your own line. Each channel comes back true, false, or null (unknown). The answer is only true right now and doesn't promise delivery. Emails are only checked for iMessage, so RCS comes back false and WhatsApp comes back null, both with recipient_unsupported. WhatsApp answers are cached for a few hours and rate limited.

post/capabilities

Request

  • Base URL: https://osis.co/api/v1/comms
  • URL: https://osis.co/api/v1/comms/capabilities
  • Auth: HTTP bearer

Request body

tostring required

A phone number, or an email address used for iMessage. Up to 254 characters.

default_countrystring

Two-letter country code. Needed if the number is local and has no country code.

Response

What Comms found right now. null means unknown. It never means false.

tostring required

The phone number in E.164 format, or the email in lowercase.

imessageboolean nullable required

true: yes. false: no. null: unknown.

rcsboolean nullable required

true: yes. false: no. null: unknown.

whatsappboolean nullable required

true: the number has a WhatsApp account. false: it doesn't. null: unknown.

checked_atstring date-time required

When Comms checked.

Changes

No recorded changes to this operation across all 1 revision of this API.