Textme API

https://docs.textme.co.il/
Admin
Textme API provides comprehensive documentation and services for integrating SMS and other...
Tokens:21,156
Snippets:51
Trust Score:6.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### C# Example for Handling Push API Data

Source: https://docs.textme.co.il/sms/push-api

An example in C# demonstrating how to read and decode incoming data from the Push API using `System.IO.StreamReader` and `System.Web.HttpUtility.UrlDecode`.

```csharp
Public async Task<ResponseObject> FuncName()
{
     System.IO.Stream stream = await Request.Content.ReadAsStreamAsync();
     System.IO.StreamReader reader = new System.IO.StreamReader(stream);
     string encodedString = reader.ReadToEnd();
     string decodedString = System.Web.HttpUtility.UrlDecode(encodedString);
     //Do Code Here…. 
     Return ResponseObject
}
```

--------------------------------

### PHP sendSms Example

Source: https://docs.textme.co.il/sms/soap-example

Provides an example of how to send a single SMS message using the TextMe PHP API. It demonstrates creating an Sms object, setting destinations, and calling the sendSms method.

```PHP
$number = '055XXXXXXX';
       $number1 = '052XXXXXXX';
       $message = 'sendSms test';
       $source = 'Test';
       $sms = new Sms();
       $sms->source = $source;
       $sms->message = $message;
       $phone = new Phone();
       $phone->phone = [$number,$number1]
       $phone->id = "externalid1";
       $sms->destinations = $phone;
       $response = $wsclient->sendSms("username","", $sms);
       print_r($response);
```

--------------------------------

### PHP Example for Handling Push API Data

Source: https://docs.textme.co.il/sms/push-api

A PHP example showing how to access POST data received from the Push API, including parameters like `external_id`, `status`, `message`, and `phone`.

```php
public function FuncName()
{
    // get the data from the request
    $external_id = $_POST["external_id"];
    $status = $_POST["status"];
    $he_message = $_POST["he_message"];
    $en_message = $_POST["en_message"];
    $date = $_POST["date"];
    $phone = $_POST["phone"];
    $operaor = $_POST["operaor"];
    $shipment_id = $_POST["shipment_id"];
   //Do Code Here…. 
}
```

--------------------------------

### Java SMS Sending Example

Source: https://docs.textme.co.il/sms/soap-example

Demonstrates how to send an SMS message using Java via an HTTP POST request to the TextMe API. Includes setting up the connection, request properties, and handling the response.

```Java
public class Http {

 public static String post(String urlString,String urlParameters){
 URL url;
 HttpURLConnection connection = null;
 try {

 //Create connection url =
new URL(urlString);
 connection = (HttpURLConnection)url.openConnection();
connection.setRequestMethod("POST");
 connection.setRequestProperty("Content-Type", application/xml");

 connection.setRequestProperty("Accept","text/html");
connection.setRequestProperty("Accept","application/xhtml+xml");
connection.setRequestProperty("Accept","application/xml");
 connection.setRequestProperty("Cache-Control","max-age=0");

 connection.setRequestProperty("Accept-Language", "he-IL");
connection.setRequestProperty("Accept-Language", "en");
connection.setRequestProperty("Accept-Language", "en-US");
 connection.setRequestProperty("Content-Length", "" +
Integer.toString(urlParameters.getBytes().length));
 connection.setUseCaches (false); connection.setDoInput(true);
 connection.setDoOutput(true);

 //Send request
 DataOutputStream wr = new DataOutputStream (
 connection.getOutputStream ()); wr.write(urlParameters.getBytes());
 wr.flush ();
 wr.close ();
 //Get Response
 InputStream is = connection.getInputStream();
 BufferedReader rd = new BufferedReader(new InputStreamReader(is));
 String line;
 StringBuffer response = new StringBuffer(); while((line =
rd.readLine()) != null) {
 response.append(line);
 response.append('\r');
 }
 rd.close();
 return response.toString();
 } catch (Exception e) {
 e.printStackTrace();
return null;
 }
 finally {
 if(connection != null) {
 connection.disconnect();
 }
 }
 }
}
public static void main(String[] args) throws UnsupportedEncodingException {

 String user ="";
 String message =" this is a test message….";
 String url="https://019sms.co.il/api";

 String xml = "<?xml version='1.0' encoding='UTF-8'?>"
 + "<sms>" + "<user>" + "<username>"+user+"</username>" + "</user>" + "<source>DemoAPI</source>" + "<destinations>" + "<phone>0xxxxxxxxx</phone>" + "<phone>0xxxxxxxxx</phone>" + "<phone>0xxxxxxxxx</phone>" + "<phone>0xxxxxxxxx</phone>" + "</destinations>" + "<message>"+ message +"</message>" + "<add_unsubscribe>0</add_unsubscribe>" + "<reponse>0</reponse>" + "</sms>";
String response="";
 response = post(url,xml);
System.out.println(response );


 }
```

