Sidebar Menu

ScriptList

This method retrieves a list of call scripts available for your license key.

Syntax

ScriptList(IncludeGlobalScripts, LicenseKey)

Request Parameters

Parameter Name Description Data Type Required Sample Value
IncludeGlobalScripts

Whether you want to include Esendex Global Scripts in the returned list.

 Boolean True False
LicenseKey

Your license key.

 String True 00000000-0000-0000-0000-000000000000

Response

Returns: Array of String values

Description: The names of all call scripts that were found.

Code Samples

You can use any programming language you want with our API, as long as it can make a REST or SOAP call. Here are examples for some of the most common platforms.

/* https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl was added as a Service Reference and given the name WSDL */

using WSDL;

var client = new PhoneNotifySoapClient(PhoneNotifySoapClient.EndpointConfiguration.PhoneNotifySoap);
var includeGlobalScripts = false;
var scripts = await client.ScriptListAsync(includeGlobalScripts, YOUR_LICENSE_KEY);

foreach (var script in scripts)
{
    Console.WriteLine(script);
}

import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Properties;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;

public final class ScriptList {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/ScriptList?"
                            + "IncludeGlobalScripts=false"
                            + "&LicenseKey=00000000-0000-0000-0000-000000000000");
            try {
                InputStream in = url.openStream();
                StreamSource source = new StreamSource(in);
                printResult(source);
            } catch (java.io.IOException e) {
                e.printStackTrace();
            }
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }
    }

    private static void printResult(Source source) {
        try {
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            StreamResult sr = new StreamResult(bos);
            Transformer trans = TransformerFactory.newInstance().newTransformer();
            Properties oprops = new Properties();
            oprops.put(OutputKeys.OMIT_XML_DECLARATION, "yes");
            trans.setOutputProperties(oprops);
            trans.transform(source, sr);
            System.out.println("**** Response ******");
            System.out.println(bos.toString());

            bos.close();
            System.out.println();
        } catch (Exception e) {
        }
    }
}

import zeep

client = zeep.Client(wsdl="https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl")
include_global_scripts = False
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.ScriptList(include_global_scripts, license_key)

print(result)

GET /NotifyWS/PhoneNotify.asmx/ScriptList?IncludeGlobalScripts=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us
POST /NotifyWS/PhoneNotify.asmx/ScriptList HTTP/1.1
Host: ws.esendex.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

IncludeGlobalScripts=string&LicenseKey=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfString xmlns="https://ws.esendex.us/NotifyWS/">
  <string>string</string>
  <string>string</string>
</ArrayOfString>
POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://ws.esendex.us/NotifyWS/ScriptList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ScriptList xmlns="https://ws.esendex.us/NotifyWS/">
      <IncludeGlobalScripts>boolean</IncludeGlobalScripts>
      <LicenseKey>string</LicenseKey>
    </ScriptList>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ScriptListResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <ScriptListResult>
        <string>string</string>
        <string>string</string>
      </ScriptListResult>
    </ScriptListResponse>
  </soap:Body>
</soap:Envelope>
POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ScriptList xmlns="https://ws.esendex.us/NotifyWS/">
      <IncludeGlobalScripts>boolean</IncludeGlobalScripts>
      <LicenseKey>string</LicenseKey>
    </ScriptList>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ScriptListResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <ScriptListResult>
        <string>string</string>
        <string>string</string>
      </ScriptListResult>
    </ScriptListResponse>
  </soap12:Body>
</soap12:Envelope>