Skip to main content
POST
imessage.message.reply

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by imessage.messages.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
text
string

Message text, up to 9999 characters.

Required string length: 1 - 9999
attachments
object[]

Up to three attachments, each at most 10 MB.

Required array length: 1 - 3 elements
effect
enum<string>

Bubble or screen effect.

Available options:
celebration,
shooting-star,
firework,
lasers,
love,
confetti,
balloons,
spotlight,
echo,
invisible,
gentle,
loud,
slam

Response

The result

status
enum<string>
required

Acceptance or sending; neither guarantees delivery.

Available options:
queued,
sent
channel
enum<string>

The actual messaging channel.

Available options:
imessage,
sms,
rcs,
whatsapp
ref
string

Reference to what this call created. Pass it as ref to imessage.message.status.