REST API
Use the eCall REST API to send messages, retrieve account balance, track status, upload media, and receive webhooks.
Use the eCall REST API to build SMS, Whatsapp and RCS messaging into your app.
Send messages over JSON and HTTPS.
Track delivery status.
Receive webhook events and inbound SMS.
At a glance
Base URL:
https://rest.ecall.chAPI style: REST over JSON and HTTPS
Authentication: HTTP Basic Authentication
Supports: messaging, account balance, status queries, media upload, and webhooks
Core features
Send SMS, Whatsapp and RCS messages.
Send to one recipient or many recipients in one request.
Query delivery status for up to seven days.
Retrieve the current point balance.
Receive webhook events for status changes and inbound SMS and Whatsapp.
Upload media for rich RCS and Whatsapp messages.
When to use this interface
You need an SMS API for a backend, integration, or automation workflow.
You need an RCS API with rich content and uploaded media.
You want webhook-based delivery tracking and inbound SMS handling.
What this REST API supports
The eCall REST API supports messaging, account balance, delivery status queries, media upload, and webhook-based event handling.
Use it for single-message sends, batch sends, and inbound SMS forwarding.
The API is provided by F24 Schweiz AG.
Use this base URL:
The connection uses TLS 1.2 or TLS 1.3.
Plain HTTP is not supported.
Authentication
Send every request with an Authorization header.
Use HTTP Basic Authentication.
Use either of these credential types:
Your eCall account credentials
A dedicated API sub-user from Interfaces → Overview
API versioning
Two API versions are available.
Target a version in the URL path or request header.
If you omit the version, the default is v1.
This default can change in later updates.
v1 (default)
2023-02-02
–
v2
2023-12-12
GET /api/message/{messageId} and POST /api/message return timestamps in UTC using ISO 8601 with Z.
Use the URL path
Use the request header
Accepted header values:
1or1.0for v12or2.0for v2
General rules
JSON field names are case-insensitive.
Enum values are case-sensitive.
Send all text as UTF-8.
Account settings are cached. Changes can apply with a delay.
Every response includes the
x-f24-request-idheader.
Include x-f24-request-id in support requests.
Notification webhooks
Set notification.addresses in a send request to receive status updates.
eCall sends these notifications to your endpoint.
Allow inbound traffic from these source IPs:
193.93.208.200193.93.208.149193.93.208.153
Your endpoint must return HTTP 200 OK.
Incoming SMS forwarding
Incoming SMS on a rented eCall number can be forwarded.
eCall sends the message to your HTTP or HTTPS endpoint with POST.
Configure the target URL in the portal for the SMS number.
The request schema is documented under ReceivedMessage.
The inbound endpoint is POST /api/webhooks/receivedmessage.
Last updated
Was this helpful?
