• en
    • fr
Contact : +33(0)4.13.41.50.70
  • en
    • fr

Parameters

Here is the list of parameters available for use with our SMS API.
WARNING : Parameters that are not mandatory, have a default value.

Code

Type

Definition

user_login

Mandatory

User login (email address).

api_key

Mandatory

API key available on your manager.

sms_recipients

Mandatory

List of numbers in international format + XXZZZZZ separated by commas.

sms_text

Mandatory

Message text (maximum 459 characters).

sms_type

Mandatory

SMS Type: XXX = Low Cost SMS; FR = Premium SMS; WWW = Global SMS. In France, if “STOP XXXXX” is missing from your text, the API will return an error.

sms_sender

Mandatory

Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z).

sms_mode

Optionnal

Sending profile : default : 1 1 = Instant sending, 2 = Delayed sending (you must specify the date)

sending_date

Conditionnal

[If mode = 2, deprecated] Timestamp, shown in GMT + 1

sending_time

Optionnal

Timestamp, shown in GMT + 1

sending_period

Optionnal

Period desired (in seconds) before the sending. This field allows you to define the time before the desired date and to prevent timezone confusing

recipients_first_names

Optionnal

Replacing {nom} string of your message, separated by commas.

recipients_last_names

Optionnal

Replacing the string {prenom} of your message, separated by commas.

sms_fields_1

Optionnal

Replacing the string {ch1} of your message, separated by commas.

sms_fields_2

Optionnal

Replacing the string {ch2} of your message, separated by commas.

sms_fields_3

Optionnal

Replacing the string {ch3} of your message, separated by commas.

request_mode

Optionnal

Allows you to choose simulation mode with the value ‘simu’. * Default: real

request_id

Optionnal

Specifies secure sending. If the field is not null, then the system will check if there are already messages with the same request_id. If there are, the request is ignored.

with_replies

Optionnal

Set to 1 to indicate that you want answers to messages that were sent

transactional

Optionnal

Set to 1 to confirm these messages, or alert us(24/7) to a FORMAL BAN on SMS marketing with this option (any abuse of this feature may lead to immediate account suspension and a fine of €1,000 per violation)

msisdn_sender

Optionnal

Default: 0. Some operators allow international phone numbers as sender. In this case, the field must be 1.

request_keys

Optionnal

Lists the key fields of the application you want to add in the sha1 hash. Example: ‘TRYS ‘ (for fields sms_text, sms_recipients, sms_type, sms_sender). See the table of keys attached.

request_sha1

Optionnal

This value contains the sha1 hash code of the field values for the selected request_keys parameter, hashed in the same order as the key.

SHA1 Request Codes

Keys

Corresponding fields

T

sms_text

R

sms_recipients

M

sms_mode

Y

sms_type

S

sms_sender

D

sending_date

a

recipients_first_names

b

recipients_last_names

c

sms_fields_1

d

sms_fields_2

e

sms_fields_3

W

with_replies

N

transactional

Q

request_id