--------------------------------

### PHP SMS API Connection Setup

Source: https://docs.textme.co.il/sms/soap-example

Configures the PHP SOAP client to connect to the TextMe SMS API using a provided WSDL URL and authorization token.

```PHP
$url = "https://019sms.co.il/soap?wsdl";
 $access_token=your_API_TOKEN_here';
 // form an array listing the http header
 $httpHeaders = array(
 'http' => array('protocol_version' => 1.1,
 'header' => "Authorization:Bearer " . $access_token . "\r\n",
 ));
 // form a stream context
 $context = stream_context_create($httpHeaders);
 // pass it in an array
 $params = array('stream_context' => $context);
 $wsclient = new SoapClient($url,$params);
```

--------------------------------

### Send SMS with XML (C#)

Source: https://docs.textme.co.il/sms/example

This C# example demonstrates how to send an SMS message via the TextMe API using an XML payload. It shows how to construct the XML request, set up a WebRequest, send the data, and process the response.

```csharp
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Net;
using System.Text; // for class Encoding
using System.IO;
namespace ConsoleApplication1 {
  class Program {
    static void Main(string[] args) {
      String url = "https://019sms.co.il/api";
      String xml = "<?xml version='1.0' encoding='UTF8'?>\n      <sms>\n        <user>\n            <username>xxx</username>\n        </user>\n        <source>019DemoAPI</source>\n        <destinations>\n            <phone>0555555555</phone>\n            <phone>0555555550</phone>\n        </destinations>\n        <message>test</message>\n      </sms>";
      WebRequest webRequest = WebRequest.Create(url);
      webRequest.Method = "POST";
      byte[] bytes = Encoding.UTF8.GetBytes(xml);
      webRequest.ContentType = "application/xml";
      webRequest.ContentLength = (long) bytes.Length;
      Stream requestStream = webRequest.GetRequestStream();
      requestStream.Write(bytes, 0, bytes.Length);
      requestStream.Close();
      WebResponse response = webRequest.GetResponse();
      Stream responseStream = response.GetResponseStream();
      StreamReader streamReader = new StreamReader(responseStream);
      string result = streamReader.ReadToEnd();
      streamReader.Close();
      responseStream.Close();
      response.Close();
      Console.WriteLine(result);
    }
  }
}
```

--------------------------------

### PHP sendBulkSms Example

Source: https://docs.textme.co.il/sms/soap-example

Illustrates sending multiple SMS messages in bulk using the TextMe PHP API. It shows how to create multiple Sms objects and pass them as an array to the sendBulkSms method.

```PHP
$number = '0523961883';
        $number1 = '0523961883';
        $message = 'sendBulkSms test';
        $message1 = 'sendBulkSms test1';
        $source = 'Test';
        $source1 = 'Test1';
        $sms = new Sms();
        $sms1 = new Sms();
        $sms->source = $source;
        $sms->message = $message;
        $sms1->source = $source1;
        $sms1->message = $message1;
        $phone = new Phone();
        $phone1 = new Phone();
        $phone->phone = $number;
        $phone->id = "externalid";
        $phone1->phone = $number1;
        $phone1->id = "externalid1";
        $sms->destinations = $phone;
        $sms1->destinations = $phone1;
        $bulk=array($sms,$sms1);
        $response = $this->wsclient->sendBulkSms("username","", $bulk);
        print_r($response);
```

--------------------------------

### Java SOAP SMS Sending Example

Source: https://docs.textme.co.il/sms/soap-example

This Java code demonstrates how to send SMS messages using the Textme SOAP API. It includes setting up the SOAP request, adding destinations, and handling the response. Ensure you replace placeholder values for token, message, source, and destinations.

