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/endpoint_id/sms \
>      -H "Authorization: Bearer <token>"

200SMS List

1 [
2   {
3     "submit_date": "2019-10-05T13:56:59.000Z",
4     "delivery_date": "2019-10-05T13:56:59.000Z",
5     "expiry_date": "2019-10-06T13:56:59.000Z",
6     "final_date": "2019-10-05T13:57:03.000Z",
7     "retry_date": null,
8     "last_delivery_attempt": "2019-10-05T13:57:00.000Z",
9     "retry_count": 0,
10     "gsm_map_error": null,
11     "dcs": 0,
12     "pid": 0,
13     "source_address": "1234567890",
14     "endpoint": {
15       "id": 166,
16       "name": "Your Endpoint"
17     },
18     "sim_id": "625",
19     "iccid": "8988303000000001000",
20     "msisdn": "883XXXXXXXXXXXX",
21     "imsi": "901XXXXXXXXXXXX",
22     "msc": "491600190000",
23     "udh": "",
24     "payload": "test",
25     "id": 590,
26     "status": {
27       "description": "DELIVERED",
28       "id": 4
29     },
30     "sms_type": {
31       "description": "MT",
32       "id": 1
33     },
34     "source_address_type": {
35       "description": "National",
36       "id": 161
37     }
38   },
39   {
40     "submit_date": "2019-09-29T07:33:15.000Z",
41     "delivery_date": "2019-09-29T07:33:15.000Z",
42     "expiry_date": "2019-09-30T07:33:15.000Z",
43     "final_date": "2019-09-29T07:33:18.000Z",
44     "retry_date": null,
45     "last_delivery_attempt": "2019-09-29T07:33:15.000Z",
46     "retry_count": 0,
47     "gsm_map_error": null,
48     "dcs": 0,
49     "pid": 0,
50     "source_address": "1234",
51     "endpoint": {
52       "id": 166,
53       "name": "Your Endpoint"
54     },
55     "sim_id": "625",
56     "iccid": "8988303000000001000",
57     "msisdn": "883XXXXXXXXXXXX",
58     "imsi": "901XXXXXXXXXXXX",
59     "msc": "491770940000",
60     "udh": "",
61     "payload": "test",
62     "id": 589,
63     "status": {
64       "description": "DELIVERED",
65       "id": 4
66     },
67     "sms_type": {
68       "description": "MT",
69       "id": 1
70     },
71     "source_address_type": {
72       "description": "National",
73       "id": 161
74     }
75   },
76   {
77     "submit_date": "2019-09-21T06:22:03.000Z",
78     "delivery_date": "2019-09-21T06:22:03.000Z",
79     "expiry_date": "2019-09-22T06:22:03.000Z",
80     "final_date": "2019-09-21T06:22:07.000Z",
81     "retry_date": null,
82     "last_delivery_attempt": "2019-09-21T06:22:04.000Z",
83     "retry_count": 0,
84     "gsm_map_error": null,
85     "dcs": 0,
86     "pid": 0,
87     "source_address": "1234",
88     "endpoint": {
89       "id": 166,
90       "name": "Your Endpoint"
91     },
92     "sim_id": "625",
93     "iccid": "8988303000000001000",
94     "msisdn": "883XXXXXXXXXXXX",
95     "imsi": "901XXXXXXXXXXXX",
96     "msc": "491770940000",
97     "udh": "",
98     "payload": "test",
99     "id": 577,
100     "status": {
101       "description": "DELIVERED",
102       "id": 4
103     },
104     "sms_type": {
105       "description": "MT",
106       "id": 1
107     },
108     "source_address_type": {
109       "description": "National",
110       "id": 161
111     }
112   }
113 ]

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

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_idstringRequired

Response

This endpoint returns a list of objects.

submit_datestring

delivery_datestring

expiry_datestring

final_datestring

retry_datestring or null

last_delivery_attemptstring

