SMS Send Statistics Report — POST /v5/sms/stats/get

Overview

The SMS Statistics API returns daily delivery metrics for your SMS sends within a specified date range. Use these statistics to monitor delivery performance, track credit consumption, and identify delivery issues over time. Base URL: https://api.effilink.co
Endpoint: POST /v5/sms/stats/get Authentication via ApiKey or OAuth header is required.

Request Parameters

string

required

The start of the reporting period, in YYYY-MM-DD format (e.g., 2025-05-01). Inclusive.

string

required

The end of the reporting period, in YYYY-MM-DD format (e.g., 2025-05-31). Inclusive.

Response

integer

HTTP-style status code. 200 on success.

string

A human-readable status message. Empty string on success.

array[object]

An array of daily statistics objects, one entry per day within the requested date range (for days with activity).

Show smsStatsList[] properties

string

The date for this statistics record, in YYYY-MM-DD format.

integer

Total number of SMS messages dispatched on this date.

integer

Number of messages successfully delivered to recipients.

integer

Number of messages that failed to send (e.g., rejected by the platform before dispatch).

integer

Number of messages that were dispatched successfully but for which the carrier reported a delivery failure. These are counted separately from failCount because the message left the EffiLink platform but was not received by the end user.

integer

Number of credits consumed on this date. Credits are typically charged per successfully dispatched message.

Example Request

curl --request POST \
  --url https://api.effilink.co/v5/sms/stats/get \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "startDate": "2025-05-01",
    "endDate": "2025-05-31"
  }'

Example Response

{
  "code": 200,
  "message": "",
  "smsStatsList": [
    {
      "statDate": "2025-05-01",
      "sentCount": 850,
      "successCount": 838,
      "failCount": 12,
      "reportFailedCount": 3,
      "chargedPoint": 838
    }
  ]
}

Metric Reference

Field	Description
`sentCount`	All outbound messages attempted on this date
`successCount`	Messages delivered and confirmed by the platform
`failCount`	Messages rejected or failed before leaving EffiLink
`reportFailedCount`	Messages sent but reported as undelivered by the carrier
`chargedPoint`	Credits deducted — typically equal to `successCount`

A high reportFailedCount relative to successCount may indicate issues with recipient numbers (e.g., invalid or ported numbers) or carrier routing problems. Review affected numbers and contact EffiLink support if the rate is consistently elevated.

Understanding Delivery Failures

There are two distinct failure types reported by this API:

failCount — The message was rejected at the EffiLink platform level and was never dispatched. These are not charged.
reportFailedCount — The message was dispatched and left the EffiLink platform, but the carrier’s delivery receipt indicated failure. These may still consume credits, and the chargedPoint field reflects actual charges.

Transactional Email

Campaign Email

SMS

Contacts & Lists

Webhooks

Authentication

SMS Send Statistics Report — POST /v5/sms/stats/get

Overview

Request Parameters

Response

Example Request

Example Response

Metric Reference

Understanding Delivery Failures

​Overview

​Request Parameters

​Response

​Example Request

​Example Response

​Metric Reference

​Understanding Delivery Failures

Overview

Request Parameters

Response

Example Request

Example Response

Metric Reference

Understanding Delivery Failures