Sidebar Menu

NotifyPhoneBasicWithTransfer

Use this method to call any phone number in the US/Canada and read the value of TextToSay to that phone number. It also allows you to transfer a call by pressing 0.

Syntax

NotifyPhoneBasicWithTransfer(PhoneNumberToDial, TransferNumber, TextToSay, CallerID, CallerIDName, VoiceID, LicenseKey)

Request Parameters

Parameter Name Description Data Type Required Sample Value
PhoneNumberToDial

The phone number to call. It can be in any format, as long as there are 10 digits. To dial an extension, add "x" followed by the extension.

String True 9135550101
TransferNumber

The phone number that the call will be transferred to if the call recipient presses 0. Transfer behavior can be further modified with TextToSay commands.

String 7575449515
TextToSay

The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.

String True Hello, this is a sample call from Phone Notify.
CallerID

The number to display on the receiving party's Caller ID.

String 7575449510
CallerIDName

The name to display on the receiving party's Caller ID. (Not commonly used, because most carriers will use their own directory assistance to display name information.)

String CDYNE Corporation
VoiceID

The text-to-speech voice ID.

String 2
LicenseKey

Your license key, which is required to invoke this web service.

String True F01d89fd-5155-5455-5585-e84ab8de8591

Response

Returns: NotifyReturn object

Code Samples

