SMS details

GET

https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/sms/:sms_id

GET

/api/v1/endpoint/:endpoint_id/sms/:sms_id

$ curl https://cdn.emnify.net/api/v1/endpoint/1/sms/1.1 \
>      -H "Authorization: Bearer <token>"

1 {
2   "submit_date": "2019-10-05T13:56:59.000Z",
3   "delivery_date": "2019-10-05T13:56:59.000Z",
4   "expiry_date": "2019-10-06T13:56:59.000Z",
5   "final_date": "2019-10-05T13:57:03.000Z",
6   "retry_date": null,
7   "last_delivery_attempt": "2019-10-05T13:57:00.000Z",
8   "retry_count": 0,
9   "dcs": 0,
10   "pid": 0,
11   "source_address": "1234567890",
12   "endpoint": {
13     "id": 166,
14     "name": "Your Endpoint"
15   },
16   "sim_id": "625",
17   "iccid": "8988303000000001000",
18   "msisdn": "883XXXXXXXXXXXX",
19   "imsi": "901XXXXXXXXXXXX",
20   "msc": "491600190000",
21   "udh": "",
22   "payload": "test",
23   "id": 590,
24   "status": {
25     "description": "DELIVERED",
26     "id": 4
27   },
28   "sms_type": {
29     "description": "MT",
30     "id": 1
31   },
32   "source_address_type": {
33     "description": "National",
34     "id": 161
35   }
36 }

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

<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

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

This endpoint returns an object.

submit_datestringOptional

delivery_datestringOptional

expiry_datestringOptional

final_datestringOptional

retry_datestring or nullOptional

last_delivery_attemptstringOptional

retry_countintegerOptional

gsm_map_errorstringOptional

dcsintegerOptional

pidintegerOptional

source_addressstringOptional

endpointobjectOptional

sim_idstringOptional

iccidstringOptional

msisdnstringOptional

imsistringOptional

mscstringOptional

udhstringOptional

payloadstringOptional

idintegerOptional

statusobjectOptional

sms_typeobjectOptional

source_address_typeobjectOptional

Errors

403

Forbidden Error