Sidebar Menu

NotifyMultiplePhoneBasicWithCPMandReferenceID

Use this method to call multiple phone numbers in the US/Canada and read the value of TextToSay to them. Additionally, you can use the CallsPerMinute and ReferenceID parameters.

Syntax

NotifyMultiplePhoneBasicWithCPM(PhoneNumbersToDial, TextToSay, CallerID, CallerIDName, VoiceID, CallsPerMinute, LicenseKey)

Request Parameters

Parameter Name Description Data Type Required Sample Value
PhoneNumbersToDial

The phone numbers to call. Separate each number with a semicolon.

String 9135550101; 9135550102; 9135550104
TextToSay

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

String 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
CallsPerMinute

The value to set the calls per minute.

Integer 50
ReferenceID

Unique ID that can be set.

String 123
LicenseKey

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

String F01d89fd-5155-5455-5585-e84ab8de8591

Response

Returns: Array of NotifyReturn objects

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 System.Threading.Tasks;
using NotifyMultiplePhoneBasicWithCPMandReferenceID.WSDL;

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

            Array Notifications = PN.NotifyMultiplePhoneBasicWithCPMandReferenceID("17575449510;18009843710", "Hello, this is a test.", "17575551234", "CDYNE", "0", 1, "123", "YOUR LICENSE KEY");

            foreach (WSDL.NotifyReturn Info in Notifications)
            {
                Console.WriteLine(
                    "QueueID: " + Info.QueueID + "\n" +
                    "Response Code: " + Info.ResponseCode + "\n" +
                    "Response Text: " + Info.ResponseText + "\n"
                );
            }

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

Imports NotifyMultiplePhoneBasicWithCPMandRefD.WSDL
Module Module1

    Sub Main()

        Dim PN As New WSDL.PhoneNotify
        Dim Notifications As Array

        Notifications = PN.NotifyMultiplePhoneBasicWithCPMandReferenceID("17575449510;18009843710", "Hello, this is a test.", "17575551234", "CDYNE", "0", 1, "123", "YOUR LICENSE KEY")

        For Each Info As WSDL.NotifyReturn In Notifications

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

        Next

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

PhoneNumbersToDial=string&TextToSay=string&CallerID=string&CallerIDname=string&VoiceID=string&CallsPerMinute=string&ReferenceID=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"?>
<ArrayOfNotifyReturn xmlns="http://ws.cdyne.com/NotifyWS/">
  <NotifyReturn>
    <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>
  <NotifyReturn>
    <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>
</ArrayOfNotifyReturn>
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/NotifyMultiplePhoneBasicWithCPMandReferenceID"

<?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>
    <NotifyMultiplePhoneBasicWithCPMandReferenceID xmlns="http://ws.cdyne.com/NotifyWS/">
      <PhoneNumbersToDial>string</PhoneNumbersToDial>
      <TextToSay>string</TextToSay>
      <CallerID>string</CallerID>
      <CallerIDname>string</CallerIDname>
      <VoiceID>string</VoiceID>
      <CallsPerMinute>int</CallsPerMinute>
      <ReferenceID>string</ReferenceID>
      <LicenseKey>string</LicenseKey>
    </NotifyMultiplePhoneBasicWithCPMandReferenceID>
  </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>
    <NotifyMultiplePhoneBasicWithCPMandReferenceIDResponse xmlns="http://ws.cdyne.com/NotifyWS/">
      <NotifyMultiplePhoneBasicWithCPMandReferenceIDResult>
        <NotifyReturn>
          <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 xsi:nil="true" />
            <Variable xsi:nil="true" />
          </VariableArray>
        </NotifyReturn>
        <NotifyReturn>
          <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 xsi:nil="true" />
            <Variable xsi:nil="true" />
          </VariableArray>
        </NotifyReturn>
      </NotifyMultiplePhoneBasicWithCPMandReferenceIDResult>
    </NotifyMultiplePhoneBasicWithCPMandReferenceIDResponse>
  </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>
    <NotifyMultiplePhoneBasicWithCPMandReferenceID xmlns="http://ws.cdyne.com/NotifyWS/">
      <PhoneNumbersToDial>string</PhoneNumbersToDial>
      <TextToSay>string</TextToSay>
      <CallerID>string</CallerID>
      <CallerIDname>string</CallerIDname>
      <VoiceID>string</VoiceID>
      <CallsPerMinute>int</CallsPerMinute>
      <ReferenceID>string</ReferenceID>
      <LicenseKey>string</LicenseKey>
    </NotifyMultiplePhoneBasicWithCPMandReferenceID>
  </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>
    <NotifyMultiplePhoneBasicWithCPMandReferenceIDResponse xmlns="http://ws.cdyne.com/NotifyWS/">
      <NotifyMultiplePhoneBasicWithCPMandReferenceIDResult>
        <NotifyReturn>
          <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 xsi:nil="true" />
            <Variable xsi:nil="true" />
          </VariableArray>
        </NotifyReturn>
        <NotifyReturn>
          <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 xsi:nil="true" />
            <Variable xsi:nil="true" />
          </VariableArray>
        </NotifyReturn>
      </NotifyMultiplePhoneBasicWithCPMandReferenceIDResult>
    </NotifyMultiplePhoneBasicWithCPMandReferenceIDResponse>
  </soap12:Body>
</soap12:Envelope>