```Java
import javax.xml.soap.*;
import java.util.ArrayList;
public class Main {
 public static SOAPElement SMSContainerElem;
 public static SOAPElement sendSMSBodyElem;
 public static void main(String args[]) {
 String soapEndpointUrl = "https://019sms.co.il/soap?wsdl";
 String soapAction = "https://019sms.co.il/soap/";
 String token = ""; // TODO: Enter your token here
 String message = ""; // TODO: Enter the message you wish to send here
 String source = ""; // TODO: Enter your source here
 String username = ""; // TODO: Enter your username here
 ArrayList<String> destinations = new ArrayList<String>();
 //TODO: modify this part to fetch destination from file/db and iterate
//over destinations with loop
 destinations.add("55999xxxx");
 callSoapWebService(soapEndpointUrl, soapAction, username, token, message,
source, destinations);
 }
 private static void createSoapEnvelope(SOAPMessage soapMessage, String
username, String message, String source) throws SOAPException {
 SOAPPart soapPart = soapMessage.getSOAPPart();
 String myNamespace = "xsi";
 String myNamespaceURI = "http://www.w3.org/2001/XMLSchema";
 // SOAP Envelope
 SOAPEnvelope envelope = soapPart.getEnvelope();
 envelope.addNamespaceDeclaration(myNamespace, myNamespaceURI);
 // SOAP Body
 SOAPBody soapBody = envelope.getBody();
 sendSMSBodyElem = soapBody.addChildElement("sendBulkSms");
 SOAPElement usernameElem = sendSMSBodyElem.addChildElement("username");
 usernameElem.addTextNode(username);
 SOAPElement passwordElem = sendSMSBodyElem.addChildElement("password");
 passwordElem.addTextNode("");
 SMSContainerElem = sendSMSBodyElem.addChildElement("sms");

 }
 public static void addDestinationToBulk(String phone, String message, String
source) {
 SOAPElement SMSBodyElem = null;
 try {
 SMSBodyElem = SMSContainerElem.addChildElement("sms");
 SOAPElement destinationsElem = 
SMSBodyElem.addChildElement("destinations");
 SOAPElement innerPhoneElem = 
destinationsElem.addChildElement("phone");
 innerPhoneElem.addTextNode(phone);
 destinationsElem.addChildElement(innerPhoneElem);
 SOAPElement messageElem = SMSBodyElem.addChildElement("message");
 messageElem.addTextNode(message);
 SOAPElement sourceElem = SMSBodyElem.addChildElement("source");
 sourceElem.addTextNode(source);
 SMSContainerElem.addChildElement(SMSBodyElem);
 } catch (SOAPException e) {
 e.printStackTrace();
 }
 }
 private static void callSoapWebService(String soapEndpointUrl, String
soapAction, String username, String token, String message, String
destinations) {
 try {
 // Create SOAP Connection
 SOAPConnectionFactory soapConnectionFactory =
SOAPConnectionFactory.newInstance();
 SOAPConnection soapConnection =
soapConnectionFactory.createConnection();
 // Create SOAP Request
 SOAPMessage soapRequest = createSOAPRequest(soapAction, username,token, message, source);
 for (String destination : destinations) {
 addDestinationToBulk(destination, message, source);
 }
 // Send SOAP Message to SOAP Server
 SOAPMessage soapResponse = soapConnection.call(soapRequest,
soapEndpointUrl);
 // Print the SOAP Response
 System.out.println("Response SOAP Message:");
 soapResponse.writeTo(System.out);
 System.out.println();
 soapConnection.close();
 } catch (Exception e) {
 System.err.println("\nError occurred while sending SOAP Request to
Server!\nMake sure you have the correct endpoint URL and SOAPAction!\n");
 e.printStackTrace();
 }
 }
 private static SOAPMessage createSOAPRequest(String soapAction, String
username, String token, String message, String source) throws Exception {
 MessageFactory messageFactory = MessageFactory.newInstance();
 SOAPMessage soapMessage = messageFactory.createMessage();
 createSoapEnvelope(soapMessage, username, message, source);
 MimeHeaders headers = soapMessage.getMimeHeaders();
 headers.addHeader("SOAPAction", soapAction);
 headers.addHeader("Authorization", "Bearer " + token);
 soapMessage.saveChanges();
 /* Print the request message, just for debugging purposes */
 System.out.println("Request SOAP Message:");
 soapMessage.writeTo(System.out);
 System.out.println("\n");
 return soapMessage;
 }
}

```

--------------------------------

### PHP getDlrReport Example

Source: https://docs.textme.co.il/sms/soap-example

Demonstrates how to retrieve delivery reports for sent SMS messages using the TextMe PHP API. It shows creating a DlrRequest object with message IDs and date ranges.

```PHP
$wsclient = new SoapClient("https://www.019sms.co.il/soap?wsdl",array(
       'encoding' => 'UTF-8'));
       $dlr = new DlrRequest();
       $dlr->id = array("externalid1","externalid2");
       $dlr->from = "01/05/14 00:00";
       $dlr->to = "07/05/14 18:29";
       $response = $wsclient->getDlrReport("username","",$d);
```

--------------------------------

### Get Subscriber Balances API

Source: https://docs.textme.co.il/sms/subscribers

API endpoint to retrieve the balances of all subscribers associated with the authenticated user account. Requires user authentication.

```APIDOC
POST https://my.textme.co.il/api

Parameters:
- getBlanceSubs (object): Contains all other elements.
  - user (object): Contains the user element.
    - username (string): The username of the account by which you are recognized in the system (Required).
```

--------------------------------

### Get Delivery Report SOAP Structure

Source: https://docs.textme.co.il/sms/soap

XML structure for the getDlrReport SOAP request, including username and dlrRequest parameters with fields for id, from, and to.

```XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:soap="https://www.019sms.co.il/soap">
    <soapenv:Header/>
    <soapenv:Body>
        <soap:getDlrReport>
            <username></username>
            <dlrRequest>
                <!--1 or more repetitions:-->
                <id></id>
                <from></from>
                <to></to>
            </dlrRequest>
        </soap:getDlrReport>
    </soapenv:Body>
</soapenv:Envelope>
```

