Webhooks

Endpoints you implement on your server to receive event notifications from eCall.

Receive a delivery status notification

Implement this endpoint on your server.

eCall calls this URL when the delivery status of a sent message changes, provided you specified a notification.addresses entry of type UrlPost in the send request.

Notification result codes

Code	Text	Description
0	Message has been delivered	Confirmed by recipient device.
1	Message has been buffered	Not yet confirmed.
2	Message has not been delivered	Could not be confirmed.
3	Error Code / Error Message	Error on transfer to central point.
4	Transmission OK	Job forwarded to central point.

Source IP addresses

Notifications originate from one of:

• 193.93.208.200
• 193.93.208.149
• 193.93.208.153

Respond with HTTP 200 OK to acknowledge receipt.

Payload

application/json

Delivery status of a single message.

channelstring · nullableOptional

Channel over which the message was sent (Sms, Whatsapp, Rcs, Voice, Pager).

Example: Sms

messageIdstring · nullableOptional

Unique identifier of the message.

Example: 97031dc9-3814-4178-a31c-1599aa83ba67

statusstring · enumOptional

Delivery status of a message. Whether a status is final (no further updates expected) depends on the channel:

SMS

Status	Final	Description
Pending	☐	Being transmitted to provider.
Sent	☐/☒	Sent by provider. May become final after 4 days without a delivery report.
Delivered	☒	Confirmed received by recipient device.
DeliveryFailed	☒	Could not be delivered.
Failed	☒	Sending failed. See reason for details.

Pager

Status	Final	Description
Pending	☐	Being transmitted.
Sent	☒	Sent successfully.
Failed	☒	Sending failed.

Voice (auto-converted SMS to landline)

Status	Final	Description
Pending	☐	Being transmitted.
Sent	☐	Handed off to voice system.
Played	☐/☒	Played on device. Final only if recipient hung up without acknowledging.
Played_with_receipt	☒	Played and recipient confirmed.
Next_try_pending	☐	No connection yet; retrying in 15 min.
Failed	☒	Sending failed.

WhatsApp

Status	Final	Description
Pending	☐	Being transmitted to provider.
Sent	☐	Sent by provider.
Delivered	☐	Received by device.
Read	☒	Read by recipient.
Failed	☒	Sending failed.

RCS

Status	Final	Description
Pending	☐	Being transmitted.
Sent	☐	Sent by provider.
Delivered	☐	Received by device.
Displayed	☒	Displayed on device.
Rejected	☒	Rejected by provider.
Expired	☒	Validity period exceeded.

Possible values:

reasonCodeinteger · int32Optional

Provider-level result code. 0 indicates success. See the table below for error codes.

Code	Description
3020	Timeout connecting to provider (pager)
5111	Text too long (pager)
5112	Invalid receiver number (pager)
5120	Not a pager number
5121	Invalid characters in receiver number (pager)
5155	Too much traffic (pager)
5502	Syntax error
5504	Maximum messages for this address exceeded
5506	Analog-to-digital converter invalid
5509	Invalid receiver number
5510	Too many messages for same receiver
5511	Too many messages with same content for same receiver
5513	Blacklisted (callback, address, or content)
5514	Blocked by outbound filter rule

Example: 0

reasonstring · nullableOptional

Human-readable provider result text.

Example: ESME_ROK

timestampstring · date-timeOptional

UTC timestamp of the latest status update.

Example: 2022-10-17T18:36:16.243Z

fromstring · nullableOptional

Sender address.

Example: 0041769999999

tostring · nullableOptional

Recipient address in international format.

Example: 0041798888888

pageTotalinteger · nullableOptional

SMS only: Total number of pages the message was split into.

Example: 2

Responses

200

Notification acknowledged.

No content

Payload

{
  "channel": "Sms",
  "messageId": "97031dc9-3814-4178-a31c-1599aa83ba67",
  "status": "Delivered",
  "reasonCode": 0,
  "reason": "Message has been delivered",
  "timestamp": "2023-01-11T07:21:50Z",
  "number": "0041789999999",
  "pageTotal": 2
}

Receive an incoming message

Implement this endpoint on your server.

eCall calls this URL when an incoming SMS or WhatsApp message is received, provided you have configured the forwarding URL in the eCall portal (SMS number settings → Forward incoming SMS to HTTP, or WhatsApp settings).

Respond with HTTP 200 OK to acknowledge receipt.

Payload

application/json

Payload sent by eCall to your webhook URL when an incoming SMS or WhatsApp message is received.

messageIdstring · nullableOptional

Unique identifier of the incoming message.

Example: 6815c501-2fe1-ee11-812a-00155dfb061c

channelstring · nullableOptional

Channel of the incoming message (Sms or Whatsapp).

Example: Sms

tostring · nullableOptional

The eCall number that received the SMS.

Example: 0041766666666

fromstring · nullableOptional

Sender's number.

Example: 0041777777777

contentone of · nullableOptional

Message content (always TextContent for incoming SMS).

or

or

or

or

or

or

or

or

or

or

or

timestampstring · date-timeOptional

Time of receipt in the eCall system (UTC, ISO 8601).

Example: 2024-03-13T11:44:40Z

Responses

200

Incoming message acknowledged.

No content

Payload

{
  "messageId": "6815c501-2fe1-ee11-812a-00155dfb061c",
  "channel": "Sms",
  "to": "0041766666666",
  "from": "0041777777777",
  "content": {
    "type": "Text",
    "text": "Hello eCall!"
  },
  "timestamp": "2024-03-13T11:44:40Z"
}