Media

Create Media

Add a media object to your account that can be used as a greeting or hold music. Users may create a media by using the built-in Text-to-speech (TTS) facility or upload a file of their choice. (Note: The maximum size for media files or JSON objects included with a POST or PUT request is 10 MB)

post/v4/accounts/{voip_id}/media

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/media
  • Auth: HTTP bearer

Path parameters

voip_idinteger required

Request body

namestring required

Name of recording

type'hold_music' | 'greeting' nullable

Can be hold_music or greeting. Indicates the purpose of this recording and where it can be used.

origin'file' | 'tts' required

Can be 'file' or 'tts'.

durationinteger nullable

Duration of greeting.

notesstring nullable

Notes of greeting.

randomizedboolean nullable

Can be Y or N. Start the greeting from random location, instead of the beginning.

extensioninteger nullable

Extension that this record belongs to.

tts_textstring nullable

Text used for text-to-speech conversion, maximum 800 characters

tts_voice'Mads / Danish' | 'Naja / Danish' | 'Lotte / Dutch' | 'Ruben / Dutch' | 'Nicole / English (Australia)' | 'Russell / English (Australia)' | 'Amy / English (Great Britain)' | 'Brian / English (Great Britain)' | 'Emma / English (Great Britain)' | 'Raveena / English (India)' | 'Ivy / English (US)' | 'Joanna / English (US)' | 'Joey / English (US)' | 'Justin / English (US)' | 'Kendra / English (US)' | 'Kimberly / English (US)' | 'Salli / English (US)' | 'Geraint / English (Wales)' | 'Celine / French' | 'Mathieu / French' | 'Chantal / French (Canada)' | 'Hans / German' | 'Marlene / German' | 'Vicki / German' | 'Dora / Icelandic' | 'Karl / Icelandic' | 'Carla / Italian' | 'Giorgio / Italian' | 'Mizuki / Japanese' | 'Takumi / Japanese' | 'Seoyeon / Korean' | 'Liv / Norwegian' | 'Jacek / Polish' | 'Jan / Polish' | 'Ewa / Polish' | 'Maja / Polish' | 'Ricardo / Portuguese' | 'Vitoria / Portuguese' | 'Cristiano / Portuguese (Brazil)' | 'Ines / Portuguese (Brazil)' | 'Carmen / Romanian' | 'Maxim / Russian' | 'Tatyana / Russian' | 'Conchita / Spanish' | 'Enrique / Spanish' | 'Miguel / Spanish (Latin America)' | 'Penelope / Spanish (Latin America)' | 'Astrid / Swedish' | 'Filiz / Turkish' | 'Gwyneth / Welsh' nullable

Allowed voices for tts

filestring nullable

Record file.

filenamestring nullable

Name of file to be uploaded, when 'origin' is set to 'file'.

Response

Created

object required

Changes

No operation changes recorded.