Sidebar Menu

GetQueueIDStatusWithAdvancedInfo

This method returns the status of a particular message. This method includes variable information and more.

Syntax

GetQueueIDStatusWithAdvancedInfo(QueueID, LicenseKey)

Request Parameters

Parameter Name Description Data Type Required Sample Value
QueueID

The message's ID, as returned from any Notify operation.

Long True 4093249
LicenseKey

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

String True F01d89fd-5155-5455-5585-e84ab8de8591

Response

Returns: NotifyStatusReturn 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 QueueID_Status_Advanced.WSDL;

namespace QueueID_Status_Advanced
{
    class Program
    {
        static void Main(string[] args)
        {

            WSDL.PhoneNotify PN = new WSDL.PhoneNotify();
            WSDL.NotifyReturn NR = new WSDL.NotifyReturn();

            NR = PN.GetQueueIDStatusWithAdvancedInfo(012345678, "YOUR LICENSE KEY");

            Console.WriteLine(
                "QueueID: " + NR.QueueID + "\n" +
                "Response Code: " + NR.ResponseCode + "\n" +
                "Response Text: " + NR.ResponseText + "\n" +
                "Call Answered: " + NR.CallAnswered + "\n" +
                "Try Count: " + NR.TryCount + "\n" +
                "Demo: " + NR.Demo + "\n" +
                "Digits Pressed: " + NR.DigitsPressed + "\n" +
                "Machine Detection: " + NR.MachineDetection + "\n" +
                "Duration: " + NR.Duration + "\n" +
                "Start Time: " + NR.StartTime + "\n" +
                "End Time: " + NR.EndTime + "\n" +
                "Minute Rate: " + NR.MinuteRate + "\n" +
                "Call Complete: " + NR.CallComplete + " \n" +
                "Text to Say: " + NR.TextToSay
            );

            Console.ReadLine();
        }
    }
}
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>" & _
"<GetQueueIDStatusWithAdvancedInfo xmlns=""http://ws.cdyne.com/NotifyWS/"">" & _
"<QueueID>012345678</QueueID>" & _
"<LicenseKey>YOUR LICENSE KEY</LicenseKey>" & _
"</GetQueueIDStatusWithAdvancedInfo>" & _
"</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 GetQueueIDStatusWithAdvancedInfo {
    public static void main(String[] args) {
        try {
            URL url = new URL("http://ws.cdyne.com/NotifyWS/PhoneNotify.asmx/GetQueueIDStatusWithAdvancedInfo?"
                            + "QueueID=000111222"
                            + "&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/GetQueueIDStatusWithAdvancedInfo?QueueID=string&LicenseKey=string HTTP/1.1
Host: ws.cdyne.com
POST /NotifyWS/PhoneNotify.asmx/GetQueueIDStatusWithAdvancedInfo HTTP/1.1
Host: ws.cdyne.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

QueueID=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/GetQueueIDStatusWithAdvancedInfo"

<?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>
    <GetQueueIDStatusWithAdvancedInfo xmlns="http://ws.cdyne.com/NotifyWS/">
      <QueueID>long</QueueID>
      <LicenseKey>string</LicenseKey>
    </GetQueueIDStatusWithAdvancedInfo>
  </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>
    <GetQueueIDStatusWithAdvancedInfoResponse xmlns="http://ws.cdyne.com/NotifyWS/">
      <GetQueueIDStatusWithAdvancedInfoResult>
        <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>
      </GetQueueIDStatusWithAdvancedInfoResult>
    </GetQueueIDStatusWithAdvancedInfoResponse>
  </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>
    <GetQueueIDStatusWithAdvancedInfo xmlns="http://ws.cdyne.com/NotifyWS/">
      <QueueID>long</QueueID>
      <LicenseKey>string</LicenseKey>
    </GetQueueIDStatusWithAdvancedInfo>
  </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>
    <GetQueueIDStatusWithAdvancedInfoResponse xmlns="http://ws.cdyne.com/NotifyWS/">
      <GetQueueIDStatusWithAdvancedInfoResult>
        <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>
      </GetQueueIDStatusWithAdvancedInfoResult>
    </GetQueueIDStatusWithAdvancedInfoResponse>
  </soap12:Body>
</soap12:Envelope>