NSns-api
Media/Music on Hold/User

Update MOH for Domain from TTS

Changed on
put/domains/{domain}/users/{user}/moh/{index}

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/users/{user}/moh/{index}
  • Auth
    HTTP bearer

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000
indexstring required

Request body

synchronous'yes' | 'no' required

When synchronous is requested with "yes" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 "Accepted" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response.

scriptstring required

This is a simple explanation of what the audio is and can include what is said in the audio file for explanation.

voice_languagestring

This is the language that can be requested when using TTS feature. Leave of to have API lookup configs from the defaults or domain specific configs.

voice_idstring

This value will allow you to select the voice to be used for TTS applications. Value must be valid or will cause errors. leave off request to have the API lookup defaults from system and/or domain.

Example request

{
  "voice_language": "en-US"
}

Response

filenamestring

This is the filename without and path or folder. Should end in .wav

ordinal-orderinteger

This is the index of the audio file.

file-duration-secondsinteger

This value is the length of the file in seconds.

file-size-kilobytesstring

This value will be a formated filesize of the file in kilobytes

created-datetimestring

This is the timestamp of create time fo the file

file-access-urlstring

This will be URL of the file for remote playback.

file-script-textstring

This is the script that was used for text to speech and also used to create a new file.

file-sourcestring

This is the source of the file, it will show how the file was created originally.

text-to-speech-voice-idstring

This is the voice id used when using text to speech.

text-to-speech-languagestring

This is the voice language when using TTS.

FromNamestring
FromUserstring
FromHoststring
NmsAnistring
recorded-datetimestring

This is the timestamp of record time fo the file

NmsRecStartTimestring
NmsRecDurationstring
TimeZonestring
transcriptionstring

Changes

  • bce16087d479Revision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status