SetIncomingCallScript

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

Syntax

SetIncomingCallScript(PhoneNumber, Script, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumber	Your incoming phone number.	String	True	8005551234
Script	The text-to-speech text or combination of text-to-speech and script to use for inbound phone calls.	String	True	Hello. Welcome to Esendex.
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: Returns true if the operation succeeded, false if not.

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#
• Java
• Python
• GET Request
• POST Request
• SOAP 1.1 Request
• SOAP 1.1 Response
• SOAP 1.2 Request
• SOAP 1.2 Response
• XML Response

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 script = "Hello. Welcome to Esendex.";
var set = await client.SetIncomingCallScriptAsync(YOUR_INCOMING_NUMBER, script, YOUR_LICENSE_KEY);

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

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 SetIncomingCallScript {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/SetIncomingCallScript?"
                            + "PhoneNumber=17575449510" + "&Script=Testing+incoming+call+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")
phone_number = "8005551234"
script = "Hello. Welcome to Esendex."
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.SetIncomingCallScript(phone_number, script, license_key)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/SetIncomingCallScript?PhoneNumber=string&Script=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us

POST Request

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

PhoneNumber=string&Script=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/SetIncomingCallScript"

<?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>
    <SetIncomingCallScript xmlns="https://ws.esendex.us/NotifyWS/">
      <PhoneNumber>string</PhoneNumber>
      <Script>string</Script>
      <LicenseKey>string</LicenseKey>
    </SetIncomingCallScript>
  </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>
    <SetIncomingCallScriptResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <SetIncomingCallScriptResult>boolean</SetIncomingCallScriptResult>
    </SetIncomingCallScriptResponse>
  </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>
    <SetIncomingCallScript xmlns="https://ws.esendex.us/NotifyWS/">
      <PhoneNumber>string</PhoneNumber>
      <Script>string</Script>
      <LicenseKey>string</LicenseKey>
    </SetIncomingCallScript>
  </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>
    <SetIncomingCallScriptResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <SetIncomingCallScriptResult>boolean</SetIncomingCallScriptResult>
    </SetIncomingCallScriptResponse>
  </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>