Actions477
- Raw Actions
- Access Log Actions
- Addresses Actions
- Create Address Endpoint
- Create Address for Domain
- Create Address for User
- Delete Address Endpoint
- Delete Address for Domain
- Delete Address for User
- Get Address Endpoints for a Domain
- Get Address Using Address ID
- Get Addresses Count for Domain
- Get Addresses for Domain
- Get Addresses for User
- Update Address Endpoint
- Update Address for Domain
- Update Address for User
- Validate Address
- Answer Rules Actions
- Audit Log Actions
- Authentication/Access Token (Oauth - Username/Password) Actions
- Authentication/API Key (Machine 2 Machine) Actions
- Authentication/JWT (JSON Web Token) Actions
- Authentication/User Credentials Actions
- Auto Attendant Actions
- Backup & Restore Actions
- Call Blocking Actions
- Call Center/Agent Actions Actions
- Call Center/Agents Actions
- Call Center/Callqueues Actions
- Call Center/QueuedCalls Actions
- Call Center/Statistics Actions
- Get Abandoned Calls for a Specific Queue
- Get Abandoned Calls for All Queues
- Get Agent Log
- Get Agent Statistics for All Queues by Agent
- Get Agent Statistics for Single Agent
- Get Agent Statistics for Single Queues by Agent
- Get Callqueue Statistics for a Specific Queue
- Get Callqueue Statistics for All Queues Aggregated
- Get Callqueue Statistics for All Queues by Queue
- Get DNIS Statistics for All Queues
- Get DNIS Statistics for Single Queue
- Call Traces & Cradle to Grave Actions
- Calls (live/active calls) Actions
- CDR (Call History) Actions
- CDR Schedule Actions
- Charts Actions
- Conference/Conferences Actions
- Conference/Participants Actions
- Configs/Configuration Definitions Actions
- Configs/Configurations Actions
- Connections (Trunks) Actions
- Contacts Actions
- Contacts/Shared Contacts Actions
- Dashboards Actions
- Departments Actions
- Devices Actions
- Dial Permisions Actions
- Add a New Permission to a Dialpolicy Table
- Add a New Permission to a Dialpolicy Table in Domain
- Create Dialpolicy Table
- Delete a Permission by ID in a Dialpolicy
- Delete a Permission by ID in a Dialpolicy in Domain
- Delete Dialpolicy
- Delete Dialpolicy in Domain
- Read Permissions in a Dialpolicy
- Read Permissions in a Dialpolicy in Domain
- Read Policies
- Read Specific Permission in a Dialpolicy
- Read Specific Permission in a Dialpolicy in Domain
- Read Specific Policy
- Read Specific Policy in Domain
- Update a Permission in a Dialpolicy Table
- Update a Permission in a Dialpolicy Table in Domain
- Update Dialpolicy
- Update Dialpolicy in Domain
- Dialrule Actions
- Add a New Dial Rule Into a Dial Plan
- Count Dialrules in a Dialplan
- Create Dialplan for Domain
- Create Dialplan Global
- Delete a Dial Rule by ID in a Dial Plan
- Delete Dialplan for Domain
- Read Dialplans
- Read Dialrules in a Dialplan
- Read Specific Dialrule in a Dialplan
- Update a Dial Rule by ID in a Dial Plan
- Update Dialplan for Domain
- Domains Actions
- Email Actions
- Event Subscriptions Actions
- Firebase Actions
- Images Actions
- iNSight Actions
- Media/Greetings Actions
- Media/Hold Messages/Domain Actions
- Media/Hold Messages/User Actions
- Media/Music on Hold/Domain Actions
- Media/Music on Hold/User Actions
- Media/Text to Speech Actions
- Media/Voicemail Actions
- Meetings Actions
- Meetings/Event Logs Actions
- Meetings/Iotum Actions
- Create a Ad Hoc Conference
- Create a Host
- Create Host Contacts
- Create Iotum Video Company
- Create Iotum Video Subscription
- Delete a Host
- Delete a Video Company
- Delete Iotum Video Subscription
- Read All Iotum Video Hosts in a Domain
- Read Iotum Video Available Products
- Read Iotum Video Company
- Read Iotum Video Company Products
- Read Iotum Video Domain Resellers
- Read Iotum Video Host
- Read Iotum Video Host Conferences
- Read Iotum Video Host Contacts
- Update Domain's Iotum Company
- Update Domain's Iotum Subscriptions
- Update User's Iotum Host
- Messages Actions
- Delete Messagesession
- Get Messages for Messagesession
- Get Messagesession for User
- Get Messagesessions for Domain
- Get Messagesessions for User
- Send a Message (chat)
- Send a Message (group Chat)
- Send a Message (group SMS)
- Send a Message (media Chat)
- Send a Message (MMS)
- Send a Message (SMS)
- Start a New Message Session
- Update Messagesession (leave)
- Update Messagesession (participants)
- Update Messagesession (session Name)
- Messages/SMS Block Actions
- Phone Numbers Actions
- Phone Numbers/Use Cases Actions
- Phones/Macs Actions
- Phones/Macs/Supported Models and Servers Actions
- Presence Actions
- Quotas Actions
- Recordings Actions
- Resellers Actions
- Routes Actions
- Sites Actions
- SMS Numbers Actions
- SnapBuilder Actions
- Count Device Profiles
- Count Phone Configurations in a Domain
- Create Phone Configuration for Specific MAC Address
- Delete Phone Configuration for Specific MAC Address
- Get Phone Configuration for Specific MAC
- Get Specific Device Profile for Model of Phone
- Read Device Profiles
- Update Phone Configuration for Specific MAC Address
- SnapBuilder/Phone Templates Actions
- SSL Certificates Actions
- Templates Actions
- Timeframes/Domain (Shared) Actions
- Timeframes/Domain (Shared)/Always Actions
- Timeframes/Domain (Shared)/Custom Actions
- Timeframes/Domain (Shared)/Days of Week Actions
- Timeframes/Domain (Shared)/Holiday Actions
- Timeframes/Domain (Shared)/Specific Dates Actions
- Timeframes/Holiday Information Actions
- Timeframes/User Actions
- Timeframes/User/Always Actions
- Timeframes/User/Custom Actions
- Timeframes/User/Days of Week Actions
- Timeframes/User/Holiday Actions
- Timeframes/User/Specific Dates Actions
- Transcriptions & Sentiment Actions
- Users Actions
- Version Actions
- Voicemail Reminders Actions
Media/Music on Hold/User → Create a New MOH for Domain from TTS
AI-generatedSummary
Creates a user-level music-on-hold (MOH) item for a domain by generating audio from the supplied text-to-speech script. Choose the domain and user, then provide the script; voice settings and the optional MOH index control the generated audio.
Inputs
- Domain (required) — Select a domain or enter its name.
- User (required) — Select a user in the chosen domain or enter the user ID.
- Synchronous (required) — Yes (default) waits for a 200 response; No requests an asynchronous 202 acknowledgement.
- Script (required) — Text-to-speech content or a description of the audio to generate.
- Index — Optional numeric MOH position; 0 is the intro greeting. Leave empty for automatic assignment.
- Voice Language — TTS voice language code, defaulting to en-US.
- Voice ID — TTS voice identifier, defaulting to en-US-Wavenet-C.
- Refresh Dropdown Cache — When enabled, bypasses cached dropdown values and fetches fresh options.
Output shape
The API response for the MOH creation request.
The response may be a completed 200 response or, when asynchronous mode is selected, a 202 acknowledgement. The exact response fields are not established by the supplied source view.
Examples
Example 1: Create a user-level MOH recording for a domain
Select a domain and user, enter the spoken script, and optionally specify an index, voice language, and voice ID.