SMS

Retrieve an SMS message

Retrieve one SMS message's current status, delivery state, and segment count by id. Requires the sms:read capability.

get/sms/{id}

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/sms/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The SMS message id (sms_…).

Response

The SMS message.

object'sms' required
idstring required
tostring required
fromstring nullable required
direction'outbound' | 'inbound' required
status'queued' | 'scheduled' | 'sending' | 'sent' | 'delivered' | 'failed' | 'suppressed' | 'canceled' | 'received' required
type'transactional' | 'marketing' required
bodystring nullable required
segmentsinteger required
countrystring nullable required
scheduled_atstring nullable required
last_errorstring nullable required

Legacy free-text error. Prefer error.code.

created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.