INinteractly
SMS Libraries and APIs

Send a test SMS to the specified phone number

Changed on

Send a test SMS to the specified phone number. This is for testing purposes only. Fixed message content is used for testing, and the message will not be persisted in the database.

post/sms/v1/test/messages

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/sms/v1/test/messages
  • Auth
    HTTP bearer

Request body

tostring nullable

Phone number to which SMS to be sent.

from_string nullable

Phone number from which SMS is received.

bodystring nullable

Message content of SMS

numSegmentsinteger nullable

Carrier segment count for the message. Inbound SMS is billed per segment.

assistantIdstring nullable
teamIdstring nullable
botconfigobject nullable
metaobject nullable
skipSmsLogboolean nullable

If true, skip persisting an SMSLogs record for this send (e.g. OTP messages).

Response

Successful Response

unknown required

Changes