/* https://ws.cdyne.com/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 NotifyPhoneBasicWithTransfer.WSDL;

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

            NR = PN.NotifyPhoneBasicWithTransfer("17575449510", "18009843710", "Hello, this is a test.", "17575551234", "CDYNE Test", "0", "YOUR LICENSE KEY");

            Console.WriteLine(
                "QueueID: " + NR.QueueID + "\n" +
                "Response Code: " + NR.ResponseCode + "\n" +
                "Response Text: " + NR.ResponseText
            );

            Console.ReadLine();
        }
    }
}
' https://ws.cdyne.com/notifyws/phonenotify.asmx?wsdl was added as a Web Reference and given the name WSDL

Imports NotifyPhoneBasicWithTransfer.WSDL
Module Module1

    Sub Main()

        Dim PN As New WSDL.PhoneNotify
        Dim NR As New WSDL.NotifyReturn

        NR = PN.NotifyPhoneBasicWithTransfer("17575449510", "18009843710", "Hello, this is a test.", "17575551234", "CDYNE Test", "0", "YOUR LICENSE KEY")

        Console.WriteLine("QueueID: " & NR.QueueID & vbLf &
                        "Response Code: " & NR.ResponseCode & vbLf &
                        "Response Text: " & NR.ResponseText & vbLf)

        Console.ReadLine()

    End Sub

End Module
Dim request, oXMLHttp, url
url = "http://ws.cdyne.com/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>" & _
"<NotifyPhoneBasicWithTransfer xmlns=""http://ws.cdyne.com/NotifyWS/"">" & _
"<PhoneNumberToDial>17575449510</PhoneNumberToDial>" & _
"<TransferNumber>18009843710</TransferNumber>" & _
"<TextToSay>Hello, this is a test.</TextToSay>" & _
"<CallerID>15551234567</CallerID>" & _
"<CallerIDname>CDYNE</CallerIDname>" & _
"<VoiceID>1</VoiceID>" & _
"<LicenseKey>YOUR LICENSE KEY</LicenseKey>" & _
"</NotifyPhoneBasicWithTransfer>" & _
"</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 NotifyPhoneBasicWithTransfer {
    public static void main(String[] args) {
        try {
            URL url = new URL("http://ws.cdyne.com/NotifyWS/PhoneNotify.asmx/NotifyPhoneBasicWithTransfer?"
                            + "PhoneNumberToDial=17575449510" + "&TransferNumber=17575449510"
                            + "&TextToSay=JAVA+Test" + "&CallerID=18009843710" + "&CallerIDname=TEST"
                            + "&VoiceID=1" + "&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/NotifyPhoneBasicWithTransfer?PhoneNumberToDial=string&TransferNumber=string&TextToSay=string&CallerID=string&CallerIDname=string&VoiceID=string&LicenseKey=string HTTP/1.1
Host: ws.cdyne.com
POST /NotifyWS/PhoneNotify.asmx/NotifyPhoneBasicWithTransfer HTTP/1.1
Host: ws.cdyne.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

PhoneNumberToDial=string&TransferNumber=string&TextToSay=string&CallerID=string&CallerIDname=string&VoiceID=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"?>
<NotifyReturn xmlns="http://ws.cdyne.com/NotifyWS/">
  <ResponseCode>int</ResponseCode>
  <ResponseText>string</ResponseText>
  <CallAnswered>boolean</CallAnswered>
  <QueueID>long</QueueID>
  <TryCount>int</TryCount>
  <Demo>boolean</Demo>
  <DigitsPressed>string</DigitsPressed>
  <MachineDetection>string</MachineDetection>
  <Duration>int</Duration>
  <StartTime>dateTime</StartTime>
  <EndTime>dateTime</EndTime>
  <MinuteRate>decimal</MinuteRate>
  <Country>string</Country>
  <CallComplete>boolean</CallComplete>
  <TextToSay>string</TextToSay>
  <VariableArray>
    <Variable>
      <VariableName>string</VariableName>
      <VariableValue>string</VariableValue>
    </Variable>
    <Variable>
      <VariableName>string</VariableName>
      <VariableValue>string</VariableValue>
    </Variable>
  </VariableArray>
</NotifyReturn>
POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.cdyne.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.cdyne.com/NotifyWS/NotifyPhoneBasicWithTransfer"

<?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>
    <NotifyPhoneBasicWithTransfer xmlns="http://ws.cdyne.com/NotifyWS/">
      <PhoneNumberToDial>string</PhoneNumberToDial>
      <TransferNumber>string</TransferNumber>
      <TextToSay>string</TextToSay>
      <CallerID>string</CallerID>
      <CallerIDname>string</CallerIDname>
      <VoiceID>string</VoiceID>
      <LicenseKey>string</LicenseKey>
    </NotifyPhoneBasicWithTransfer>
  </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>
    <NotifyPhoneBasicWithTransferResponse xmlns="http://ws.cdyne.com/NotifyWS/">
      <NotifyPhoneBasicWithTransferResult>
        <ResponseCode>int</ResponseCode>
        <ResponseText>string</ResponseText>
        <CallAnswered>boolean</CallAnswered>
        <QueueID>long</QueueID>
        <TryCount>int</TryCount>
        <Demo>boolean</Demo>
        <DigitsPressed>string</DigitsPressed>
        <MachineDetection>string</MachineDetection>
        <Duration>int</Duration>
        <StartTime>dateTime</StartTime>
        <EndTime>dateTime</EndTime>
        <MinuteRate>decimal</MinuteRate>
        <Country>string</Country>
        <CallComplete>boolean</CallComplete>
        <TextToSay>string</TextToSay>
        <VariableArray>
          <Variable>
            <VariableName>string</VariableName>
            <VariableValue>string</VariableValue>
          </Variable>
          <Variable>
            <VariableName>string</VariableName>
            <VariableValue>string</VariableValue>
          </Variable>
        </VariableArray>
      </NotifyPhoneBasicWithTransferResult>
    </NotifyPhoneBasicWithTransferResponse>
  </soap:Body>
</soap:Envelope>
POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.cdyne.com
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>
    <NotifyPhoneBasicWithTransfer xmlns="http://ws.cdyne.com/NotifyWS/">
      <PhoneNumberToDial>string</PhoneNumberToDial>
      <TransferNumber>string</TransferNumber>
      <TextToSay>string</TextToSay>
      <CallerID>string</CallerID>
      <CallerIDname>string</CallerIDname>
      <VoiceID>string</VoiceID>
      <LicenseKey>string</LicenseKey>
    </NotifyPhoneBasicWithTransfer>
  </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>
    <NotifyPhoneBasicWithTransferResponse xmlns="http://ws.cdyne.com/NotifyWS/">
      <NotifyPhoneBasicWithTransferResult>
        <ResponseCode>int</ResponseCode>
        <ResponseText>string</ResponseText>
        <CallAnswered>boolean</CallAnswered>
        <QueueID>long</QueueID>
        <TryCount>int</TryCount>
        <Demo>boolean</Demo>
        <DigitsPressed>string</DigitsPressed>
        <MachineDetection>string</MachineDetection>
        <Duration>int</Duration>
        <StartTime>dateTime</StartTime>
        <EndTime>dateTime</EndTime>
        <MinuteRate>decimal</MinuteRate>
        <Country>string</Country>
        <CallComplete>boolean</CallComplete>
        <TextToSay>string</TextToSay>
        <VariableArray>
          <Variable>
            <VariableName>string</VariableName>
            <VariableValue>string</VariableValue>
          </Variable>
          <Variable>
            <VariableName>string</VariableName>
            <VariableValue>string</VariableValue>
          </Variable>
        </VariableArray>
      </NotifyPhoneBasicWithTransferResult>
    </NotifyPhoneBasicWithTransferResponse>
  </soap12:Body>
</soap12:Envelope>