endpoint

SMS details

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

Endpoint.Sms + Get

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info>

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
get/api/v1/endpoint/{endpoint_id}/sms/{sms_id}

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/endpoint/{endpoint_id}/sms/{sms_id}
  • Auth: HTTP bearer

Path parameters

endpoint_idinteger required

Numeric ID of an endpoint

sms_idnumber double required

The numeric ID of an SMS

Response

Response with status 200

submit_datestring
delivery_datestring
expiry_datestring
final_datestring
retry_datestring nullable
last_delivery_attemptstring
retry_countinteger
gsm_map_errorstring
dcsinteger
pidinteger
source_addressstring
endpointApiV1EndpointEndpointIdSmsSmsIdGetResponsesContentApplicationJsonSchemaEndpoint
sim_idstring
iccidstring
msisdnstring
imsistring
mscstring
udhstring
payloadstring
idinteger
statusApiV1EndpointEndpointIdSmsSmsIdGetResponsesContentApplicationJsonSchemaStatus
sms_typeApiV1EndpointEndpointIdSmsSmsIdGetResponsesContentApplicationJsonSchemaSmsType
source_address_typeApiV1EndpointEndpointIdSmsSmsIdGetResponsesContentApplicationJsonSchemaSourceAddressType

Changes

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