ReturnSoundFileIDs

This method retrieves the IDs of all sound files that you can use in your calls.

Syntax

ReturnSoundFileIDs(LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Array of String objects

Description: The IDs of all uploaded or recorded sound files available on your license key.

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 ids = await client.ReturnSoundFileIDsAsync(YOUR_LICENSE_KEY);

Console.WriteLine(ids.Length + " sound files were found.");

foreach (var id in ids)
{
    Console.WriteLine(id);
}

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 ReturnSoundFileIDs {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/ReturnSoundFileIDs?"
                            + "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")
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.ReturnSoundFileIDs(license_key)

print(result)

GET Request

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

POST Request

POST /NotifyWS/PhoneNotify.asmx/ReturnSoundFileIDs HTTP/1.1
Host: ws.esendex.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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/ReturnSoundFileIDs"

<?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>
    <ReturnSoundFileIDs xmlns="https://ws.esendex.us/NotifyWS/">
      <LicenseKey>string</LicenseKey>
    </ReturnSoundFileIDs>
  </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>
    <ReturnSoundFileIDsResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <ReturnSoundFileIDsResult>
        <string>string</string>
        <string>string</string>
      </ReturnSoundFileIDsResult>
    </ReturnSoundFileIDsResponse>
  </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>
    <ReturnSoundFileIDs xmlns="https://ws.esendex.us/NotifyWS/">
      <LicenseKey>string</LicenseKey>
    </ReturnSoundFileIDs>
  </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>
    <ReturnSoundFileIDsResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <ReturnSoundFileIDsResult>
        <string>string</string>
        <string>string</string>
      </ReturnSoundFileIDsResult>
    </ReturnSoundFileIDsResponse>
  </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"?>
<ArrayOfString xmlns="https://ws.esendex.us/NotifyWS/">
  <string>string</string>
  <string>string</string>
</ArrayOfString>