> For the complete documentation index, see [llms.txt](https://developer.ecall-messaging.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.ecall-messaging.com/api-references/https-interface/getting-started.md).

# Getting started

### Core features

* Send SMS, fax, and voice messages.
* Query message status with `JobID` or a time range.
* Receive callbacks and forward inbound SMS.

### Prerequisites

* You need an eCall business account.
* A standard account is enough for a 30-day test.
* The HTTP interface must be enabled on your account.
* Your software must be able to call a URL.

### Request format

Messages can be submitted with **GET** or **POST**.

The interface uses these rules:

* Parameters use `key=value` pairs.
* Parameters are separated by `&`.
* IDs are case-insensitive.
* Send all characters as UTF-8.
* URL-encode reserved characters when needed.

For `POST`, keep `&` separators when the content type is `application/x-www-form-urlencoded`.

**Example:**

```
https://url.ecall.ch/api/sms?username=johnsmith&password=s3cr3t&address=0041791234567&message=This%20is%20a%20test
```

{% hint style="info" %}
Account settings are cached for performance. Changes can take some time to apply.
{% endhint %}

### Endpoint

Use this base URL for send jobs:

```
https://url.ecall.ch/
```

### Testing the interface

You can test the interface directly in a browser.

{% stepper %}
{% step %}

### Open your browser

{% endstep %}

{% step %}

### Enter a test URL

Replace `username`, `password`, and `address` with your values.

```
https://url.ecall.ch/api/sms?username=johnsmith&password=s3cr3t&address=0041791234567&message=This%20is%20a%20test
```

```
https://url.ecall.ch/Api/Sms?Address=%2B41791112233&Message=Test&Username=foo&Password=bar
```

{% endstep %}

{% step %}

### Check the response

The service returns HTTP status codes and eCall result codes.
{% endstep %}
{% endstepper %}

### Reference document

* Specification version: `2.22`
* Source document date: `2025-03-17`
* Owner: `F24 Schweiz AG, Wollerau, Switzerland`
* Classification: `public`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.ecall-messaging.com/api-references/https-interface/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.