Get Custom String Message Report

This API allows you to retrieve message reports based on a specific customString. It's useful for tracking messages that were tagged with a custom string during submission (e.g., campaign identifier, integration tag, or client reference).

Parameters for Get Message Report API

Header Parameters

Parameter	Description
Authorization	Bearer token linked to your Cellcast account. Required for authenticating API requests. Check here

Query Parameters

Name	Example	Description
customString	Cellcast	A custom identifier attached during message submission for filtering report results. Supports letters, numbers, and dashes.

Code Sample

curl --location 'https://devapi.cellcast.com/api/v2/report/message?customString=Cellcast' \
--header 'Authorization: Bearer {{API_KEY}}'

:::

Replace with the actual API key that you own.

Responses

200 Success

{
    "app_type": "web",
    "app_version": "1.0",
    "maintainence": 0,
    "new_version": 0,
    "force_update": 0,
    "invalid_token": 0,
    "refresh_token": "",
    "show_message": 0,
    "is_enc": false,
    "status": true,
    "message": "Success",
    "message_type": "toast",
    "data": {
        "items": [
            {
                "_id": "6819c28b9000000000000000",
                "status": "delivered",
                "replyStop": false,
                "message": "Add custom string",
                "sender": "61400000000",
                "receiver": "400000001",
                "gateway_count": 1,
                "smsDetail": {
                    "_id": "6819c28b9000000000000000",
                    "messagelength": 17,
                    "smscount": 1,
                    "costpersms": 0.047,
                    "deductibleCredit": 0.047
                },
                "customString": "Cellcast",
                "request_from": "API",
                "request_name": "API_KEY_NAME",
                "creditAmount": 1,
                "createdAt": "2025-05-06T08:04:27.871Z",
                "replyMessage": null
            }
        ],
        "total": 1,
        "limit": 10,
        "current": 1,
        "totalPages": 1,
        "pagingCounter": 1,
        "hasPrevPage": false,
        "hasNextPage": false,
        "offset": 0,
        "prevPage": null,
        "nextPage": null
    },
    "error": {}
}

401 Unauthorized

{
  "code": 401,
  "message": "Token expired",
  "stack": "APIError: Token expired ...."
}