--------------------------------

### Send SMS with XML (Node.js)

Source: https://docs.textme.co.il/sms/example

This Node.js example demonstrates how to send an SMS message using the TextMe API with an XML payload. It utilizes the 'node-fetch' library to make a POST request to the API endpoint with the necessary authentication and message details.

```javascript
const fetch = require('node-fetch');

const sendSmsWithXML = async () => {
    try {
        const endPoint = 'https://019sms.co.il/api';
        const phone = '5xxxxxxxx';
        const userName = 'yours_user_name';
        // get yours access token from https://docs.019sms.co.il/guide/
        const accessToken = 'yours_access_token';
        const source = 'DemoAPI';
        const message = 'This is an example';
        const body = `<?xml version='1.0' encoding='UTF-8'?>
      <sms>
         <user>
           <username>${userName}</username>
        </user>
        <source>${source}</source>
        <destinations>
        <phone>${phone}</phone>
        </destinations>
        <message>${message}</message>
      </sms>`;
        let ans = await fetch(endPoint, {
            method: 'POST',
            body: body,
            headers: {
                'Content-Type': 'application/xml',
                'Authorization': `Bearer ${accessToken}`
            }
        }).catch(function(err) {
            console.error('error in fetch:', err);
            return false;
        });
        ans = await ans.text();
        return ans;
    } catch (err) {
        console.error('error in sendSms:', err);
        return false;
    }
}
```

--------------------------------

### PHP: Send SMS via TextMe API (XML POST)

Source: https://docs.textme.co.il/sms/example

This PHP example demonstrates sending an SMS message using the TextMe API. It constructs an XML payload with user details, source, destinations, and the message content. cURL is used to send this XML data as a POST request, including an Authorization header with an API key. The response is then processed.

```php
<?php
$url = "https://019sms.co.il/api";
$key = 'put_your_API_TOKEN_here';
$xml ="<?xml version='1.0' encoding='UTF-8'?>
      <sms>
         <user>
           <username>Leeroy</username>
        </user>
        <source>DemoAPI</source>
        <destinations>
        <phone id="someid1">5xxxxxxx</phone>
        <phone id="someid2">5xxxxxxx</phone>
        </destinations>
        <message>This is an example</message>
      </sms>";
$CR = curl_init();
curl_setopt($CR, CURLOPT_URL, $url);
curl_setopt($CR, CURLOPT_POST, 1);
curl_setopt($CR, CURLOPT_FAILONERROR, true);
curl_setopt($CR, CURLOPT_POSTFIELDS, $xml);
curl_setopt($CR, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($CR, CURLOPT_HTTPHEADER, array(
 'charset=utf-8',
 'Content-Type: application/xml',
 'Authorization: Bearer ' . $key
 )
);
$result = curl_exec($CR);
$error = curl_error($CR);
if (!empty($error))
 die("Error: " . $error);
else
 $response = new SimpleXMLElement($result);

  
?>
```

--------------------------------

### Send SMS with JSON (Node.js)

Source: https://docs.textme.co.il/sms/example

This Node.js example shows how to send an SMS message using the TextMe API with a JSON payload. It also uses 'node-fetch' for making the API request, sending the message details in a structured JSON format.

```javascript
const sendSmsWithJson = async () => {
    try {
        const endPoint = 'https://019sms.co.il/api';
        const phone = '5xxxxxxxx';
        const userName = 'yours_user_name';
        // get yours access token from https://docs.019sms.co.il/guide/
        const accessToken = 'yours_access_token';
        const source = 'DemoAPI';
        const message = 'This is an example';
        const body = {
            sms: {
                user: {
                    username: userName,
                },
                source: source,
                destinations: {
                    phone: phone
                },
                message: message
            }
        };
        let ans = await fetch(endPoint, {
            method: 'POST',
            body: JSON.stringify(body),
            headers: {
                'Content-Type': 'application/json',
                'Authorization': `Bearer ${accessToken}`
            }
        }).catch(function(err) {
            console.error('error in fetch:', err);
            return false;
        });
        ans = await ans.json();
        // check the errors in https://docs.019sms.co.il/sms/errors-and-status.html
        if(ans.status == 0){
            return true;
        }else{
            return false;
        }
    } catch (err) {
        console.error('error in sendSms:', err);
        return false;
    }
}
```

--------------------------------

### TextMe SMS API - Get Balance

Source: https://docs.textme.co.il/sms/get-balance

This API endpoint allows users to check their remaining SMS or mail balance. It requires authentication via username and specifies the type of balance to retrieve (SMS or mail). The response includes the current balance and status information.

