Introduction

The iLeads API lets you send SMS, receive delivery reports, manage contact lists and send verification codes – directly from your own systems. Every action is a POST request to a single URL; the request’s root element determines the action.

Base URLs

Productionhttps://app.ileads.co.il/api

Testhttps://app.ileads.co.il/api/test

The test URL returns the same response as a real request but doesn’t perform the action – useful for validating requests during development.

Format

Send XML or JSON; the response is returned in the same format. Set the header accordingly: Content-Type: application/xml or Content-Type: application/json.

Response structure

Every response includes a status field – 0 means success and any other value is an error code (see Error codes). The message field explains the result. The response root element varies by action.

Conventions

Phone numbers: formatted as 5xxxxxxxx or 05xxxxxxxx.
Dates: formatted as dd/mm/yy hh:mm.
Attributes in JSON: an XML attribute (e.g. the id of phone) is written in JSON under "$", and the value itself under "_". See the example in Send SMS.

Security

Connections must use TLS 1.2 or higher.

We recommend restricting access to authorized IP addresses: in the web interface, under the “Settings” tab → “My account”, enable “Authorized IP address check” and add at least one address.

Postman

All actions are ready to try in Postman: download the collection. After importing, set the token and username variables.

Quick test

curl -X POST "https://app.ileads.co.il/api/test" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"balance":{"user":{"username":"my_username"}}}'

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <status>0</status>
    <message>SMS will be sent</message>
    <shipment_id>12345678</shipment_id>
</sms>

Authentication

Every request is sent with an API token in the Authorization header, using the Bearer scheme.

Creating your first token

Log in to the web interface, open the “Settings” tab and choose “API Token Management”.
Click “Create New Token”.
The token is shown only once – store it securely. It cannot be retrieved later.

Rules

Up to 5 active tokens per user, all working concurrently. Each token has a unique name.
Each token is valid for 24 months from creation. The expiration date is returned in expiration_date and is not extended.
Additional tokens can also be created via the API using an existing valid token – see Generate an API token.
Deleting a token in the interface deactivates it immediately.

Creating tokens with a username and password is not supported. Tokens are created only in the web interface, or via the API with an existing token.

Generate an API token

POSThttps://app.ileads.co.il/api<getApiToken>

Create a new token, or retrieve the most recent one, using an existing valid token. A parent account can create a token for one of its sub-accounts.

A token created via the API is automatically named after its creation date and time. Each token’s expiration date is fixed and is not extended when additional tokens are created.

Parameters

Name	Type	Description
`getApiToken`required	object	Root element. Contains all other elements.
`user → username`required	string	Admin (parent) account username – the account whose token is sent with the request.
`username`required	string	The username of the account the token is requested for.
`action`required	string	"new" – create a new token. "current" – retrieve the most recent token.

All status codes

Request

XML

<?xml version='1.0' encoding='UTF-8'?>
<getApiToken>
    <user>
        <username>admin_username</username>
    </user>
    <username>username_for_token</username>
    <action>new</action>
</getApiToken>

JSON

