OPopenmicai
SMS

Send SMS

Changed on

Send an SMS message to a phone number. Messages are queued for delivery.

post/v2/send-sms

Request

  • Base URL
    https://api.openmic.ai
  • URL
    https://api.openmic.ai/v2/send-sms
  • Auth
    HTTP bearer

Request body

from_numberstring

Sender phone number in E.164 format. Optional — defaults to your account's Surge phone number if not provided.

to_numberstring required

Recipient phone number in E.164 format.

messagestring required

The text message to send. Must not be empty.

Example request

{
  "from_number": "+16625658792",
  "to_number": "+17189153182",
  "message": "Hello from OpenMic!"
}

Response

SMS queued for delivery

idstring

Unique message identifier.

from_numberstring

The phone number the message was sent from.

to_numberstring

The phone number the message was sent to.

messagestring

The message body that was sent.

status'queued'

The delivery status of the message.

Example response

{
  "id": "msg_01kpbgtyntfktvzseh0ykcmqm4",
  "from_number": "+16625658792",
  "to_number": "+17189153182",
  "message": "Hello from OpenMic!",
  "status": "queued"
}

Changes

  • v2c14af47763eaRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • 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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • v2c9e63b75d28fRevision changes
    • info

      endpoint added