```APIDOC
POST https://my.textme.co.il/api

Parameters:
Name | Type | Description | Required  
---|---|---|---
balance | object | Contains all other elements. | ✔️  
user | object | Contains the user element. | ✔️  
username | string | The username of the account by which you are recognized in the system | ✔️  
type | string | If you want to get mail balance add <type>mail</type> under the balance element. the balance element. If not sent consider as SMS balance | ➖  

Request Example (XML):
<?xml version="1.0" encoding="UTF-8"?>
<balance>
    <user>
        <username>Leeroy</username>
    </user>
    <type>mail</type>
</balance>

Response Example (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>
```

--------------------------------

### PHP: Send SMS via TextMe API (cURL Options)

Source: https://docs.textme.co.il/sms/example

This PHP example shows another way to send an SMS using the TextMe API with cURL. It configures cURL options using `curl_setopt_array`, including the API endpoint, request method (POST), XML payload, and necessary headers like `Content-Type` and `Authorization`. It handles potential cURL errors and outputs the API response.

```php
<?php
$curl = curl_init();
$key = 'put_your_API_TOKEN_here';
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://019sms.co.il/api",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_ENCODING => "",
 CURLOPT_MAXREDIRS => 10,
 CURLOPT_TIMEOUT => 30,
 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "<?xml version='1.0' encoding='UTF-8'?>
 
 <sms>
 <user>
 <username>my_username</username>
 </user>
 <source>sender</source>
 <destinations>
 <phone
id='someid1'>0500123456</phone>
 </destinations>
 <message>test</message>
</sms>",
 CURLOPT_HTTPHEADER => array(
 "Cache-Control: no-cache",
 "Content-Type: application/xml",
 "Authorization: Bearer ". $key
 ),
));
$response = curl_exec($curl);
48
$err = curl_error($curl);
curl_close($curl);
if ($err) {
 echo "cURL Error #:". $err;
} else {
 echo $response;
}

  
?>
```

--------------------------------

### TextMe SMS API: Get Birthday Campaigns

Source: https://docs.textme.co.il/sms/birthday-campaigns

Retrieves a list of birthday campaigns from the TextMe SMS API. Requires user authentication with username.

```APIDOC
POST https://my.textme.co.il/api

Parameters:
- get_birthday_campaigns (object): Contains all other elements. (Required)
  - user (object): Contains the user element. (Required)
    - username (string): The username of the account by which you are recognized in the system. (Required)
```

--------------------------------

### Get Verified Phones API

Source: https://docs.textme.co.il/sms/verify-phone

API to retrieve all verified phone numbers associated with an account. Optionally, it can return verified numbers of users.

```APIDOC
POST https://my.textme.co.il/api

Parameters:
- getVerifiedPhones (object): Contains all other elements.
  - user (object): Contains the user element.
    - username (string): The username of the account by which you are recognized in the system (Required).
  - is_subs (int): If you want to return the verified numbers of your users put 1, if not, do not put the field (Optional).

Request Example (XML):
<?xml version="1.0" encoding="UTF-8"?>
<getVerifiedPhones>
    <user>
        <username>username</username>
    </user>
    <is_subs>1</is_subs>
</getVerifiedPhones>

Response Example (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>
```

--------------------------------

### TextMe SMS API: Get Blacklist

Source: https://docs.textme.co.il/sms/blacklist

Retrieves the list of blocked phone numbers from the TextMe system. Requires username and date range for the report.

```APIDOC
Endpoint:
    POST https://my.textme.co.il/api

Parameters:
Name | Type | Description | Required  
---|---|---|---
blacklist | object | Contains all other elements. | ✔️  
user | object | Contains the user element. | ✔️  
username | string | The username of the account by which you are recognized in the system | ✔️  
from | object | The start date to take the report from. Format : dd/mm/yy hh:mm | ✔️  
to | object | The end date to take the report from. Format : dd/mm/yy hh:mm | ✔️  

Request Example (XML):
    <?xml version="1.0" encoding="UTF-8"?>
<blacklist>
    <user>
        <username>XXXXXX</username>
    </user>
    <from>02/06/15 00:00</from>
    <to>15/12/15 23:59</to>
</blacklist>

Response Example (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>

```

--------------------------------

### Get Delivery Reports by Date (dlrByDate)

Source: https://docs.textme.co.il/sms/reports

Retrieves delivery reports without using external IDs, based on a specified date range. The allowed date range is up to one week.

```APIDOC
POST https://my.textme.co.il/api

Parameters:
- dlrbyDate (object): Contains all other elements.
  - user (object): Contains the user element.
    - username (string): The username of the account.
  - transactions (object): Contains SMS destinations for DLRs.
    - external_id (string): Can contain a value of null.
  - from (object): Start date for DLRs (dd/mm/yy hh:mm).
  - to (object): End date for DLRs (dd/mm/yy hh:mm).

Notes:
- Date range allowed is up to 1 week.
```

--------------------------------

### Get Incoming SMS

Source: https://docs.textme.co.il/sms/reports

Retrieves incoming SMS messages within a specified date range. The allowed date range is from one week up to one year back.

