Docs
Open dashboard

Get SMS message

GET/sms/{id}

Returns one message with its delivery timestamps and any carrier error.

Requires Authorization: Bearer <api_key>. Create a key in the Inspra dashboard under Workspace Settings → API Keys.

Path parameters

  • idstringrequired
    UUID of the resource.

Response 200 OK

The message.

  • idstringuuidoptional
  • directionstringoptional
    outboundinbound
  • statusstringoptional
    queuedsentdeliveredfailedundeliveredopted_out
  • tostringoptional
  • fromstringnullableoptional
  • bodystringnullableoptional
  • segmentsintegernullableoptional
    Carrier segment count.
  • providerstringnullableoptional
    twiliotouchsmsatmic
  • provider_message_idstringnullableoptional
  • campaign_idstringnullableuuidoptional
    Set when an SMS campaign sent it.
  • recipient_idstringnullableuuidoptional
  • error_codestringnullableoptional
    Carrier error code on a failed message.
  • error_messagestringnullableoptional
  • queued_atstringnullabledate-timeoptional
  • sent_atstringnullabledate-timeoptional
  • delivered_atstringnullabledate-timeoptional
  • failed_atstringnullabledate-timeoptional
  • read_atstringnullabledate-timeoptional
    Inbound only. When a teammate opened the conversation.
  • created_atstringdate-timeoptional
  • updated_atstringdate-timeoptional

Errors

  • 401Unauthorized
    Missing, malformed, or invalid API key.
  • 403Forbidden
    Workspace unavailable, suspended, or paywalled.
  • 404Not Found
    Resource not found in this workspace.
  • 429Too Many Requests
    Workspace request limit exceeded; shared across all its API keys.