GetMultipleQueueIdStatus

This method retrieves the statuses of one or more calls.

Syntax

GetMultipleQueueIdStatus(QueueIDs, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
QueueIDs	One or more call IDs, as returned from any `Notify*` operation. Separate the IDs with semicolons.	`String`	True	4093249; 4093250; 4093251
LicenseKey	Your license key.	`String`	True	00000000-0000-0000-0000-000000000000

Response

Returns: Array of NotifyReturn objects

Code Samples

You can use any programming language you want with our API, as long as it can make a REST or SOAP call. Here are examples for some of the most common platforms.

C#
Java
Python
GET Request
POST Request
SOAP 1.1 Request
SOAP 1.1 Response
SOAP 1.2 Request
SOAP 1.2 Response
XML Response

C#

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

using WSDL;

var client = new PhoneNotifySoapClient(PhoneNotifySoapClient.EndpointConfiguration.PhoneNotifySoap);
var queueIds = "4093249; 4093250; 4093251";
var calls = await client.GetMultipleQueueIdStatusAsync(queueIds, YOUR_LICENSE_KEY);

Console.WriteLine($"{calls.Length} calls were found.");

foreach (var call in calls)
{
    Console.WriteLine(Environment.NewLine +
        "QueueID: " + call.QueueID + Environment.NewLine +
        "Response Code: " + call.ResponseCode + Environment.NewLine +
        "Response Text: " + call.ResponseText
    );
}

Java

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("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/GetMultipleQueueIdStatus?"
                            + "QueueIDs=000111222;333444555"
                            + "&LicenseKey=00000000-0000-0000-0000-000000000000");
            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) {
        }
    }
}

Python

import zeep

client = zeep.Client(wsdl="https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl")
queue_ids = "4093249; 4093250; 4093251"
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.GetMultipleQueueIdStatus(queue_ids, license_key)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/GetMultipleQueueIdStatus?QueueIDs=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us

POST Request

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

SOAP 1.1 Request

POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://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="https://ws.esendex.us/NotifyWS/">
      <QueueIDs>string</QueueIDs>
      <LicenseKey>string</LicenseKey>
    </GetMultipleQueueIdStatus>
  </soap:Body>
</soap:Envelope>

SOAP 1.1 Response

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="https://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>

SOAP 1.2 Request

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

SOAP 1.2 Response

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="https://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>

XML Response

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfNotifyReturn xmlns="https://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>

Messaging

Voice

Data Verification

Quick Start

Methods

Types