```APIDOC
POST https://my.textme.co.il/api

Parameters:
- incoming (object): Contains all other elements.
  - user (object): Contains the user element.
    - username (string): The username of the account.
  - from (object): Start date for incoming SMS (dd/mm/yy hh:mm).
  - to (object): End date for incoming SMS (dd/mm/yy hh:mm).

Notes:
- Date range allowed is from 1 week up to 1 year back.
```

--------------------------------

### Get Delivery Reports (DLR) Basic

Source: https://docs.textme.co.il/sms/reports

Retrieves delivery reports for submitted SMS messages using external IDs. Supports a date range of up to one week and a maximum of 1000 external IDs per request.

```APIDOC
POST https://my.textme.co.il/api

Parameters:
- dlr (object): Contains all other elements.
  - user (object): Contains the user element.
    - username (string): The username of the account.
  - transactions (object): Contains SMS destinations for DLRs.
    - external_id (string): The ID submitted with the SMS.
  - from (object): Start date for DLRs (dd/mm/yy hh:mm).
  - to (object): End date for DLRs (dd/mm/yy hh:mm).

Notes:
- Date range allowed is up to 1 week.
- Max limit of external_id's per request is 1000.
```

--------------------------------

### Get Contact List by ID API

Source: https://docs.textme.co.il/sms/contact-lists

This API endpoint allows you to retrieve a specific contact list by its ID. It requires authentication and specific parameters to identify the user and the contact list.

```APIDOC
POST https://my.textme.co.il/api

Parameters:
- getCLbyID (object, required): Contains all other elements.
  - user (object, required): Contains the user element.
    - username (string, required): The username of the account by which you are recognized in the system.
  - cl (object, required): Contains contact list elements.
    - id (int, required): Contains the id of the contact list you want to get.

Response Example:
Full description of the response status and message can be found in here:
(Note: Actual XML/JSON response structure not provided in the source text)
```

--------------------------------

### Get Delivery Report

Source: https://docs.textme.co.il/sms/soap

Retrieves delivery report (DLR) data for sent SMS messages. Requires a username and a DlrRequest object. The time range for DLR requests cannot exceed 30 days, and the oldest possible date is 1 year from today.

```Java
DlrResponse dr = getDlrReport("username",dlrRequest);
```

--------------------------------

### Textme SMS API Introduction

Source: https://docs.textme.co.il/sms

This section explains how to use the Textme SMS API. To send an SMS, you need to use an HTTP POST request with an XML/JSON stream. The response will also be in XML/JSON format. All requests must be sent to https://my.textme.co.il/api, with a test environment available at https://my.textme.co.il/api/test. Requests require an API token.

```APIDOC
SMS API Endpoints:
  Production: https://my.textme.co.il/api
  Test: https://my.textme.co.il/api/test

Request Method:
  HTTP POST

Data Format:
  XML/JSON stream for both request and response.

Authentication:
  Requires an API token. Generate one via the provided link.

Key Functionalities:
  - Send SMS
  - Check Balance
  - Retrieve Reports
  - Manage Blacklist
  - Manage Subscribers
  - Manage Contact Lists
  - Cancel Campaigns
  - Verify Phone Numbers
  - SOAP API Integration
  - Push API Integration
  - Error and Status Codes
```

--------------------------------

### Add Subscriber API

Source: https://docs.textme.co.il/sms/subscribers

API endpoint to add a new subscriber to the Textme system. It requires user authentication and subscriber details including name, username, password, and initial credit amount. OTP phone is optional.

```APIDOC
POST https://my.textme.co.il/api

Parameters:
- addSub (object): Contains all other elements.
  - user (object): Contains the user element.
    - username (string): The username of the account by which you are recognized in the system (Required).
  - userDetails (object): Contains the Details elements for the user that you want to add.
    - name (string): Contains the name you want to give the user (Required).
    - username (string): Contains the username you want to give the user (Required).
    - password (string): Contains the password you want to give the user (Required).
    - source (string): Contains the default source you want to give the user (Required).
    - amount (int): Contains the amount of credits you want to give the user (Required).
    - otpPhone (string): Phone number for OTP authentication (Optional).
```

--------------------------------

### PHP SMS Classes Definition

Source: https://docs.textme.co.il/sms/soap-example

Defines the necessary PHP classes for interacting with the TextMe SMS API, including structures for phone numbers, SMS messages, and delivery report requests.

```PHP
class Phones {
    public $phone=[];
}
class Phone {
    public $id;
    public $phone;
    public $cl_id;
}
class Sms {
    public $destinations;
    public $message;
    public $timing;
    public $source;
    public $tag;
    public $add_unsubscribe;
}
class DlrRequest {
    public $id;
    public $from;
    public $to;
}
```

--------------------------------

### Send SMS API Parameters

Source: https://docs.textme.co.il/sms/send-sms

Defines the parameters for sending an SMS message, including sender, recipients, message content, and optional settings like links and scheduling.

