Voice Broadcast API

Voice API
Quick Start Guides
Methods
Types
FAQ

ScriptSave

This method saves a call script.

Syntax

ScriptSave(ScriptName, ScriptText, LicenseKey)

Request Parameters

Parameter NameDescriptionData TypeRequiredSample Value
ScriptNameThe script name. Must be 50 characters or fewer. Using an existing name will overwrite the old script.StringTrueScript1
ScriptTextThe text-to-speech text or combination of text-to-speech and script to be read.StringTrueHello. Welcome to Esendex.
LicenseKeyYour license key.StringTrue00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if the save succeeded. False otherwise.

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.

C#

/* 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 scriptName = "Script1";
var scriptText = "Hello. Welcome to Esendex.";
var saved = await client.ScriptSaveAsync(scriptName, scriptText, YOUR_LICENSE_KEY);

Console.WriteLine("Script was saved: " + saved);

Java

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 ScriptSave {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/ScriptSave?"
                            + "ScriptName=TestScript" + "&ScriptText=This+is+a+test+script."
                            + "&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) {
        }
    }
}

Python

import zeep

client = zeep.Client(wsdl="https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl")
script_name = "Script1"
script_text = "Hello. Welcome to Esendex."
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.ScriptSave(script_name, script_text, license_key)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/ScriptSave?ScriptName=string&ScriptText=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us

POST Request

POST /NotifyWS/PhoneNotify.asmx/ScriptSave HTTP/1.1
Host: ws.esendex.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ScriptName=string&ScriptText=string&LicenseKey=string

SOAP 1.1 Request

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/ScriptSave"

<?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>
    <ScriptSave xmlns="https://ws.esendex.us/NotifyWS/">
      <ScriptName>string</ScriptName>
      <ScriptText>string</ScriptText>
      <LicenseKey>string</LicenseKey>
    </ScriptSave>
  </soap:Body>
</soap:Envelope>

SOAP 1.1 Response

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>
    <ScriptSaveResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <ScriptSaveResult>boolean</ScriptSaveResult>
    </ScriptSaveResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2 Request

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>
    <ScriptSave xmlns="https://ws.esendex.us/NotifyWS/">
      <ScriptName>string</ScriptName>
      <ScriptText>string</ScriptText>
      <LicenseKey>string</LicenseKey>
    </ScriptSave>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.2 Response

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>
    <ScriptSaveResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <ScriptSaveResult>boolean</ScriptSaveResult>
    </ScriptSaveResponse>
  </soap12:Body>
</soap12:Envelope>

XML Response

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

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="https://ws.esendex.us/NotifyWS/">boolean</boolean>

Let’s start sending, together.