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.000+0000",
    "delivery_date": "2019-10-05T13:56:59.000+0000",
    "expiry_date": "2019-10-06T13:56:59.000+0000",
    "final_date": "2019-10-05T13:57:03.000+0000",
    "retry_date": null,
    "last_delivery_attempt": "2019-10-05T13:57:00.000+0000",
    "retry_count": "0",
    "gsm_map_error": null,
    "dcs": "0",
    "pid": "0",
    "source_address": "1234567890",
    "endpoint_id": "166",
    "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.000+0000",
    "delivery_date": "2019-09-29T07:33:15.000+0000",
    "expiry_date": "2019-09-30T07:33:15.000+0000",
    "final_date": "2019-09-29T07:33:18.000+0000",
    "retry_date": null,
    "last_delivery_attempt": "2019-09-29T07:33:15.000+0000",
    "retry_count": "0",
    "gsm_map_error": null,
    "dcs": "0",
    "pid": "0",
    "source_address": "1234",
    "endpoint_id": "166",
    "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.000+0000",
    "delivery_date": "2019-09-21T06:22:03.000+0000",
    "expiry_date": "2019-09-22T06:22:03.000+0000",
    "final_date": "2019-09-21T06:22:07.000+0000",
    "retry_date": null,
    "last_delivery_attempt": "2019-09-21T06:22:04.000+0000",
    "retry_count": "0",
    "gsm_map_error": null,
    "dcs": "0",
    "pid": "0",
    "source_address": "1234",
    "endpoint_id": "166",
    "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

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

Successfully returned the list of SMS for the endpoint.

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