RenameSoundFile

This method renames a given sound file.

Syntax

RenameSoundFile(SoundFileID, NewSoundFileID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
SoundFileID	The current sound file ID (name).	String	True	hello
NewSoundFileID	The new sound file ID (name). The ID will be converted to lowercase.	String	True	greeting
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if the renaming was successful. False otherwise.

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 soundFileId = "hello";
var newSoundFileId = "greeting";
var renamed = await client.RenameSoundFileAsync(soundFileId, newSoundFileId, YOUR_LICENSE_KEY);

Console.WriteLine("Sound file renamed: " + renamed);

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 RenameSoundFile {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/RenameSoundFile?"
                            + "SoundFileID=test+sound+file" + "&NewSoundFileID=dev+sound+file"
                            + "&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")
sound_file_id = "hello"
new_sound_file_id = "greeting"
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.RenameSoundFile(sound_file_id, new_sound_file_id, license_key)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/RenameSoundFile?SoundFileID=string&NewSoundFileID=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us

POST Request

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

SoundFileID=string&NewSoundFileID=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/RenameSoundFile"

<?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>
    <RenameSoundFile xmlns="https://ws.esendex.us/NotifyWS/">
      <SoundFileID>string</SoundFileID>
      <NewSoundFileID>string</NewSoundFileID>
      <LicenseKey>string</LicenseKey>
    </RenameSoundFile>
  </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>
    <RenameSoundFileResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <RenameSoundFileResult>boolean</RenameSoundFileResult>
    </RenameSoundFileResponse>
  </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>
    <RenameSoundFile xmlns="https://ws.esendex.us/NotifyWS/">
      <SoundFileID>string</SoundFileID>
      <NewSoundFileID>string</NewSoundFileID>
      <LicenseKey>string</LicenseKey>
    </RenameSoundFile>
  </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>
    <RenameSoundFileResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <RenameSoundFileResult>boolean</RenameSoundFileResult>
    </RenameSoundFileResponse>
  </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"?>
<boolean xmlns="https://ws.esendex.us/NotifyWS/">boolean</boolean>