Skip to navigation
EndpointSMS details

SMS details

Required permissions Beta Learn more

Endpoint.Sms + Get

Roles: Administrator User Observer

Returns details about an Endpoint SMS by SMS ID.

A description of the SMS statuses is as follows:

  • 1: Delivery attempt pending
  • 2: In progress
  • 3: Buffered
  • 4: Delivered
  • 5: Failed
  • 6: Expired
  • 7: Canceled

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

endpoint_idintegerRequired
Numeric ID of an endpoint
sms_iddoubleRequired
The numeric ID of an SMS

Response

Successfully returned the details of the SMS.
submit_datestringOptional
delivery_datestringOptional
expiry_datestringOptional
final_datestring or nullOptional
retry_datestring or nullOptional
last_delivery_attemptstring or nullOptional
retry_countstringOptional
gsm_map_errorobject or nullOptional
dcsstringOptional
pidstringOptional
source_addressstringOptional
endpoint_idstringOptional
sim_idstringOptional
iccidstringOptional
msisdnstringOptional
imsistringOptional
mscstring or nullOptional
udhstringOptional
payloadstringOptional
idintegerOptional
dlr_status_idstringOptional
organisation_idstringOptional
registered_deliverystringOptional
p2p_extintegerOptional
esme_interface_typeobjectOptional
statusobjectOptional
sms_typeobjectOptional
source_address_typeobjectOptional

Errors

403
Forbidden Error