INinkbox
iMessage

Send Message

Changed on
post/api/v1/imessage/messages

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/imessage/messages
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Query parameters

agent_identity_idstring uuid nullable

Agent identity to send as. Required for org-wide callers when sending by to; ignored for agent-scoped keys.

Headers

Idempotency-Keystring nullable
Preferstring nullable

Use idempotency-replay with Idempotency-Key to replay the original send result.

Request body

conversation_idstring uuid nullable

Existing conversation to reply into. Mutually exclusive with to.

reply_to_message_idstring uuid nullable

Message to reply to within conversation_id. Omit for an ordinary message.

plain_reply_fallbackboolean

Allow an ordinary message in the same conversation when, before sending, the reply target is known to use SMS, RCS, or downgraded transport, or is a text-only inbound reaction notice that cannot anchor a native reply. Set false to require a native reply. A rejected or uncertain native send is not resent as an ordinary message. Ignored without reply_to_message_id.

textstring nullable
media_urlsstring[] nullable
send_style'celebration' | 'shooting_star' | 'fireworks' | 'lasers' | 'love' | 'confetti' | 'balloons' | 'spotlight' | 'echo' | 'invisible' | 'gentle' | 'loud' | 'slam'

Example request

{
  "to": "+15551234567"
}

Response

Successful Response

OR
OR

Changes

  • 5cbaa42f14f7Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 8583fbe88b90Revision changes
    • info

      added the new optional header request parameter Prefer