retry_countinteger

gsm_map_errorstring or null

dcsinteger

pidinteger

source_addressstring

endpointobject

sim_idstring

iccidstring

msisdnstring

imsistring

mscstring

udhstring

payloadstring

idinteger

statusobject

sms_typeobject

source_address_typeobject

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

1	[
2	{
3	"submit_date": "2019-10-05T13:56:59.000Z",
4	"delivery_date": "2019-10-05T13:56:59.000Z",
5	"expiry_date": "2019-10-06T13:56:59.000Z",
6	"final_date": "2019-10-05T13:57:03.000Z",
7	"retry_date": null,
8	"last_delivery_attempt": "2019-10-05T13:57:00.000Z",
9	"retry_count": 0,
10	"gsm_map_error": null,
11	"dcs": 0,
12	"pid": 0,
13	"source_address": "1234567890",
14	"endpoint": {
15	"id": 166,
16	"name": "Your Endpoint"
17	},
18	"sim_id": "625",
19	"iccid": "8988303000000001000",
20	"msisdn": "883XXXXXXXXXXXX",
21	"imsi": "901XXXXXXXXXXXX",
22	"msc": "491600190000",
23	"udh": "",
24	"payload": "test",
25	"id": 590,
26	"status": {
27	"description": "DELIVERED",
28	"id": 4
29	},
30	"sms_type": {
31	"description": "MT",
32	"id": 1
33	},
34	"source_address_type": {
35	"description": "National",
36	"id": 161
37	}
38	},
39	{
40	"submit_date": "2019-09-29T07:33:15.000Z",
41	"delivery_date": "2019-09-29T07:33:15.000Z",
42	"expiry_date": "2019-09-30T07:33:15.000Z",
43	"final_date": "2019-09-29T07:33:18.000Z",
44	"retry_date": null,
45	"last_delivery_attempt": "2019-09-29T07:33:15.000Z",
46	"retry_count": 0,
47	"gsm_map_error": null,
48	"dcs": 0,
49	"pid": 0,
50	"source_address": "1234",
51	"endpoint": {
52	"id": 166,
53	"name": "Your Endpoint"
54	},
55	"sim_id": "625",
56	"iccid": "8988303000000001000",
57	"msisdn": "883XXXXXXXXXXXX",
58	"imsi": "901XXXXXXXXXXXX",
59	"msc": "491770940000",
60	"udh": "",
61	"payload": "test",
62	"id": 589,
63	"status": {
64	"description": "DELIVERED",
65	"id": 4
66	},
67	"sms_type": {
68	"description": "MT",
69	"id": 1
70	},
71	"source_address_type": {
72	"description": "National",
73	"id": 161
74	}
75	},
76	{
77	"submit_date": "2019-09-21T06:22:03.000Z",
78	"delivery_date": "2019-09-21T06:22:03.000Z",
79	"expiry_date": "2019-09-22T06:22:03.000Z",
80	"final_date": "2019-09-21T06:22:07.000Z",
81	"retry_date": null,
82	"last_delivery_attempt": "2019-09-21T06:22:04.000Z",
83	"retry_count": 0,
84	"gsm_map_error": null,
85	"dcs": 0,
86	"pid": 0,
87	"source_address": "1234",
88	"endpoint": {
89	"id": 166,
90	"name": "Your Endpoint"
91	},
92	"sim_id": "625",
93	"iccid": "8988303000000001000",
94	"msisdn": "883XXXXXXXXXXXX",
95	"imsi": "901XXXXXXXXXXXX",
96	"msc": "491770940000",
97	"udh": "",
98	"payload": "test",
99	"id": 577,
100	"status": {
101	"description": "DELIVERED",
102	"id": 4
103	},
104	"sms_type": {
105	"description": "MT",
106	"id": 1
107	},
108	"source_address_type": {
109	"description": "National",
110	"id": 161
111	}
112	}
113	]