Message List

Send multiple messages in a single request and query their statuses collectively using the returned messageListId. Status can be queried up to seven days after sending.

Send multiple messages

post

Sends multiple messages in a single request. Each message object in the messages array follows the same structure as a single POST /api/v2/message request body (without the top-level notification field, which is specified once at the list level).

The response includes individual results per message — messages that fail validation are reported with an error object, while valid messages receive a messageId. The overall messageListId can be used to query the combined status later.

Authorizations

BasicAuth

AuthorizationstringRequired

HTTP Basic Authentication. Encode username:password in Base64 and pass as: Authorization: Basic <base64_encoded_credentials>

Use your eCall account credentials or a dedicated API sub-user created in the eCall portal (Interfaces → Overview).

Body

application/json

Request body for sending multiple messages in a single call.

Responses

200

Request processed. Individual messages may still have been rejected — check each entry in results for an error object.

application/json

400

The request is invalid. This may be caused by a missing required parameter, an invalid value, or a constraint violation. Check the errorCode and errorDetails in the response body for specifics.

application/json

401

The Authorization header is missing or the credentials are invalid. Verify your username, password, and Base64 encoding.

application/json

500

An unexpected error occurred on the eCall server. Retry after a short delay. If the problem persists, contact eCall support and include the x-f24-request-id header value from the response.

application/json

post/api/v2/messagelist

HTTPcURLJavaScriptPython

POST /api/v2/messagelist HTTP/1.1
Host: rest.ecall.ch
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 418

{
  "messages": [
    {
      "channel": "Sms",
      "from": "0041769999999",
      "to": "0041798888888",
      "content": {
        "type": "Text",
        "text": "Hello from eCall, your messaging partner!"
      }
    },
    {
      "channel": "Rcs",
      "from": "MyRcsSenderId",
      "to": "0041790000001",
      "content": {
        "type": "Text",
        "text": "This is a second message in the same request."
      }
    }
  ],
  "notification": {
    "forEvent": "FinalOnly",
    "addresses": [
      {
        "type": "UrlPost",
        "address": "https://example.com/webhook_endpoint"
      }
    ]
  }
}

{
  "results": [
    {
      "messageId": "15ad3ed5-dc5b-4e11-8adf-e87900bd228d",
      "address": "0041798888888"
    },
    {
      "address": "004188123456",
      "error": {
        "errorCode": "InvalidContent",
        "errorMessage": "Invalid content.",
        "errorDetails": {
          "errors": [
            {
              "parameter": "To",
              "messages": [
                "'004188123456' is an invalid receiver."
              ]
            }
          ],
          "type": "Parameter"
        }
      }
    }
  ],
  "messageListId": "c28baf6b-e08b-449f-8f96-6262a9c88b9d",
  "timestamp": "2024-04-05T00:51:29.098Z"
}

Get status of a message list

get

Retrieves the delivery status of all messages that were accepted in a POST /api/v2/messagelist request.

Status can be queried up to seven days after sending.

Authorizations

BasicAuth

AuthorizationstringRequired

HTTP Basic Authentication. Encode username:password in Base64 and pass as: Authorization: Basic <base64_encoded_credentials>

Use your eCall account credentials or a dedicated API sub-user created in the eCall portal (Interfaces → Overview).

Path parameters

messageListIdstring · uuidRequired

Unique identifier of the message list, as returned in the send response.

Example: 58f7ec29-fa61-412b-938e-6c05d5c88ecb

Responses

200

Status retrieved successfully.

application/json

400

The request is invalid. This may be caused by a missing required parameter, an invalid value, or a constraint violation. Check the errorCode and errorDetails in the response body for specifics.

application/json

401

The Authorization header is missing or the credentials are invalid. Verify your username, password, and Base64 encoding.

application/json

404

The requested resource (message ID, media ID, etc.) was not found.

application/json

500

An unexpected error occurred on the eCall server. Retry after a short delay. If the problem persists, contact eCall support and include the x-f24-request-id header value from the response.

application/json

get/api/v2/messagelist/{messageListId}

HTTPcURLJavaScriptPython

GET /api/v2/messagelist/{messageListId} HTTP/1.1
Host: rest.ecall.ch
Authorization: Basic username:password
Accept: */*

{
  "states": [
    {
      "channel": "Sms",
      "messageId": "1ca5df7f-27e0-4621-b9ea-d559a0d2750c",
      "status": "Delivered",
      "reasonCode": 0,
      "reason": "Ok",
      "timestamp": "2024-03-26T01:45:41.287Z",
      "from": "0041769999999",
      "to": "0041798888888",
      "pageTotal": 1
    },
    {
      "channel": "Rcs",
      "messageId": "bca05c16-2b06-4b48-aff3-cbcaa342b988",
      "status": "Delivered",
      "reasonCode": 0,
      "reason": "Ok",
      "timestamp": "2024-03-26T01:45:42.293Z",
      "from": "MyRcsSenderId",
      "to": "0041790000001"
    }
  ],
  "messageListId": "58f7ec29-fa61-412b-938e-6c05d5c88ecb",
  "timestamp": "2024-03-26T01:45:55.179Z"
}