Messaging Core eDash API Walkthrough

This document describes the programmatic API available through the Messaging Core eDash platform. All endpoints use your existing dashboard credentials and return JSON.

Base URL: https://tools-be.sharpencx.com

Step 1: Authenticate

Every API session begins by exchanging your dashboard credentials for an access token. This token is required for all subsequent requests.

Request

POST https://tools-be.sharpencx.com/authenticate

Body

{
  "email": "your-dashboard-email@example.com",
  "pwd": "your-dashboard-password"
}

Response (200 OK)

{
  "token": "eyJhbGciOiJIUzI1NiIs...{JWT token}",
  "user": {
    "id": 54321,
    "forename": "Jane",
    "surname": "Doe",
    "is_admin": 0,
    "email": "your-dashboard-email@example.com",
    "accountId": 12345,
    "roles": []
  }
}

Save the token value. You will include it as a Bearer token in every request below.

Step 2: Choose Your Use-Case

Once authenticated, you can call any of the following endpoints. Each request must include your token:

Use-Case A: Message Volume by Day (Daily / Weekly / Monthly Reporting)

Returns aggregate message counts grouped by date. Use this to build volume trend reports.

Request

GET https://tools-be.sharpencx.com/edash-admin/traffic/stats?from_date={start}&to_date={end}&period=DAILY

Response (200 OK)

{
  "stats": {
    "2025-03-15": {
      "pending": 70,
      "failed": 2,
      "delivered": 6226,
      "total": 6298,
      "inbound": 72
    },
    "2025-03-16": {
      "pending": 101,
      "failed": 10,
      "delivered": 5918,
      "total": 6029,
      "inbound": 54
    }
  }
}

Each date entry contains:

Notes:

• Date ranges up to 13+ months are supported.

• One entry is returned per day. For weekly or monthly totals, sum the daily values across the desired date range in your reporting tool.

Use-Case B: Delivery Status per Message (Sent, Delivered, Failed, Opt-Outs)

Returns individual message records with delivery status, segment count, and timestamps. Use this for per-message auditing and delivery analysis.

Request

GET https://tools-be.sharpencx.com/edash-admin/traffic/outbox?limit={n}&offset={n}&includeSubAccounts=true&from_date={start}&to_date={end}

Response (200 OK)

{
  "count": "84650",
  "messages": [
    {
      "id": "361405608",
      "message_id": "US-AWS01-1503406461234",
      "account_id": 12345,
      "created_ts": "2026-04-15T16:36:55.250Z",
      "source_type": "service",
      "source_data": "STOP",
      "parts": 1,
      "destination": "17775551234",
      "source": "13175551234",
      "content": "(message text)",
      "status": 1,
      "status_text": "RECEIVED",
      "status_string": "DELIVRD_TO_HANDSET",
      "status_updated_ts": "2026-04-15T16:36:56.851Z",
      "transmit_ts": "2026-04-15T16:36:55.235Z",
      "receipt_ts": "2026-04-15T16:36:56.851Z",
      "carrier": "smppom",
      "send_type": "sms",
      "forward_endpoint": null,
      "deleted": false,
      "deleted_by": null,
      "deleted_ts": null,
      "deleted_host": null
    }
  ]
}

Key fields:

Pagination: To retrieve all messages, increment offset by your limit value until offset >= count. For example, with limit=100:

• Page 1: offset=0 (messages 1-100)

• Page 2: offset=100 (messages 101-200)

• Page 3: offset=200 (messages 201-300)

• Continue until offset >= 84650

Identifying opt-outs: Messages where source_type = "service" and source_data = "STOP" are system-generated opt-out confirmation replies. Filter on these two fields to count opt-out events.

Use-Case C: Segment Count per Message

Segment counts are included in every outbox message record (Use-Case B above). The parts field on each message indicates how many SMS segments the message was split into.

Standard SMS segments are 160 characters (GSM-7 encoding) or 70 characters (Unicode). Longer messages are automatically split:

No separate API call is needed. Use the outbox endpoint from Use-Case B and read the parts field from each message.

Use-Case D: Provisioned Phone Numbers

Lists all phone numbers provisioned to your account, including routing configuration and carrier details.

Request

GET https://tools-be.sharpencx.com/edash-admin/numbers

No query parameters required.

Response (200 OK)

{
  "numbers": [
    {
      "id": 5172,
      "account_id": 1234,
      "account_routing_param": "13175551234",
      "carrier": 103,
      "active": 1,
      "default": 1,
      "status": 1,
      "added": "2023-11-30T21:56:51.241Z",
      "routing_type_id": 1,
      "custom_queue": "MOQueue:smppGW:12345",
      "account_routing": 1,
      "verified": "N/A",
      "forward_url": null,
      "comment": "",
      "originator_id": null,
      "openmarket_acc_id": null,
      "status_updated_at": null,
      "deprovision_date": null,
      "provision_date": null
    }
  ]
}

Authentication Reference

Delivery Status Reference

Not Currently Available (Feature Requests)

The following use-cases cannot be fulfilled by the current API. Feature requests are open with our Product and Engineering teams for each:

1. Campaign or Template Name

Message records do not include campaign names, template IDs, or batch identifiers. Each outbound message is stored as a flat record with no linkage back to the campaign or template that originated it. The source-identifying fields are source_type (smpp/https/service) and source_data (account ID or system tag), which identify the sending method but not the business-level campaign.

Current Feature Request: Add campaign_id, template_id, and/or a freeform metadata field to outbound message records at send time, so messages can be grouped and reported by campaign or template.

2. Total Cost (Daily or Monthly)

There is no cost or billing endpoint exposed on the dashboard API. The platform tracks a per-message rate, but this data is not available to API consumers. Calculating cost requires multiplying by the segment count (parts field), which the platform does not pre-compute.

Current Feature Request: Expose a /edash-admin/billing/summary endpoint (or similar) that returns daily/monthly cost totals, factoring in per-segment pricing.

3. Dedicated Opt-Out Reporting

While opt-out events can be identified by filtering outbox records for source_type = "service" and source_data = "STOP", there is no dedicated opt-out count endpoint or opt-out list. Retrieving opt-out data requires paginating through the entire outbox and filtering client-side.

Current Feature Request: Expose a /edash-admin/traffic/optouts endpoint that returns opt-out events with timestamps, phone numbers, and counts, without requiring full outbox pagination.