SetIncomingCallScript

Use this method to update the call script for incoming calls to a particular number. You must have incoming phone numbers set by Esendex.

Syntax

SetIncomingCallScript(PhoneNumber, Script, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumber	Your incoming phone number, as set up by Esendex.	`String`	True	8005551234
Script	The text-to-speech text or combination of text-to-speech and script for inbound phone call.	`String`	True	Hello. Welcome to Esendex.
LicenseKey	Your license key, which is required to invoke this web service.	`String`	True	F01d89fd-5155-5455-5585-e84ab8de8591

Response

Returns: Boolean

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

Code Samples

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

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using SetIncomingScript.WSDL;

namespace SetIncomingScript
{
    class Program
    {
        static void Main(string[] args)
        {
            WSDL.PhoneNotify PN = new WSDL.PhoneNotify();

            bool Script = PN.SetIncomingCallScript("18885551234", @"Hello, this is a test. ~\EndCall()~ ~\Label(AMD)~ Hello, this is a test. ~\EndCall()", "YOUR LICENSE KEY");

            Console.WriteLine("Incoming Call Script Set: " + Script);

            Console.ReadLine();
        }
    }
}

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

Imports SetIncomingCallScript.WSDL
Module Module1

    Sub Main()

        Dim PN As New WSDL.PhoneNotify
        Dim Script As Boolean

        Script = PN.SetIncomingCallScript("18885551234", "Hello, this is a test. ~\EndCall()~ ~\Label(AMD)~ Hello, this is a test. ~\EndCall()", "YOUR LICENSE KEY")

        Console.WriteLine("Incoming Call Script Set: " & Script)

        Console.ReadLine()

    End Sub

End Module

Dim request, oXMLHttp, url
url = "http://ws.esendex.us/NotifyWS/PhoneNotify.asmx"

request = "<?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=""http://ws.esendex.us/NotifyWS/"">" & _
"<PhoneNumber>18885551234</PhoneNumber>" & _
"<Script>Hello, this is a test.</Script>" & _
"<LicenseKey>YOUR LICENSE KEY</LicenseKey>" & _
"</SetIncomingCallScript>" & _
"</soap:Body>" & _
"</soap:Envelope>"

Set oXMLHttp = CreateObject("MSXML2.ServerXMLHTTP")
oXMLHttp.open "POST", url, False
oXMLHttp.setRequestHeader "Content-Type", "text/xml; charset=utf-8"
oXMLHttp.send request
response = oXMLHttp.responseText

MsgBox oXMLHTTP.responseText

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("http://ws.esendex.us/NotifyWS/PhoneNotify.asmx/SetIncomingCallScript?"
                            + "PhoneNumber=17575449510" + "&Script=Testing+incoming+call+script."
                            + "&LicenseKey=f01d89fd-5155-5455-5585-e84ab8de8591");
            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) {
        }
    }
}

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

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

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

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

POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://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="http://ws.esendex.us/NotifyWS/">
      <PhoneNumber>string</PhoneNumber>
      <Script>string</Script>
      <LicenseKey>string</LicenseKey>
    </SetIncomingCallScript>
  </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>
    <SetIncomingCallScriptResponse xmlns="http://ws.esendex.us/NotifyWS/">
      <SetIncomingCallScriptResult>boolean</SetIncomingCallScriptResult>
    </SetIncomingCallScriptResponse>
  </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>
    <SetIncomingCallScript xmlns="http://ws.esendex.us/NotifyWS/">
      <PhoneNumber>string</PhoneNumber>
      <Script>string</Script>
      <LicenseKey>string</LicenseKey>
    </SetIncomingCallScript>
  </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>
    <SetIncomingCallScriptResponse xmlns="http://ws.esendex.us/NotifyWS/">
      <SetIncomingCallScriptResult>boolean</SetIncomingCallScriptResult>
    </SetIncomingCallScriptResponse>
  </soap12:Body>
</soap12:Envelope>