```APIDOC
Parameters for Send SMS:

- username (string, required): The username for authentication.
- source (string, required): The sender's phone number (max 11 numeric chars).
- destinations (object, required): Contains destination phone numbers.
  - phone (string, required): Recipient phone number (format: 5xxxxxxx or 05xxxxxxx).
  - id (string, optional): Identifier for tracking delivery reports.
- message (string, required): The SMS message content (max 1005 chars).
- links (object, optional): Contains links to be shortened.
  - link (string, required): The URL to shorten, must have an 'id' attribute.
- timing (string, optional): Scheduled send time (dd/mm/yy hh:mm).
- add_unsubscribe (int, optional): Option to add unsubscribe functionality (3 for link, 2 for SMS reply).
- cl_id (string, optional): ID of the contact list for sending.
- messages (array of objects, required): List of SMS objects (max 2500).
- temp_bl (string, optional): Filter destinations based on recent message history (1-14 days).
- includes_international (int, optional): Flag for international SMS (1 for yes, 0 for no).
- campaign_name (string, optional): Name for campaign reporting (max 50 chars).
```

--------------------------------

### Push DLRs via HTTP POST

Source: https://docs.textme.co.il/sms/push-api

Configure your URL to receive delivery reports via HTTP POST requests. The parameters mimic the XML response structure but are sent as form-urlencoded data.

```apache
http://legalizeit.org?external_id=1234&status=102&he_message=ליעד+הגיע&en_message=Delivered
&date=01/04/14 16:05:05&phone=9725xxxxxxxx&operaor=Telzar&shipment_id=xxxxxxxxx
```

--------------------------------

### Push Incoming SMS via HTTP POST

Source: https://docs.textme.co.il/sms/push-api

Configure your URL to receive incoming SMS messages via HTTP POST requests. The parameters mirror the XML response structure but are sent as form-urlencoded data.

```apache
http://legalize-it.org?message=This+is+a+sample+message&date=01/04/14 16:05:05&phone=9725xxxxxxxx&dest=9725xxxxxxxx
```

--------------------------------

### Push Blacklist Updates via HTTP POST

Source: https://docs.textme.co.il/sms/push-api

Configure your URL to receive blacklist updates via HTTP POST requests. The parameters are based on the XML response structure but sent as form-urlencoded data.

```apache
http://legalize-it.org?message=נחסם+מנוי&date=01/04/14 16:05:05&dest=9725xxxxxxxx
```

--------------------------------

### Textme SMS API Objects

Source: https://docs.textme.co.il/sms/soap

Defines the data structures used within the Textme SMS API for sending messages and retrieving delivery reports.

```java
public class Response {
   int status;
   String message;
}
```

```java
public class Phone {
     int phone;
     String id;
}
```

```java
public class Sms {
  List<Phone> destinations;
  String message;
  String timing;
  String source;
}
```

```java
public class Messages {
   List<Sms> sms;
}
```

```java
public class DlrRequest {
   List<String> id;
   String from;
   String to;
}
```

```java
public class Dlr {
     String id;
     String status;
     String heMessage;
     String enMessage;
     String date;
     int phone;
}
```

```java
public class DlrResponse {
   int status;
   String message;
   List<Dlr> dlrs;
}
```

--------------------------------

### Generate API Token

Source: https://docs.textme.co.il/guide

API endpoint for generating new API tokens or retrieving the current token. Supports both XML and JSON request formats. Requires an existing valid token for authentication.

```APIDOC
POST https://my.textme.co.il/api

Headers:
  Content-Type: application/xml | application/json
  Authorization: Bearer YOUR TOKEN

Parameters:
  user->username (string, required): Admin account username.
  username (string, required): Requested account username.
  action (string, required): "new" to generate a new token, "current" to retrieve the most recent token.

"current" action:
  Retrieves the most recent token. A valid token must be included in the request.

Request Example (XML):
<?xml version='1.0' encoding='UTF-8'?>
<getApiToken>
    <user>
        <username>username</username>
    </user>
    <username>username_for_token</username>
    <action>new</action>
</getApiToken>

Request Example (JSON):
{
    "user": {
        "username": "username"
    },
    "username": "username_for_token",
    "action": "new"
}

Response Example (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>

Response Example (JSON):
{
    "status": 0,
    "message": "0zrjDjZ26Dll5dqdTBmuwwtQg8",
    "expiration_date": "07/06/2025 09:17:34"
}
```

--------------------------------

### Verify Phone Number SOAP Structure

Source: https://docs.textme.co.il/sms/soap

XML structure for the verify_phone SOAP request, including username and a list of phone numbers to verify.

```XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="
https://019sms.co.il/soap">
    <soapenv:Header/>
    <soapenv:Body>
        <soap:verify_phone>
            <username>?</username>
            <phones>
                <!--1 or more repetitions:-->
                <phone>?</phone>
            </phones>
        </soap:verify_phone>
    </soapenv:Body>
</soapenv:Envelope>
```

