telecoms.soundclip.get function

Home > telephony > nts > example-scenarios > func.telecoms.soundclip.get

function telecoms.soundclip.get

Returns the details of a single soundclip from the system, including the base64 encoded audio data.

Note: The b64audiodata will not be exactly the same as was originally uploaded. The returned data will be the converted version for use with the telephony equipment. As such it will have been resampled to a low bitrate wav file.

Arguments:

arg	required?	syntax	info
`custID`	N	posint	custID of account whose soundclip you want to get (default is your own account)
`soundclipID`	N	list:posint	identifies the soundclip you want to get

Return values

Upon success, the function will return a single record containing these fields:

soundclipID - the soundclipID
custID - the custID of the owner
created - the date and time the soundclip was first uploaded (does not represent any subsequent edit time/date)
desc - text description of the soundclip
roles - an array listing the roles currently applied to the soundclip
b64audiodata - a base64 encoded string containing the binary audio data stream (you can base64 decode this and save the results to a wav file to listen to it)
audioformat - the audio format of the audio data returned (will usually be "wav")