For the complete documentation index, see llms.txt. This page is also available as Markdown.

Parameter reference

Field-level reference for request parameters and fax token fields.

Required fields

Parameter
Description

AccountName

Name of the eCall account, for example johnsmith

AccountPassword

Password of the eCall account

Address

Full phone number, for example 0041791112233. Separate multiple numbers with ;, or use a person or group name from the eCall address book. Pager with authorization code: 074123456:1234

Message

Message text

Optional fields

Parameter
Description

JobID

Unique identifier for the message, for example 123AB. Required for later status queries.

SendDate

Scheduled send time, for example 2004-12-20 20:31:50

Subject

Title of the message

NoLog

Do not write to the log. Values: "", "true", "false". Default: false

MsgType

Message type. Supported value: Flash

SMSCallback

Callback number for SMS or mobile only. Up to 16 numeric or 11 alphanumeric characters. Business numbers are not allowed. Ignored if Answer is set.

Answer

Reply destination for mobile only. Use a mobile or pager number, an email address, or "" for log entry only. Max. 100 characters. Overrides SMSCallback.

FromText

Sender identification text or number, for example 0791234567

Notification

Recipient addresses for delivery status forwarding. Supported values: mobile number, email address, HTTP(S) URL, or "" for log only. Separate multiple values with ;. Max. 100 characters. Replaced by AlwaysNotification if both are set.

AlwaysNotification

Recipient address for notification on every status change. Supports SMS, pager, or email. Overrides Notification if set.

MessageLanguage

SendVoiceBasic only. Text-to-speech language. Values: DE, FR, IT, EN. Default: auto-detect.

FaxHeaderID

Fax only. Sender number in the fax header, for example +41 44 123 45 67

FaxHeaderInfo

Fax only. Additional text in the fax header, for example F24 Schweiz AG

Attachments

SendFax only. Documents to attach. Maximum: 10 files. Each entry contains FileName and FileContent.

TokenFields

Fax only. Additional control fields. Format: <Name1>;=<Value1>;:<Name2>;=<Value2>

TokenFields

Use TokenFields for fax-specific control values.

Token
Description

CallingNumber

Sender number for fax transmission

MaxRetries

Maximum number of retry attempts

RetriesTimeIntervallInMin

Wait time between retries in minutes

NoCoversheet

Do not use a cover sheet. Default: false

Example:

This retries the fax up to 6 times with a 20-minute interval.

Last updated

Was this helpful?