{
  "getApiToken": {
    "user": {
      "username": "admin_username"
    },
    "username": "username_for_token",
    "action": "new"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="utf-8"?>
<getApiToken>
    <status>0</status>
    <message>0zrjDjZ26Dll5dqdTBmuwwtQg8</message>
    <expiration_date>07/06/2025 09:17:34</expiration_date>
</getApiToken>

JSON

{
  "status": 0,
  "message": "0zrjDjZ26Dll5dqdTBmuwwtQg8",
  "expiration_date": "07/06/2025 09:19:14"
}

Verify a sender number

POSThttps://app.ileads.co.il/api<verify_phone>

Verify a phone number for use as a message source (sender). A mobile receives a verification link; a landline gets call-verification instructions.

Parameters

Name	Type	Description
`verify_phone`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`phone`required	string	A valid mobile or landline number to verify. May contain multiple fields.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<verify_phone>
    <user>
        <username>my_username</username>
    </user>
    <phone>5xxxxxxxx</phone>
    <phone>3xxxxxxx</phone>
</verify_phone>

JSON

{
  "verify_phone": {
    "user": {
      "username": "my_username"
    },
    "phone": [
      "5xxxxxxxx",
      "3xxxxxxx"
    ]
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="utf-8"?>
<verify_phone>
    <status>0</status>
    <verify_message>
        verification link will be send to 5********
        in order to complete the verification of 3******* call to 0552458888
    </verify_message>
</verify_phone>

JSON

{
  "status": 0,
  "verify_message": "verification link will be send to 5******** in order to complete the verification of 3******* call to 0552458888"
}

Get verified phones

POSThttps://app.ileads.co.il/api<getVerifiedPhones>

Get all verified numbers in the account.

Parameters

Name	Type	Description
`getVerifiedPhones`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`is_subs`	int	1 – include your sub-accounts’ verified numbers. Otherwise, omit the field.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<getVerifiedPhones>
    <user>
        <username>my_username</username>
    </user>
    <is_subs>1</is_subs>
</getVerifiedPhones>

JSON

{
  "getVerifiedPhones": {
    "user": {
      "username": "my_username"
    },
    "is_subs": "1"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<getVerifiedPhones>
    <status>0</status>
    <message></message>
    <verified_phones>
        <verified_phone>
            <PHONE>xxxxxxxxxx</PHONE>
            <USER_ID>xxx</USER_ID>
            <ASSIGNMENT_DATE>03/12/14 12:33</ASSIGNMENT_DATE>
            <LAST_UPDATE>03/12/14 12:33</LAST_UPDATE>
        </verified_phone>
    </verified_phones>
</getVerifiedPhones>

JSON

{
  "status": 0,
  "message": "",
  "verified_phones": [
    {
      "PHONE": "xxxxxxxxxx",
      "USER_ID": "XXXX",
      "ASSIGNMENT_DATE": "03/12/14 12:33",
      "LAST_UPDATE": "03/12/14 12:33"
    },
    {
      "PHONE": " xxxxxxxxxx ",
      "USER_ID": "XXXX",
      "ASSIGNMENT_DATE": "03/12/14 12:33",
      "LAST_UPDATE": "03/12/14 12:33"
    }
  ]
}

Send SMS

POSThttps://app.ileads.co.il/api<sms>

Send one message to one or many recipients – individual numbers, contact lists, or both.

Parameters

Name	Type	Description
`sms`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`source`required	string	Sender name or number. Up to 11 characters – digits (no + sign) and English letters. The source must be verified.
`destinations`required	object	Contains the recipients. May contain multiple phone and cl_id fields.
`phone`required	string	Recipient phone number. Formatted as 5xxxxxxxx or 05xxxxxxxx.
`phone@id`	string	Attribute of phone – your own external ID, used to query the delivery report (DLR) later. Leave empty if not needed.
`cl_id`	string	ID of a contact list to send to.
`message`required	string	The message content. Up to 1005 characters.
`timing`	string	Scheduled send time. If omitted, the message is sent immediately. Format: dd/mm/yy hh:mm
`tag`	string	For Google’s automatic SMS verification – adds a tag to the beginning of the message. For example, tag=# with message=Hello world is sent as "<#>Hello world".
`add_dynamic`	string	1 – send using the contact list’s dynamic fields. Only one cl_id and no single phone tags are allowed. In the message use [DYNAMIC_FIELD1], [DYNAMIC_FIELD2], etc.
`add_unsubscribe`	int	Opt-out option: 3 – remove by link, 2 – remove by reply SMS. Any other value – none.
`temp_bl`	string	Filter out recipients who received a message in the last X days (1–14).
`includes_international`	int	1 – recipients include international numbers, 0 – they don’t.
`campaign_name`	string	Campaign name shown in system reports. Up to 50 characters.
`links`	object	Contains links to shorten inside the message. May contain multiple link fields.
`link`	string	A link to shorten. Must have an id attribute. In the message, write [link-id] where the short link should appear.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <user>
        <username>my_username</username>
    </user>
    <source>DemoAPI</source>
    <destinations>
        <cl_id>21518</cl_id>
        <cl_id>21500</cl_id>
        <phone id="external id1">5xxxxxxxx</phone>
        <phone id="external id2">5xxxxxxxx</phone>
        <phone>5xxxxxxxx</phone>
        <phone id="">5xxxxxxxx</phone>
    </destinations>
    <tag>#</tag>
    <message>This is a sample message. [link-a1]</message>
    <add_dynamic>0</add_dynamic>
    <timing>30/03/14 10:10</timing>
    <add_unsubscribe>0</add_unsubscribe>
    <temp_bl>2</temp_bl>
    <includes_international>1</includes_international>
    <campaign_name>Sample Campaign</campaign_name>
    <links>
        <link id="a1">https://www.example.com/path/to/resource</link>
    </links>
</sms>

JSON

{
  "sms": {
    "user": {
      "username": "my_username"
    },
    "source": "DemoAPI",
    "destinations": {
      "cl_id": [
        "21518",
        "21500"
      ],
      "phone": [
        {
          "$": {
            "id": "external id1"
          },
          "_": "5xxxxxxxx"
        },
        {
          "$": {
            "id": "external id2"
          },
          "_": "5xxxxxxxx"
        },
        {
          "_": "5xxxxxxxx"
        },
        {
          "$": {
            "id": ""
          },
          "_": "5xxxxxxxx"
        }
      ]
    },
    "tag": "#",
    "message": "This is a sample message. [link-a1]",
    "add_dynamic": "0",
    "timing": "30/03/14 10:10",
    "add_unsubscribe": "0",
    "temp_bl": "2",
    "includes_international": "1",
    "campaign_name": "Sample Campaign",
    "links": {
      "link": [
        {
          "$": {
            "id": "a1"
          },
          "_": "https://www.example.com/path/to/resource"
        }
      ]
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <status>0</status>
    <message>SMS will be sent</message>
    <shipment_id>xxxxxxx</shipment_id>
</sms>

JSON

{
  "status": 0,
  "message": "SMS will be sent",
  "shipment_id": "XXXXXXX"
}

Send bulk SMS

POSThttps://app.ileads.co.il/api<bulk>

Send different messages to different recipients in a single request – for example, a personal message per customer.

Parameters

Name	Type	Description
`bulk`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`messages`required	array	Array of sms objects. Up to 2500 messages per request.
`sms → source`required	string	Sender name or number. Up to 11 characters – digits and English letters.
`sms → destinations`required	object	The recipients of this message.
`sms → phone`required	string	Recipient phone number. Formatted as 5xxxxxxxx or 05xxxxxxxx. Optional id attribute for delivery reports.
`sms → message`required	string	The message content. Up to 1005 characters.
`sms → links`	object	Links to shorten in this message (link with an id attribute; use [link-id] in the message).
`cl_id`	string	Contact list ID.
`timing`	string	Scheduled send time. Format: dd/mm/yy hh:mm
`add_unsubscribe`	int	3 – remove by link, 2 – remove by reply SMS.
`temp_bl`	string	Filter out recipients who received a message in the last X days (1–14).
`includes_international`	int	1 – includes international numbers.
`campaign_name`	string	Campaign name in reports. Up to 50 characters.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<bulk>
    <user>
        <username>my_username</username>
    </user>
    <messages>
        <sms>
            <source>DemoAPI</source>
            <destinations>
                <phone id="external id1">5xxxxxxxx</phone>
                <phone id="external id2">5xxxxxxxx</phone>
                <phone>5xxxxxxxx</phone>
                <phone id="">5xxxxxxxx</phone>
            </destinations>
            <message>This is a sample message</message>
        </sms>
        <sms>
            <source>DemoAPI</source>
            <destinations>
                <phone id="">5xxxxxxxx</phone>
            </destinations>
            <message>This is a different message sent. [link-a1]</message>
            <links>
                <link id="a1">https://www.example.com/path/to/resource</link>
            </links>
        </sms>
    </messages>
    <timing>10/10/17 10:10</timing>
    <temp_bl>2</temp_bl>
    <includes_international>1</includes_international>
    <campaign_name>Sample Bulk Campaign</campaign_name>
</bulk>

JSON

{
  "bulk": {
    "user": {
      "username": "my_username"
    },
    "messages": {
      "sms": [
        {
          "source": "DemoAPI",
          "destinations": {
            "phone": [
              {
                "$": {
                  "id": "external id1"
                },
                "_": "5xxxxxxxx"
              },
              {
                "$": {
                  "id": "external id2"
                },
                "_": "5xxxxxxxx"
              },
              {
                "_": "5xxxxxxxx"
              },
              {
                "$": {
                  "id": ""
                },
                "_": "5xxxxxxxx"
              }
            ]
          },
          "message": "This is a sample message"
        },
        {
          "source": "DemoAPI",
          "destinations": {
            "phone": {
              "_": "5xxxxxxxx",
              "$": {
                "id": ""
              }
            }
          },
          "message": "This is a different message sent. [link-a1]",
          "links": {
            "link": [
              {
                "$": {
                  "id": "a1"
                },
                "_": "https://www.example.com/path/to/resource"
              }
            ]
          }
        }
      ]
    },
    "timing": "10/10/17 10:10",
    "temp_bl": "2",
    "includes_international": "1",
    "campaign_name": "Sample Bulk Campaign"

  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?> <sms>
    <status>0</status>
    <message>SMS bulk will be sent</message>
    <shipment_id>xxxxxxx</shipment_id>
</sms>

JSON

{
  "status": 0,
  "message": "SMS will be sent",
  "shipment_id": "XXXXXXX"
}

Get balance

POSThttps://app.ileads.co.il/api<balance>

Check the remaining message balance of the account.

Parameters

Name	Type	Description
`balance`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<balance>
    <user>
        <username>my_username</username>
    </user>
</balance>

JSON

{
  "balance": {
    "user": {
      "username": "my_username"
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<balance>
    <status>0</status>
    <message>Your balance is : 42 and international balance: 40.5 nis</message>
    <balance>42</balance>
    <interantional_balance>40.5</interantional_balance>
</balance>

JSON

{
  "status": 0,
  "message": "Your balance is : 42 and international balance: 40.5 nis",
  "balance": "42",
  "international_balance": "40.5"
}

Send OTP code

POSThttps://app.ileads.co.il/api<send_otp>

Send a 6-digit one-time code by SMS. The code is generated and stored by the system for later validation.

Parameters

Name	Type	Description
`send_otp`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`phone`required	string	Formatted as 5xxxxxxxx or 05xxxxxxxx.
`source`required	string	The sender name or number shown to the recipient.
`app_id`	int	Distinguishes between several applications using the service. Default: 1.
`max_tries`	int	Number of attempts to enter the code, 3–5. Default: 3.
`valid_time`	int	Code validity in minutes, 1–15. Default: 5.
`text`	string	Custom text – must include [code]. Default: "the code is [code]".

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<send_otp>
    <user>
        <username>my_username</username>
    </user>
    <phone>05XXXXXXXX</phone>
    <app_id>1000</app_id>
    <source>MyBrand</source>
    <max_tries>4</max_tries>
    <text>the code is [code]</text>
</send_otp>

JSON

{
  "send_otp": {
    "user": {
      "username": "my_username"
    },
    "phone": "05XXXXXXXX",
    "app_id": "1000",
    "source": "MyBrand",
    "max_tries": "4",
    "text": "the code is [code]"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <code>494036</code>
    <message>The code is : 494036 and is valid for 5 minutes</message>
</sms>

JSON

{
  "status": 0,
  "code": "494036",
  "message": "The code is : 494036 and is valid for 5 minutes"
}

Validate OTP code

POSThttps://app.ileads.co.il/api<validate_otp>

Check whether the code entered by the user is valid for the number.

A wrong code returns status 12 (Unverified code).

Parameters

Name	Type	Description
`validate_otp`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`phone`required	string	Formatted as 5xxxxxxxx or 05xxxxxxxx.
`code`required	int	The 6-digit code to validate.
`app_id`	int	The same app_id used when sending the code. Default: 1.
`service_type`	string	sms or whatsapp. Default: sms.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<validate_otp>
    <user>
        <username>my_username</username>
    </user>
    <phone>05XXXXXXXX</phone>
    <app_id>1000</app_id>
    <code>494036</code>
</validate_otp>

JSON

{
  "validate_otp": {
    "user": {
      "username": "my_username"
    },
    "phone": "05XXXXXXXX",
    "app_id": "1000",
    "code": "494036"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <message>The code successfully validated</message>
</sms>

JSON

{
  "status": 0,
  "message": "The code successfully validated"
}

Receiving updates (Push)

Instead of pulling reports, you can receive them automatically at your URL as soon as they arrive.

Updates are sent as a POST request in application/x-www-form-urlencoded format, using the same field names as the API responses.
Respond with 200 OK. Any other response delays the pushes, and after several failures pushing stops.
Set the URL in the web interface, or via Add push URL.

Delivery report (dlr)

Fields: external_id, status (see DLR statuses), he_message, en_message, date, phone, operaor (the field is spelled this way), shipment_id.

HTTP

POST https://your-site.com/ileads/dlr
Content-Type: application/x-www-form-urlencoded

external_id=1234&status=102&he_message=הגיע+ליעד&en_message=Delivered
&date=01/04/26 16:05:05&phone=9725xxxxxxxx&operaor=Cellcom&shipment_id=12345678

Incoming SMS (incoming_sms)

Fields: message, date, phone (sender), dest (your number).

Text

message=This+is+a+sample+message&date=01/04/26 16:05:05
&phone=9725xxxxxxxx&dest=9725xxxxxxxx

Blacklist (blacklist)

Fields: message, date, dest.

Text

message=נחסם+מנוי&date=01/04/26 16:05:05&dest=9725xxxxxxxx

PHP

<?php
// Delivery report (DLR) receiver
$externalId = $_POST['external_id'] ?? '';
$status     = (int) ($_POST['status'] ?? -1);
$phone      = $_POST['phone'] ?? '';
$shipmentId = $_POST['shipment_id'] ?? '';

if ($status === 102) {
    // Delivered – update your records here
}

http_response_code(200);

Node.js

import express from 'express';

const app = express();
app.use(express.urlencoded({ extended: false }));

app.post('/ileads/dlr', (req, res) => {
  const { external_id, status, phone, shipment_id } = req.body;
  if (Number(status) === 102) {
    // Delivered – update your records here
  }
  res.sendStatus(200);
});

app.listen(3000);

Add push URL

POSThttps://app.ileads.co.il/api<push_url>

Set the URL updates are pushed to. It can also be set from the web interface.

An existing URL is never replaced. If a URL is already set for that type, status 517 is returned and nothing changes.

Parameters

Name	Type	Description
`push_url`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`type`required	string	Push type: dlr, incoming_sms, blacklist, dlr_whatsapp, incoming_whatsapp.
`url`required	string	A public http/https URL.

All status codes

Request

XML

<?xml version='1.0' encoding='UTF-8'?>
<push_url>
    <user>
        <username>XXXX</username>
    </user>
    <type>dlr</type>
    <url>https://www.example.com/path/to/resource</url>
</push_url>

JSON

{
  "push_url": {
    "user": {
      "username": "my_username"
    },
    "type": "dlr",
    "url": "https://www.example.com/path/to/resource"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <message>push url has successfully added</message>
</sms>

JSON

{
  "status": 0,
  "message": "push url has successfully added"
}

Delivery reports (DLR)

POSThttps://app.ileads.co.il/api<dlr>

Retrieve the delivery status of messages by the external id you attached when sending.

Date range – up to 1 week. Up to 1000 external IDs per request.

Parameters

Name	Type	Description
`dlr`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`transactions`required	object	Contains the IDs to check. May contain multiple external_id fields.
`external_id`required	string	The id you sent as the phone attribute when submitting the SMS.
`from`required	string	Start of the range. Format: dd/mm/yy hh:mm
`to`required	string	End of the range. Format: dd/mm/yy hh:mm

All status codes · DLR statuses

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<dlr>
    <user>
        <username>my_username</username>
    </user>
    <transactions>
        <external_id>some id 1</external_id> <external_id>some id
        2</external_id>
    </transactions>
    <from>01/01/14 00:00</from>
    <to>01/01/14 23:59</to>
</dlr>

JSON

{
  "dlr": {
    "user": {
      "username": "my_username"
    },
    "transactions": {
      "external_id": [
        "some id 1",
        "some id 2"
      ]
    },
    "from": "01/01/14 00:00",
    "to": "01/01/14 23:59"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<dlr>
    <status>0</status>
    <message></message>
    <transactions>
        <transaction>
            <external_id>1391438285</external_id>
            <status>102</status>
            <he_message>הגיע ליעד</he_message>
            <en_message>Delivered</en_message>
            <date>03/02/14 16:38</date>
            <shipment_id>12345678</shipment_id>
        </transaction>
        <transaction>
            <external_id>1391438286</external_id>
            <status>102</status>
            <he_message>הגיע ליעד</he_message>
            <en_message>Delivered</en_message>
            <date>03/02/14 16:38</date>
            <shipment_id>12345678</shipment_id>
        </transaction>
    </transactions>
</dlr>

JSON

{
  "status": 0,
  "message": "all is well!",
  "transactions": [
    {
      "external_id": "1391438285",
      "source": "Test",
      "phone": "5XXXXXXXX",
      "status": "102",
      "message_he": "הגיע ליעד",
      "en_message": "Delivered",
      "shipment_id": "XXXXXXX",
      "date": "02/05/23 10:22",
      "operator": "Telzar"
    },
    {
      "external_id": "1391438285",
      "source": "Test",
      "phone": "5XXXXXXXX",
      "status": "102",
      "message_he": "הגיע ליעד",
      "en_message": "Delivered",
      "shipment_id": "XXXXXXX",
      "date": "02/05/23 10:23",
      "operator": "Telzar"
    }
  ]
}

Delivery reports by date

POSThttps://app.ileads.co.il/api<dlrByDate>

Retrieve delivery reports by date range, without an external id.

Date range – up to 1 week.

Parameters

Name	Type	Description
`dlrByDate`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`transactions`required	object	Contains external_id.
`external_id`required	string	May contain the value null.
`from`required	string	Start of the range. Format: dd/mm/yy hh:mm
`to`required	string	End of the range. Format: dd/mm/yy hh:mm

All status codes · DLR statuses

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<dlrByDate>
    <user>
        <username>my_username</username>
    </user>
    <transactions>
        <external_id>null</external_id>
    </transactions>
    <from>01/01/14 00:00</from>
    <to>01/01/14 23:59</to>
</dlrByDate>

JSON

{
  "dlrByDate": {
    "user": {
      "username": "my_username"
    },
    "transactions": {
      "external_id": "null"
    },
    "from": "04/09/22 00:00",
    "to": "04/09/22 23:59"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<dlr>
    <status>0</status>
    <message></message>
    <transactions>
        <transaction>
            <external_id>1391438285</external_id>
            <status>102</status>
            <he_message>הגיע ליעד</he_message>
            <en_message>Delivered</en_message>
            <date>03/02/14 16:38</date>
            <shipment_id>12345678</shipment_id>
        </transaction>
        <transaction>
            <external_id>1391438286</external_id>
            <status>102</status>
            <he_message>הגיע ליעד</he_message>
            <en_message>Delivered</en_message>
            <date>03/02/14 16:38</date>
            <shipment_id>12345678</shipment_id>
        </transaction>
    </transactions>
</dlr>

JSON

{
  "status": 0,
  "message": "all is well!",
  "transactions": [
    {
      "external_id": "1391438285",
      "source": "Test",
      "phone": "5XXXXXXXX",
      "status": "102",
      "message_he": "הגיע ליעד",
      "en_message": "Delivered",
      "shipment_id": "XXXXXXX",
      "date": "02/05/23 10:22",
      "operator": "Telzar"
    },
    {
      "external_id": "1391438285",
      "source": "Test",
      "phone": "5XXXXXXXX",
      "status": "102",
      "message_he": "הגיע ליעד",
      "en_message": "Delivered",
      "shipment_id": "XXXXXXX",
      "date": "02/05/23 10:23",
      "operator": "Telzar"
    }
  ]
}

Incoming SMS

POSThttps://app.ileads.co.il/api<incoming>

Retrieve received SMS messages (recipient replies).

A range of up to 1 week, up to 1 year back.

Parameters

Name	Type	Description
`incoming`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`from`required	string	Start of the range. Format: dd/mm/yy hh:mm
`to`required	string	End of the range. Format: dd/mm/yy hh:mm

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<incoming>
    <user>
        <username>my_username</username>
    </user>
    <from>01/01/15 00:00</from>
    <to>01/01/15 23:59</to>
</incoming>

JSON

{
  "incoming": {
    "user": {
      "username": "my_username"
    },
    "from": "01/11/22 00:00",
    "to": "01/11/22 23:59"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<incoming>
    <status>0</status>
    <message></message>
    <transactions>
        <transaction>
            <source>05********</source>
            <destination>05********</destination>
            <message> This is a sample message</message>
            <date>03/12/14 16:38</date>
        </transaction>
        <transaction>
            <source>05********</source>
            <destination>05********</destination>
            <message> This is a test message</message>
            <date>03/12/14 12:33</date>
        </transaction>
    </transactions>
</incoming>

JSON

{
  "status": 0,
  "message": "",
  "transactions": [
    {
      "source": "test",
      "destination": "9725XXXXXXX",
      "message": "test ",
      "date": "01/05/23 00:00"
    },
    {
      "source": "test1",
      "destination": "9725XXXXXXX",
      "message": "test",
      "date": "01/05/23 00:00"
    }
  ]
}

Create contact list

POSThttps://app.ileads.co.il/api<newCL>

Create one or more lists, including numbers and dynamic fields.

Parameters

Name	Type	Description
`newCL`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`cl`required	object	Details of the list to create. May contain multiple cl elements.
`cl → name`required	string	List name.
`destinations`required	object	The numbers to add to the list.
`destination`required	object	Details of a single number.
`phone`required	string	Formatted as 5xxxxxxxx or 05xxxxxxxx.
`df1 … df6`	string	Dynamic fields for the number (e.g. first name, last name, city).

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<newCL>
    <user>
        <username>my_username</username>
    </user>
    <cl>
        <name>name1</name>
        <destinations>
            <destination>
                <phone>055XXXXXXX</phone>
                <df1>Israel</df1>
                <df2>Israeli</df2>
                <df3>Haifa</df3>
            </destination>
            <destination>
                <phone>55XXXXXXX</phone>
            </destination>
        </destinations>
    </cl>
    <cl>
        <name>name2</name>
        <destinations>
            <destination>
                <phone>055XXXXXXX</phone>
            </destination>
            <destination>
                <phone>55XXXXXXX</phone>
            </destination>
        </destinations>
    </cl>
</newCL>

JSON

{
  "newCL": {
    "user": {
      "username": "my_username"
    },
    "cl": [
      {
        "name": "name1",
        "destinations": {
          "destination": [
            {
              "phone": "55XXXXXXX",
              "df1": "Israel",
              "df2": "Israeli",
              "df3": "Haifa"
            },
            {"phone": "55XXXXXXX"}
          ]
        }
      },
      {
        "name": "name2",
        "destinations": {
          "destination": [
            {"phone": "55XXXXXXX"},
            {"phone": "55XXXXXXX"}
          ]
        }
      }
    ]
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<newCL>
    <status>0</status>
    <message>conact list successfully created</message>
    <errors>
        <error>The phone is too long or too short or contain characters
            and therefore not added</error>
    </errors>
    <identifiers>
        <identifier>17419</identifier>
    </identifiers>
</newCL>

JSON

{
  "status": 0,
  "message": "conact list successfully created",
  "errors": ["The phone is too long or too short or contain characters and therefore not added"],
    "identifiers": "17419"
}

Remove contact list

POSThttps://app.ileads.co.il/api<removeCL>

Remove one or more lists by ID.

Parameters

Name	Type	Description
`removeCL`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`cl`required	object	Contains the IDs of the lists to remove.
`id`required	string	List ID.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<removeCL>
    <user>
        <username>my_username</username>
    </user>
    <cl>
        <id>21518</id>
        <id>21500</id>
    </cl>
</removeCL>

JSON

{
  "removeCL": {
    "user": {
      "username": "my_username"
    },
    "cl": {
      "id": ["21518","21500"]
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<removeCL>
    <status>0</status>
    <message>contact list successfully removed</message>
    <errors>
        <error>contact list id: 21500 does not exist and therefore not removed</error>
    </errors>
</removeCL>

JSON

{
  "status": 0,
  "message": "conact lists successfully removed",
  "errors": ["contact list id: 21500 does not exist and therefore not removed"]
}

Add numbers to a list

POSThttps://app.ileads.co.il/api<addNumCL>

Add numbers to an existing list.

Parameters

Name	Type	Description
`addNumCL`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`cl`required	object	Details of the list to update. May contain multiple cl elements.
`id`required	int	List ID.
`destinations`required	object	The numbers to add.
`destination`required	object	Details of a single number.
`phone`required	string	Formatted as 5xxxxxxxx or 05xxxxxxxx.
`df1 … df6`	string	Dynamic fields for this number in this list.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<addNumCL>
    <user>
        <username>my_username</username>
    </user>
    <cl>
        <id>21518</id>
        <destinations>
            <destination>
                <phone>055XXXXXXX</phone>
                <df1>Israel</df1>
                <df2>Israeli</df2>
                <df3>Haifa</df3>
            </destination>
            <destination>
                <phone>55XXXXXXX</phone>
            </destination>
        </destinations>
    </cl>
    <cl>
        <id>21500</id>
        <destinations>
            <destination>
                <phone>055XXXXXXX</phone>
            </destination>
            <destination>
                <phone>55XXXXXXX</phone>
            </destination>
        </destinations>
    </cl>
</addNumCL>

JSON

{
  "addNumCL": {
    "user": {
      "username": "my_username"
    },
    "cl": [
      {
        "id": "21518",
        "destinations": {
          "destination": [
            {
              "phone": "055XXXXXXX",
              "df1": "Israel",
              "df2": "Israeli",
              "df3": "Haifa"
            },
            {
              "phone": "055XXXXXXX"
            }
          ]
        }
      },
      {
        "id": "21500",
        "destinations": {
          "destination": [
            {"phone": "055XXXXXXX"},
            {"phone": "055XXXXXXX"}
          ]
        }
      }
    ]
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <message>The phone numbers have been added successfully</message>
    <errors>
        <error>The phone 055XXXXXXX is already on the contact list and therefore not added</error>
        <error>The phone 55XXXXXXX is already on the contact list and therefore not added</error>
    </errors>
</sms>

JSON

{
  "status": 0,
  "message": "The phone numbers have been added successfully",
  "errors": [
    "The phone 05XXXXXXXX is already on the contact list and therefore not added",
    "The phone 55XXXXXXX is already on the contact list and therefore not added"
  ]
}

Remove numbers from a list

POSThttps://app.ileads.co.il/api<rmNumCL>

Remove numbers from an existing list.

Parameters

Name	Type	Description
`rmNumCL`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`cl`required	object	Details of the list to update.
`id`required	int	List ID.
`destinations`required	object	The numbers to remove.
`phone`required	string	Formatted as 5xxxxxxxx or 05xxxxxxxx.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<rmNumCL>
    <user>
        <username>my_username</username>
    </user>
    <cl>
        <id>21518</id>
        <destinations>
            <phone>055XXXXXXX</phone>
        </destinations>
    </cl>
    <cl>
        <id>21500</id>
        <destinations>
            <phone>055XXXXXXX</phone>
            <phone>55XXXXXXX</phone>
        </destinations>
    </cl>
</rmNumCL>

JSON

{
  "rmNumCL": {
    "user": {
      "username": "my_username"
    },
    "cl": [
      {
        "id": "21518",
        "destinations": {
          "phone": "055XXXXXXX"
        }
      },
      {
        "id": "21500",
        "destinations": {
          "phone": ["055XXXXXXX", "055XXXXXXX"]
        }
      }
    ]
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<rmNumCL>
    <status>0</status>
    <message>Successfully deleted phone numbers</message>
    <errors>
        <error>contact list id: 21500 does not exist and therefore not removed</error>
    </errors>
</rmNumCL>

JSON

{
  "status": 0,
  "message": "Successfully deleted phone numbers",
  "errors": [
    "contact list id: 21500 does not exist and therefore not removed"
  ]
}

Get all contact lists

POSThttps://app.ileads.co.il/api<getCL>

Get all lists in the account, including empty ones.

Parameters

Name	Type	Description
`getCL`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<getCL>
    <user>
        <username>my_username</username>
    </user>
</getCL>

JSON

{
  "getCL": {
    "user": {
      "username": "my_username"
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<getCL>
    <status>0</status>
    <message></message>
    <contact_lists>
        <contact_list>
            <cl_id>21518</cl_id>
            <phone>55XXXXXXX</phone>
            <name>name1</name>
        </contact_list>
        <contact_list>
            <cl_id>21518</cl_id>
            <phone>555XXXXXX</phone>
            <name>name1</name>
        </contact_list>
        <contact_list>
            <cl_id>21500</cl_id>
            <phone>055XXXXXXX</phone>
            <name>name2</name>
        </contact_list>
    </contact_lists>
</getCL>

JSON

{
  "status": 0,
  "message": "",
  "contact_lists": [
    {
      "cl_id": "21518",
      "phone": "55XXXXXXX",
      "name": "name1"
    },
    {
      "cl_id": "21518",
      "phone": "555XXXXXX",
      "name": "name1"
    },
    {
      "cl_id": "21500",
      "phone": "555XXXXXX",
      "name": "name2"
    }
  ]
}

Get contact list by ID

POSThttps://app.ileads.co.il/api<getCLbyID>

Get the numbers of a specific list.

Parameters

Name	Type	Description
`getCLbyID`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`cl`required	object	Contains the list ID.
`id`required	int	List ID.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<getCLbyID>
    <user>
        <username>my_username</username>
    </user>
    <cl>
        <id>xxxxx</id>
    </cl>
</getCLbyID>

JSON

{
  "getCLbyID": {
    "user": {
      "username": "my_username"
    },
    "cl": {
      "id": "1234"
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<getCLbyID>
    <status>0</status>
    <message></message>
    <contact_lists>
        <contact_list>
            <phone>55XXXXXXX</phone>
            <name>name1</name>
        </contact_list>
        <contact_list>
            <phone>555XXXXXX</phone>
            <name>name1</name>
        </contact_list>
        <contact_list>
            <phone>055XXXXXXX</phone>
            <name>name2</name>
        </contact_list>
    </contact_lists>
</getCLbyID>

JSON

{
  "status": 0,
  "message": "",
  "contact_lists": [
    {
      "cl_id": "21518",
      "phone": "55XXXXXXX",
      "name": "name1"
    },
    {
      "cl_id": "21518",
      "phone": "555XXXXXX",
      "name": "name1"
    },
    {
      "cl_id": "21500",
      "phone": "555XXXXXX",
      "name": "name2"
    }
  ]
}

Get blacklist

POSThttps://app.ileads.co.il/api<blacklist>

Get blocked numbers by date range.

Parameters

Name	Type	Description
`blacklist`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`from`required	string	Start of the range. Format: dd/mm/yy hh:mm
`to`required	string	End of the range. Format: dd/mm/yy hh:mm

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<blacklist>
    <user>
        <username>my_username</username>
    </user>
    <from>02/06/15 00:00</from>
    <to>15/12/15 23:59</to>
</blacklist>

JSON

{
  "blacklist": {
    "user": {
      "username": "my_username"
    },
    "from": "02/06/22 00:00",
    "to": "15/12/22 23:59"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<blacklist>
    <status>0</status>
    <message></message>
    <transactions>
        <transaction>
            <phone>5********</phone>
            <date>03/12/14 16:38</date>
        </transaction>
        <transaction>
            <phone>5********</phone>
            <date>03/12/14 12:33</date>
        </transaction>
    </transactions>
</blacklist>

JSON

{
  "status": 0,
  "message": "",
  "transactions": [
    {
      "phone": "5********",
      "date": "22/08/22 11:00"
    },
    {
      "phone": "5********",
      "date": "23/11/22 12:37"
    }
  ]
}

Remove from blacklist

POSThttps://app.ileads.co.il/api<rmNumBL>

Remove numbers from the blacklist, with a reason.

Parameters

Name	Type	Description
`rmNumBL`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`phones`required	object	Contains the phone numbers.
`phone`required	string	A number to remove.
`reason`required	string	The reason for removal.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<rmNumBL>
    <user>
        <username>my_username</username>
    </user>
    <phones>
        <phone>5********</phone>
        <phone>05********</phone>
    </phones>
    <reason>Text here</reason>
</rmNumBL>

JSON

{
  "rmNumBL": {
    "user": {
      "username": "my_username"
    },
    "phones": {
      "phone": [
        "5********",
        "05********"
      ]
    },
    "reason": "Text here"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<status>944</status>
<message>X phone numbers Successfully deleted , Y Phone numbers not exist in
blacklist</message>

JSON

{
  "status": 944,
  "message": "X phone numbers Successfully deleted , Y Phone numbers not exist in blacklist"
}

Add to blacklist

POSThttps://app.ileads.co.il/api<addNumBL>

Add numbers to the blacklist – messages will not be sent to them.

Parameters

Name	Type	Description
`addNumBL`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`phones`required	object	Contains the phone numbers.
`phone`required	string	A number to add.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<addNumBL>
    <user>
        <username>my_username</username>
    </user>
    <phones>
        <phone>5********</phone>
        <phone>05********</phone>
    </phones>
</addNumBL>

JSON

{
  "addNumBL": {
    "user": {
      "username": "my_username"
    },
    "phones": {
      "phone": [
        "5********",
        "05********"
      ]
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<status>946</status>
<message>number has successfully added to blacklist</message>

JSON

{
  "status": 946,
  "message": "number has successfully added to blacklist"
}

Cancel campaign

POSThttps://app.ileads.co.il/api<cancel>

Cancel a scheduled send by campaign ID.

Parameters

Name	Type	Description
`cancel`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`campaign_id`required	int	The campaign ID.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <user>
        <username>my_username</username>
    </user>
    <campaign_id>1234</campaign_id>
</cancel>

JSON

{
  "cancel": {
    "user": {
      "username": "my_username"
    },
    "campaign_id": "1324"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <status>0</status>
    <message>Campaign successfuly cancel</message>
</cancel>

JSON

{
  "status": 0,
  "message": "Campaign successfuly cancel"
}

Cancel campaigns by name

POSThttps://app.ileads.co.il/api<cancel>

Cancel all scheduled campaigns with a given name.

Parameters

Name	Type	Description
`cancel`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`campaign_name`required	string	The campaign name.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <user>
        <username>my_username</username>
    </user>
    <campaign_name>My Campaign</campaign_name>
</cancel>

JSON

{
  "cancel": {
    "user": {
      "username": "my_username"
    },
    "campaign_name": "My Campaign"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <status>0</status>
    <message>Campaigns successfully cancel</message>
    <count>1</count>
</cancel>

JSON

{
  "status": 0,
  "message": "Campaigns successfully cancel",
  "count": 1
}

Voice message (TTS)Requires activation

POSThttps://app.ileads.co.il/api<sms>

The text is converted into a recorded voice call to the recipient. Identical to Send SMS, with an additional tts object. The call source is a system number.

Available on accounts where it has been enabled. Contact us to enable it.

Parameters

Name	Type	Description
`sms`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`source`required	string	Sender name or number (for SMS). Calls come from a system number.
`destinations`required	object	The recipients.
`phone`required	string	Formatted as 5xxxxxxxx or 05xxxxxxxx.
`message`required	string	The text to read out. Up to 1005 characters.
`tts`required	object	Call settings.
`tts → type`required	int	2 – SMS to regular phones and a voice call to Kosher phones. 3 – both SMS and a call to everyone. 4 – voice call only to everyone.
`tts → rate`	int	Speech rate, -10 to 10 (0 is normal).
`tts → repeat`	int	Times the message plays in a call. Default: 2.
`tts → voice`	string	ymMale – male voice (default), ymFemale – female voice.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <user>
        <username>my_username</username>
    </user>
    <source>DemoAPI</source>
    <destinations>
        <cl_id>21518</cl_id>
        <cl_id>21500</cl_id>
        <phone id="external id1">5xxxxxxxx</phone>
        <phone id="external id2">5xxxxxxxx</phone>
        <phone>5xxxxxxxx</phone>
        <phone id="">5xxxxxxxx</phone>
    </destinations>
    <message>This is a sample tts message</message>
    <tts>
        <type>4</type>
        <rate>-1</rate>
        <repeat>1</repeat>
        <voice>ymMale</voice>
    </tts>
</sms>

JSON

{
  "sms": {
    "user": {
      "username": "my_username"
    },
    "source": "DemoAPI",
    "destinations": {
      "cl_id": [
        "21518",
        "21500"
      ],
      "phone": [
        {
          "$": {
            "id": "external id1"
          },
          "_": "5xxxxxxxx"
        },
        {
          "$": {
            "id": "external id2"
          },
          "_": "5xxxxxxxx"
        },
        {
          "_": "5xxxxxxxx"
        },
        {
          "$": {
            "id": ""
          },
          "_": "5xxxxxxxx"
        }
      ]
    },
    "message": "This is a sample tts message",
    "tts": {
      "type": 4,
      "rete": -1,
      "repeat": 1,
      "voice": "ymMale"
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <status>0</status>
    <message>SMS will be sent</message>
    <shipment_id>xxxxxxx</shipment_id>
</sms>

JSON

{
  "status": 0,
  "message": "SMS will be sent",
  "shipment_id": "XXXXXXX"
}

Voice delivery reportsRequires activation

POSThttps://app.ileads.co.il/api<ttsDlr>

Delivery reports of voice (TTS) campaigns.

Available on accounts where it has been enabled. Contact us to enable it.

Date range – up to 1 week.

Parameters

Name	Type	Description
`ttsDlr`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`shipment_id`	string	The campaign ID. Digits only.
`from`required	string	Start of the range (required). Format: dd/mm/yy hh:mm
`to`required	string	End of the range (required). Format: dd/mm/yy hh:mm

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<ttsDlr>
    <user>
        <username>my_username</username>
    </user>
    <from>01/05/23 00:00</from>
    <to>01/05/23 23:59</to>
</ttsDlr>

JSON

{
  "ttsDlr": {
    "user": {
      "username": "my_username"
    },
    "from": "01/05/23 00:00",
    "to": "01/05/23 23:59"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<dlr>
    <status>0</status>
    <message>all is well!</message>
    <transactions>
        <transaction>
            <shipment_id>12345678</shipment_id>
             <status>102</status>
            <source>07********</source>
            <phone>5********</phone>
            <he_message>הגיע ליעד</he_message>
            <en_message>Delivered</en_message>
            <date>01/05/23 10:22</date>
        </transaction>
        <transaction>
            <shipment_id>12345678</shipment_id>
            <status>6</status>
            <source>07********</source>
            <phone>5********</phone>
            <he_message>נכשל</he_message>
            <en_message>Failed</en_message>
            <date>01/05/23 10:23</date>
        </transaction>
    </transactions>
</dlr>

JSON

{
  "status": 0,
  "message": "all is well!",
  "transactions": [
    {
      "shipment_id": "12345678",
      "status": "102",
      "source": "07XXXXXXX",
      "phone": "5XXXXXXXX",
      "he_message": "הגיע ליעד",
      "en_message": "Delivered",
      "date": "01/05/23 10:22"
    },
    {
      "shipment_id": "12345678",
      "status": "6",
      "source": "07XXXXXXX",
      "phone": "5XXXXXXXX",
      "he_message": "נכשל",
      "en_message": "Failed",
      "date": "01/05/23 10:23"
    }
  ]
}

Add sub-accountRequires activation

POSThttps://app.ileads.co.il/api<addSub>

Create a sub-account under your account, with a message balance.

Available on accounts where it has been enabled. Contact us to enable it.

Parameters

Name	Type	Description
`addSub`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`userDetails`required	object	The new account details.
`userDetails → name`required	string	Account name.
`userDetails → username`required	string	Username for the account.
`userDetails → password`required	string	Password for the account.
`userDetails → source`required	string	Default source (sender).
`userDetails → amount`required	int	Message credits to assign. Digits only.
`userDetails → otpPhone`	string	Phone number for OTP authentication.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<addSub>
    <user>
        <username>my_username</username>
    </user>
    <userDetails>
        <name>israel israeli</name>
        <username> israelisraeli</username>
        <password> israelisraeli</password>
        <source>055xxxxxxx</source>
        <amount>70000</amount>
        <otpPhone>5xxxxxxxx</otpPhone>
    </userDetails>
</addSub>

JSON

{
  "addSub": {
    "user": {
      "username": "my_username"
    },
    "userDetails": {
      "name": "israel israeli",
      "username": " israelisraeli ",
      "password": " israelisraeli ",
      "source": "055xxxxxxx",
      "amount": "70000",
      "otpPhone": "5xxxxxxxx"
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<addSub>
    <status>0</status>
    <message>The user was created successfully</message>
</addSub>

JSON

{
  "status": 0,
  "message": "The user was created successfully"
}

Update sub-account balanceRequires activation

POSThttps://app.ileads.co.il/api<updateAmountSub>

Update the message balance of a sub-account.

Available on accounts where it has been enabled. Contact us to enable it.

Parameters

Name	Type	Description
`updateAmountSub`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`userDetails`required	object	The account to update.
`userDetails → username`required	string	The sub-account username.
`userDetails → amount`required	int	Message credits to assign.
`userDetails → amount_int`	int	Update a monetary amount (international balance) instead of message credits.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<updateAmountSub>
    <user>
        <username>my_username</username>
    </user>
    <userDetails>
        <username>username1</username>
        <amount>70000</amount>
        <amount_int>6000</amount_int>
    </userDetails>
</updateAmountSub>

JSON

{
  "updateAmountSub": {
    "user": {
      "username": "my_username"
    },
    "userDetails": {
      "username": "username1",
      "amount": "70000",
      "amount_int": "6000"
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<updateAmountSub>
    <status>0</status>
    <message>Wallet successfully updated</message>
</updateAmountSub>

JSON

{
  "status": 0,
  "message": "Wallet successfully updated"
}

Get sub-account balancesRequires activation

POSThttps://app.ileads.co.il/api<getBlanceSubs>

Get the balance of all sub-accounts.

Available on accounts where it has been enabled. Contact us to enable it.

The element name getBlanceSubs is spelled this way intentionally – it is the name the system expects.

Parameters

Name	Type	Description
`getBlanceSubs`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<getBlanceSubs>
    <user>
        <username>my_username</username>
    </user>
</getBlanceSubs>

JSON

{
  "getBlanceSubs": {
    "user": {
      "username": "my_username"
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<getBlanceSubs>
<status>0</status>
<message></message>
<balances> <balance>
    <amount>80</amount>
    <sms_user_id>xxx</sms_user_id>
    <name>name1</name>
</balance> <balance>
    <amount>50</amount>
    <sms_user_id>xxx</sms_user_id>
    <name> name2</name>
</balance> </balances>
</getBlanceSubs>

JSON

{
  "status": 0,
  "message": "",
  "balances": [
    {
      "amount": "80",
      "sms_user_id": "XXXX",
      "name": "name1"
    },
    {
      "amount": "50",
      "sms_user_id": "XXXX",
      "name": "name2"
    }
  ]
}

Get birthday campaignsRequires activation

POSThttps://app.ileads.co.il/api<get_birthday_campaigns>

Get the birthday campaigns (automatic messages sent on the recipient’s birthday).

Available on accounts where it has been enabled. Contact us to enable it.

Parameters

Name	Type	Description
`get_birthday_campaigns`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.

All status codes

Request

XML

<?xml version="1.0" encoding="UTF-8"?>
<get_birthday_campaigns>
    <user>
        <username>my_username</username>
    </user>
</get_birthday_campaigns>

JSON

{
  "get_birthday_campaigns": {
    "user": {
      "username": "my_username"
    }
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <message></message>
    <birthday_campaigns>
        <birthday_campaign>
            <CAMPAIGN_ID>XXXX</CAMPAIGN_ID>
            <CAMPAIGN_NAME>XXXX</CAMPAIGN_NAME>
            <CREATED_ON>18/10/23 14:40:39</CREATED_ON>
            <ACTIVE_DESTINATIONS>X</ACTIVE_DESTINATIONS>
        </birthday_campaign>
        <birthday_campaign>
            <CAMPAIGN_ID>XXXX</CAMPAIGN_ID>
            <CAMPAIGN_NAME>XXXX</CAMPAIGN_NAME>
            <CREATED_ON>18/10/23 14:40:39</CREATED_ON>
            <ACTIVE_DESTINATIONS>X</ACTIVE_DESTINATIONS>
        </birthday_campaign>
    </birthday_campaigns>
</sms>

JSON

{
  "status": 0,
  "message": "",
  "birthday_campaigns": {
    "birthday_campaign": [
      {
        "CAMPAIGN_ID": "xxxxx",
        "CAMPAIGN_NAME": "xxxxx",
        "CREATED_ON": "",
        "ACTIVE_DESTINATIONS": ""
      },
      {
        "CAMPAIGN_ID": "xxxxx",
        "CAMPAIGN_NAME": "xxxxx",
        "CREATED_ON": "",
        "ACTIVE_DESTINATIONS": ""
      }
    ]
  }
}

Edit birthday campaignRequires activation

POSThttps://app.ileads.co.il/api<edit_birthday_campaign>

Update the message of a birthday campaign.

Available on accounts where it has been enabled. Contact us to enable it.

Parameters

Name	Type	Description
`edit_birthday_campaign`required	object	Root element. Contains all other elements.
`user`required	object	Contains the user element.
`username`required	string	The username of the account by which you are recognized in the system.
`campaign_id`required	string	The campaign ID to edit.
`message`required	string	The new message.

All status codes

Request

XML

<?xml version='1.0' encoding='UTF-8'?>
<edit_birthday_campaign>
    <user>
        <username>XXXX</username>
    </user>
    <campaign_id>XXXX</campaign_id>
    <message>XXXX</message>
</edit_birthday_campaign>

JSON

{
  "edit_birthday_campaign": {
    "user": {
      "username": "my_username"
    },
    "campaign_id": "XXXX",
    "message": "XXXX"
  }
}

cURL

PHP

Python

Node.js

Response

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <message>birthday campaign successfully updated</message>
</sms>

JSON

{
  "status": 0,
  "message": "birthday campaign successfully updated"
}

Error codes

The value returned in the status field of every response.

Code	Meaning
`0`	Success. The message field varies by action, e.g. "SMS will be sent".
`1`	There was a problem parsing your XML.
`2`	A required field is missing. The message field names the missing field.
`3`	Username or password is incorrect and the API token is invalid.
`4`	Not enough credit.
`5`	No permission to send SMS at this time.
`6`	Process failure.
`7`	You cannot send in this format – send a group using bulk. Contact support for details.
`8`	All numbers are on a blocked list.
`9`	At least one of the destinations is too short or too long.
`10`	Username or password is incorrect and the API token has expired.
`11`	The API token is valid but doesn’t match the username, or a newer token exists and should be used instead.
`12`	When sending SMS: not enough money. When validating an OTP code: unverified code.
`502`	Action type not valid.
`503`	Username does not exist in your account.
`504`	Current token not found.
`510`	Invalid verify_phone request – no phones to verify.
`511`	You don’t have permission for this function.
`515`	Unverified source. See “Verify a sender number”.
`517`	A push URL already exists for this type.
`714`	Invalid content in parameter temp_bl.
`715`	All numbers have been temporarily blocked.
`933`	Phone or reason not valid.
`944`	Some of the numbers are not in the blacklist.
`955`	Campaign already cancelled.
`966`	Campaign already sent.
`970`	Campaigns were not cancelled. Contact support.
`977`	Campaign does not belong to the customer or does not exist.
`980`	Invalid link.
`981`	Error creating hash.
`986`	Add unsubscribe error – invalid value.
`988`	The contact list entered does not exist.
`989`	The message is too long or too short, or the campaign name is too long.
`990`	Amount must be smaller than your credits.
`991`	The amount must contain only digits.
`992`	The source is too long or too short.
`993`	The password is too long or too short.
`994`	Username already exists.
`995`	The username is too long or too short.
`996`	The name is too long or too short.
`997`	Not a valid command sent.
`998`	There was an unknown error in the request.
`999`	Contact support.

DLR statuses

The value returned in the status field of each transaction in delivery reports and pushes.

Status	Meaning
`-1`	Sent – no delivery confirmation
`0`	Delivered
`1`	Failed
`2`	Timeout
`3`	Failed
`4`	Failed – cellular
`5`	Failed
`6`	Failed
`7`	No balance
`14`	Failed – cellular, after store & forward
`15`	Kosher number
`16`	No permission for this sending time
`17`	Blocked for advertising messages
`18`	Invalid message
`101`	Not delivered
`102`	Delivered
`103`	Expired
`104`	Deleted
`105`	Not delivered
`106`	Not delivered
`107`	Not delivered
`108`	Rejected
`109–132`	Not delivered
`201`	Blocked by request
`747`	Subscriber is outside local network coverage
`998`	No permission
`999`	Unknown error