function telecoms.soundclip

NTS Telephony Soundclip Functions

Soundclips are small soundfiles to play audio into a call. They are used in a number of different places, eg IVR prompts, callee whispers, caller messages etc.

When you create a soundclip with telecoms.soundclip.create the API returns a soundclipID which you can then use to reference the soundclip.

Soundclips can be assigned roles, see telecoms.soundclip.roletype.list to get a list of types. In order to be used, a soundclip must have the appropriate role assigned to it. Roles are a useful way to filter your list of soundclips. For example, you wouldn't necessarily want to sift through all of your caller announcements (eg "Thank you for calling X", etc) in order to choose a soundclip to play to a callee (which might say "This call has been brought to you by X").

Functions

telecoms.soundclip.createUpload a new soundclip
telecoms.soundclip.editEdit an existing soundclip
telecoms.soundclip.getDownload the soundclip audio
telecoms.soundclip.listList your soundclips
telecoms.soundclip.deleteDelete a soundclip
 
telecoms.soundclip.roletype.listShow a list of soundclip roles