List sent and received SMS

GET

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

GET

/api/v1/endpoint/:endpoint_id/sms

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

[
  {
    "submit_date": "2019-10-05T13:56:59.000Z",
    "delivery_date": "2019-10-05T13:56:59.000Z",
    "expiry_date": "2019-10-06T13:56:59.000Z",
    "final_date": "2019-10-05T13:57:03.000Z",
    "retry_date": null,
    "last_delivery_attempt": "2019-10-05T13:57:00.000Z",
    "retry_count": 0,
    "gsm_map_error": null,
    "dcs": 0,
    "pid": 0,
    "source_address": "1234567890",
    "endpoint": {
      "id": 166,
      "name": "Your Endpoint"
    },
    "sim_id": "625",
    "iccid": "8988303000000001000",
    "msisdn": "883XXXXXXXXXXXX",
    "imsi": "901XXXXXXXXXXXX",
    "msc": "491600190000",
    "udh": "",
    "payload": "test",
    "id": 590,
    "status": {
      "description": "DELIVERED",
      "id": 4
    },
    "sms_type": {
      "description": "MT",
      "id": 1
    },
    "source_address_type": {
      "description": "National",
      "id": 161
    }
  },
  {
    "submit_date": "2019-09-29T07:33:15.000Z",
    "delivery_date": "2019-09-29T07:33:15.000Z",
    "expiry_date": "2019-09-30T07:33:15.000Z",
    "final_date": "2019-09-29T07:33:18.000Z",
    "retry_date": null,
    "last_delivery_attempt": "2019-09-29T07:33:15.000Z",
    "retry_count": 0,
    "gsm_map_error": null,
    "dcs": 0,
    "pid": 0,
    "source_address": "1234",
    "endpoint": {
      "id": 166,
      "name": "Your Endpoint"
    },
    "sim_id": "625",
    "iccid": "8988303000000001000",
    "msisdn": "883XXXXXXXXXXXX",
    "imsi": "901XXXXXXXXXXXX",
    "msc": "491770940000",
    "udh": "",
    "payload": "test",
    "id": 589,
    "status": {
      "description": "DELIVERED",
      "id": 4
    },
    "sms_type": {
      "description": "MT",
      "id": 1
    },
    "source_address_type": {
      "description": "National",
      "id": 161
    }
  },
  {
    "submit_date": "2019-09-21T06:22:03.000Z",
    "delivery_date": "2019-09-21T06:22:03.000Z",
    "expiry_date": "2019-09-22T06:22:03.000Z",
    "final_date": "2019-09-21T06:22:07.000Z",
    "retry_date": null,
    "last_delivery_attempt": "2019-09-21T06:22:04.000Z",
    "retry_count": 0,
    "gsm_map_error": null,
    "dcs": 0,
    "pid": 0,
    "source_address": "1234",
    "endpoint": {
      "id": 166,
      "name": "Your Endpoint"
    },
    "sim_id": "625",
    "iccid": "8988303000000001000",
    "msisdn": "883XXXXXXXXXXXX",
    "imsi": "901XXXXXXXXXXXX",
    "msc": "491770940000",
    "udh": "",
    "payload": "test",
    "id": 577,
    "status": {
      "description": "DELIVERED",
      "id": 4
    },
    "sms_type": {
      "description": "MT",
      "id": 1
    },
    "source_address_type": {
      "description": "National",
      "id": 161
    }
  }
]

Endpoint.Sms + List

Roles: Administrator User Observer

Returns the list of SMS sent and received by this endpoint.

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` + `List` <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 the list of SMS sent and received by this endpoint. 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

Response

This endpoint returns a list of objects.

submit_datestringOptional

delivery_datestringOptional

expiry_datestringOptional

final_datestringOptional

retry_datestring or nullOptional

last_delivery_attemptstringOptional

retry_countintegerOptional

gsm_map_errorstring or nullOptional

dcsintegerOptional

pidintegerOptional

source_addressstringOptional

endpointobjectOptional

sim_idstringOptional

iccidstringOptional

msisdnstringOptional

imsistringOptional

mscstringOptional

udhstringOptional

payloadstringOptional

idintegerOptional

statusobjectOptional

sms_typeobjectOptional

source_address_typeobjectOptional

Errors

403

Forbidden Error