Sidebar Menu

GetIncomingCallScript

This method retrieves the call script for incoming calls to a given number. (Contact Esendex to enable incoming phone numbers.)

Syntax

GetIncomingCallScript(PhoneNumber, LicenseKey)

Request Parameters

Parameter Name Description Data Type Required Sample Value
PhoneNumber

Your incoming phone number.

String True 8005551234
LicenseKey

Your license key.

String True 00000000-0000-0000-0000-000000000000

Response

Returns: String

Description: The script currently in use for incoming calls to the specified phone number.

Sample:
~\Label(Begin)~
~\ClearDTMF()~
~\ActOnDigitPress(false)~
~\SetVar(Attempt|1)~
Hello. Welcome to Esendex.
Press 1 to speak to a sales representative or press…, etc.
~\EndCall()~

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 script = await client.GetIncomingCallScriptAsync(YOUR_INCOMING_NUMBER, YOUR_LICENSE_KEY);

if (script is null)
{
    Console.WriteLine("Your number has no incoming call script.");
}
else
{
    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 GetIncomingCallScript {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/GetIncomingCallScript?"
                            + "PhoneNumber=17575449510"
                            + "&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")
phone_number = "8005551234"
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.GetIncomingCallScript(phone_number, license_key)

print(result)
GET /NotifyWS/PhoneNotify.asmx/GetIncomingCallScript?PhoneNumber=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us
POST /NotifyWS/PhoneNotify.asmx/GetIncomingCallScript HTTP/1.1
Host: ws.esendex.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

PhoneNumber=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"?>
<string xmlns="https://ws.esendex.us/NotifyWS/">string</string>
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/GetIncomingCallScript"

<?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>
    <GetIncomingCallScript xmlns="https://ws.esendex.us/NotifyWS/">
      <PhoneNumber>string</PhoneNumber>
      <LicenseKey>string</LicenseKey>
    </GetIncomingCallScript>
  </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>
    <GetIncomingCallScriptResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <GetIncomingCallScriptResult>string</GetIncomingCallScriptResult>
    </GetIncomingCallScriptResponse>
  </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>
    <GetIncomingCallScript xmlns="https://ws.esendex.us/NotifyWS/">
      <PhoneNumber>string</PhoneNumber>
      <LicenseKey>string</LicenseKey>
    </GetIncomingCallScript>
  </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>
    <GetIncomingCallScriptResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <GetIncomingCallScriptResult>string</GetIncomingCallScriptResult>
    </GetIncomingCallScriptResponse>
  </soap12:Body>
</soap12:Envelope>