Sidebar Menu

GetMultipleQueueIdStatus

This method returns the statuses of multiple notifies (messages).

Syntax

GetMultipleQueueIdStatus(QueueIDs, LicenseKey)

Request Parameters

Parameter Name Description Data Type Required Sample Value
QueueIDs

The messages' IDs, as returned from any Notify operation. Separate the IDs with semicolons.

 String True 4093249; 4093250; 4093251
LicenseKey

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

 String True F01d89fd-5155-5455-5585-e84ab8de8591

Response

Returns: Array of NotifyStatusReturn objects

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

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

            Array Status = PN.GetMultipleQueueIdStatus("012345678; 876543210", "YOUR LICENSE KEY");

            foreach (WSDL.NotifyReturn Info in Status)
            {
                Console.WriteLine(
                    "QueueID: " + Info.QueueID + "\n" +
                    "Response Code: " + Info.ResponseCode + "\n" +
                    "Response Text: " + Info.ResponseText + "\n" +
                    "Call Answered: " + Info.CallAnswered + "\n" +
                    "Try Count: " + Info.TryCount + "\n" +
                    "Demo: " + Info.Demo + "\n" +
                    "Digits Pressed: " + Info.DigitsPressed + "\n" +
                    "Machine Detection: " + Info.MachineDetection + "\n" +
                    "Duration: " + Info.Duration + "\n" +
                    "Start Time: " + Info.StartTime + "\n" +
                    "End Time: " + Info.EndTime + "\n" +
                    "Minute Rate: " + Info.MinuteRate + "\n" +
                    "Call Complete: " + Info.CallComplete + "\n\n"
                );
            }

            Console.ReadLine();
        }
    }
}

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

Imports GetMultipleQueueIdStatus.WSDL
Module Module1

    Sub Main()

        Dim PN As New WSDL.PhoneNotify
        Dim Status As Array

        Status = PN.GetMultipleQueueIdStatus("012345678; 876543210", "YOUR LICENSE KEY")

        If (Status.Length > 0) Then

            For Each Info As WSDL.NotifyReturn In Status

                Console.WriteLine("QueueID: " & Info.QueueID & vbLf &
                                "Response Code: " & Info.ResponseCode & vbLf &
                                "Response Text: " & Info.ResponseText & vbLf &
                                "Call Answered: " & Info.CallAnswered & vbLf &
                                "Try Count: " & Info.TryCount & vbLf &
                                "Demo: " & Info.Demo & vbLf &
                                "Digits Pressed: " & Info.DigitsPressed & vbLf &
                                "Machine Detection: " & Info.MachineDetection & vbLf &
                                "Duration: " & Info.Duration & vbLf &
                                "Start Time: " & Info.StartTime & vbLf &
                                "End Time: " & Info.EndTime & vbLf &
                                "Minute Rate: " & Info.MinuteRate & vbLf &
                                "Call Complete: " & Info.CallComplete & vbLf)
            Next

        Else : Console.WriteLine("No information found.")

        End If

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

QueueIDs=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.esendex.us/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.esendex.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.esendex.us/NotifyWS/GetMultipleQueueIdStatus"

<?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>
    <GetMultipleQueueIdStatus xmlns="http://ws.esendex.us/NotifyWS/">
      <QueueIDs>string</QueueIDs>
      <LicenseKey>string</LicenseKey>
    </GetMultipleQueueIdStatus>
  </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>
    <GetMultipleQueueIdStatusResponse xmlns="http://ws.esendex.us/NotifyWS/">
      <GetMultipleQueueIdStatusResult>
        <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>
      </GetMultipleQueueIdStatusResult>
    </GetMultipleQueueIdStatusResponse>
  </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>
    <GetMultipleQueueIdStatus xmlns="http://ws.esendex.us/NotifyWS/">
      <QueueIDs>string</QueueIDs>
      <LicenseKey>string</LicenseKey>
    </GetMultipleQueueIdStatus>
  </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>
    <GetMultipleQueueIdStatusResponse xmlns="http://ws.esendex.us/NotifyWS/">
      <GetMultipleQueueIdStatusResult>
        <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>
      </GetMultipleQueueIdStatusResult>
    </GetMultipleQueueIdStatusResponse>
  </soap12:Body>
</soap12:Envelope>