--------------------------------

### Update Subscriber Wallets API

Source: https://docs.textme.co.il/sms/subscribers

API endpoint to update the credit balance (wallet) of existing subscribers. Requires user authentication and the subscriber's internal username along with the amount to update.

```APIDOC
POST https://my.textme.co.il/api

Parameters:
- updateAmountSub (object): Contains all other elements.
  - user (object): Contains the user element.
    - username (string): The username of the account by which you are recognized in the system (Required).
  - userDetails (object): Contains the elements of the details of the user that you want to update.
    - username (string): (The internal user name) Contains the username you want to update subscriber (Required).
    - amount (int): Contains the amount of credits you want to give the user (Required).
    - amount_int (int): If you want to update the amount of money, You should enter amount you want to give the user without amount tag (Optional).
```

--------------------------------

### Send Bulk SMS SOAP Structure

Source: https://docs.textme.co.il/sms/soap

XML structure for the sendBulkSms SOAP request, detailing the message format including destinations, message content, timing, and source.

```XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:soap="https://www.019sms.co.il/soap">
    <soapenv:Header/>
    <soapenv:Body>
        <soap:sendBulkSms>
            <username></username>
            <sms>
                <!--1 or more repetitions:-->
                <sms>
                    <!--1 or more repetitions:-->
                    <destinations>
                        <!--You may enter the following 2 items in any order-->
                        <phone></phone>
                        <id></id>
                    </destinations>
                    <message></message>
                    <timing></timing>
                    <source></source>
                </sms>
            </sms>
        </soap:sendBulkSms>
    </soapenv:Body>
</soapenv:Envelope>
```

--------------------------------

### Textme SMS API Error Codes

Source: https://docs.textme.co.il/sms/errors-and-status

Details the various error codes returned by the Textme SMS API, explaining the reasons for request failures or invalid operations.

```APIDOC
Error Codes:
0: Successful transaction. Message will be positive.
1: Problem parsing XML.
2: Missing XML field. Message will specify the field.
3: Username/password incorrect and API token invalid.
4: Insufficient credit.
5: No permission to send SMS at this time.
6: Process failure.
7: Invalid format for group sending. Send in 'bulk'.
8: All destinations are on a blocked list.
9: Destination number too short or too long.
10: Username/password incorrect and API token expired.
11: API token valid but mismatched with username, or a newer token should be used.
12: Insufficient funds.
502: Invalid action type.
503: Username does not exist.
504: Current token not found.
510: Invalid verify_phone request: no phones to verify.
511: Insufficient permission for this function.
515: Unverified source.
714: Invalid content in parameter temp_bl.
715: All numbers temporarily blocked.
933: Invalid phone or reason.
944: Some numbers not in blacklist.
955: Campaign already cancelled.
966: Campaign already sent.
970: Campaign not cancelled. Contact support.
977: Campaign does not belong to customer or does not exist.
980: Invalid link.
981: Error creating hash.
986: Error adding unsubscribe - invalid value.
988: Contact list does not exist.
989: Message too long/short OR campaign name too long.
990: Amount must be less than available credits.
991: Amount must contain only digits.
992: Source too long or too short.
993: Password too long or too short.
994: Username already exists.
995: Username too long or too short.
996: Name too long or too short.
997: Invalid command sent.
998: Unknown error in request.
999: Contact support.
```

--------------------------------

### Send SMS Method

Source: https://docs.textme.co.il/sms/soap

Used to send a single SMS message to one or more destinations. The method requires username and an Sms object containing destination details, message content, timing, and source.

```java
Response r = sendSms("username", sms);
```

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:soap="https://www.019sms.co.il/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:sendSms>
<username>?</username>
<sms>
<destinations>
<phone></phone>
<id></id>
</destinations>
<message></message>
<timing></timing>
<source></source>
</sms>
</soap:sendSms>
</soapenv:Body>
</soapenv:Envelope>
```

--------------------------------

### Send SMS with TTS API Parameters

Source: https://docs.textme.co.il/sms/send-sms

Details the parameters for sending voice messages (TTS), extending the SMS API with voice-specific options like speech rate and voice type.

```APIDOC
Endpoint: POST https://my.textme.co.il/api

Parameters for Send SMS with TTS:

- username (string, required): The username for authentication.
- source (string, required): The source phone number for calls (system number).
- destinations (object, required): Contains destination phone numbers.
  - phone (string, required): Recipient phone number (format: 5xxxxxxx or 05xxxxxxx).
- message (string, required): The message content (max 1005 chars).
- tts (object, required): Settings for voice messages.
  - type (int, required): Sending type (2: voice to Kosher, 3: SMS+voice, 4: voice only).
  - rate (int, optional): Speech speed (-10 to 10).
  - repeat (int, optional): Number of message repetitions in call (default: 2).
  - voice (string, optional): Voice type ('ymMale' or 'ymFemale', default: 'ymMale').
```
Tokens:
Raw