Install our app 🪄 click on the icon in the top right of the address bar.

Devices

Retrieve all

GET https://sms.sociostacks.com/api/devices/
curl --request GET \
--url 'https://sms.sociostacks.com/api/devices/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "name": "Example",
            "notifications": [
                1,
                2,
                3
            ],
            "settings": null,
            "sims": [
                {
                    "subscription_id": 1,
                    "phone_number": "+1234567890",
                    "carrier_name": "T-Mobile",
                    "display_name": "SIM 1",
                    "slot_index": 0
                }
            ],
            "device_fcm_token": "",
            "device_model": "sdk_gphone64_arm64",
            "device_brand": "google",
            "device_os": "16",
            "device_battery": 59,
            "device_is_charging": true,
            "ip": "123.123.123.123",
            "total_sent_sms": 50,
            "total_pending_sms": 10,
            "total_received_sms": 25,
            "total_failed_sms": 1,
            "last_sent_datetime": "2025-10-29 03:26:01",
            "last_ping_datetime": "2025-10-29 03:26:01",
            "last_received_datetime": null,
            "datetime": "2025-10-29 03:26:01",
            "last_datetime": null
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms.sociostacks.com/api/devices?page=1",
        "last": "https://sms.sociostacks.com/api/devices?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms.sociostacks.com/api/devices?page=1"
    }
}

Retrieve one

GET https://sms.sociostacks.com/api/devices/{device_id}
curl --request GET \
--url 'https://sms.sociostacks.com/api/devices/{device_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example",
        "notifications": [
            1,
            2,
            3
        ],
        "settings": null,
        "sims": [
            {
                "subscription_id": 1,
                "phone_number": "+1234567890",
                "carrier_name": "T-Mobile",
                "display_name": "SIM 1",
                "slot_index": 0
            }
        ],
        "device_fcm_token": "",
        "device_model": "sdk_gphone64_arm64",
        "device_brand": "google",
        "device_os": "16",
        "device_battery": 59,
        "device_is_charging": true,
        "ip": "123.123.123.123",
        "total_sent_sms": 50,
        "total_pending_sms": 10,
        "total_received_sms": 25,
        "total_failed_sms": 1,
        "last_sent_datetime": "2025-10-29 03:26:01",
        "last_ping_datetime": "2025-10-29 03:26:01",
        "last_received_datetime": null,
        "datetime": "2025-10-29 03:26:01",
        "last_datetime": null
    },
}

Create

POST https://sms.sociostacks.com/api/devices
Parameters Details Description
name Required String -
notifications Optional Array Notification handler ids
sms_in_between_delay Optional Integer Allowed values: 1 - 300
curl --request POST \
--url 'https://sms.sociostacks.com/api/devices' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
{
    "data": {
        "id": 1
    }
}

Update

POST https://sms.sociostacks.com/api/devices/{device_id}
Parameters Details Description
name Optional String -
notifications Optional Array Notification handler ids
sms_in_between_delay Optional Integer Allowed values: 1 - 300
curl --request POST \
--url 'https://sms.sociostacks.com/api/devices/{device_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{
    "data": {
        "id": 1
    }
}

Delete

DELETE https://sms.sociostacks.com/api/devices/{device_id}
curl --request DELETE \
--url 'https://sms.sociostacks.com/api/devices/{device_id}' \
--header 'Authorization: Bearer {api_key}' \