QUERY SOUND META

Lists sounds available for use in calls

This operation returns a list of sound metadata that includes id, status, name, length, among other. It only returns metadata, not the actual sound data. The raw binary sound data can be obtained using the GetSoundData method.

REQUEST PARAMETERS

Parameter	Data Type	Demo Value	Description
QuerySoundMeta	object		SoundMeta request by query
MaxResults	long	1000	Max number of results to return limited to 1000 (default: 1000)
FirstResult	long	0	Start of next result set (default: 0)

RESPONSE PARAMETERS

Parameter	Data Type	Description
SoundMetaQueryResult		List of SoundMeta returned from query
TotalResults	long	Results count
SoundMeta		Sounds are prerecorded audio stored on CallFire, and made available for use in voice broadcasts and IVRs.
Id	long
Status	SoundStatus	[PENDING, ACTIVE, FAILED, ARCHIVED]
Name	string	Name of sound meta
Created	dateTime	DateTime when sound was created
LengthInSeconds	int	Duration of stored sound in seconds

EXAMPLE

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string QuerySoundMeta()
        {
            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest("call/sound", Method.GET);
            request.AddParameter("MaxResults", "3");
            request.AddParameter("FirstResult", "5");

            var response = client.Execute(request);
            string content = response.Content;
            return content;
        }
    }
}

The XML returned is:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<r:ResourceList xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource" totalResults="131">

    <SoundMeta id="658741003">

       <Status>ACTIVE</Status>

       <Name>My API Test Sound'</Name>

       <Created>2014-12-17T14:06:11Z</Created>

       <LengthInSeconds>210</LengthInSeconds>

    </SoundMeta>

</r:ResourceList>