Activity soon

Get information about your SMS activity, including your sent SMS messages, and whether they were received by the recipient.

Get a list of activities

With this endpoint, you can retrieve every single data point of the activity that happened for a specific phone number.

Get a list of activities with the following GET request:

GET https://api.mailersend.com/v1/sms-activity
1

Request parameters

Query parameterTypeRequiredLimitationsDetails
sms_number_idstringno
date_fromintnoTimestamp is assumed to be UTC. Must be lower than date_toFormat: 1443651141
date_tointnoTimestamp is assumed to be UTC. Must be higher than date_fromFormat: 1443651141
status[]string[]noPossible types: processed,queued,sent,delivered, failed
pageintno
limitintnoMin: 10, Max: 100Default: 25

Responses

Valid

Response Code: 200 OK
Response Headers:
	Content-Type: application/json
1
2
3
{
	"data": [
		{
			"from": "+18332647501",
			"to": "+16203221059",
			"created_at": "2022-02-21T08:15:46.627000Z",
			"content": "Lorem Ipsum is simply dummy text",
			"status": "delivered",
            "sms_message_id": "62134a2d7de3253bf10d6642"
		},
        {
          "from": "+18332647501",
          "to": "+16203221059",
          "created_at": "2022-02-21T08:15:42.508000Z",
          "content": "Lorem Ipsum is simply dummy text",
          "status": "processed",
          "sms_message_id": "62134a2d7de3253bf10d6642"
        },
        {
          "from": "+18332647501",
          "to": "+16203221059",
          "created_at": "2022-02-21T08:15:42.579000Z",
          "content": "Lorem Ipsum is simply dummy text",
          "status": "queued",
          "sms_message_id": "62134a2d7de3253bf10d6642"
        },
        {
          "from": "+18332647501",
          "to": "+16203221059",
          "created_at": "2022-02-21T08:15:43.624000Z",
          "content": "Lorem Ipsum is simply dummy text",
          "status": "sent",
          "sms_message_id": "62134a2d7de3253bf10d6642"
        }
	],
	"links": {
		"first": "https:\/\/api.mailersend.com\/v1\/sms-activity?page=1",
		"last": null,
		"prev": null,
		"next": "https:\/\/api.mailersend.com\/v1\/sms-activity?page=2"
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"path": "https:\/\/api.mailersend.com\/v1\/sms-activity",
		"per_page": 25,
		"to": 1
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

Error

Response Code: 422 Unprocessable Entity
1

See - Validations errors

Get activity of a single message

With this endpoint, you can get every single activity data point that happened to a specific SMS message.

Get a list of activities for the SMS message specified with this GET request:

GET https://api.mailersend.com/v1/sms-messages/{sms_message_id}
1

Request parameters

URL parameterTypeRequiredLimitationsDetails
sms_message_idstringyes

Responses

Valid

Response Code: 200 OK
Response Headers:
	Content-Type: application/json
1
2
3
{
  "data": {
    "id": "62134a2d7de3253bf10d6642",
    "from": "+18332647501",
    "to": [
      "+16203221059",
      "+18044064234"
    ],
    "text": "Lorem Ipsum is simply dummy text",
    "paused": false,
    "created_at": "2022-02-21T08:15:41.339000Z",
    "sms": [
      {
        "id": "62134a2e4709ec689f72ea62",
        "from": "+18332647501",
        "to": "+16203221059",
        "text": "Lorem Ipsum is simply dummy text",
        "status": "delivered",
        "segment_count": 1,
        "error_type": null,
        "error_description": null
      }
    ],
    "sms_activity": [
      {
        "from": "+18332647501",
        "to": "+16203221059",
        "created_at": "2022-02-21T08:15:46.627000Z",
        "status": "delivered",
        "sms_message_id": "62134a2d7de3253bf10d6642"
      },
      {
        "from": "+18332647501",
        "to": "+16203221059",
        "created_at": "2022-02-21T08:15:42.508000Z",
        "status": "processed",
        "sms_message_id": "62134a2d7de3253bf10d6642"
      },
      {
        "from": "+18332647501",
        "to": "+16203221059",
        "created_at": "2022-02-21T08:15:42.579000Z",
        "status": "queued",
        "sms_message_id": "62134a2d7de3253bf10d6642"
      },
      {
        "from": "+18332647501",
        "to": "+16203221059",
        "created_at": "2022-02-21T08:15:43.624000Z",
        "status": "sent",
        "sms_message_id": "62134a2d7de3253bf10d6642"
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

Error

Response Code: 422 Unprocessable Entity
1

See - Validations errors

Last Updated: