{"openapi":"3.0.0","info":{"title":"FracTEL API 2.12.87c (Hail)","description":"FracTEL's Middleware API","version":"2.12.87c","termsOfService":"https://fractel.com/legal/terms","contact":{"name":"FracTEL, LLC"},"license":{"name":"ISC","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://api.fonestorm.com/v2"}],"tags":[{"name":"accounts","description":"Account Functions"},{"name":"announcements","description":"Announcement Functions"},{"name":"api","description":"API Functions"},{"name":"auth","description":"Authentication Functions"},{"name":"call-to-actions","description":"Call to Action Functions"},{"name":"callbacks","description":"Callbacks"},{"name":"calls","description":"Calling"},{"name":"campaigns","description":"Campaign Functions"},{"name":"conferences","description":"Conference Functions"},{"name":"contacts","description":"Contact Functions"},{"name":"devices","description":"Device Functions"},{"name":"digitquery","description":"DigitQuery Functions"},{"name":"documents","description":"Document Functions"},{"name":"e911locations","description":"E911Location Functions"},{"name":"emails","description":"Emailing Functions"},{"name":"events","description":"Event Functions"},{"name":"faxes","description":"Fax Functions"},{"name":"fonenumbers","description":"FoneNumber Functions"},{"name":"forms","description":"Forms Functions"},{"name":"integrations","description":"Integration Functions"},{"name":"lists","description":"List Functions"},{"name":"locations","description":"Location Functions"},{"name":"messages","description":"Messaging Functions"},{"name":"messaging-brands","description":"Messaging Brands Functions"},{"name":"pagegroups","description":"PageGroup Functions"},{"name":"ringgroups","description":"RingGroup Functions"},{"name":"schedulers","description":"Scheduler Functions"},{"name":"soundfiles","description":"SoundFile Functions"},{"name":"subaccounts","description":"Subaccount Functions"},{"name":"surveys","description":"Survey Functions"},{"name":"templates","description":"Template Functions"},{"name":"users","description":"Users Functions"},{"name":"voicemails","description":"Voicemail Functions"}],"paths":{"/auth":{"post":{"summary":"Create Auth Token","operationId":"createToken","description":"Create an authentication token to use for API requests.","tags":["Authorization","auth"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"type":"object","$ref":"#/components/schemas/Authorization"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"description":"Response status code.","type":"integer","example":401},"error":{"description":"Response error label.","type":"string","example":"Unauthorized"},"message":{"description":"Response error message.","type":"string","example":"Invalid Email or Password."}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["username","password"],"properties":{"username":{"type":"string","description":"FracTEL username"},"password":{"type":"string","format":"password","description":"FracTEL password"},"expires":{"type":"integer","description":"FracTEL Token Life Time in Seconds | Default is 3600 seconds | Maximum is 86400 seconds (24 hours)"}}}}},"description":"Credentials to request authentication token"}}},"/calls":{"post":{"summary":"Send Call","operationId":"sendCall","description":"Send a new voice call from a FoneNumber to a recipient phone number.","security":[{"jwt":[]}],"tags":["Calls","calls"],"responses":{"201":{"description":"Sent","content":{"application/json":{"schema":{"type":"object","properties":{"call":{"type":"object","$ref":"#/components/schemas/Call"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumber","to","service_type","service_id"],"properties":{"fonenumber":{"description":"FoneNumber associated with the account","type":"string"},"to":{"description":"Phone number or speed dial to connect first","type":"string"},"service_type":{"description":"Type of call","type":"string","enum":["Device","VoiceMail","SoundFile","TTS","Phonenumber"]},"service_id":{"description":"Destination for call","type":"string"}}}}}}}},"/faxes":{"post":{"summary":"Send Fax","operationId":"sendFax","description":"Send a fax to a recipient phone number.","security":[{"jwt":[]}],"tags":["Faxes","faxes"],"responses":{"201":{"description":"Sent","content":{"application/json":{"schema":{"type":"object","properties":{"fax":{"type":"object","$ref":"#/components/schemas/Fax"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumber","to"],"properties":{"fonenumber":{"description":"FoneNumber to use for Fax","type":"string"},"to":{"description":"Receiving 10 digit phone number","type":"string"},"message":{"description":"Message to fax","type":"string"},"pdf":{"description":"URL of a PDF file to send with fax","type":"string"}}}}}}}},"/users":{"post":{"summary":"Create User","operationId":"createUser","description":"Add a new User to an account.","security":[{"jwt":[]}],"tags":["Users","users"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","$ref":"#/components/schemas/User"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"description":"User email address","type":"string"},"dashboard_role":{"description":"User Role.","type":"string","enum":["None","Location","Organization","Agent","Master"]},"dashboard_access":{"description":"User access","type":"string","enum":["None","User","Manager","Administrator","Custom"]},"first_name":{"description":"User First Name","type":"string"},"last_name":{"description":"User Last Name","type":"string"},"title":{"description":"User Title","type":"string"},"fractelfone":{"description":"FracTELfone device id","type":"string"},"subaccount":{"description":"User subaccount id","type":"string"},"custom_access":{"type":"object","description":"Custom access options","properties":{"subaccounts":{"description":"Subaccount access options","type":"string","enum":["None","Read","Edit","Add"]},"users":{"description":"Users access options","type":"string","enum":["None","Read","Edit","Add","Remove"]},"business_objects":{"description":"Business Object access options","type":"string","enum":["None","Read","Edit","Add","Remove"]},"fonenumbers":{"description":"FoneNumbers access options","type":"string","enum":["None","Read","Edit","Add","Remove"]},"billing":{"description":"Billing access options","type":"string","enum":["None","Read"]},"call_records":{"description":"Call Records access options","type":"string","enum":["None","Read"]}}}}}}}}},"get":{"summary":"Get Users","operationId":"getUsers","description":"Get a list of all users.","security":[{"jwt":[]}],"tags":["Users","users"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/ivrmenu":{"post":{"summary":"Create IVRMenu","operationId":"createIVRMenu","description":"Add a new IVRMenu to an account.","security":[{"jwt":[]}],"tags":["IVRMenus","ivrmenus"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"ivrmenu":{"type":"object","$ref":"#/components/schemas/IVRMenu"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label","options"],"properties":{"label":{"description":"Human-readable label used for ivrmenu.","type":"string"},"options":{"type":"object","properties":{"option0":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 0 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 0 Destination","type":"string"}}},"option1":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 1 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 1 Destination","type":"string"}}},"option2":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 2 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 2 Destination","type":"string"}}},"option3":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 0 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 0 Destination","type":"string"}}},"option4":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 4 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 4 Destination","type":"string"}}},"option5":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 5 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 5 Destination","type":"string"}}},"option6":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 6 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 6 Destination","type":"string"}}},"option7":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 7 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 7 Destination","type":"string"}}},"option8":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 8 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 8 Destination","type":"string"}}},"option9":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 9 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 9 Destination","type":"string"}}},"optionStar":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option Star Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option Star Destination","type":"string"}}}}},"digit_timeout":{"description":"Digit timeout.","type":"string"},"menu_repeat":{"description":"Menu repeat.","type":"string"},"menu_timeout":{"description":"Menu timeout.","type":"string"},"menu_timeout_options":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Menu Timeout Destination Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Menu Timeout Destination","type":"string"}}},"enable_speed_dials":{"description":"Enable speed dials on IVRMenu.","type":"boolean"},"soundfile":{"description":"SoundFile ID or Text to speech.","type":"string"}}}}}}},"get":{"summary":"Get IVRMenus","operationId":"getIVRMenus","description":"Get a list of all ivrmenus in the system.","security":[{"jwt":[]}],"tags":["IVRMenus","ivrmenus"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ivrmenus":{"type":"array","items":{"$ref":"#/components/schemas/IVRMenu"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/devices":{"post":{"summary":"Create Device","operationId":"createDevice","description":"Add a new Device to an account.","security":[{"jwt":[]}],"tags":["Devices","devices"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"device":{"type":"object","properties":{"username":{"description":"Unique identifier of device (12 digit number).","type":"string","example":123456123456},"name":{"description":"Human-readable label used for device.","type":"string","example":"My Device"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"fonenumber":{"description":"10-digit Caller ID for device. Leave it blank if device type is Trunk Device. Otherwise REQUIRED","type":"string"},"name":{"description":"Name/Label for device","type":"string"},"type":{"description":"Device type","type":"string"},"mac_address":{"description":"Macaddress of device. Leave it blank if device type is FracTELfone OR WebRTC Device. Otherwise REQUIRED","type":"string"},"speed_dial":{"description":"1 to 6 digit speed dial for device. Leave it blank if device type is Trunk Device. Otherwise REQUIRED","type":"string"},"call_recording":{"description":"Call recording setting for device","type":"string","enum":["default","yes","no","inbound","outbound","ondemand"]},"e911location_id":{"description":"ID of E911Location object","type":"string"},"areacode":{"description":"3-digit local area code for device","type":"string"},"timezone":{"description":"Timezone for device. Default timezone is EST5EDT","type":"string"},"ring_simultaneously":{"description":"10-digit Phone number to ring simultaneously with device","type":"string"},"host_type":{"description":"Host type for Trunk Device. REQUIRED if Device type is Trunk Device","type":"string","enum":["static","dynamic"]},"host_ip":{"description":"Host IP for Trunk Device. REQUIRED if Host type is static","type":"string"},"host_port":{"description":"Host Port for Trunk Device. REQUIRED if Host type is static","type":"number"},"timeout_service":{"type":"object","description":"Timeout Service for a Device.","properties":{"timeout_type":{"description":"Timeout Service Type","type":"string","enum":["None","Forward","Voicemail","Voice2Email"]},"timeout_id":{"description":"Timeout Service ID","type":"string"},"timeout_seconds":{"description":"Timeout after specified seconds","type":"string"},"voice2email_greeting":{"description":"Greeting for Service Type Voice2Email","type":"string"}}},"busy_service":{"type":"object","description":"Busy Service for a Device.","properties":{"busy_type":{"description":"Busy Service Type","type":"string","enum":["None","Forward"]},"busy_id":{"description":"Busy Service ID","type":"string"}}},"directory_settings":{"type":"object","description":"Directory Settings for a Device.","properties":{"first_name":{"description":"Directory First Name","type":"string"},"last_name":{"description":"Directory Last Name","type":"string"},"show":{"description":"Show in Directory or not","type":"boolean"},"speed_dial":{"description":"Directory Speed Dial","type":"string"}}},"forwardall_settings":{"type":"object","description":"ForwardAll Settings for a Device.","properties":{"phonenumber":{"description":"ForwardAll Phonenumber","type":"string"},"start_time":{"description":"ForwardAll Start Time","type":"string"},"end_time":{"description":"ForwardAll End Time","type":"string"}}}}}}}}},"get":{"summary":"Get Devices","operationId":"getDevices","description":"Get a list of all devices.","security":[{"jwt":[]}],"tags":["Devices","devices"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/Device"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/scheduler":{"get":{"summary":"Get Schedulers","operationId":"getSchedulers","description":"Get a list of all schedulers in the system.","security":[{"jwt":[]}],"tags":["Schedulers","schedulers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"schedulers":{"type":"array","items":{"$ref":"#/components/schemas/Scheduler"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Scheduler","operationId":"createScheduler","description":"Add a new Scheduler to an account.","security":[{"jwt":[]}],"tags":["Schedulers","schedulers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"scheduler":{"type":"object","$ref":"#/components/schemas/Scheduler"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label","timezone"],"properties":{"label":{"description":"Human-readable label used for scheduler.","type":"string"},"timezone":{"description":"Timezone of scheduler.","type":"string"},"business_hours":{"type":"object","properties":{"business_hours_service_type":{"description":"Business Hours Service Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"business_hours_service_id":{"description":"Business Hours Service ID","type":"string"},"after_hours_service_type":{"description":"After Hours Service Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"after_hours_service_id":{"description":"After Hours Service ID","type":"string"},"lunch_hours_service_type":{"description":"Lunch Hours Service Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"lunch_hours_service_id":{"description":"Lunch Hours Service Type","type":"string"},"monday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"tuesday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"wednesday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"thursday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"friday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"saturday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"sunday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}}}},"holiday_hours":{"type":"object","properties":{"holiday_hours_service_type":{"description":"Holiday Hours Service Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"holiday_hours_service_id":{"description":"Holiday Hours Service ID","type":"string"},"holidays":{"type":"array","items":{"type":"object","properties":{"holiday_name":{"description":"Holiday name","type":"string"},"holiday_type":{"description":"Holiday type","type":"string","enum":["Custom","New Years Day","Martin Luther King Birthday","George Washington Birthday","Memorial Day","Independence Day","Labor Day","Columbus Day","Veterans Day","Thanksgiving Day","Black Friday","Christmas Eve","Christmas Day","Boxing Day","Fat Tuesday","Ash Wednesday","Palm Sunday","Maundy Thursday","Good Friday","Black Saturday","Easter Sunday","Ascension","Pentecost","Trinity Sunday"]},"custom_holiday_start":{"description":"Custom holiday start time (MM-DD HH:mm)","type":"string"},"custom_holiday_end":{"description":"Custom holiday end time (MM-DD HH:mm)","type":"string"}}}}}},"override_mode":{"description":"Scheduler override mode","type":"string","enum":["Scheduler","OfficeHours","AfterHours","Lunch","Holiday"]},"override_extension":{"description":"Scheduler override extension","type":"string"}}}}}}}},"/soundfiles":{"post":{"summary":"Create SoundFile","operationId":"createSoundFile","description":"Add a new SoundFile to an account.","security":[{"jwt":[]}],"tags":["SoundFiles","soundfiles"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"soundfile":{"type":"object","$ref":"#/components/schemas/SoundFile"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label"],"properties":{"label":{"description":"Name/Label for SoundFile","type":"string"},"file":{"description":"SoundFile or URL","type":"string"},"tts":{"description":"Text to speech string","type":"string"},"tts_volume":{"description":"Text to speech volume","type":"string"},"expires_at":{"description":"Expiration date","type":"string"}}}}}}},"get":{"summary":"Get SoundFiles","operationId":"getSoundFiles","description":"Get a list of all soundfiles.","security":[{"jwt":[]}],"tags":["SoundFiles","soundfiles"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"soundfiles":{"type":"array","items":{"$ref":"#/components/schemas/SoundFile"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/voicemails":{"post":{"summary":"Create Voicemail","operationId":"createVoicemail","description":"Add a new Voicemail to an account.","security":[{"jwt":[]}],"tags":["Voicemails","voicemails"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"voicemail":{"type":"object","$ref":"#/components/schemas/Voicemail"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label","access_id","access_pin"],"properties":{"label":{"description":"Name/Label for voicemail","type":"string"},"access_id":{"description":"1 to 6 digit Voicemail access id.","type":"string"},"access_pin":{"description":"1 to 6 digit Voicemail access pin.","type":"string"},"email_preference":{"description":"Email preference for voicemail.","type":"string","enum":["OnDemand","Always"]},"timezone":{"description":"Timezone for voicemail.","type":"string"},"email":{"description":"Email address for voicemail.","type":"string"},"delete_emailed_messages":{"description":"Delete email after emailing them.","type":"boolean"},"announcement":{"description":"SoundFile ID to play as the voicemail prompt.","type":"string"},"greeting":{"description":"Play greeting or skip.","type":"string","enum":["play","skip"]},"instructions":{"description":"Play instructions or skip.","type":"string","enum":["play","skip"]},"notify":{"type":"object","required":["type"],"properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Email","Call","Callback"]},"url":{"description":"URL for callback.","type":"string"},"url_method":{"description":"URL method for callback.","type":"string","enum":["GET","POST","JSON"]},"url_username":{"description":"URL username for callback.","type":"string"},"url_password":{"description":"URL password for callback.","type":"string"},"email":{"description":"Email address for for email notification.","type":"string"},"phone":{"description":"Phonenumber for for call notification.","type":"string"}}},"active":{"description":"Status of the voicemail.","type":"boolean"}}}}}}},"get":{"summary":"Get Voicemails","operationId":"getVoicemails","description":"Get a list of all voicemail inboxes in the system.","security":[{"jwt":[]}],"tags":["Voicemails","voicemails"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"voicemails":{"type":"array","items":{"$ref":"#/components/schemas/Voicemail"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/ringgroups":{"get":{"summary":"Get RingGroups","operationId":"getRingGroups","description":"Get a list of all ringgroups.","security":[{"jwt":[]}],"tags":["RingGroups","ringgroups"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ringgroups":{"type":"array","items":{"$ref":"#/components/schemas/RingGroup"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create RingGroup","operationId":"createRingGroup","description":"Add a new RingGroup to an account.","security":[{"jwt":[]}],"tags":["RingGroups","ringgroups"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"ringgroup":{"type":"object","$ref":"#/components/schemas/RingGroup"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label","ring_strategy"],"properties":{"label":{"description":"Name/Label for RingGroup","type":"string"},"destinations":{"type":"array","items":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Destination type for RingGroup","type":"string","enum":["Device","SpeedDial"]},"destination":{"description":"Destination id for RingGroup","type":"string"}}}},"greeting":{"description":"Greeting text or soundfile","type":"string"},"ring_strategy":{"description":"Ring strategy for RingGroup","type":"string","enum":["Simultaneous","Sequential","Random","LongestIdle"]},"max_ring_time":{"description":"Maximum ring time in seconds","type":"integer"},"ring_timeout":{"description":"Ring timeout in seconds","type":"integer"},"ring_busy_destinations":{"description":"Ring busy destinations or not","type":"boolean"},"failover_type":{"description":"RingGroup Failover Type.","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"failover":{"description":"Failover ID.","type":"string"}}}}}}}},"/pagegroups":{"get":{"summary":"Get PageGroups","operationId":"getPageGroups","description":"Get a list of all pagegroups.","security":[{"jwt":[]}],"tags":["PageGroups","pagegroups"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pagegroups":{"type":"array","items":{"$ref":"#/components/schemas/PageGroup"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create PageGroup","operationId":"createPageGroup","description":"Add a new PageGroup to an account.","security":[{"jwt":[]}],"tags":["PageGroups","pagegroups"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"pagegroup":{"type":"object","$ref":"#/components/schemas/PageGroup"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label","devices"],"properties":{"label":{"description":"Name/Label for PageGroup","type":"string"},"soundfile":{"description":"SoundFile ID","type":"string"},"max_page_time":{"description":"Max page time in seconds","type":"integer"},"tone_length":{"description":"Tone length in seconds","type":"integer"},"devices":{"type":"array","items":{"description":"Device IDs","type":"string"}}}}}}}}},"/fonenumbers":{"get":{"summary":"Get FoneNumbers","operationId":"getFonenumbers","description":"Get a list of all FoneNumbers, or a selection based on a filter.","security":[{"jwt":[]}],"parameters":[{"name":"filter","description":"Filter the response attributes. Allowed values are `FoneNumbers` or `all`. See **Notes** for additional information.","in":"query","required":false,"schema":{"type":"string","enum":["fonenumbers","all"]}},{"name":"active","description":"Filter the response attributes based on FoneNumber's activation status. Allowed values are `yes` or `no` or `cancel`.","in":"query","required":false,"schema":{"type":"string","enum":["yes","no","cancel"]}},{"name":"offnet","description":"Filter the response attributes if FoneNumber is offnet or not. Allowed values are `yes` or `no` or `only`.","in":"query","required":false,"schema":{"type":"string","enum":["yes","no","only"]}}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumbers":{"type":"array","items":{"$ref":"#/components/schemas/FoneNumber"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Instant FoneNumber","operationId":"instantFonenumber","description":"Order a ready to use voice and messaging enabled local or toll-free phone number.","security":[{"jwt":[]}],"tags":["FoneNumbers","fonenumbers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["area_code"],"properties":{"area_code":{"description":"Local number area code (e.g 321) or toll-free exchange (e.g. 888). Use 8XX to order a toll-free in any available exchange.","type":"string"}}}}}}}},"/conferences":{"get":{"summary":"Get Conferences","operationId":"getConferences","description":"Get a list of all conferences.","security":[{"jwt":[]}],"tags":["Conferences","conferences"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"conferences":{"type":"array","items":{"$ref":"#/components/schemas/Conference"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create Conference","operationId":"createConference","description":"Create a conference.","security":[{"jwt":[]}],"tags":["Conferences","conferences"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"conference":{"type":"object","$ref":"#/components/schemas/Conference"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label"],"properties":{"label":{"description":"Label of conference","type":"string"},"fonenumber":{"description":"FoneNumber to use for conference","type":"string"},"start_time":{"description":"Start time and date of conference","type":"string","format":"date-time"},"end_time":{"description":"End time and date of conference","type":"string","format":"date-time"},"before_message":{"description":"Message to play before conference start time","type":"string"},"after_message":{"description":"Message to play after conference end time","type":"string"},"max_members":{"description":"Maximum number of allowed conference attendees","type":"number"},"conference_pin":{"description":"Conference PIN for attendees","type":"number"},"play_sounds":{"description":"Play member entry and exit sound","type":"boolean"},"record_conference":{"description":"Record conference or not","type":"boolean"},"hold_music":{"description":"Hold music to play. SoundFile ID or Text to Speech","type":"string"},"moderator_options":{"type":"object","properties":{"moderator_pin":{"description":"Conference PIN for moderator","type":"number"},"terminate_on_exit":{"description":"Terminate conference when the moderator leaves","type":"boolean"},"music_on_hold":{"description":"Play music on hold if only the moderator is in the conference","type":"boolean"},"mute_members":{"description":"Mute all members until the moderator joins","type":"boolean"},"wait_for_moderator":{"description":"Wait until the moderator joins","type":"boolean"}}}}}}}}}},"/portorders":{"get":{"summary":"Get PortOrders","operationId":"getPortOrders","description":"Get a list of all portorders.","security":[{"jwt":[]}],"tags":["PortOrders","portorders"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"portorders":{"type":"array","items":{"$ref":"#/components/schemas/PortOrder"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create PortOrder","operationId":"createPortOrder","description":"Add a new PortOrder to an account.","security":[{"jwt":[]}],"tags":["PortOrders","portorders"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"portorder":{"type":"object","$ref":"#/components/schemas/PortOrder"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["account_info","contact_info","current_service","port_settings","phone_numbers"],"properties":{"subaccount":{"description":"PortOrder subaccount.","type":"string"},"customer_pon":{"description":"Customer PortOrder Number for PortOrder.","type":"string"},"account_info":{"type":"object","description":"Account information.","required":["city","zip","country"],"properties":{"company":{"description":"Company name.","type":"string"},"address_1":{"description":"Address line 1.","type":"string"},"address_2":{"description":"Address line 2.","type":"string"},"house_prefix":{"description":"House prefix.","type":"string"},"house_number":{"description":"House number.","type":"string"},"house_suffix":{"description":"House suffix.","type":"string"},"pre_directional":{"description":"Pre directional.","type":"string"},"street_name":{"description":"Street name.","type":"string"},"street_suffix":{"description":"Street suffix.","type":"string"},"post_directional":{"description":"Post directional.","type":"string"},"city":{"description":"City.","type":"string"},"state":{"description":"State.","type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"]},"zip":{"description":"Zip code.","type":"string"},"country":{"description":"Country.","type":"string","enum":["United States","Canada","International"]}}},"contact_info":{"type":"object","description":"Contact information.","required":["first_name","last_name","email","phone"],"properties":{"first_name":{"description":"First name.","type":"string"},"middle_initial":{"description":"Middle initial.","type":"string"},"last_name":{"description":"Last name.","type":"string"},"email":{"description":"Email.","type":"string"},"phone":{"description":"Phone.","type":"string"},"title":{"description":"Title.","type":"string"},"authorized_user":{"description":"Authorized user full name.","type":"string"}}},"current_service":{"type":"object","description":"Contact information.","required":["service_provider","billing_number"],"properties":{"service_provider":{"description":"Current service provider.","type":"string"},"account_number":{"description":"Account number with current service provider.","type":"string"},"pin":{"description":"PIN with current service provider.","type":"string"},"billing_number":{"description":"Billing number with current service provider.","type":"string"}}},"port_settings":{"type":"object","description":"Contact information.","required":["desired_due_date"],"properties":{"desired_due_date":{"description":"Desired due date for PortOrder in YYYY-MM-DD format.","type":"string"},"partial_port":{"description":"Partial port or not.","type":"boolean"},"wireless":{"description":"Wireless numbers or not.","type":"boolean"},"business":{"description":"Business numbers or not.","type":"boolean"},"new_btn":{"description":"New BTN.","type":"string"}}},"observers":{"description":"PortOrder ID.","type":"array","items":{"type":"string"}},"phone_numbers":{"description":"PortOrder ID.","type":"array","items":{"type":"object","properties":{"phone_number":{"description":"Phone number.","type":"string"},"fax":{"description":"Fax number or not.","type":"boolean"}}}}}}}}}}},"/speeddials":{"post":{"summary":"Create SpeedDial","operationId":"createSpeedDial","description":"Add a new SpeedDial to an account.","security":[{"jwt":[]}],"tags":["SpeedDials","speeddials"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"speedDial":{"type":"object","$ref":"#/components/schemas/SpeedDial"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["speed_dial"],"properties":{"speed_dial":{"description":"1 to 6 digit speeddial","type":"string"},"label":{"description":"Name/Label for speeddial","type":"string"},"service_type":{"description":"SpeedDial destination type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"service_id":{"description":"SpeedDial destination","type":"string"}}}}}}},"get":{"summary":"Get SpeedDials","operationId":"getSpeedDials","description":"Get a list of all speeddials.","security":[{"jwt":[]}],"tags":["SpeedDials","speeddials"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"speedDials":{"type":"array","items":{"$ref":"#/components/schemas/SpeedDial"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/subaccounts":{"post":{"summary":"Create Subaccount","operationId":"createSubaccount","description":"Add a new Subaccount to an account.","security":[{"jwt":[]}],"tags":["Subaccounts","subaccounts"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"subaccount":{"type":"object","$ref":"#/components/schemas/Subaccount"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label"],"properties":{"label":{"description":"Name/Label for subaccount","type":"string"},"ip_address":{"description":"IP address if the subaccount is not a PBX account","type":"string"},"service_address":{"type":"object","description":"Service Address","properties":{"company_name":{"description":"Company Name","type":"string"},"first_name":{"description":"First Name","type":"string"},"last_name":{"description":"Last Name","type":"string"},"email":{"description":"Email Address","type":"string"},"phone":{"description":"Phone number","type":"string"},"address_line1":{"description":"Address Line 1","type":"string"},"address_line2":{"description":"Address Line 2","type":"string"},"city":{"description":"City","type":"string"},"state":{"description":"State","type":"string"},"zipcode":{"description":"Zipcode","type":"string"}}}}}}}}},"get":{"summary":"Get Subaccounts","operationId":"getSubaccounts","description":"Get a list of all subaccounts.","security":[{"jwt":[]}],"tags":["Subaccounts","subaccounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"subaccounts":{"type":"array","items":{"$ref":"#/components/schemas/Subaccount"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/devices/{id}":{"put":{"summary":"Update Device","operationId":"updateDevice","description":"Update a Device.","security":[{"jwt":[]}],"tags":["Devices","devices"],"parameters":[{"name":"id","description":"ID of device","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"device":{"type":"object","$ref":"#/components/schemas/Device"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"description":"10-digit Caller ID for device","type":"string"},"name":{"description":"Name/Label for device","type":"string"},"type":{"description":"Device type","type":"string"},"mac_address":{"description":"Macaddress of device. Leave it blank if device type is FracTELfone OR WebRTC Device. Otherwise `REQUIRED`","type":"string"},"speed_dial":{"description":"1 to 6 digit speed dial for device","type":"string"},"call_recording":{"description":"Call recording setting for device","type":"string","enum":["default","yes","no","inbound","outbound","ondemand"]},"e911location_id":{"description":"ID of E911Location object","type":"string"},"areacode":{"description":"3-digit local area code for device","type":"string"},"ring_simultaneously":{"description":"10-digit Phone number to ring simultaneously with device","type":"string"},"receive_notify":{"type":"object","description":"Callback URL to notify when a device gets a call.","required":["type"],"properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}},"send_notify":{"type":"object","description":"Callback URL to notify when a device makes a call.","required":["type"],"properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}},"host_type":{"description":"Host type for Trunk Device. REQUIRED if Device type is Trunk Device","type":"string","enum":["static","dynamic"]},"host_ip":{"description":"Host IP for Trunk Device. REQUIRED if Host type is static","type":"string"},"host_port":{"description":"Host Port for Trunk Device. REQUIRED if Host type is static","type":"number"},"timeout_service":{"type":"object","description":"Timeout Service for a Device.","properties":{"timeout_type":{"description":"Timeout Service Type","type":"string","enum":["None","Forward","Voicemail","Voice2Email"]},"timeout_id":{"description":"Timeout Service ID","type":"string"},"timeout_seconds":{"description":"Timeout after specified seconds","type":"string"},"voice2email_greeting":{"description":"Greeting for Service Type Voice2Email","type":"string"}}},"busy_service":{"type":"object","description":"Busy Service for a Device.","properties":{"busy_type":{"description":"Busy Service Type","type":"string","enum":["None","Forward"]},"busy_id":{"description":"Busy Service ID","type":"string"}}},"directory_settings":{"type":"object","description":"Directory Settings for a Device.","properties":{"first_name":{"description":"Directory First Name","type":"string"},"last_name":{"description":"Directory Last Name","type":"string"},"show":{"description":"Show in Directory or not","type":"boolean"},"speed_dial":{"description":"Directory Speed Dial","type":"string"}}},"forwardall_settings":{"type":"object","description":"ForwardAll Settings for a Device.","properties":{"phonenumber":{"description":"ForwardAll Phonenumber","type":"string"},"start_time":{"description":"ForwardAll Start Time","type":"string"},"end_time":{"description":"ForwardAll End Time","type":"string"}}}}}}}}},"get":{"summary":"Get Device","operationId":"getDevice","description":"Get information for a single Device.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"ID of the device","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Devices","devices"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"device":{"type":"object","$ref":"#/components/schemas/Device"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"summary":"Delete Device","operationId":"deleteDevice","description":"Remove a Device from an account.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"ID of the device","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Devices","devices"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"device":{"type":"object","$ref":"#/components/schemas/Device"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/ivrmenu/{id}":{"put":{"summary":"Update IVRMenu","operationId":"updateIVRMenu","description":"Update a IVRMenu.","security":[{"jwt":[]}],"tags":["IVRMenus","ivrmenus"],"parameters":[{"name":"id","description":"IVRMenu ID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ivrmenu":{"type":"object","$ref":"#/components/schemas/IVRMenu"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"Human-readable label used for ivrmenu.","type":"string"},"options":{"type":"object","properties":{"option0":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 0 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 0 Destination","type":"string"}}},"option1":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 1 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 1 Destination","type":"string"}}},"option2":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 2 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 2 Destination","type":"string"}}},"option3":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 0 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 0 Destination","type":"string"}}},"option4":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 4 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 4 Destination","type":"string"}}},"option5":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 5 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 5 Destination","type":"string"}}},"option6":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 6 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 6 Destination","type":"string"}}},"option7":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 7 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 7 Destination","type":"string"}}},"option8":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 8 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 8 Destination","type":"string"}}},"option9":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option 9 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option 9 Destination","type":"string"}}},"optionStar":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Option Star Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Option Star Destination","type":"string"}}}}},"digit_timeout":{"description":"Digit timeout.","type":"string"},"menu_repeat":{"description":"Menu repeat.","type":"string"},"menu_timeout":{"description":"Menu timeout.","type":"string"},"menu_timeout_options":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Menu Timeout Destination Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Menu Timeout Destination","type":"string"}}},"enable_speed_dials":{"description":"Enable speed dials on IVRMenu.","type":"boolean"},"soundfile":{"description":"SoundFile ID or Text to speech.","type":"string"}}}}}}},"get":{"summary":"Get IVRMenu","operationId":"getIVRMenu","description":"Get information of a IVRMenu.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"IVRMenu ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["IVRMenus","ivrmenus"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ivrmenu":{"type":"object","$ref":"#/components/schemas/IVRMenu"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"summary":"Delete IVRMenu","operationId":"deleteIVRMenu","description":"Remove a IVRMenu from an account.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"IVRMenu ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["IVRMenus","ivrmenus"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ivrmenu":{"type":"object","$ref":"#/components/schemas/IVRMenu"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/auth/refresh":{"post":{"summary":"Refresh Auth Token","operationId":"refreshToken","description":"Refresh an authentication token.","security":[{"jwt":[]}],"tags":["Authorization","auth"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"type":"object","$ref":"#/components/schemas/Authorization"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"expires":{"type":"integer","description":"FracTEL Token Life Time in Seconds | Default is 3600 seconds | Maximum is 86400 seconds (24 hours)"}}}}}}}},"/accounts/{id}":{"put":{"summary":"Update Account","operationId":"updateAccount","description":"Update an account.","security":[{"jwt":[]}],"tags":["Accounts","accounts"],"parameters":[{"name":"id","description":"Account id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"object","$ref":"#/components/schemas/Account"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"primary_color":{"description":"Branding primary color","type":"string"},"secondary_color":{"description":"Branding secondary color","type":"string"},"background_color":{"description":"Branding background color","type":"string"},"font_family":{"description":"Branding font family","type":"string"},"logo":{"description":"Branding logo","type":"string"}}}}}}},"get":{"summary":"Get Account","operationId":"getAccount","description":"Get information about an account.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Account id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Accounts","accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"object","$ref":"#/components/schemas/Account"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/digitqueries":{"get":{"summary":"Get DigitQueries","operationId":"getDigitQueries","description":"Get a list of all digitqueries.","security":[{"jwt":[]}],"tags":["DigitQueries","digitqueries"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"digitqueries":{"type":"array","items":{"$ref":"#/components/schemas/DigitQuery"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create DigitQuery","operationId":"createDigitQuery","description":"Add a new DigitQuery to an account.","security":[{"jwt":[]}],"tags":["DigitQueries","digitqueries"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"digitquery":{"type":"object","$ref":"#/components/schemas/DigitQuery"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label"],"properties":{"label":{"description":"Name/Label for DigitQuery.","type":"string"},"soundfile":{"description":"DigitQuery soundfile or text to speech string","type":"string"},"maxdigits":{"description":"Maximum digits allowed. Default is 1","type":"integer"},"mindigits":{"description":"Minimum digits allowed. Default is 24","type":"integer"},"retries":{"description":"Number of allowed retries. Default is 3","type":"integer"},"timeout":{"description":"Number of seconds before timeout. Default is 5 seconds","type":"integer"},"invalid_prompt":{"description":"Play invalid prompt or not","type":"boolean"},"callback_settings":{"type":"object","required":["url","url_method"],"properties":{"url":{"description":"Callback URL","type":"string"},"url_method":{"description":"Callback URL method","type":"string","enum":["GET","POST","JSON"]},"url_username":{"description":"HTTP authentication username","type":"string"},"url_password":{"description":"HTTP authentication password","type":"string"}}},"match_pattern":{"description":"Match pattern a regular expression","type":"string"},"match_destination":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Match destination type","type":"string","enum":["Hangup","Busy","Reject","Forward","FoneNumber","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Match destination value","type":"string"}}},"nomatch_destination":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"No Match destination type","type":"string","enum":["Hangup","Busy","Reject","Forward","FoneNumber","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"No Match destination value","type":"string"}}},"default_destination":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Default destination type","type":"string","enum":["Hangup","Busy","Reject","Forward","FoneNumber","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Default destination value","type":"string"}}},"email_options":{"type":"object","required":["email"],"properties":{"email":{"description":"Email address","type":"string"},"subject":{"description":"Email subject","type":"string"},"body":{"description":"Email body","type":"string"}}}}}}}}}},"/users/{email}":{"get":{"summary":"Get User","operationId":"getUser","description":"Get information for a single User.","security":[{"jwt":[]}],"parameters":[{"name":"email","description":"Email address of a user","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Users","users"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","$ref":"#/components/schemas/User"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update User","operationId":"updateUser","description":"Update a User.","security":[{"jwt":[]}],"tags":["Users","users"],"parameters":[{"name":"email","description":"Email address of a user","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","$ref":"#/components/schemas/User"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dashboard_role":{"description":"User Role.","type":"string","enum":["None","Location","Organization","Agent","Master"]},"dashboard_access":{"description":"User access","type":"string","enum":["None","User","Manager","Administrator","Custom"]},"first_name":{"description":"User First Name","type":"string"},"last_name":{"description":"User Last Name","type":"string"},"title":{"description":"User Title","type":"string"},"fractelfone":{"description":"FracTELfone device id","type":"string"},"subaccount":{"description":"User subaccount id","type":"string"},"custom_access":{"type":"object","description":"Custom access options","properties":{"subaccounts":{"description":"Subaccount access options","type":"string","enum":["None","Read","Edit","Add"]},"users":{"description":"Users access options","type":"string","enum":["None","Read","Edit","Add","Remove"]},"business_objects":{"description":"Business Object access options","type":"string","enum":["None","Read","Edit","Add","Remove"]},"fonenumbers":{"description":"FoneNumbers access options","type":"string","enum":["None","Read","Edit","Add","Remove"]},"billing":{"description":"Billing access options","type":"string","enum":["None","Read"]},"call_records":{"description":"Call Records access options","type":"string","enum":["None","Read"]}}}}}}}}},"delete":{"summary":"Delete User","operationId":"deleteUser","description":"Remove a User from an account.","security":[{"jwt":[]}],"parameters":[{"name":"email","description":"Email address of a user","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Users","users"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","$ref":"#/components/schemas/User"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/calls/{id}":{"delete":{"summary":"Terminate Call","operationId":"killCall","description":"Terminate (hang up) an in-progress call by its call ID.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Call ID from the create call response.","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Calls","calls"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"call":{"type":"object","properties":{"id":{"description":"Unique identifier of the call.","type":"string"},"result":{"description":"Result of the terminate request.","type":"string"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messages/send":{"post":{"summary":"Send Message","operationId":"sendMessage","description":"Send an SMS or MMS message.","security":[{"jwt":[]}],"tags":["Messages","messages"],"responses":{"201":{"description":"Sent","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"object","$ref":"#/components/schemas/Message"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"410":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/RateLimit"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["to","fonenumber"],"properties":{"to":{"description":"Receiving phone numbers","type":"array","items":{"type":"string"}},"fonenumber":{"description":"Your FracTEL FoneNumber","type":"string"},"message":{"description":"Message body. Either message or media **REQUIRED**.","type":"string"},"media":{"description":"Media URL or media file. Either message or media **REQUIRED**.","type":"string"},"confirmation_url":{"description":"Callback URL for confirmation","type":"string"},"confirmation_url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"confirmation_url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}}}}}}},"/calls/receive":{"post":{"summary":"Set Call Service Type","operationId":"configureCallReceive","description":"Configure the delivery service type used as the destination for calls","security":[{"jwt":[]}],"tags":["Calls","calls"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumber","type"],"properties":{"fonenumber":{"description":"Your FracTEL FoneNumber","type":"string"},"type":{"description":"Service type.","type":"string","enum":["Conference","Hangup","Busy","Reject","Forward","IVRMenu","Scheduler","SpeedDial","Announcement","Device","Fax","Voicemail","DigitQuery","Monetizer"]},"value":{"description":"Service id. `REQUIRED` unless type is `Reject`, `Hangup` or `Busy`.","type":"string"}}}}}}}},"/announcements":{"post":{"summary":"Create Announcement","operationId":"createAnnouncement","description":"Add a new Announcement to an account.","security":[{"jwt":[]}],"tags":["Announcements","announcements"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"announcement":{"type":"object","$ref":"#/components/schemas/Announcement"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["label","soundfile"],"properties":{"label":{"description":"Name/Label for announcement","type":"string"},"soundfile":{"description":"SoundFile ID or Text to speech string","type":"string"},"destination_type":{"description":"Announcement destination type","type":"string","enum":["Hangup","Busy","Reject","Forward","FoneNumber","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Announcement destination","type":"string"}}}}}}},"get":{"summary":"Get Announcements","operationId":"getAnnouncements","description":"Get a list of all announcements.","security":[{"jwt":[]}],"tags":["Announcements","announcements"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"announcements":{"type":"array","items":{"$ref":"#/components/schemas/Announcement"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/scheduler/{id}":{"get":{"summary":"Get Scheduler","operationId":"getScheduler","description":"Get information of a Scheduler.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Scheduler ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Schedulers","schedulers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"scheduler":{"type":"object","$ref":"#/components/schemas/Scheduler"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update Scheduler","operationId":"updateScheduler","description":"Update a Scheduler.","security":[{"jwt":[]}],"tags":["Schedulers","schedulers"],"parameters":[{"name":"id","description":"Scheduler ID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"scheduler":{"type":"object","$ref":"#/components/schemas/Scheduler"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"Human-readable label used for scheduler.","type":"string"},"timezone":{"description":"Timezone of scheduler.","type":"string"},"business_hours":{"type":"object","properties":{"business_hours_service_type":{"description":"Business Hours Service Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"business_hours_service_id":{"description":"Business Hours Service ID","type":"string"},"after_hours_service_type":{"description":"After Hours Service Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"after_hours_service_id":{"description":"After Hours Service ID","type":"string"},"lunch_hours_service_type":{"description":"Lunch Hours Service Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"lunch_hours_service_id":{"description":"Lunch Hours Service Type","type":"string"},"monday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"tuesday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"wednesday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"thursday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"friday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"saturday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}},"sunday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string"},"business_close":{"description":"Business close time (HH:mm)","type":"string"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string"}}}}},"holiday_hours":{"type":"object","properties":{"holiday_hours_service_type":{"description":"Holiday Hours Service Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"holiday_hours_service_id":{"description":"Holiday Hours Service ID","type":"string"},"holidays":{"type":"array","items":{"type":"object","properties":{"holiday_name":{"description":"Holiday name","type":"string"},"holiday_type":{"description":"Holiday type","type":"string","enum":["Custom","New Years Day","Martin Luther King Birthday","George Washington Birthday","Memorial Day","Independence Day","Labor Day","Columbus Day","Veterans Day","Thanksgiving Day","Black Friday","Christmas Eve","Christmas Day","Boxing Day","Fat Tuesday","Ash Wednesday","Palm Sunday","Maundy Thursday","Good Friday","Black Saturday","Easter Sunday","Ascension","Pentecost","Trinity Sunday"]},"custom_holiday_start":{"description":"Custom holiday start time (MM-DD HH:mm)","type":"string"},"custom_holiday_end":{"description":"Custom holiday end time (MM-DD HH:mm)","type":"string"}}}}}},"override_mode":{"description":"Scheduler override mode","type":"string","enum":["Scheduler","OfficeHours","AfterHours","Lunch","Holiday"]},"override_extension":{"description":"Scheduler override extension","type":"string"}}}}}}},"delete":{"summary":"Delete Scheduler","operationId":"deleteScheduler","description":"Remove a Scheduler from an account.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Scheduler ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Schedulers","schedulers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"scheduler":{"type":"object","$ref":"#/components/schemas/Scheduler"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/portorders/{id}":{"put":{"summary":"Update PortOrder","operationId":"updatePortOrder","description":"Update a PortOrder.","security":[{"jwt":[]}],"tags":["PortOrders","portorders"],"parameters":[{"name":"id","description":"PortOrder ID","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","description":"Parameter to confirm or activate PortOrder","in":"query","required":false,"schema":{"type":"string","enum":["confirm","activate"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"portorder":{"type":"object","$ref":"#/components/schemas/PortOrder"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"subaccount":{"description":"PortOrder subaccount.","type":"string"},"customer_pon":{"description":"Customer PortOrder Number for PortOrder.","type":"string"},"account_info":{"type":"object","description":"Account information.","properties":{"company":{"description":"Company name.","type":"string"},"address_1":{"description":"Address line 1.","type":"string"},"address_2":{"description":"Address line 2.","type":"string"},"house_prefix":{"description":"House prefix.","type":"string"},"house_number":{"description":"House number.","type":"string"},"house_suffix":{"description":"House suffix.","type":"string"},"pre_directional":{"description":"Pre directional.","type":"string"},"street_name":{"description":"Street name.","type":"string"},"street_suffix":{"description":"Street suffix.","type":"string"},"post_directional":{"description":"Post directional.","type":"string"},"city":{"description":"City.","type":"string"},"state":{"description":"State.","type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"]},"zip":{"description":"Zip code.","type":"string"},"country":{"description":"Country.","type":"string","enum":["United States","Canada","International"]}}},"contact_info":{"type":"object","description":"Contact information.","properties":{"first_name":{"description":"First name.","type":"string"},"middle_initial":{"description":"Middle initial.","type":"string"},"last_name":{"description":"Last name.","type":"string"},"email":{"description":"Email.","type":"string"},"phone":{"description":"Phone.","type":"string"},"title":{"description":"Title.","type":"string"},"authorized_user":{"description":"Authorized user full name.","type":"string"}}},"current_service":{"type":"object","description":"Contact information.","properties":{"service_provider":{"description":"Current service provider.","type":"string"},"account_number":{"description":"Account number with current service provider.","type":"string"},"pin":{"description":"PIN with current service provider.","type":"string"},"billing_number":{"description":"Billing number with current service provider.","type":"string"}}},"port_settings":{"type":"object","description":"Contact information.","properties":{"desired_due_date":{"description":"Desired due date for PortOrder in YYYY-MM-DD format.","type":"string"},"partial_port":{"description":"Partial port or not.","type":"boolean"},"wireless":{"description":"Wireless numbers or not.","type":"boolean"},"business":{"description":"Business numbers or not.","type":"boolean"},"new_btn":{"description":"New BTN.","type":"string"}}},"observers":{"description":"PortOrder ID.","type":"array","items":{"type":"string"}},"phone_numbers":{"description":"PortOrder ID.","type":"array","items":{"type":"object","properties":{"phone_number":{"description":"Phone number.","type":"string"},"fax":{"description":"Fax number or not.","type":"boolean"}}}}}}}}}},"get":{"summary":"Get PortOrder","operationId":"getPortOrder","description":"Get information of a PortOrder.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"PortOrder ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["PortOrders","portorders"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"portorder":{"type":"object","$ref":"#/components/schemas/PortOrder"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"summary":"Delete PortOrder","operationId":"deletePortOrder","description":"Remove a PortOrder.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"PortOrder ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["PortOrders","portorders"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"portorder":{"type":"object","$ref":"#/components/schemas/PortOrder"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/soundfiles/{id}":{"get":{"summary":"Get SoundFile","operationId":"getSoundFile","description":"Get information for a single SoundFile.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"SoundFile ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["SoundFiles","soundfiles"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"soundfile":{"type":"object","$ref":"#/components/schemas/SoundFile"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update SoundFile","operationId":"updateSoundFile","description":"Update a SoundFile.","security":[{"jwt":[]}],"tags":["SoundFiles","soundfiles"],"parameters":[{"name":"id","description":"SoundFile ID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"soundfile":{"type":"object","$ref":"#/components/schemas/SoundFile"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"Name/Label for SoundFile","type":"string"},"file":{"description":"SoundFile or URL","type":"string"},"tts":{"description":"Text to speech string","type":"string"},"tts_volume":{"description":"Text to speech volume","type":"string"},"expires_at":{"description":"Expiration date","type":"string"}}}}}}},"delete":{"summary":"Delete SoundFile","operationId":"deleteSoundFile","description":"Remove a SoundFile from an account.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"SoundFile ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["SoundFiles","soundfiles"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"soundfile":{"type":"object","$ref":"#/components/schemas/SoundFile"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/ringgroups/{id}":{"put":{"summary":"Update RingGroup","operationId":"updateRingGroup","description":"Update a RingGroup.","security":[{"jwt":[]}],"tags":["RingGroups","ringgroups"],"parameters":[{"name":"id","description":"RingGroup ID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ringgroup":{"type":"object","$ref":"#/components/schemas/RingGroup"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"Name/Label for RingGroup","type":"string"},"destinations":{"type":"array","items":{"type":"object","required":["destination_type"],"properties":{"destination_type":{"description":"Destination type for RingGroup","type":"string","enum":["Device","SpeedDial"]},"destination":{"description":"Destination id for RingGroup","type":"string"}}}},"greeting":{"description":"Greeting text or soundfile","type":"string"},"ring_strategy":{"description":"Ring strategy for RingGroup","type":"string","enum":["Simultaneous","Sequential","Random","LongestIdle"]},"max_ring_time":{"description":"Maximum ring time in seconds","type":"integer"},"ring_timeout":{"description":"Ring timeout in seconds","type":"integer"},"ring_busy_destinations":{"description":"Ring busy destinations or not","type":"boolean"},"failover_type":{"description":"RingGroup Failover Type.","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"failover":{"description":"Failover ID.","type":"string"}}}}}}},"get":{"summary":"Get RingGroup","operationId":"getRingGroup","description":"Get information for a single RingGroup.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"RingGroup ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["RingGroups","ringgroups"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ringgroup":{"type":"object","$ref":"#/components/schemas/RingGroup"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"summary":"Delete RingGroup","operationId":"deleteRingGroup","description":"Remove a RingGroup from an account.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"RingGroup ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["RingGroups","ringgroups"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ringgroup":{"type":"object","$ref":"#/components/schemas/RingGroup"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/voicemails/{id}":{"get":{"summary":"Get Voicemail","operationId":"getVoicemail","description":"Get information for a single Voicemail.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Voicemail ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Voicemails","voicemails"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"voicemail":{"type":"object","$ref":"#/components/schemas/Voicemail"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update Voicemail","operationId":"updateVoicemail","description":"Update a Voicemail.","security":[{"jwt":[]}],"tags":["Voicemails","voicemails"],"parameters":[{"name":"id","description":"Voicemail ID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"voicemail":{"type":"object","$ref":"#/components/schemas/Voicemail"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"Name/Label for voicemail","type":"string"},"access_id":{"description":"1 to 6 digit Voicemail access id.","type":"string"},"access_pin":{"description":"1 to 6 digit Voicemail access pin.","type":"string"},"email_preference":{"description":"Email preference for voicemail.","type":"string","enum":["OnDemand","Always"]},"timezone":{"description":"Timezone for voicemail.","type":"string"},"email":{"description":"Email address for voicemail.","type":"string"},"delete_emailed_messages":{"description":"Delete email after emailing them.","type":"boolean"},"announcement":{"description":"SoundFile ID to play as the voicemail prompt.","type":"string"},"greeting":{"description":"Play greeting or skip.","type":"string","enum":["play","skip"]},"instructions":{"description":"Play instructions or skip.","type":"string","enum":["play","skip"]},"notify":{"type":"object","properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Email","Call","Callback"]},"url":{"description":"URL for callback.","type":"string"},"url_method":{"description":"URL method for callback.","type":"string","enum":["GET","POST","JSON"]},"url_username":{"description":"URL username for callback.","type":"string"},"url_password":{"description":"URL password for callback.","type":"string"},"email":{"description":"Email address for for email notification.","type":"string"},"phone":{"description":"Phonenumber for for call notification.","type":"string"}}},"active":{"description":"Status of the voicemail.","type":"boolean"}}}}}}},"delete":{"summary":"Delete Voicemail","operationId":"deleteVoicemail","description":"Remove a Voicemail from an account.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Voicemail ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Voicemails","voicemails"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"voicemail":{"type":"object","$ref":"#/components/schemas/Voicemail"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/pagegroups/{id}":{"put":{"summary":"Update PageGroup","operationId":"updatePageGroup","description":"Update a PageGroup.","security":[{"jwt":[]}],"tags":["PageGroups","pagegroups"],"parameters":[{"name":"id","description":"PageGroup ID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pagegroup":{"type":"object","$ref":"#/components/schemas/PageGroup"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"Name/Label for PageGroup","type":"string"},"soundfile":{"description":"SoundFile ID","type":"string"},"max_page_time":{"description":"Max page time in seconds","type":"integer"},"tone_length":{"description":"Tone length in seconds","type":"integer"},"devices":{"type":"array","items":{"description":"Device IDs","type":"string"}}}}}}}},"get":{"summary":"Get PageGroup","operationId":"getPageGroup","description":"Get information for a single PageGroup.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"PageGroup ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["PageGroups","pagegroups"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pagegroup":{"type":"object","$ref":"#/components/schemas/PageGroup"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"summary":"Delete PageGroup","operationId":"deletePageGroup","description":"Remove a PageGroup from an account.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"PageGroup ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["PageGroups","pagegroups"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pagegroup":{"type":"object","$ref":"#/components/schemas/PageGroup"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/users/directory":{"get":{"summary":"Get Directory","operationId":"getDirectory","description":"The account's users that have a fonenumber, sorted by name, each with the device assigned to them (via fractelfone). Users come from the same source as GET /users, so an account that may not list users gets a 403. A user with no device, or whose device has no caller id, is left out.","security":[{"jwt":[]}],"tags":["Users","users"],"parameters":[{"name":"tenant","in":"query","required":false,"description":"Tenant type - either \"fractel\" or \"fonestorm\".","schema":{"type":"string","enum":["fractel","fonestorm"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"directory":{"type":"array","items":{"$ref":"#/components/schemas/DirectoryEntry"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"403":{"description":"Not permitted to list users for this account"},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/conferences/{id}":{"get":{"summary":"Get Conference","operationId":"getConference","description":"Get information about a conference.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Conference id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Conferences","conferences"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"conference":{"type":"object","$ref":"#/components/schemas/Conference"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update Conference","operationId":"updateConference","description":"Update a conference.","security":[{"jwt":[]}],"tags":["Conferences","conferences"],"parameters":[{"name":"id","description":"Conference id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"conference":{"type":"object","$ref":"#/components/schemas/Conference"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"Label of conference","type":"string"},"start_time":{"description":"Start time and date of conference","type":"string","format":"date-time"},"end_time":{"description":"End time and date of conference","type":"string","format":"date-time"},"fonenumber":{"description":"FoneNumber to use for conference","type":"string"},"before_message":{"description":"Message to play before conference start time","type":"string"},"after_message":{"description":"Message to play after conference end time","type":"string"},"max_members":{"description":"Maximum number of allowed conference attendees","type":"number"},"conference_pin":{"description":"Conference PIN for attendees","type":"number"},"play_sounds":{"description":"Play member entry and exit sound","type":"boolean"},"record_conference":{"description":"Record conference or not","type":"boolean"},"hold_music":{"description":"Hold music to play. SoundFile ID or Text to Speech","type":"string"},"moderator_options":{"type":"object","properties":{"moderator_pin":{"description":"Conference PIN for moderator","type":"number"},"terminate_on_exit":{"description":"Terminate conference when the moderator leaves","type":"boolean"},"music_on_hold":{"description":"Play music on hold if only the moderator is in the conference","type":"boolean"},"mute_members":{"description":"Mute all members until the moderator joins","type":"boolean"},"wait_for_moderator":{"description":"Wait until the moderator joins","type":"boolean"}}}}}}}}},"delete":{"summary":"Delete Conference","operationId":"deleteConference","description":"Delete a conference.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Conference id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Conferences","conferences"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"conference":{"type":"object","$ref":"#/components/schemas/Conference"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/subaccounts/{id}":{"put":{"summary":"Update Subaccount","operationId":"updateSubaccount","description":"Update a Subaccount.","security":[{"jwt":[]}],"tags":["Subaccounts","subaccounts"],"parameters":[{"name":"id","description":"10 digit Subaccount id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"subaccount":{"type":"object","$ref":"#/components/schemas/Subaccount"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"Subaccount status","type":"string","enum":["enabled","suspended","suspendoutbound"]}}}}}}},"get":{"summary":"Get Subaccount","operationId":"getSubaccount","description":"Get information for a single Subaccount.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"10 digit Subaccount id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Subaccounts","subaccounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"subaccount":{"type":"object","$ref":"#/components/schemas/Subaccount"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/fonenumbers/add":{"post":{"summary":"Add Off-net FoneNumber","operationId":"addOffnetFonenumber","description":"Add Off network local or toll-free phone number.","security":[{"jwt":[]}],"tags":["FoneNumbers","fonenumbers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["phonenumber"],"properties":{"phonenumber":{"description":"10 digit local or tollfree phonenumber","type":"string"},"messaging_enabled":{"description":"true if FoneNumbers need to be messaging enabled. Default is false.","type":"boolean"}}}}}}}},"/digitqueries/{id}":{"put":{"summary":"Update DigitQuery","operationId":"updateDigitQuery","description":"Update a DigitQuery.","security":[{"jwt":[]}],"tags":["DigitQueries","digitqueries"],"parameters":[{"name":"id","description":"DigitQuery ID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"digitquery":{"type":"object","$ref":"#/components/schemas/DigitQuery"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"Name/Label for DigitQuery.","type":"string"},"soundfile":{"description":"DigitQuery soundfile or text to speech string","type":"string"},"maxdigits":{"description":"Maximum digits allowed. Default is 1","type":"integer"},"mindigits":{"description":"Minimum digits allowed. Default is 24","type":"integer"},"retries":{"description":"Number of allowed retries. Default is 3","type":"integer"},"timeout":{"description":"Number of seconds before timeout. Default is 5 seconds","type":"integer"},"invalid_prompt":{"description":"Play invalid prompt or not","type":"boolean"},"callback_settings":{"type":"object","properties":{"url":{"description":"Callback URL","type":"string"},"url_method":{"description":"Callback URL method","type":"string","enum":["GET","POST","JSON"]},"url_username":{"description":"HTTP authentication username","type":"string"},"url_password":{"description":"HTTP authentication password","type":"string"}}},"match_pattern":{"description":"Match pattern a regular expression","type":"string"},"match_destination":{"type":"object","properties":{"destination_type":{"description":"Match destination type","type":"string","enum":["Hangup","Busy","Reject","Forward","FoneNumber","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Match destination value","type":"string"}}},"nomatch_destination":{"type":"object","properties":{"destination_type":{"description":"No Match destination type","type":"string","enum":["Hangup","Busy","Reject","Forward","FoneNumber","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"No Match destination value","type":"string"}}},"default_destination":{"type":"object","properties":{"destination_type":{"description":"Default destination type","type":"string","enum":["Hangup","Busy","Reject","Forward","FoneNumber","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Default destination value","type":"string"}}},"email_options":{"type":"object","properties":{"email":{"description":"Email address","type":"string"},"subject":{"description":"Email subject","type":"string"},"body":{"description":"Email body","type":"string"}}}}}}}}},"get":{"summary":"Get DigitQuery","operationId":"getDigitQuery","description":"Get information for a single DigitQuery.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"DigitQuery ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["DigitQueries","digitqueries"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"digitquery":{"type":"object","$ref":"#/components/schemas/DigitQuery"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"summary":"Delete DigitQuery","operationId":"deleteDigitQuery","description":"Remove a DigitQuery from an account.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"DigitQuery ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["DigitQueries","digitqueries"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"digitquery":{"type":"object","$ref":"#/components/schemas/DigitQuery"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messaging-brands":{"post":{"summary":"Create a new messaging brand","operationId":"createMessagingBrands","description":"Creates a new messaging brand","security":[{"jwt":[]}],"tags":["MessagingBrands","messagingbrands"],"responses":{"201":{"description":"Brand created","content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"type":"object","$ref":"#/components/schemas/MessagingBrands"}}}}}},"202":{"description":"Brand creation request pending review","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["displayName","phone","street","city","state","postalCode","country","email","entityType"],"properties":{"displayName":{"type":"string","maxLength":255,"description":"Brand/Marketing/DBA name of the business"},"companyName":{"type":"string","maxLength":255,"description":"The legal name of the business"},"ein":{"type":"string","maxLength":21,"description":"Tax ID of the business"},"einIssuingCountry":{"type":"string","minLength":2,"maxLength":2,"default":"US","description":"Two-letter ISO-2 country code of Tax ID issuing country"},"altBusinessId":{"type":"string","maxLength":50,"description":"Alternative Business Identifier"},"altBusinessIdType":{"type":"string","enum":["NONE","DUNS","GIIN","LEI"],"description":"Alternative Business Identifier Type"},"firstName":{"type":"string","maxLength":100,"description":"First name of business contact"},"lastName":{"type":"string","maxLength":100,"description":"Last name of business contact"},"phone":{"type":"string","maxLength":20,"description":"Support contact telephone number in E.164 format"},"mobilePhone":{"type":"string","maxLength":20,"description":"Valid wireless telephone in E.164 format"},"street":{"type":"string","maxLength":255,"description":"House number and street name"},"city":{"type":"string","maxLength":100,"description":"City Name"},"state":{"type":"string","maxLength":20,"description":"State or province"},"postalCode":{"type":"string","maxLength":10,"description":"Zipcode or postal code"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Two-letter ISO-2 country code"},"email":{"type":"string","maxLength":100,"format":"email","description":"Email address of support contact"},"stockSymbol":{"type":"string","maxLength":10,"description":"Stock symbol of the PUBLIC_PROFIT brand"},"stockExchange":{"type":"string","enum":["NONE","NASDAQ","NYSE","AMEX","AMX","ASX","B3","BME","BSE","FRA","ICEX","JPX","JSE","KRX","LON","NSE","OMX","SEHK","SGX","SSE","STO","SWX","SZSE","TSX","TWSE","VSE","OTHER"],"description":"The stock exchange where the PUBLIC_PROFIT brand is registered"},"website":{"type":"string","maxLength":255,"format":"uri","description":"The website/online URL address of the brand"},"brandRelationship":{"type":"string","enum":["BASIC_ACCOUNT","SMALL_ACCOUNT","MEDIUM_ACCOUNT","LARGE_ACCOUNT","KEY_ACCOUNT"],"description":"The brand relationship level to the CSP"},"vertical":{"type":"string","description":"The industry segment where the brand operates"},"referenceId":{"type":"string","maxLength":50,"description":"A customer-unique identifier managed by the CSP"},"entityType":{"type":"string","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"description":"The type of business entity"},"mock":{"type":"boolean","default":false,"description":"Signifies a brand as a mock brand"},"businessContactEmail":{"type":"string","maxLength":255,"format":"email","description":"Email of the business contact for the brand"},"tag":{"type":"array","items":{"type":"string"},"description":"Tags that can be set on the brand"}}}}}}},"get":{"summary":"Get Messaging Brands","operationId":"getMessagingBrands","description":"Get a list of all Messaging Brands","security":[{"jwt":[]}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"brands":{"type":"array","items":{"$ref":"#/components/schemas/MessagingBrands"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messages/receive":{"post":{"summary":"Set Delivery Service","operationId":"configureMessageReceive","description":"Configure the delivery service type used as the destination for messages received at a FoneNumber.","security":[{"jwt":[]}],"tags":["Messages","messages"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumber","type","value","url_method"],"properties":{"fonenumber":{"description":"Your FracTEL FoneNumber","type":"string"},"type":{"description":"Message routing type","type":"string","enum":["None","Device","Email","URL","Forward"]},"value":{"description":"Message routing type value","type":"string"},"url_method":{"description":"URL method (when `type` is URL)","type":"string","enum":["GET","POST","JSON"]},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}}}}}}},"/calls/send_notify":{"post":{"summary":"Set Send Callback","operationId":"configureCallSendNotify","description":"Configure the callback URL to notify when an outbound call is made. Each FoneNumber can be configured to use its own callback URL for handling send notifications.","security":[{"jwt":[]}],"tags":["Calls","calls"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumber","type"],"properties":{"fonenumber":{"description":"Your FracTEL FoneNumber","type":"string"},"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}}}}}}},"/announcements/{id}":{"get":{"summary":"Get Announcement","operationId":"getAnnouncement","description":"Get information for a single Announcement.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Announcement ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Announcements","announcements"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"announcement":{"type":"object","$ref":"#/components/schemas/Announcement"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update Announcement","operationId":"updateAnnouncement","description":"Update a Announcement.","security":[{"jwt":[]}],"tags":["Announcements","announcements"],"parameters":[{"name":"id","description":"Announcement ID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"announcement":{"type":"object","$ref":"#/components/schemas/Announcement"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"Name/Label for announcement","type":"string"},"soundfile":{"description":"SoundFile ID or Text to speech string","type":"string"},"destination_type":{"description":"Announcement destination type","type":"string","enum":["Hangup","Busy","Reject","Forward","FoneNumber","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"destination":{"description":"Announcement destination","type":"string"}}}}}}},"delete":{"summary":"Delete Announcement","operationId":"deleteAnnouncement","description":"Remove a Announcement from an account.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Announcement ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Announcements","announcements"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"announcement":{"type":"object","$ref":"#/components/schemas/Announcement"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/faxes/send_notify":{"post":{"summary":"Set Send Callback","operationId":"configureFaxSendNotify","description":"Configure the callback URL to notify when an outbound fax is made. Each FoneNumber can be configured to use its own callback URL for handling send notifications.","security":[{"jwt":[]}],"tags":["Faxes","faxes"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumber","type"],"properties":{"fonenumber":{"description":"Your FracTEL FoneNumber","type":"string"},"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}}}}}}},"/fonenumbers/order":{"post":{"summary":"Order FoneNumbers","operationId":"orderFonenumbers","description":"Order FoneNumbers available in FracTEL inventory.","security":[{"jwt":[]}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumberOrder"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumbers"],"properties":{"fonenumbers":{"description":"Array of Valid 10 digit fonenumbers (Maximum 20)","type":"array","items":{"type":"string"}},"messaging_enabled":{"description":"true if FoneNumbers need to be messaging enabled. Default is false.","type":"boolean"}}}}}}}},"/calls/{id}/answer":{"post":{"summary":"Answer Call","operationId":"answerCall","description":"Answer an in-progress call and connect it to a destination service.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Call ID from the create call response.","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Calls","calls"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"call":{"type":"object","properties":{"id":{"description":"Unique identifier of the call.","type":"string"},"result":{"description":"Result of the answer request.","type":"string"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["service_type","service_id"],"properties":{"service_type":{"description":"Destination service type.","type":"string","enum":["Conference","Forward","IVRMenu","Device","Scheduler","Fax","Voicemail"]},"service_id":{"description":"Destination service id for the selected service type.","type":"string"}}}}}}}},"/subaccounts/token":{"post":{"summary":"Create Subaccount Token","operationId":"createSubaccountToken","description":"Create new Subaccount token.","security":[{"jwt":[]}],"tags":["Subaccounts","subaccounts"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"subaccount":{"type":"object","properties":{"token":{"description":"JWT Token","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50Ijp7ImlkIjoiODAwODA1NjU2MiJ9LCJwb3J0YWwiOnsidG9rZW4iOiJjODJjMmVkYzMzNWIwYzI3NjYwOWIzNDcxMmFmOWZlOCJ9LCJpYXQiOjE1MTYxMzc1NTQsImV4cCI6MTUxNjE0MTE1NH0.9XdG1o-KIsO_K7o0eaHb-Enqy4ETkQSQS4MhpdvhsrE"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["subaccount"],"properties":{"subaccount":{"description":"Subaccount code","type":"string"}}}}}}}},"/fonenumbers/lookup":{"post":{"summary":"Lookup numbers","operationId":"lookupNumbers","description":"API to lookup number information.","security":[{"jwt":[]}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","items":{"$ref":"#/components/schemas/NumberLookup"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["numbers"],"properties":{"numbers":{"description":"Array of Valid 10 digit numbers","type":"array","items":{"type":"string"}}}}}}}}},"/fonenumbers/reserve":{"get":{"summary":"Get Reserved FoneNumbers","operationId":"getReservedFonenumbers","description":"Get a list of all Reserved FoneNumbers.","security":[{"jwt":[]}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumbers":{"type":"array","items":{"$ref":"#/components/schemas/FoneNumberReserved"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Reserve FoneNumbers","operationId":"reserveFonenumbers","description":"Reserve FoneNumbers available in FracTEL inventory.","security":[{"jwt":[]}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumberReserve"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_string"],"properties":{"order_string":{"description":"Array of Valid order strings (Maximum 20)","type":"string"}}}}}}},"delete":{"summary":"Release FoneNumbers","operationId":"releaseFonenumbers","description":"Release reserved fonenumbers.","security":[{"jwt":[]}],"parameters":[{"name":"fonenumber","description":"A reserved FoneNumber","in":"query","required":true,"schema":{"type":"string"}}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumbers":{"type":"array","items":{"type":"object","properties":{"fonenumber":{"type":"string","description":"FoneNumber","example":3214991000},"result":{"type":"string","description":"Result of the order","example":"SUCCESS"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/calls/{id}/transfer":{"post":{"summary":"Transfer Call","operationId":"transferCall","description":"Transfer an in-progress call to a destination service.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Call ID from the create call response.","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Calls","calls"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"call":{"type":"object","properties":{"id":{"description":"Unique identifier of the call.","type":"string"},"result":{"description":"Result of the transfer request.","type":"string"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["service_type","service_id"],"properties":{"service_type":{"description":"Destination service type.","type":"string","enum":["Conference","Forward","IVRMenu","Device","Scheduler","Fax","Voicemail"]},"service_id":{"description":"Destination service id for the selected service type.","type":"string"}}}}}}}},"/accounts/cdr_notify":{"post":{"summary":"Set CDR Callback","operationId":"configureAccountCdrNotify","description":"Configure the callback URL to notify when a call dialing record is available.","security":[{"jwt":[]}],"tags":["Accounts","accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"object","$ref":"#/components/schemas/Account"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["account_id","method","url"],"properties":{"account_id":{"description":"FoneStorm account id","type":"string"},"method":{"description":"Callback URL method","type":"string"},"url":{"description":"Callback URL. See **Notes** for additional information.","type":"string"},"username":{"description":"Callback URL username","type":"string"},"password":{"description":"Callback URL password","type":"string"}}}}}}}},"/messages/send_notify":{"post":{"summary":"Set Send Callback","operationId":"configureMessageSendNotify","description":"Configure the callback URL to notify when a message is sent. Each FoneNumber can be configured to use its own callback URL for handling send notifications.","security":[{"jwt":[]}],"tags":["Messages","messages"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumber","type"],"properties":{"fonenumber":{"description":"Your FracTEL FoneNumber","type":"string"},"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}}}}}}},"/calls/receive_notify":{"post":{"summary":"Set Receive Callback","operationId":"configureCallReceiveNotify","description":"Configure the callback URL to notify when a call is received. Each FoneNumber can be configured to use its own callback URL for handling receive notifications.","security":[{"jwt":[]}],"tags":["Calls","calls"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumber","type"],"properties":{"fonenumber":{"description":"Your FracTEL FoneNumber","type":"string"},"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}}}}}}},"/faxes/receive_notify":{"post":{"summary":"Set Receive Callback","operationId":"configureFaxReceiveNotify","description":"Configure the callback URL to notify when an inbound fax is received. Each FoneNumber can be configured to use its own callback URL for handling receive notifications.","security":[{"jwt":[]}],"tags":["Faxes","faxes"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumber","type"],"properties":{"fonenumber":{"description":"Your FracTEL FoneNumber","type":"string"},"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}}}}}}},"/speeddials/{speed_dial}":{"get":{"summary":"Get SpeedDial","operationId":"getSpeedDial","description":"Get information for a single SpeedDial.","security":[{"jwt":[]}],"parameters":[{"name":"speed_dial","description":"1 to 6 digit SpeedDial","in":"path","required":true,"schema":{"type":"string"}}],"tags":["SpeedDials","speeddials"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"speedDial":{"type":"object","$ref":"#/components/schemas/SpeedDial"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update SpeedDial","operationId":"updateSpeedDial","description":"Update a SpeedDial.","security":[{"jwt":[]}],"tags":["SpeedDials","speeddials"],"parameters":[{"name":"speed_dial","description":"1 to 6 digit SpeedDial","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"speedDial":{"type":"object","$ref":"#/components/schemas/SpeedDial"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"Name/Label for speeddial","type":"string"},"service_type":{"description":"SpeedDial destination type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"service_id":{"description":"SpeedDial destination","type":"string"}}}}}}},"delete":{"summary":"Delete SpeedDial","operationId":"deleteSpeedDial","description":"Remove a SpeedDial from an account.","security":[{"jwt":[]}],"parameters":[{"name":"speed_dial","description":"1 to 6 digit SpeedDial","in":"path","required":true,"schema":{"type":"string"}}],"tags":["SpeedDials","speeddials"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"speedDial":{"type":"object","$ref":"#/components/schemas/SpeedDial"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/fonenumbers/{fonenumber}":{"get":{"summary":"Get FoneNumber","operationId":"getFonenumber","description":"Get information for a single FoneNumber.","security":[{"jwt":[]}],"parameters":[{"name":"fonenumber","description":"FoneNumber associated with the account","in":"path","required":true,"schema":{"type":"string"}}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update FoneNumber","operationId":"updateFonenumber","description":"Update a FoneNumber.","security":[{"jwt":[]}],"tags":["FoneNumbers","fonenumbers"],"parameters":[{"name":"fonenumber","description":"FoneNumber associated with the account","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"description":"FoneNumber label","type":"string"},"cnam":{"description":"FoneNumber CNAM. Max length 15.","type":"string"},"group":{"description":"FoneNumber group","type":"string"},"record_calls":{"description":"Call recording options.","type":"string","enum":["Default","Yes","No","InBound","OutBound"]},"message_options":{"description":"Message settings for FoneNumber","type":"object","properties":{"enable_messaging":{"description":"Enable messaging on the FoneNumber.","type":"boolean"},"messaging_campaign":{"description":"Campaign ID for messaging.","type":"string"},"receive":{"description":"Message service type settings","type":"object","required":["type"],"properties":{"type":{"description":"Message routing type.","type":"string","enum":["None","Device","Email","URL","Forward"]},"value":{"description":"Message routing type value","type":"string"},"url_method":{"description":"URL method. See **Notes** for additional information.","type":"string","enum":["GET","POST","JSON"]},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}},"receive_notify":{"type":"object","required":["type"],"properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}},"send_notify":{"type":"object","required":["type"],"properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}}}},"call_options":{"description":"Call settings for FoneNumber","type":"object","properties":{"receive":{"description":"Voice service type settings","type":"object","required":["type","value"],"properties":{"type":{"description":"Voice Service type.","type":"string","enum":["Hangup","Busy","Reject","Forward","FoneNumber","SpeedDial","Announcement","CallMonetizer","Conference","Device","DigitQuery","Fax2Email","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"]},"value":{"description":"Voice routing type value","type":"string"},"url_method":{"description":"URL method. See **Notes** for additional information.","type":"string","enum":["GET","POST","JSON"]},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}},"receive_notify":{"type":"object","required":["type"],"properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}},"send_notify":{"type":"object","required":["type"],"properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}}}},"fax_options":{"description":"Fax settings for FoneNumber","type":"object","properties":{"receive_notify":{"type":"object","required":["type"],"properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}},"send_notify":{"type":"object","required":["type"],"properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}},"valid_senders":{"description":"Valid Fax sender email addresses","type":"array","items":{"type":"string"}}}},"e911_options":{"description":"E911 settings for FoneNumber","type":"object","properties":{"location_id":{"description":"Location ID of the location to set as the E911 Location.","type":"string"},"set_default":{"description":"Set the location as the account default E911 location.","type":"boolean"},"active":{"description":"Location status flag","type":"string","enum":["Yes","No","Test","Cancel","Delete"]}}},"port_out_pin":{"description":"FoneNumber PortOut 4 digit security PIN","type":"string"}}}}}}},"delete":{"summary":"Delete FoneNumber","operationId":"deleteFonenumber","description":"Remove a FoneNumber from an account.","security":[{"jwt":[]}],"parameters":[{"name":"fonenumber","description":"FoneNumber associated with the account","in":"path","required":true,"schema":{"type":"string"}}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/voicemails/{id}/messages":{"get":{"summary":"Get Voicemail Messages","operationId":"getVoicemail Messages","description":"Get information for Voicemail Messages.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Voicemail ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Voicemails","voicemails"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"voicemail":{"type":"object","$ref":"#/components/schemas/VoicemailMessages"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update Voicemail Messages","operationId":"updateVoicemailMessages","description":"Update a Voicemail Message.","security":[{"jwt":[]}],"tags":["Voicemails","voicemails"],"parameters":[{"name":"id","description":"Voicemail ID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"voicemail":{"type":"object","$ref":"#/components/schemas/VoicemailMessages"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["url","status"],"properties":{"url":{"description":"Voicemail message url.","type":"string"},"status":{"description":"Status of voicemail message.","type":"string","enum":["New","Old","Delete"]}}}}}}}},"/messages/receive_notify":{"post":{"summary":"Set Receive Callback","operationId":"configureMessageReceiveNotify","description":"Configure the callback URL to notify when a message is received. Each FoneNumber can be configured to use its own callback URL for handling receive notifications.","security":[{"jwt":[]}],"tags":["Messages","messages"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fonenumber","type"],"properties":{"fonenumber":{"description":"Your FracTEL FoneNumber","type":"string"},"type":{"description":"Notification type.","type":"string","enum":["None","Callback","Email"]},"email":{"description":"Email address. `REQUIRED` if type is `Email`.","type":"string"},"method":{"description":"Callback URL method. `REQUIRED` if type is `Callback`.","type":"string","enum":["GET","POST","JSON"]},"url":{"description":"Callback URL. `REQUIRED` if type is `Callback`. See **Notes** for additional information.","type":"string"},"url_username":{"description":"Username for HTTP **Basic** authentication scheme","type":"string"},"url_password":{"description":"Password for HTTP **Basic** authentication scheme","type":"string"}}}}}}}},"/fonenumbers/reserve/local":{"get":{"summary":"Search Local Reserve Inventory FoneNumbers","operationId":"searchLocalReserveInventoryFonenumbers","description":"Get a list of local Reserve inventory FoneNumbers based on search parameters.","security":[{"jwt":[]}],"parameters":[{"name":"area_code","description":"A valid 3-digit area code","in":"query","required":true,"schema":{"type":"string"}},{"name":"search_option","description":"Allowed values are `Starts with`, `Ends with` or `Contains`","in":"query","required":false,"schema":{"type":"string","enum":["Starts with","Ends with","Contains"]}},{"name":"search_pattern","description":"A valid alphanumeric (a-z,A-Z,0-9) search pattern. Max length 7.","in":"query","required":false,"schema":{"type":"string"}},{"name":"overlapping_area_code","description":"Include overlapping area codes in result","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"max","description":"Maximum fonenumbers in result","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10000,"default":1000}}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumbers":{"type":"array","items":{"$ref":"#/components/schemas/FoneNumberInventory"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/accounts/{id}/integrations":{"get":{"summary":"Get Account Integrations","operationId":"getAccountIntegrations","description":"Get configured account integrations.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Account id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Accounts","accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"integrations":{"type":"array","items":{"$ref":"#/components/schemas/Integration"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messaging-brands/{brand_id}":{"put":{"summary":"Update an existing brand","operationId":"updateMessagingBrand","description":"Updates a brand","security":[{"jwt":[]}],"parameters":[{"name":"brand_id","description":"Brand ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["messagingbrands","MessagingBrands"],"responses":{"200":{"description":"Brand updated","content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"type":"object","$ref":"#/components/schemas/MessagingBrands"}}}}}},"202":{"description":"Brand update request pending review","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"brand_id":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyName":{"type":"string","maxLength":255,"description":"The legal name of the business"},"firstName":{"type":"string","maxLength":100,"description":"First name of business contact"},"lastName":{"type":"string","maxLength":100,"description":"Last name of business contact"},"phone":{"type":"string","maxLength":20,"description":"Support contact telephone number in E.164 format"},"street":{"type":"string","maxLength":255,"description":"House number and street name"},"city":{"type":"string","maxLength":100,"description":"City Name"},"state":{"type":"string","maxLength":20,"description":"State or province"},"postalCode":{"type":"string","maxLength":10,"description":"Zipcode or postal code"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"Two-letter ISO-2 country code"},"email":{"type":"string","maxLength":100,"format":"email","description":"Email address of support contact"},"stockSymbol":{"type":"string","maxLength":10,"description":"Stock symbol of the PUBLIC_PROFIT brand"},"stockExchange":{"type":"string","enum":["NONE","NASDAQ","NYSE","AMEX","AMX","ASX","B3","BME","BSE","FRA","ICEX","JPX","JSE","KRX","LON","NSE","OMX","SEHK","SGX","SSE","STO","SWX","SZSE","TSX","TWSE","VSE","OTHER"],"description":"The stock exchange where the PUBLIC_PROFIT brand is registered"},"website":{"type":"string","maxLength":255,"format":"uri","description":"The website/online URL address of the brand"},"vertical":{"type":"string","description":"The industry segment where the brand operates"},"altBusinessId":{"type":"string","maxLength":50,"description":"Alternative Business Identifier"},"altBusinessIdType":{"type":"string","enum":["NONE","DUNS","GIIN","LEI"],"description":"Alternative Business Identifier Type"},"businessContactEmail":{"type":"string","maxLength":255,"format":"email","description":"Email of the business contact for the brand"}}}}}}},"get":{"summary":"Get brand identified by id","operationId":"getMessagingBrandById","description":"Get a brand by its ID.","security":[{"jwt":[]}],"parameters":[{"name":"brand_id","description":"Brand ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"type":"object","$ref":"#/components/schemas/MessagingBrands"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"summary":"Delete Messaging Brand","operationId":"deleteMessagingBrand","description":"Delete a Messaging Brand by ID","security":[{"jwt":[]}],"tags":["MessagingBrands","messagingbrands"],"parameters":[{"name":"brand_id","description":"ID of the Messaging Brand to delete","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"type":"object","$ref":"#/components/schemas/MessagingBrands"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/fonenumbers/inventory/local":{"get":{"summary":"Search Local FoneNumbers","operationId":"searchLocalFonenumbers","description":"Get a list of local FoneNumbers based on search parameters.","security":[{"jwt":[]}],"parameters":[{"name":"area_code","description":"A valid 3-digit area code. Either `area_code` or `search_pattern` required.","in":"query","required":false,"schema":{"type":"string"}},{"name":"rate_center","description":"A valid Ratecenter name","in":"query","required":false,"schema":{"type":"string"}},{"name":"state","description":"A valid State name","in":"query","required":false,"schema":{"type":"string"}},{"name":"search_option","description":"Allowed values are `Starts with`, `Ends with` or `Contains`","in":"query","required":false,"schema":{"type":"string","enum":["Starts with","Ends with","Contains"]}},{"name":"search_pattern","description":"A valid alphanumeric (a-z,A-Z,0-9) search pattern. Either `area_code` or `search_pattern` required.","in":"query","required":false,"schema":{"type":"string"}},{"name":"overlapping_area_code","description":"Include overlapping area codes in result","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"include_offnet","description":"Include offnet fonenumbers","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"max","description":"Maximum fonenumbers in result","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10000,"default":1000}},{"name":"max_tier","description":"Max tier for FoneNumber","in":"query","required":false,"schema":{"type":"string","enum":["X","A","B","C","D","E","F","G","H","I","T","Z"]}}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumbers":{"type":"array","items":{"$ref":"#/components/schemas/FoneNumberInventory"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/conferences/{id}/fonenumbers":{"get":{"summary":"Conference FoneNumbers","operationId":"getConferenceFonenumbers","description":"Get FoneNumbers assigned to a conference.","security":[{"jwt":[]}],"parameters":[{"name":"id","description":"Conference id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Conferences","conferences"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumbers":{"type":"array","items":{"type":"string","example":3214990000}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/fonenumbers/reserve/tollfree":{"get":{"summary":"Search TollFree Reserve Inventory FoneNumbers","operationId":"searchTollFreeReserveInventoryFonenumbers","description":"Get a list of tollfree Reserve Inventory FoneNumbers based on search parameters.","security":[{"jwt":[]}],"parameters":[{"name":"tollfree_code","description":"One or more valid 3-digit tollfree codes, comma separated","in":"query","required":true,"schema":{"type":"string"}},{"name":"search_option","description":"Allowed values are `Starts with`, `Ends with` or `Contains`","in":"query","required":false,"schema":{"type":"string","enum":["Starts with","Ends with","Contains"]}},{"name":"search_pattern","description":"A valid alphanumeric (a-z,A-Z,0-9) search pattern. Max length 7.","in":"query","required":false,"schema":{"type":"string"}},{"name":"max","description":"Maximum fonenumbers in result","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10000,"default":1000}}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumbers":{"type":"array","items":{"$ref":"#/components/schemas/FoneNumberInventory"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messaging-brands/enum/usecase":{"get":{"summary":"List all use case types","operationId":"listMessagingBrandsUseCases","description":"Returns a list of all possible use case types for campaigns","security":[{"jwt":[]}],"tags":["MessagingBrands","messagingbrands"],"parameters":[{"name":"valid_sub_usecase","in":"query","description":"Filter by sub-usecase validity","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Keyed by use case code.","additionalProperties":{"type":"object","properties":{"classification":{"type":"string","description":"Classification type of the use case"},"description":{"type":"string","description":"Detailed description of the use case"},"displayName":{"type":"string","description":"Human-readable display name for the use case"},"maxSubUsecases":{"type":"integer","description":"Maximum number of sub-use cases allowed"},"minSubUsecases":{"type":"integer","description":"Minimum number of sub-use cases required"},"validSubUsecase":{"type":"boolean","description":"Whether this use case supports sub-use cases"}}},"example":{"2FA":{"classification":"STANDARD","description":"Two-Factor authentication, one-time use password, password reset","displayName":"2FA","maxSubUsecases":0,"minSubUsecases":0,"validSubUsecase":true},"ACCOUNT_NOTIFICATION":{"classification":"STANDARD","description":"All reminders, alerts, and notifications.  (Examples include:  flight delayed, hotel booked, appointment reminders.)","displayName":"Account Notification","maxSubUsecases":0,"minSubUsecases":0,"validSubUsecase":true}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messaging-brands/enum/usState":{"get":{"summary":"List all US states","operationId":"listMessagingBrandUsStates","description":"Returns a list of all US states and territories","security":[{"jwt":[]}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"states":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"State full name"},"code":{"type":"string","description":"Two-letter state code"}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messaging-brands/enum/country":{"get":{"summary":"List all countries","operationId":"listMessagingBrandCountries","description":"Returns a list of all countries with their ISO codes","security":[{"jwt":[]}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"countries":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Country name"},"code":{"type":"string","description":"Two-letter ISO country code"}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/fonenumbers/inventory/tollfree":{"get":{"summary":"Search TollFree FoneNumbers","operationId":"searchTollFreeFonenumbers","description":"Get a list of tollfree FoneNumbers based on search parameters.","security":[{"jwt":[]}],"parameters":[{"name":"tollfree_code","description":"One or more valid 3-digit tollfree codes, comma separated","in":"query","required":false,"schema":{"type":"string"}},{"name":"search_option","description":"Allowed values are `Starts with`, `Ends with` or `Contains`","in":"query","required":false,"schema":{"type":"string","enum":["Starts with","Ends with","Contains"]}},{"name":"search_pattern","description":"A valid alphanumeric (a-z,A-Z,0-9) search pattern. Max length 7.","in":"query","required":false,"schema":{"type":"string"}},{"name":"max","description":"Maximum fonenumbers in result","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10000,"default":1000}}],"tags":["FoneNumbers","fonenumbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumbers":{"type":"array","items":{"$ref":"#/components/schemas/FoneNumberInventory"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messaging-brands/enum/vertical":{"get":{"summary":"List all vertical types","operationId":"listMessagingBrandsVerticals","description":"Returns a list of all possible vertical types for brands","security":[{"jwt":[]}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Keyed by vertical code.","additionalProperties":{"type":"object","properties":{"industryId":{"type":"string","description":"Industry identifier"},"displayName":{"type":"string","description":"Human-readable display name for the vertical"},"description":{"type":"string","description":"Description of the vertical industry"}}},"example":{"PROFESSIONAL":{"industryId":"professional-services","displayName":"Professional Services","description":"Professional services."},"REAL_ESTATE":{"industryId":"real-estate","displayName":"Real Estate","description":"Buying and Selling of residential and commercial properties."}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/fonenumbers/{fonenumber}/restore":{"put":{"summary":"Restore a Deleted FoneNumber","operationId":"restoreFonenumber","description":"Restore a Deleted FoneNumber.","security":[{"jwt":[]}],"tags":["FoneNumbers","fonenumbers"],"parameters":[{"name":"fonenumber","description":"FoneNumber associated with the account","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/fonenumbers/{fonenumber}/service":{"post":{"summary":"Set Service Type","operationId":"setFonenumberServiceType","description":"Set service type for a FoneNumber.","security":[{"jwt":[]}],"tags":["FoneNumbers","fonenumbers"],"parameters":[{"name":"fonenumber","description":"FoneNumber associated with the account","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"fonenumber":{"type":"object","$ref":"#/components/schemas/FoneNumber"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["service_type"],"properties":{"service_type":{"description":"Service type. Allowed values are `Conference`, `Hangup`, `Busy`, `Reject`","type":"string","enum":["Conference","Hangup","Busy","Reject"]},"service_id":{"description":"Service id","type":"string"}}}}}}}},"/messaging-brands/{brand_id}/revet":{"put":{"summary":"Resubmit a brand for verification","operationId":"revetMessagingBrand","description":"Resubmits a brand with UNVERIFIED identity status for verification","security":[{"jwt":[]}],"parameters":[{"name":"brand_id","description":"Brand ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Re-vetting request successful","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["evpId","vettingClass"],"properties":{"evpId":{"type":"string","description":"External vetting partner ID"},"vettingClass":{"type":"string","description":"Type of vetting"}}}}}}}},"/messaging-brands/{brand_id}/vetting":{"get":{"summary":"List external vetting records for a brand","operationId":"listMessagingBrandVetting","description":"Returns all external vetting records associated with a brand","security":[{"jwt":[]}],"parameters":[{"name":"brand_id","description":"Brand ID","in":"path","required":true,"schema":{"type":"string"}},{"name":"evpId","description":"External vetting partner ID","in":"query","required":false,"schema":{"type":"string"}},{"name":"vettingClass","description":"Type of vetting","in":"query","required":false,"schema":{"type":"string"}},{"name":"vettingStatus","description":"Status of vetting","in":"query","required":false,"schema":{"type":"string"}}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"vettingId":{"type":"string"},"evpId":{"type":"string"},"vettingClass":{"type":"string"},"vettingStatus":{"type":"string"},"vettingScore":{"type":"number"},"vettingDate":{"type":"string","format":"date-time"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Request external vetting for a brand","operationId":"requestMessagingBrandVetting","description":"Places an order for an external vet via a TCR-approved vetting provider","security":[{"jwt":[]}],"parameters":[{"name":"brand_id","description":"Brand ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["MessagingBrands","messagingbrands"],"responses":{"202":{"description":"Vetting request accepted","content":{"application/json":{"schema":{"type":"object","properties":{"vettingId":{"type":"string"},"evpId":{"type":"string"},"vettingClass":{"type":"string"},"vettingStatus":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["evpId","vettingClass"],"properties":{"evpId":{"type":"string","description":"External vetting partner ID"},"vettingClass":{"type":"string","description":"Type of vetting"}}}}}}}},"/messaging-brands/{brand_id}/campaigns":{"get":{"summary":"Get brand campaigns","operationId":"getMessagingBrandCampaigns","description":"Get campaigns of a brand.","security":[{"jwt":[]}],"parameters":[{"name":"brand_id","description":"Brand ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/MessagingCampaigns"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Create a campaign under a brand","operationId":"createMessagingCampaign","description":"Creates a new campaign for the specified brand","security":[{"jwt":[]}],"parameters":[{"name":"brand_id","description":"Brand ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["MessagingBrands","messagingbrands"],"responses":{"201":{"description":"Campaign created","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","$ref":"#/components/schemas/MessagingCampaigns"}}}}}},"202":{"description":"Campaign creation request pending review","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["usecase","description","embeddedLink","embeddedPhone","termsAndConditions","numberPool","ageGated","directLending","subscriberOptin","subscriberOptout","subscriberHelp","sample1","messageFlow","helpMessage"],"properties":{"usecase":{"type":"string","description":"The campaign's intended use (e.g., 2FA, MARKETING)"},"subUsecases":{"type":"array","items":{"type":"string"},"description":"Sub-use cases for additional campaign context"},"resellerId":{"type":"string","description":"ID of reseller (if applicable)"},"description":{"type":"string","minLength":40,"description":"Detailed description of the campaign's purpose"},"embeddedLink":{"type":"boolean","description":"Whether the campaign uses embedded links"},"embeddedPhone":{"type":"boolean","description":"Whether the campaign uses embedded phone numbers"},"termsAndConditions":{"type":"boolean","default":true,"description":"Agreement to TCR terms"},"numberPool":{"type":"boolean","description":"Whether campaign uses more than 50 numbers"},"ageGated":{"type":"boolean","description":"Whether campaign contains age-gated content"},"directLending":{"type":"boolean","description":"Whether the campaign is for direct lending"},"subscriberOptin":{"type":"boolean","description":"Whether subscriber opt-in is required"},"subscriberOptout":{"type":"boolean","description":"Whether subscribers can opt out"},"subscriberHelp":{"type":"boolean","description":"Whether help options are available"},"sample1":{"type":"string","description":"Sample message 1"},"sample2":{"type":"string","description":"Sample message 2"},"sample3":{"type":"string","description":"Sample message 3"},"sample4":{"type":"string","description":"Sample message 4"},"sample5":{"type":"string","description":"Sample message 5"},"messageFlow":{"type":"string","description":"Description of subscriber opt-in flow"},"helpMessage":{"type":"string","description":"Sample help message"},"autoRenewal":{"type":"boolean","default":true,"description":"Whether campaign auto-renews"},"referenceId":{"type":"string","maxLength":50,"description":"CSP-managed reference identifier"},"mock":{"type":"boolean","default":false,"description":"Signifies a mock campaign"},"optinKeywords":{"type":"string","description":"Keywords for opt-in"},"optoutKeywords":{"type":"string","description":"Keywords for opt-out"},"helpKeywords":{"type":"string","description":"Keywords for help"},"optinMessage":{"type":"string","description":"Sample opt-in message"},"optoutMessage":{"type":"string","description":"Sample opt-out message"},"privacyPolicyLink":{"type":"string","format":"uri","description":"Link to privacy policy"},"termsAndConditionsLink":{"type":"string","format":"uri","description":"Link to terms and conditions"},"embeddedLinkSample":{"type":"string","description":"Sample embedded link"},"mnoIds":{"type":"array","items":{"type":"string"},"description":"Specific MNOs to target"}}}}}}}},"/messaging-brands/enum/extVettingProvider":{"get":{"summary":"List all external vetting providers","operationId":"listMessagingBrandVettingProviders","description":"Returns a list of all external vetting partners that participate in the TCR ecosystem","security":[{"jwt":[]}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"vettingProviders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Provider ID"},"name":{"type":"string","description":"Provider name"},"vettingClasses":{"type":"array","items":{"type":"string"},"description":"Supported vetting classes"}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messaging-brands/enum/terms_and_conditions":{"get":{"summary":"List all terms and conditions","operationId":"listMessagingBrandsTermsAndConditions","description":"Returns a list of all possible terms and conditions for brands","security":[{"jwt":[]}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"verticals":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Terms and conditions"}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messaging-brands/{brand_id}/campaigns/{campaign_id}":{"get":{"summary":"Get brand campaign by ID","operationId":"getMessagingBrandCampaignById","description":"Get a specific campaign of a brand by its ID.","security":[{"jwt":[]}],"parameters":[{"name":"brand_id","description":"Brand ID","in":"path","required":true,"schema":{"type":"string"}},{"name":"campaign_id","description":"Campaign ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","$ref":"#/components/schemas/MessagingCampaigns"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"summary":"Update an existing campaign","operationId":"updateMessagingCampaign","description":"Updates a campaign","security":[{"jwt":[]}],"parameters":[{"name":"brand_id","description":"Brand ID","in":"path","required":true,"schema":{"type":"string"}},{"name":"campaign_id","description":"Campaign ID","in":"path","required":true,"schema":{"type":"string"}}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Campaign updated","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","$ref":"#/components/schemas/MessagingCampaigns"}}}}}},"202":{"description":"Campaign update request pending review","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"campaign_id":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","minLength":40,"description":"Detailed description of the campaign's purpose"},"embeddedLink":{"type":"boolean","description":"Whether the campaign uses embedded links"},"embeddedPhone":{"type":"boolean","description":"Whether the campaign uses embedded phone numbers"},"numberPool":{"type":"boolean","description":"Whether campaign uses more than 50 numbers"},"ageGated":{"type":"boolean","description":"Whether campaign contains age-gated content"},"directLending":{"type":"boolean","description":"Whether the campaign is for direct lending"},"sample1":{"type":"string","description":"Sample message 1"},"sample2":{"type":"string","description":"Sample message 2"},"sample3":{"type":"string","description":"Sample message 3"},"sample4":{"type":"string","description":"Sample message 4"},"sample5":{"type":"string","description":"Sample message 5"},"messageFlow":{"type":"string","description":"Description of subscriber opt-in flow"},"helpMessage":{"type":"string","description":"Sample help message"},"autoRenewal":{"type":"boolean","description":"Whether campaign auto-renews"},"optinKeywords":{"type":"string","description":"Keywords for opt-in"},"optoutKeywords":{"type":"string","description":"Keywords for opt-out"},"helpKeywords":{"type":"string","description":"Keywords for help"},"optinMessage":{"type":"string","description":"Sample opt-in message"},"optoutMessage":{"type":"string","description":"Sample opt-out message"},"privacyPolicyLink":{"type":"string","format":"uri","description":"Link to privacy policy"},"termsAndConditionsLink":{"type":"string","format":"uri","description":"Link to terms and conditions"},"embeddedLinkSample":{"type":"string","description":"Sample embedded link"}}}}}}},"delete":{"summary":"Delete Messaging Campaign","operationId":"deleteMessagingCampaign","description":"Delete a Messaging Campaign by ID","security":[{"jwt":[]}],"tags":["MessagingBrands","messagingbrands"],"parameters":[{"name":"brand_id","description":"ID of the Messaging Brand to delete","in":"path","required":true,"schema":{"type":"string"}},{"name":"campaign_id","description":"ID of the Messaging Campaign to delete","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","$ref":"#/components/schemas/MessagingCampaigns"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messaging-brands/{brand_id}/campaigns/{campaign_id}/phonenumbers":{"get":{"summary":"List phonenumbers of a campaign","operationId":"getCampaignPhonenumbers","description":"List phonenumbers of a campaign.","security":[{"jwt":[]}],"parameters":[{"name":"brand_id","description":"Brand ID","in":"path","required":true,"schema":{"type":"string"}},{"name":"campaign_id","description":"Campaign ID","in":"path","required":true,"schema":{"type":"string"}},{"name":"active","description":"Active on campaign","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"page_no","description":"Page no for next result","in":"query","required":false,"schema":{"type":"integer","default":1}},{"name":"per_page","description":"Phonenumbers per page","in":"query","required":false,"schema":{"type":"integer","default":10}}],"tags":["MessagingBrands","messagingbrands"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","properties":{"phonenumbers":{"type":"array","items":{"$ref":"#/components/schemas/MessagingCampaignPhonenumbers"}},"page_no":{"type":"integer"},"per_page":{"type":"integer"},"total_records":{"type":"integer"}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NotFound"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"jwt":{"type":"apiKey","name":"token","in":"header"},"tokenAuth":{"type":"apiKey","in":"header","name":"Token"}},"schemas":{"Fax":{"type":"object","required":["id"],"properties":{"id":{"description":"Unique identifier of fax.","type":"string","example":"556d82fc-5d64-41f6-b2f6-2d807e4ff95c"}}},"Call":{"type":"object","required":["id"],"properties":{"id":{"description":"Unique identifier of call.","type":"string","example":"556d82fc-5d64-41f6-b2f6-2d807e4ff95c"}}},"User":{"type":"object","properties":{"email":{"description":"Email address.","type":"string","example":"support@fractel.net"},"dashboard_role":{"description":"User Role.","type":"string","enum":["None","Location","Organization","Agent","Master"],"example":"Organization"},"dashboard_access":{"description":"User access","type":"string","enum":["None","User","Manager","Administrator","Custom"],"example":"Administrator"},"first_name":{"description":"User First Name","type":"string","example":"John"},"last_name":{"description":"User Last Name","type":"string","example":"Doe"},"title":{"description":"User Title","type":"string","example":"Admin"},"fractelfone":{"description":"FracTELfone device id","type":"string","example":123456123456},"account_id":{"description":"User account id","type":"string","example":2005559999},"custom_access":{"type":"object","description":"Custom access options","properties":{"subaccounts":{"description":"Subaccount access options","type":"string","enum":["None","Read","Edit","Add"],"example":"Add"},"users":{"description":"Users access options","type":"string","enum":["None","Read","Edit","Add","Remove"],"example":"Remove"},"business_objects":{"description":"Business Object access options","type":"string","enum":["None","Read","Edit","Add","Remove"],"example":"Remove"},"fonenumbers":{"description":"FoneNumbers access options","type":"string","enum":["None","Read","Edit","Add","Remove"],"example":"Remove"},"billing":{"description":"Billing access options","type":"string","enum":["None","Read"],"example":"Read"},"call_records":{"description":"Call Records access options","type":"string","enum":["None","Read"],"example":"Read"}}}}},"List":{"type":"object","required":["id"],"properties":{"id":{"description":"Unique identifier of list.","type":"string"},"account_id":{"description":"Unique identifier of associated account.","type":"string"},"name":{"description":"Name of list.","type":"string"}}},"Error":{"type":"object","required":["error","message","status_code"],"properties":{"error":{"type":"string"},"message":{"type":"string"},"status_code":{"type":"integer"}}},"Device":{"type":"object","properties":{"username":{"description":"Unique identifier of device (12-digit number).","type":"string","example":123456123456},"name":{"description":"Human-readable label used for device.","type":"string","example":"My Device"},"fonenumber":{"description":"Caller ID assigned to this device.","type":"string","example":3214991000},"mac_address":{"description":"Mac address of device (If available).","type":"string","example":"aabbccddeeff"},"type":{"description":"Device type","type":"string","example":"FracTELfone"},"speed_dial":{"description":"1 to 6 digit device speed dial.","type":"string","example":1234},"call_recording":{"description":"Call recording setting on device. One of the following - default, yes, no, inbound, outbound, ondemand","type":"string","example":"default"},"e911location_id":{"description":"ID for E911Location setting object.","type":"string","example":null},"areacode":{"description":"3-digit local area code.","type":"string","example":321},"ring_simultaneously":{"description":"10-digit Phone number to ring simultaneously with device","type":"string","example":null},"receive_notify":{"type":"object","description":"Callback URL to notify when a device gets a call.","properties":{"type":{"type":"string","description":"Configured notification type.","example":"Email"},"email":{"type":"string","description":"Email address if configured for email.","example":"support@fractel.net"},"url":{"type":"string","description":"HTTP URL.","example":null},"method":{"type":"string","description":"HTTP URL method.","example":null}}},"send_notify":{"type":"object","description":"Callback URL to notify when a device makes a call.","properties":{"type":{"type":"string","description":"Configured notification type.","example":"URL"},"email":{"type":"string","description":"Email address if configured for email.","example":null},"url":{"type":"string","description":"HTTP URL.","example":"https://example.com/send_notify"},"method":{"type":"string","description":"HTTP URL method.","example":"JSON"}}},"host_type":{"description":"Host type for Trunk Device. static or dynamic","type":"string","example":"dynamic"},"host_ip":{"description":"IP of the host if host_type is static","type":"string","example":null},"host_port":{"description":"Port of the host if host_type is static","type":"string","example":null},"timeout_service":{"type":"object","description":"Timeout Service for a Device.","properties":{"timeout_type":{"description":"Timeout Service Type","type":"string","enum":["None","Forward","Voicemail","Voice2Email"],"example":"Voicemail"},"timeout_id":{"description":"Timeout Service ID","type":"string","example":"VM12341234"},"timeout_seconds":{"description":"Timeout after specified seconds","type":"string","example":20},"voice2email_greeting":{"description":"Greeting for Service Type Voice2Email","type":"string","example":null}}},"busy_service":{"type":"object","description":"Busy Service for a Device.","properties":{"busy_type":{"description":"Busy Service Type","type":"string","enum":["None","Forward"],"example":"Forward"},"busy_id":{"description":"Busy Service ID","type":"string","example":3214991000}}},"directory_settings":{"type":"object","description":"Directory Settings for a Device.","properties":{"first_name":{"description":"Directory First Name","type":"string","example":"John"},"last_name":{"description":"Directory Last Name","type":"string","example":"Doe"},"show":{"description":"Show in Directory or not","type":"boolean","example":true},"speed_dial":{"description":"Directory Speed Dial","type":"string","example":1234}}},"forwardall_settings":{"type":"object","description":"ForwardAll Settings for a Device.","properties":{"phonenumber":{"description":"ForwardAll Phonenumber","type":"string","example":3214991000},"start_time":{"description":"ForwardAll Start Time","type":"string","example":"18:00"},"end_time":{"description":"ForwardAll End Time","type":"string","example":"24:00"}}}}},"Account":{"type":"object","required":["id"],"properties":{"id":{"description":"Unique identifier of account.","type":"string","example":2005559999},"cdr_notify_url":{"description":"Call dialing record callback URL.","type":"string","example":"https://example.com/cdr/notify"},"cdr_notify_method":{"description":"Call dialing record callback URL method.","type":"string","example":"POST"},"cdr_notify_username":{"description":"Call dialing record callback URL username.","type":"string","example":"USERNAME"},"cdr_notify_password":{"description":"Call dialing record callback URL password.","type":"string","example":"PASSWORD"},"font_family":{"description":"Account font family.","type":"string","example":"Arial"},"background_color":{"description":"Account background color.","type":"string","example":"Blue"},"primary_color":{"description":"Account primary brand color.","type":"string","example":"Black"},"secondary_color":{"description":"Account secondary brand color.","type":"string","example":"Red"}}},"Message":{"type":"object","required":["id"],"properties":{"id":{"description":"Unique identifier of message.","type":"string","example":"556d82fc-5d64-41f6-b2f6-2d807e4ff95c"}}},"IVRMenu":{"type":"object","properties":{"id":{"description":"Unique identifier for ivrmenu.","type":"string","example":"IVR12341234"},"label":{"description":"Human-readable label used for ivrmenu.","type":"string","example":"My IVR"},"options":{"type":"object","properties":{"option0":{"type":"object","properties":{"destination_type":{"description":"Option 0 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"Device"},"destination":{"description":"Option 0 Destination","type":"string","example":123456123456}}},"option1":{"type":"object","properties":{"destination_type":{"description":"Option 1 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"IVRMenu"},"destination":{"description":"Option 1 Destination","type":"string","example":"IVR12341234"}}},"option2":{"type":"object","properties":{"destination_type":{"description":"Option 2 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"DigitQuery"},"destination":{"description":"Option 2 Destination","type":"string","example":"DQ12341234"}}},"option3":{"type":"object","properties":{"destination_type":{"description":"Option 0 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"RingGroup"},"destination":{"description":"Option 0 Destination","type":"string","example":"RG12341234"}}},"option4":{"type":"object","properties":{"destination_type":{"description":"Option 4 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"Invalid"},"destination":{"description":"Option 4 Destination","type":"string","example":null}}},"option5":{"type":"object","properties":{"destination_type":{"description":"Option 5 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"Invalid"},"destination":{"description":"Option 5 Destination","type":"string","example":null}}},"option6":{"type":"object","properties":{"destination_type":{"description":"Option 6 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"Invalid"},"destination":{"description":"Option 6 Destination","type":"string","example":null}}},"option7":{"type":"object","properties":{"destination_type":{"description":"Option 7 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"Invalid"},"destination":{"description":"Option 7 Destination","type":"string","example":null}}},"option8":{"type":"object","properties":{"destination_type":{"description":"Option 8 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"Invalid"},"destination":{"description":"Option 8 Destination","type":"string","example":null}}},"option9":{"type":"object","properties":{"destination_type":{"description":"Option 9 Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"Invalid"},"destination":{"description":"Option 9 Destination","type":"string","example":null}}},"optionStar":{"type":"object","properties":{"destination_type":{"description":"Option Star Destination Type","type":"string","enum":["Invalid","Ignore","Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"Invalid"},"destination":{"description":"Option Star Destination","type":"string","example":null}}}}},"digit_timeout":{"description":"Digit timeout.","type":"integer","example":10},"menu_repeat":{"description":"Menu repeat.","type":"integer","example":3},"menu_timeout":{"description":"Menu timeout.","type":"integer","example":30},"menu_timeout_options":{"type":"object","properties":{"destination_type":{"description":"Menu Timeout Destination Type","type":"string","enum":["Hangup","Busy","Reject","Forward","SpeedDial","Announcement","Conference","Device","DigitQuery","IVRMenu","RingGroup","Scheduler","Voicemail","Directory","PageGroup","RingAllPhones","SIPURI","Queue","WebHook","WebRequest","FoneStormConnector"],"example":"Voicemail"},"destination":{"description":"Menu Timeout Destination","type":"string","example":"VM12341234"}}},"enable_speed_dials":{"description":"Enable speed dials on IVRMenu.","type":"boolean","example":true},"soundfile":{"description":"SoundFile ID or Text to speech.","type":"string","example":"SF12341234"}}},"NotFound":{"type":"object","properties":{"status_code":{"description":"Response status code.","type":"integer","example":404},"error":{"description":"Response error label.","type":"string","example":"Not Found"},"message":{"description":"Response error message.","type":"string","example":"Requested Property Not Found"}}},"SpeedDial":{"type":"object","properties":{"speed_dial":{"description":"1 to 6 digit SpeedDial number.","type":"string","example":1234},"label":{"description":"Name/Label for SpeedDial.","type":"string","example":"My Extension"},"service_type":{"description":"SpeedDial destination type","type":"string","example":"Device"},"service_id":{"description":"SpeedDial destination value","type":"string","example":123456123456},"type":{"description":"SpeedDial status","type":"string","enum":["auto","manual"],"example":"manual"},"active":{"description":"SpeedDial status","type":"string","example":"yes"}}},"SoundFile":{"type":"object","properties":{"id":{"description":"SoundFile ID","type":"string","example":"SF12341234"},"label":{"description":"Name/Label for SoundFile","type":"string","example":"My SoundFile"},"soundfile":{"description":"SoundFile name","type":"string","example":"my_soundfile.wav"},"recording_id":{"description":"Recording ID","type":"string","example":"my_soundfile.wav"},"tts":{"description":"Text to speech string","type":"string","example":null},"tts_volume":{"description":"Text to speech volume","type":"string","example":null}}},"Scheduler":{"type":"object","properties":{"id":{"description":"Unique identifier for scheduler.","type":"string","example":"SH12341234"},"label":{"description":"Human-readable label used for scheduler.","type":"string","example":"My Scheduler"},"timezone":{"description":"Timezone of scheduler.","type":"string","example":"EST5EDT"},"business_hours":{"type":"object","properties":{"business_hours_service_type":{"description":"Business Hours Service Type","type":"string","enum":["SpeedDial","Device","Phonenumber","RingGroup","Conference","DigitQuery","IVRMenu","Scheduler","Voicemail","WebHook","WebRequest","FoneStormConnector","Hangup","Busy","Reject"],"example":"RingGroup"},"business_hours_service_id":{"description":"Business Hours Service ID","type":"string","example":"RG12341234"},"after_hours_service_type":{"description":"After Hours Service Type","type":"string","enum":["SpeedDial","Device","Phonenumber","RingGroup","Conference","DigitQuery","IVRMenu","Scheduler","Voicemail","WebHook","WebRequest","FoneStormConnector","Hangup","Busy","Reject"],"example":"Voicemail"},"after_hours_service_id":{"description":"After Hours Service ID","type":"string","example":"VM12341234"},"lunch_hours_service_type":{"description":"Lunch Hours Service Type","type":"string","enum":["SpeedDial","Device","Phonenumber","RingGroup","Conference","DigitQuery","IVRMenu","Scheduler","Voicemail","WebHook","WebRequest","FoneStormConnector","Hangup","Busy","Reject"],"example":"Voicemail"},"lunch_hours_service_id":{"description":"Lunch Hours Service Type","type":"string","example":"VM23452345"},"monday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string","example":"09:00"},"business_close":{"description":"Business close time (HH:mm)","type":"string","example":"18:00"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string","example":"12:00"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string","example":"1:00"}}},"tuesday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string","example":"09:00"},"business_close":{"description":"Business close time (HH:mm)","type":"string","example":"18:00"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string","example":"12:00"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string","example":"1:00"}}},"wednesday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string","example":"09:00"},"business_close":{"description":"Business close time (HH:mm)","type":"string","example":"18:00"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string","example":"12:00"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string","example":"1:00"}}},"thursday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string","example":"09:00"},"business_close":{"description":"Business close time (HH:mm)","type":"string","example":"18:00"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string","example":"12:00"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string","example":"1:00"}}},"friday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string","example":"09:00"},"business_close":{"description":"Business close time (HH:mm)","type":"string","example":"18:00"},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string","example":"12:00"},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string","example":"1:00"}}},"saturday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string","example":null},"business_close":{"description":"Business close time (HH:mm)","type":"string","example":null},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string","example":null},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string","example":null}}},"sunday":{"type":"object","properties":{"business_open":{"description":"Business open time (HH:mm)","type":"string","example":null},"business_close":{"description":"Business close time (HH:mm)","type":"string","example":null},"lunch_start":{"description":"Lunch start time (HH:mm)","type":"string","example":null},"lunch_end":{"description":"Lunch end time (HH:mm)","type":"string","example":null}}}}},"holiday_hours":{"type":"object","properties":{"holiday_hours_service_type":{"description":"Holiday Hours Service Type","type":"string","enum":["SpeedDial","Device","Phonenumber","RingGroup","Conference","DigitQuery","IVRMenu","Scheduler","Voicemail","WebHook","WebRequest","FoneStormConnector","Hangup","Busy","Reject"],"example":"Voicemail"},"holiday_hours_service_id":{"description":"Holiday Hours Service ID","type":"string","example":"VM34563456"},"holidays":{"type":"array","items":{"type":"object","properties":{"holiday_name":{"description":"Holiday name","type":"string","example":"Holiday 1"},"holiday_type":{"description":"Holiday type","type":"string","enum":["Custom","New Years Day","Martin Luther King Birthday","George Washington Birthday","Memorial Day","Independence Day","Labor Day","Columbus Day","Veterans Day","Thanksgiving Day","Black Friday","Christmas Eve","Christmas Day","Boxing Day","Fat Tuesday","Ash Wednesday","Palm Sunday","Maundy Thursday","Good Friday","Black Saturday","Easter Sunday","Ascension","Pentecost","Trinity Sunday"],"example":"New Years Day"},"custom_holiday_start":{"description":"Custom holiday start time (MM-DD HH:mm)","type":"string","example":null},"custom_holiday_end":{"description":"Custom holiday end time (MM-DD HH:mm)","type":"string","example":null}}}}}},"override_mode":{"description":"Scheduler override mode","type":"string","enum":["Scheduler","OfficeHours","AfterHours","Lunch","Holiday"],"example":"Scheduler"},"override_extension":{"description":"Scheduler override extension","type":"string","example":null}}},"RingGroup":{"type":"object","properties":{"id":{"description":"RingGroup ID.","type":"string","example":"RG12341234"},"label":{"description":"Name/Label for RingGroup.","type":"string","example":"My RingGroup"},"destinations":{"type":"array","items":{"type":"object","properties":{"destination_type":{"description":"Destination type for RingGroup","type":"string","enum":["Device","SpeedDial"],"example":"SpeedDial"},"destination":{"description":"Destination id for RingGroup","type":"string","example":1234}}}},"greeting":{"description":"Greeting SoundFile or Greeting Text for RingGroup","type":"string","example":"SF12341234"},"ring_strategy":{"description":"RingGroup strategy","type":"string","enum":["Simultaneous","Sequential","Random","LongestIdle"],"example":"Simultaneous"},"max_ring_time":{"description":"Maximum ring time in seconds","type":"integer","example":20},"ring_timeout":{"description":"Ring timeout in seconds","type":"integer","example":20},"ring_busy_destinations":{"description":"Ring busy destinations or not","type":"boolean","example":false},"failover_type":{"description":"RingGroup Failover Type.","type":"string","enum":["SpeedDial","Device","Phonenumber","RingGroup","Conference","DigitQuery","IVRMenu","Scheduler","Voicemail","WebHook","WebRequest","FoneStormConnector","Hangup","Busy","Reject"],"example":"Voicemail"},"failover":{"description":"Failover ID.","type":"string","example":"VM12341234"}}},"Voicemail":{"type":"object","properties":{"id":{"description":"Unique identifier for voicemail.","type":"string","example":"VM12341234"},"label":{"description":"Human-readable label used for voicemail.","type":"string","example":"My Voicemail Box"},"timezone":{"description":"Timezone for voicemail.","type":"string","example":"EST5EDT"},"access_id":{"description":"1 to 6 digit Voicemail access id.","type":"string","example":1234},"access_pin":{"description":"1 to 6 digit Voicemail access pin.","type":"string","example":1234},"email_preference":{"description":"Email preference for voicemail.","type":"string","enum":["OnDemand","Always"],"example":"OnDemand"},"email":{"description":"Email address for voicemail.","type":"string","example":"support@fractel.net"},"delete_emailed_messages":{"description":"Delete email after emailing them.","type":"boolean","example":true},"announcement":{"description":"SoundFile ID to play as the voicemail prompt.","type":"string","example":"SF12341234"},"greeting":{"description":"Play greeting or skip.","type":"string","enum":["play","skip"],"example":"skip"},"instructions":{"description":"Play instructions or skip.","type":"string","enum":["play","skip"],"example":"skip"},"notify":{"type":"object","properties":{"type":{"description":"Notification type.","type":"string","enum":["None","Email","Call","Callback"],"example":"None"},"url":{"description":"URL for callback.","type":"string","example":"URL"},"url_method":{"description":"URL method for callback.","type":"string","enum":["GET","POST","JSON"],"example":"JSON"},"url_username":{"description":"URL username for callback.","type":"string","example":"USERNAME"},"url_password":{"description":"URL password for callback.","type":"string","example":"PASSWORD"},"email":{"description":"Email address for for email notification.","type":"string","example":"support@fractel.net"},"phone":{"description":"Phonenumber for for call notification.","type":"string","example":3214991000}}},"active":{"description":"Status of the voicemail.","type":"boolean","example":true}}},"RateLimit":{"type":"object","properties":{"status_code":{"description":"Response status code.","type":"integer","example":410},"error":{"description":"Response error label.","type":"string","example":"Rate Limit Exceeded"},"message":{"description":"Response error message.","type":"string","example":"Rate Limit Exceeded. 10 messages per 10 seconds are allowed."}}},"PortOrder":{"type":"object","properties":{"id":{"description":"PortOrder ID.","type":"string","example":11011223344},"customer_pon":{"description":"Customer PortOrder Number.","type":"string","example":"ABC1234"},"status":{"description":"PortOrder status.","type":"string","example":"Draft"},"port_order_date":{"description":"PortOrder creation date.","type":"string","example":"2022-03-30"},"foc_at":{"description":"PortOrder FOC date and time.","type":"string","example":"2022-04-10"},"subaccount":{"description":"PortOrder subaccount.","type":"string","example":2005559999},"account_info":{"type":"object","description":"Account information.","properties":{"company":{"description":"Company name.","type":"string","example":"FracTEL LLC"},"address_1":{"description":"Address line 1.","type":"string","example":"122 4th Ave #201"},"address_2":{"description":"Address line 2.","type":"string","example":null},"house_prefix":{"description":"House prefix.","type":"string","example":null},"house_number":{"description":"House number.","type":"string","example":null},"house_suffix":{"description":"House suffix.","type":"string","example":null},"pre_directional":{"description":"Pre directional.","type":"string","example":null},"street_name":{"description":"Street name.","type":"string","example":null},"street_suffix":{"description":"Street suffix.","type":"string","example":null},"post_directional":{"description":"Post directional.","type":"string","example":null},"city":{"description":"City.","type":"string","example":"Indialantic"},"state":{"description":"State.","type":"string","example":"FL"},"zip":{"description":"Zip code.","type":"string","example":32903},"country":{"description":"Country.","type":"string","example":"United States"}}},"contact_info":{"type":"object","description":"Contact information.","properties":{"first_name":{"description":"First name.","type":"string","example":"John"},"middle_initial":{"description":"Middle initial.","type":"string","example":"A"},"last_name":{"description":"Last name.","type":"string","example":"Doe"},"email":{"description":"Email.","type":"string","example":"support@fractel.net"},"phone":{"description":"Phone.","type":"string","example":3214991000},"title":{"description":"Title.","type":"string","example":"Manager"},"authorized_user":{"description":"Authorized user full name.","type":"string","example":"John Doe"}}},"current_service":{"type":"object","description":"Contact information.","properties":{"service_provider":{"description":"Current service provider.","type":"string","example":"Verizon"},"account_number":{"description":"Account number with current service provider.","type":"string","example":111222},"pin":{"description":"PIN with current service provider.","type":"string","example":1111},"billing_number":{"description":"Billing number with current service provider.","type":"string","example":3214991000}}},"port_settings":{"type":"object","description":"Contact information.","properties":{"desired_due_date":{"description":"Desired due date for PortOrder.","type":"string","example":"2022-04-10"},"partial_port":{"description":"Partial port or not.","type":"boolean","example":false},"wireless":{"description":"Wireless numbers or not.","type":"boolean","example":true},"business":{"description":"Business numbers or not.","type":"boolean","example":true},"new_btn":{"description":"New BTN.","type":"string","example":3214991000}}},"customer_notes":{"description":"Customer notes.","type":"string","example":null},"observers":{"description":"PortOrder ID.","type":"string","example":null},"phone_numbers":{"description":"PortOrder ID.","type":"array","items":{"type":"object","properties":{"phone_number":{"description":"Phone number.","type":"string","example":3214991000},"fax":{"description":"Fax number or not.","type":"boolean","example":false}}}}}},"PageGroup":{"type":"object","properties":{"id":{"description":"PageGroup ID.","type":"string","example":"RG12341234"},"label":{"description":"Name/Label for PageGroup.","type":"string","example":"My PageGroup"},"max_page_time":{"description":"Max page time in seconds","type":"integer","example":10},"tone_length":{"description":"Tone length in seconds","type":"integer","example":10},"soundfile":{"description":"SoundFile ID","type":"string","example":"SF12341234"},"devices":{"type":"array","items":{"description":"Device IDs","type":"string","example":123456789000}}}},"BadRequest":{"type":"object","properties":{"status_code":{"description":"Response status code.","type":"integer","example":400},"error":{"description":"Response error label.","type":"string","example":"Bad Request"},"message":{"description":"Response error message.","type":"string","example":"Parameter missing"}}},"Conference":{"type":"object","properties":{"id":{"description":"Unique identifier of conference.","type":"string","example":"CON12341234"},"label":{"description":"Label for conference.","type":"string","example":"My Conference"},"start_time":{"description":"Start time and date of conference.","type":"string","example":"2022-03-01 12:00:00"},"end_time":{"description":"End time and date of conference.","type":"string","example":"2022-03-01 14:00:00"},"before_message":{"description":"Message to play before conference start time.","type":"string","example":"Welcome to my conference"},"after_message":{"description":"Message to play after conference end time.","type":"string","example":"Thank you for attending"},"max_members":{"description":"Maximum number of allowed conference attendees.","type":"integer","example":10},"conference_pin":{"description":"Conference PIN for attendees","type":"integer","example":1111},"play_sounds":{"description":"Play member entry and exit sound","type":"boolean","example":true},"record_conference":{"description":"Record conference or not","type":"boolean","example":true},"hold_music":{"description":"Hold music to play. SoundFile ID or Text to Speech","type":"string","example":"SF12341234"},"moderator_options":{"type":"object","properties":{"moderator_pin":{"description":"Conference PIN for moderator","type":"integer","example":1111},"terminate_on_exit":{"description":"Terminate conference when the moderator leaves","type":"boolean","example":true},"music_on_hold":{"description":"Play music on hold if only the moderator is in the conference","type":"boolean","example":true},"mute_members":{"description":"Mute all members until the moderator joins","type":"boolean","example":true},"wait_for_moderator":{"description":"Wait until the moderator joins","type":"boolean","example":true}}}}},"DigitQuery":{"type":"object","properties":{"id":{"description":"DigitQuery ID.","type":"string","example":"DQ12341234"},"label":{"description":"Name/Label for DigitQuery.","type":"string","example":"My DigitQuery"},"soundfile":{"description":"DigitQuery soundfile or text to speech string","type":"string","example":"SF12341234"},"maxdigits":{"description":"Maximum digits allowed","type":"integer","example":1},"mindigits":{"description":"Minimum digits allowed","type":"integer","example":1},"retries":{"description":"Number of allowed retries","type":"integer","example":3},"timeout":{"description":"Number of seconds before timeout","type":"integer","example":30},"invalid_prompt":{"description":"Play invalid prompt or not","type":"boolean","example":true},"callback_settings":{"type":"object","properties":{"url":{"description":"Callback URL","type":"string","example":"https://example.com/callback"},"url_method":{"description":"Callback URL method GET, POST or JSON","type":"string","example":"JSON"},"url_username":{"description":"HTTP authentication username","type":"string","example":"USERNAME"},"url_password":{"description":"HTTP authentication password","type":"string","example":"PASSWORD"}}},"match_pattern":{"description":"Match pattern a regular expression","type":"string","example":"(0-9)"},"match_destination":{"type":"object","properties":{"destination_type":{"description":"Match destination type","type":"string","example":"Forward"},"destination":{"description":"Match destination value","type":"string","example":3214991000}}},"nomatch_destination":{"type":"object","properties":{"destination_type":{"description":"No Match destination type","type":"string","example":"SoundFile"},"destination":{"description":"No Match destination value","type":"string","example":"SF12341234"}}},"default_destination":{"type":"object","properties":{"destination_type":{"description":"Default destination type","type":"string","example":"Voicemail"},"destination":{"description":"Default destination value","type":"string","example":"VM12341234"}}},"email_options":{"type":"object","properties":{"email":{"description":"Email address","type":"string","example":"support@fractel.net"},"subject":{"description":"Email subject","type":"string","example":"Input from DQ12341234"},"body":{"description":"Email body","type":"string","example":"Input 1 received"}}},"active":{"description":"DigitQuery active or not","type":"boolean","example":true}}},"FoneNumber":{"type":"object","properties":{"fonenumber":{"type":"string","description":"FoneNumber.","example":3214991000},"label":{"type":"string","description":"Label for FoneNumber.","example":"Main Office IVR"},"group":{"type":"string","description":"Group for FoneNumber.","example":"Main Office"},"type":{"type":"string","description":"FoneNumber type - 'Local' or 'Tollfree'.","example":"Local"},"record_calls":{"type":"string","description":"Call recording configuration for FoneNumber.","example":"yes"},"state":{"type":"string","description":"US State for FoneNumber.","example":"FL"},"rate_center":{"type":"string","description":"Rate center for FoneNumber.","example":"ORLANDO"},"is_active":{"type":"string","description":"Status of FoneNumber.","example":"yes"},"message_options":{"type":"object","description":"SMS related properties.","properties":{"receive":{"type":"object","description":"Delivery service type used as the destination to receive messages.","properties":{"type":{"type":"string","description":"Configured service type.","example":"Device"},"email":{"type":"string","description":"Email address if configured for email.","example":null},"device":{"type":"string","description":"FracTEL device if configured for device.","example":123456123456},"forward":{"type":"string","description":"Telephone number if configured for forward.","example":null},"url":{"type":"string","description":"HTTP URL if configured for URL.","example":null},"url_method":{"type":"string","description":"HTTP URL method if configured for URL.","example":null}}},"receive_notify":{"type":"object","description":"Callback URL to notify when a message is received.","properties":{"type":{"type":"string","description":"Configured notification type.","example":"URL"},"email":{"type":"string","description":"Email address if configured for email.","example":null},"url":{"type":"string","description":"HTTP URL.","example":"https://example.com/receive_notify"},"method":{"type":"string","description":"HTTP URL method.","example":"JSON"}}},"send_notify":{"type":"object","description":"Callback URL to notify when a message is sent.","properties":{"type":{"type":"string","description":"Configured notification type.","example":"Email"},"email":{"type":"string","description":"Email address if configured for email.","example":"support@fractel.net"},"url":{"type":"string","description":"HTTP URL.","example":null},"method":{"type":"string","description":"HTTP URL method.","example":null}}},"messaging_enabled":{"type":"string","description":"SMS/MMS service is enabled for FoneNumber.","example":"yes"},"messaging_campaign":{"type":"string","description":"Messaging Campaign ID for FoneNumber.","example":"CXX11XX11"}}},"call_options":{"type":"object","description":"Voice related properties.","properties":{"receive":{"type":"object","description":"Voice Service type related properties.","properties":{"type":{"type":"string","description":"Delivery service type used for FoneNumber.","example":"Device"},"value":{"type":"string","description":"Delivery service id used for FoneNumber.","example":123456123456}}},"receive_notify":{"type":"object","description":"Callback URL to notify when a call is received.","properties":{"type":{"type":"string","description":"Configured notification type.","example":"URL"},"email":{"type":"string","description":"Email address if configured for email.","example":null},"url":{"type":"string","description":"HTTP URL.","example":"https://example.com/send_notify"},"method":{"type":"string","description":"HTTP URL method.","example":"JSON"}}},"send_notify":{"type":"object","description":"Callback URL to notify when a call is made.","properties":{"type":{"type":"string","description":"Configured notification type.","example":"Email"},"email":{"type":"string","description":"Email address if configured for email.","example":"support@fractel.net"},"url":{"type":"string","description":"HTTP URL.","example":null},"method":{"type":"string","description":"HTTP URL method.","example":null}}}}},"fax_options":{"type":"object","description":"Fax related properties.","properties":{"receive_notify":{"type":"object","description":"Callback URL to notify when a fax is received.","properties":{"type":{"type":"string","description":"Configured notification type.","example":"URL"},"email":{"type":"string","description":"Email address if configured for email.","example":null},"url":{"type":"string","description":"HTTP URL.","example":"https://example.com/send_notify"},"method":{"type":"string","description":"HTTP URL method.","example":"JSON"}}},"send_notify":{"type":"object","description":"Callback URL to notify when a fax is sent.","properties":{"type":{"type":"string","description":"Configured notification type.","example":"Email"},"email":{"type":"string","description":"Email address if configured for email.","example":"support@fractel.net"},"url":{"type":"string","description":"HTTP URL.","example":null},"method":{"type":"string","description":"HTTP URL method.","example":null}}}}},"e911location_options":{"type":"object","description":"E911Location related properties.","properties":{"location_id":{"type":"string","description":"ID of the saved location.","example":"LO12341234"},"e911location_id":{"type":"string","description":"ID of the saved E911Location.","example":"EN12341234"},"e911location_default":{"type":"string","description":"Value 'yes' if the location is the default E911Location.","example":"no"},"e911location_active":{"type":"string","description":"Status of the E911Location, 'yes', 'no', 'cancel' or 'test'.","example":"yes"}}},"activation_date":{"type":"string","description":"Date and time of the FoneNumber activation","example":"2022-03-30"},"cancellation_date":{"type":"string","description":"Date and time of the FoneNumber cancellation","example":null},"is_offnet":{"type":"string","description":"If FoneNumber is an Offnet phonenumber or not. 'yes' or 'no'","example":"no"},"offnet_services":{"type":"object","description":"Off-net services on the FoneNumber.","properties":{"call":{"type":"string","description":"Call service status if FoneNumber is offnet.","example":null},"message":{"type":"string","description":"Messaging service status if FoneNumber is offnet.","example":null},"e911location":{"type":"string","description":"E911Location service status if FoneNumber is offnet.","example":null}}},"port_out_pin":{"type":"string","description":"FoneNumber PortOut 4 digit security PIN.","example":1234}}},"Subaccount":{"type":"object","properties":{"id":{"description":"10 digit Subaccount number.","type":"string","example":2005559999},"label":{"description":"Name/Label for Subaccount.","type":"string","example":"My Subaccount"},"status":{"description":"Subaccount status enabled, disabled, suspended or suspendoutbound","type":"string","example":"enabled"},"service_address":{"type":"object","description":"Service Address","properties":{"company_name":{"description":"Company Name","type":"string","example":"FracTEL LLC"},"first_name":{"description":"First Name","type":"string","example":"John"},"last_name":{"description":"Last Name","type":"string","example":"Doe"},"email":{"description":"Email Address","type":"string","example":"support@fractel.net"},"phone":{"description":"Phone number","type":"string","example":3214991000},"address_line1":{"description":"Address Line 1","type":"string","example":"122 4th Avenue #122"},"address_line2":{"description":"Address Line 2","type":"string","example":null},"city":{"description":"City","type":"string","example":"Indialantic"},"state":{"description":"State","type":"string","example":"FL"},"zipcode":{"description":"Zipcode","type":"string","example":32903}}}}},"Integration":{"type":"object","required":["id"],"properties":{"id":{"description":"Unique identifier of integration.","type":"string"},"account_id":{"description":"Unique identifier of associated account.","type":"string"},"name":{"description":"Integration service name.","type":"string"},"slug":{"description":"Integration slug name.","type":"string"},"token":{"$ref":"#/components/schemas/IntegrationToken"}}},"Announcement":{"type":"object","properties":{"id":{"description":"Announcement ID.","type":"string","example":"AN12341234"},"label":{"description":"Name/Label for Announcement.","type":"string","example":"My Announcement"},"destination_type":{"description":"Announcement destination type","type":"string","example":"Forward"},"destination":{"description":"Announcement destination value","type":"string","example":3214991000},"soundfile":{"description":"Announcement soundfile or text to speech string","type":"string","example":"SF12341234"}}},"Unauthorized":{"type":"object","properties":{"status_code":{"description":"Response status code.","type":"integer","example":401},"error":{"description":"Response error label.","type":"string","example":"Unauthorized"},"message":{"description":"Response error message.","type":"string","example":"Invalid or expired token."}}},"NumberLookup":{"type":"object","properties":{"number":{"type":"string","description":"Number","example":3214991009},"type":{"type":"string","description":"Number type","example":"local"},"lrn":{"type":"string","description":"Location Routing Number the number is currently ported to","example":4074760000},"owner_id":{"type":"string","description":"OCN or RESPORG","example":"902E"},"spid":{"type":"string","description":"Service Provider ID","example":"902E"},"itg":{"type":"string","description":"Whether the number is an intermediate/tandem gateway number - 'yes' or 'no'","example":"no"},"valid":{"type":"string","description":"Whether the number is valid - 'yes' or 'no'","example":"yes"},"fractel_status":{"type":"string","description":"FracTEL assignment status of the number","example":"assigned"},"npanxx":{"type":"string","description":"NPA-NXX (area code and exchange) of the number","example":321499},"state":{"type":"string","description":"US State for the number","example":"FL"},"company":{"type":"string","description":"Carrier/company associated with the number","example":"PEERLESS NETWORK OF FLORIDA LLC - FL"},"ocn":{"type":"string","description":"Operating Company Number","example":"902E"},"ratecenter":{"type":"string","description":"Rate center for the number","example":"MELBOURNE"},"clli":{"type":"string","description":"Common Language Location Identifier for the switch","example":"ORLDFL60DS2"},"assigndate":{"type":"string","description":"Date the number was assigned","example":"00/00/0000"},"prefixtype":{"type":"string","description":"Prefix type - e.g. 'CLEC', 'ILEC'","example":"CLEC"},"switchname":{"type":"string","description":"Switch name, when available","example":null},"switchtype":{"type":"string","description":"Switch type, when available","example":null},"lata":{"type":"string","description":"Local Access and Transport Area","example":45806},"ilecname":{"type":"string","description":"Incumbent Local Exchange Carrier name, when available","example":null},"ilecocn":{"type":"string","description":"Incumbent Local Exchange Carrier Operating Company Number","example":9417},"country":{"type":"string","description":"Country code","example":"US"}}},"Authorization":{"type":"object","required":["token"],"properties":{"token":{"description":"JSON Web Token.","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50Ijp7ImlkIjoiODAwODA1NjU2MiJ9LCJwb3J0YWwiOnsidG9rZW4iOiJjODJjMmVkYzMzNWIwYzI3NjYwOWIzNDcxMmFmOWZlOCJ9LCJpYXQiOjE1MTYxMzc1NTQsImV4cCI6MTUxNjE0MTE1NH0.9XdG1o-KIsO_K7o0eaHb-Enqy4ETkQSQS4MhpdvhsrE"}}},"DirectoryEntry":{"type":"object","properties":{"name":{"type":"string","description":"Display name - the user's first and last name, else the email.","example":"Dana Reed"},"first_name":{"type":"string","description":"User first name.","example":"Dana"},"last_name":{"type":"string","description":"User last name.","example":"Reed"},"email":{"type":"string","description":"User email.","example":"dana@example.com"},"title":{"type":"string","description":"User title.","example":"CEO"},"speed_dial":{"type":"string","description":"The device's directory speed dial if set, else its extension.","example":101},"fonenumber":{"type":"string","description":"Device caller id. Always present; users without one are not listed.","example":3215550101},"device_id":{"type":"string","description":"Device id.","example":560537488172},"device_type":{"type":"string","description":"Device type.","example":"fractelfone"},"show":{"type":"string","description":"The device's directory setting - 'No', 'Name Only' or 'Name and Extension'.","example":"Name and Extension"}}},"FoneNumberOrder":{"type":"object","properties":{"fonenumber":{"type":"string","description":"FoneNumber","example":3214991000},"state":{"type":"string","description":"State","example":"FL"},"rate_center":{"type":"string","description":"Rate Center","example":"ORLANDO"},"messaging_enabled":{"type":"string","description":"SMS or MMS support","example":"yes"},"fax_enabled":{"type":"string","description":"Fax enabled","example":"yes"},"result":{"type":"string","description":"FoneNumber order result","example":"SUCCESS"}}},"MessagingBrands":{"type":"object","properties":{"entity_type":{"type":"string","description":"The type of business entity","example":"PRIVATE_PROFIT","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"]},"brand_id":{"type":"string","description":"Unique brand identifier","example":"B123ABC"},"status":{"type":"string","description":"Current status of the brand","example":"ACTIVE","enum":["ACTIVE","PENDING_REVIEW","PENDING_UPDATE","DELETED","SUBMISSION_FAILED"]},"display_name":{"type":"string","description":"Brand/Marketing/DBA name of the business","example":"Global Testing"},"company_name":{"type":"string","description":"The legal name of the business","example":"Global Testing"},"ein":{"type":"string","description":"Tax ID of the business","example":"999999999"},"ein_issuing_country":{"type":"string","description":"Two-letter ISO-2 country code of Tax ID issuing country","example":"US"},"phone":{"type":"string","description":"Support contact telephone number in E.164 format","example":"+15555555555"},"street":{"type":"string","description":"House number and street name","example":"123 Main Street"},"city":{"type":"string","description":"City name","example":"Vienna"},"state":{"type":"string","description":"State or province","example":"VA"},"postal_code":{"type":"string","description":"Zipcode or postal code","example":"52741"},"country":{"type":"string","description":"Two-letter ISO-2 country code","example":"US"},"email":{"type":"string","description":"Email address of support contact","example":"support@global.com"},"ip_address":{"type":"string","description":"IP address associated with the brand","example":"127.0.0.1"},"website":{"type":"string","description":"The website/online URL address of the brand","example":"www.testglobal.com"},"vertical":{"type":"string","description":"The industry segment where the brand operates","example":"COMMUNICATION"},"universal_ein":{"type":"string","description":"Universal tax ID in format COUNTRY_EIN","example":"US_999999999"},"identity_status":{"type":"string","description":"Current vetting status of the brand","example":"VETTED_VERIFIED","enum":["VETTED_VERIFIED","UNVERIFIED","VETTED_REJECTED"]},"registered_on":{"type":"string","description":"Date and time when the brand was created","example":"2023-12-18T18:42:57.000Z","format":"date-time"}}},"IntegrationToken":{"type":"object","required":["id"],"properties":{"id":{"description":"Unique identifier of integration token.","type":"string"},"account_id":{"description":"Unique identifier of associated account.","type":"string"},"token":{"description":"Integration service token.","type":"string"}}},"FoneNumberReserve":{"type":"object","properties":{"fonenumber":{"type":"string","description":"FoneNumber","example":3214991000},"state":{"type":"string","description":"State","example":"FL"},"rate_center":{"type":"string","description":"Rate Center","example":"ORLANDO"},"expires_at":{"type":"string","description":"FoneNumber expires at","example":"2022-03-30 12:00:00"},"result":{"type":"string","description":"Result of the order","example":"SUCCESS"}}},"VoicemailMessages":{"type":"object","properties":{"id":{"description":"Unique identifier for voicemail.","type":"string","example":"VM12341234"},"label":{"description":"Human-readable label used for voicemail.","type":"string","example":"My Voicemail Box"},"total_messages":{"description":"Total number of messages in voicemail.","type":"integer","example":10},"messages":{"type":"array","items":{"type":"object","properties":{"caller_id":{"description":"Caller ID of the incoming call","type":"string","example":3214991000},"caller_name":{"description":"Caller ID name of the incoming call","type":"string","example":"FracTEL"},"status":{"description":"Status of voicemail message","type":"string","enum":["New","Read"],"example":"Read"},"length":{"description":"Length in seconds of voicemail message","type":"string","example":24},"url":{"description":"URL of voicemail message","type":"string","example":"https://example.com/vm1.wav"},"created_at":{"description":"Voicemail message created at timestamp","type":"string","example":"2022-03-30 12:00:00"},"read_at":{"description":"Voicemail message read at timestamp","type":"string","example":"2022-03-30 13:12:00"}}}}}},"FoneNumberReserved":{"type":"object","properties":{"fonenumber":{"type":"string","description":"FoneNumber","example":3214991000},"state":{"type":"string","description":"State","example":"FL"},"rate_center":{"type":"string","description":"Rate Center","example":"ORLANDO"},"expires_at":{"type":"string","description":"FoneNumber expires at","example":"2022-03-30 12:00:00"}}},"MessagingCampaigns":{"type":"object","properties":{"campaign_id":{"type":"string","description":"Unique campaign identifier","example":"C123ABC"},"status":{"type":"string","description":"Current status of the campaign","example":"ACTIVE","enum":["ACTIVE","PENDING_REVIEW","PENDING_UPDATE","EXPIRED","SUBMISSION_FAILED"]},"registered_on":{"type":"string","description":"Date and time when the campaign was created","example":"2024-11-11T21:35:00.000Z","format":"date-time"},"auto_renewal":{"type":"boolean","description":"Whether campaign auto-renews","example":true},"billed_date":{"type":"string","description":"Date when the campaign was last billed","example":"2024-11-11T00:00:00.000Z","format":"date-time"},"brand_id":{"type":"string","description":"ID of the brand this campaign belongs to","example":"B123ABC"},"vertical":{"type":"string","description":"The industry vertical for the campaign","example":null},"usecase":{"type":"string","description":"The campaign's intended use","example":"MARKETING"},"sub_usecases":{"type":"array","description":"Sub-use cases for additional campaign context","items":{"type":"string"},"example":[]},"description":{"type":"string","description":"Detailed description of the campaign's purpose","example":"Lorem ipsum dolor set amitet. Lorem ipsum dolor set amitet."},"embedded_link":{"type":"boolean","description":"Whether the campaign uses embedded links","example":false},"embedded_phone":{"type":"boolean","description":"Whether the campaign uses embedded phone numbers","example":false},"terms_and_conditions":{"type":"boolean","description":"Agreement to TCR terms","example":true},"number_pool":{"type":"boolean","description":"Whether campaign uses more than 50 numbers","example":false},"age_gated":{"type":"boolean","description":"Whether campaign contains age-gated content","example":false},"direct_lending":{"type":"boolean","description":"Whether the campaign is for direct lending","example":false},"subscriber_opt_in":{"type":"boolean","description":"Whether subscriber opt-in is required","example":true},"subscriber_opt_out":{"type":"boolean","description":"Whether subscribers can opt out","example":true},"subscriber_help":{"type":"boolean","description":"Whether help options are available","example":true},"message_sample1":{"type":"string","description":"Sample message 1","example":"Lorem ipsum dolor set amitet."},"message_sample2":{"type":"string","description":"Sample message 2","example":"Lorem ipsum dolor set amitet."},"message_sample3":{"type":"string","description":"Sample message 3","example":"Lorem ipsum dolor set amitet."},"message_sample4":{"type":"string","description":"Sample message 4","example":null},"message_sample5":{"type":"string","description":"Sample message 5","example":null},"message_flow":{"type":"string","description":"Description of subscriber opt-in flow","example":"Lorem ipsum dolor set amitet. Lorem ipsum dolor set amitet."},"help_message":{"type":"string","description":"Sample help message","example":"Lorem ipsum dolor set amitet."},"next_renewal_or_expiration_date":{"type":"string","description":"Date of next renewal or expiration","example":"2025-02-11"},"expiration_date":{"type":"string","description":"Campaign expiration date","example":null},"opt_in_keywords":{"type":"string","description":"Keywords for opt-in","example":null},"opt_out_keywords":{"type":"string","description":"Keywords for opt-out","example":"STOP"},"help_keywords":{"type":"string","description":"Keywords for help","example":"HELP"},"opt_in_message":{"type":"string","description":"Sample opt-in message","example":"Lorem ipsum dolor set amitet."},"opt_out_message":{"type":"string","description":"Sample opt-out message","example":"Lorem ipsum dolor set amitet."},"privacy_policy_link":{"type":"string","description":"Link to privacy policy","example":""},"terms_and_conditions_link":{"type":"string","description":"Link to terms and conditions","example":""},"embedded_link_sample":{"type":"string","description":"Sample embedded link","example":""},"monthly_fee":{"type":"number","description":"Monthly fee for the campaign in USD","example":10}}},"FoneNumberInventory":{"type":"object","properties":{"fonenumber":{"type":"string","description":"FoneNumber","example":3214991000},"state":{"type":"string","description":"State","example":"FL"},"rate_center":{"type":"string","description":"Rate Center","example":"ORLANDO"}}},"MessagingCampaignPhonenumbers":{"type":"object","properties":{"provision_date":{"type":"string","description":"Date when the number was provisioned to the campaign","example":"2023-06-17T23:01:26.000Z","format":"date-time"},"active":{"type":"boolean","description":"Whether the number is currently active on the campaign","example":true},"phonenumber":{"type":"string","description":"Phone number in E.164 format","example":"15552345678"}}}}},"x-samples-languages":["node","curl","ruby","javascript","python","java","php"]}