[Index]
Model ref.: device/msteamsonline/CsAutoAttendant
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"TimeZoneId": {
"target": "/api/device/msteamsonline/CsAutoAttendantSupportedTimeZone/choices/?field=DisplayName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"convert_to_primary_key": true,
"choices": [],
"target_attr": "DisplayName",
"target_model_type": "device/msteamsonline/CsAutoAttendantSupportedTimeZone",
"title": "Time Zone",
"type": "string",
"name": "TimeZoneId"
},
"OperatorType": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "User",
"title": "User"
},
{
"value": "ExternalPstn",
"title": "External PSTN"
},
{
"value": "ApplicationEndpoint",
"title": "Application Endpoint"
}
],
"type": "string",
"name": "OperatorType",
"title": "Operator Type"
},
"AfterHoursCallFlow": {
"properties": {
"Menu": {
"properties": {
"DialByNameEnabled": {
"type": "boolean",
"name": "DialByNameEnabled",
"title": "Dial By Name Enabled"
},
"DirectorySearchMethod": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "ByName",
"title": "By Name"
},
{
"value": "ByExtension",
"title": "By Extension"
}
],
"type": "string",
"name": "DirectorySearchMethod",
"title": "Directory Search Method"
},
"MenuOptions": {
"items": {
"type": "object",
"properties": {
"CallTarget_MailBox": {
"type": "string",
"name": "CallTarget_MailBox",
"title": "Call Target"
},
"Greeting": {
"properties": {
"TextToSpeechPrompt": {
"type": "string",
"name": "TextToSpeechPrompt",
"title": "Text To Speech Prompt"
},
"AudioFilePrompt": {
"format": "db_filename",
"type": "string",
"name": "AudioFilePrompt",
"title": "Audio File Prompt"
},
"ActiveType": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "TextToSpeech",
"title": "Text To Speech"
},
{
"value": "AudioFile",
"title": "Audio File"
}
],
"type": "string",
"name": "ActiveType",
"title": "Active Type"
}
},
"type": "object",
"name": "Greeting",
"title": "Greeting"
},
"CallTargetEnableTranscription": {
"type": "boolean",
"name": "CallTargetEnableTranscription",
"title": "Call Target Enable Transcription"
},
"VoiceResponses": {
"type": "string",
"name": "VoiceResponses",
"title": "Voice Command"
},
"CallTarget_User": {
"target": "/api/device/msteamsonline/CsOnlineUser/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Call Target",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "UserPrincipalName",
"target_model_type": "device/msteamsonline/CsOnlineUser",
"type": "string",
"name": "CallTarget_User"
},
"DtmfResponse": {
"choices": [
{
"value": "Tone0",
"title": "Tone 0"
},
{
"value": "Tone1",
"title": "Tone 1"
},
{
"value": "Tone2",
"title": "Tone 2"
},
{
"value": "Tone3",
"title": "Tone 3"
},
{
"value": "Tone4",
"title": "Tone 4"
},
{
"value": "Tone5",
"title": "Tone 5"
},
{
"value": "Tone6",
"title": "Tone 6"
},
{
"value": "Tone7",
"title": "Tone 7"
},
{
"value": "Tone8",
"title": "Tone 8"
},
{
"value": "Tone9",
"title": "Tone 9"
},
{
"value": "Automatic",
"title": "Automatic"
}
],
"type": "string",
"name": "DtmfResponse",
"title": "Dial key"
},
"CallTarget_ApplicationEndpoint": {
"target": "/api/device/msteamsonline/CsOnlineApplicationInstance/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Call Target",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "UserPrincipalName",
"target_model_type": "device/msteamsonline/CsOnlineApplicationInstance",
"type": "string",
"name": "CallTarget_ApplicationEndpoint"
},
"CallTarget_Phone": {
"type": "string",
"name": "CallTarget_Phone",
"title": "Call Target"
},
"Action": {
"choices": [
{
"value": "Announcement",
"title": "Announcement"
},
{
"value": "DisconnectCall",
"title": "Disconnect Call"
},
{
"value": "TransferCallToOperator",
"title": "Transfer Call To Operator"
},
{
"value": "TransferCallToTarget",
"title": "Transfer Call To Target"
}
],
"type": "string",
"name": "Action",
"title": "Action"
},
"CallTargetType": {
"choices": [
{
"value": "ExternalPstn",
"title": "External phone number"
},
{
"value": "User",
"title": "Person in organization"
},
{
"value": "ApplicationEndpoint",
"title": "Resource Account"
},
{
"value": "SharedVoicemail",
"title": "Voicemail"
}
],
"type": "string",
"name": "CallTargetType",
"title": "Call Target Type"
}
}
},
"type": "array",
"name": "MenuOptions",
"title": "Menu Options"
},
"Greeting": {
"properties": {
"TextToSpeechPrompt": {
"type": "string",
"name": "TextToSpeechPrompt",
"title": "Text To Speech Prompt"
},
"AudioFilePrompt": {
"format": "db_filename",
"type": "string",
"name": "AudioFilePrompt",
"title": "Audio File Prompt"
},
"ActiveType": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "TextToSpeech",
"title": "Text To Speech"
},
{
"value": "AudioFile",
"title": "Audio File"
}
],
"type": "string",
"name": "ActiveType",
"title": "Active Type"
}
},
"type": "object",
"name": "Greeting",
"title": "Greeting"
},
"Name": {
"type": "string",
"name": "Name",
"title": "Name"
}
},
"type": "object",
"name": "Menu",
"title": "Menu"
},
"Schedule": {
"properties": {
"FixedSchedule": {
"properties": {
"DateTimeRanges": {
"items": {
"type": "object",
"properties": {
"Start": {
"title": "Start",
"type": "string",
"name": "Start",
"description": "Format should be d/M/yyyy H:mm OR d/M/yyyy"
},
"End": {
"title": "End",
"type": "string",
"name": "End",
"description": "Format should be d/M/yyyy H:mm OR d/M/yyyy"
}
}
},
"type": "array",
"name": "DateTimeRanges",
"title": "Date Time Ranges"
}
},
"type": "object",
"name": "FixedSchedule",
"title": "Fixed Schedule"
},
"WeeklyRecurrentSchedule": {
"properties": {
"SaturdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "SaturdayHours",
"title": "Saturday Hours"
},
"ThursdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "ThursdayHours",
"title": "Thursday Hours"
},
"WednesdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "WednesdayHours",
"title": "Wednesday Hours"
},
"MondayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "MondayHours",
"title": "Monday Hours"
},
"FridayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "FridayHours",
"title": "Friday Hours"
},
"SundayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "SundayHours",
"title": "Sunday Hours"
},
"TuesdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "TuesdayHours",
"title": "Tuesday Hours"
}
},
"type": "object",
"name": "WeeklyRecurrentSchedule",
"title": "Weekly Recurrent Schedule"
},
"ScheduleType": {
"choices": [
{
"value": "WeeklyRecurrence",
"title": "Weekly Recurring"
},
{
"value": "Fixed",
"title": "Fixed"
}
],
"type": "string",
"name": "ScheduleType",
"title": "Type"
},
"ScheduleName": {
"type": "string",
"name": "ScheduleName",
"title": "Name"
}
},
"type": "object",
"name": "Schedule",
"title": "Schedule"
},
"Greeting": {
"properties": {
"TextToSpeechPrompt": {
"type": "string",
"name": "TextToSpeechPrompt",
"title": "Text To Speech Prompt"
},
"AudioFilePrompt": {
"format": "db_filename",
"type": "string",
"name": "AudioFilePrompt",
"title": "Audio File Prompt"
},
"ActiveType": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "TextToSpeech",
"title": "Text To Speech"
},
{
"value": "AudioFile",
"title": "Audio File"
}
],
"type": "string",
"name": "ActiveType",
"title": "Active Type"
}
},
"type": "object",
"name": "Greeting",
"title": "Greeting"
},
"Name": {
"type": "string",
"name": "Name",
"title": "Name"
}
},
"type": "object",
"name": "AfterHoursCallFlow",
"title": "After Hours Call Flow"
},
"LanguageId": {
"target": "/api/device/msteamsonline/CsAutoAttendantSupportedLanguage/choices/?field=DisplayName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"convert_to_primary_key": true,
"choices": [],
"target_attr": "DisplayName",
"target_model_type": "device/msteamsonline/CsAutoAttendantSupportedLanguage",
"title": "Language",
"type": "string",
"name": "LanguageId"
},
"VoiceResponseEnabled": {
"type": "boolean",
"name": "VoiceResponseEnabled",
"title": "Enable Voice Inputs"
},
"OperatorDisplay": {
"readonly": true,
"type": "string",
"name": "OperatorDisplay",
"title": "Operator Display"
},
"ApplicationInstances": {
"items": {
"type": "object",
"properties": {
"ApplicationInstance": {
"target": "/api/device/msteamsonline/CsOnlineApplicationInstance/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Resource Account",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "UserPrincipalName",
"target_model_type": "device/msteamsonline/CsOnlineApplicationInstance",
"type": "string",
"name": "ApplicationInstance"
},
"ApplicationInstanceNumber": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "ApplicationInstanceNumber",
"title": "Resource Account Number"
}
}
},
"type": [
"array",
"null"
],
"name": "ApplicationInstances",
"title": "Resource Accounts"
},
"HolidayCallFlows": {
"items": {
"type": "object",
"properties": {
"Menu": {
"properties": {
"DialByNameEnabled": {
"type": "boolean",
"name": "DialByNameEnabled",
"title": "Dial By Name Enabled"
},
"DirectorySearchMethod": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "ByName",
"title": "By Name"
},
{
"value": "ByExtension",
"title": "By Extension"
}
],
"type": "string",
"name": "DirectorySearchMethod",
"title": "Directory Search Method"
},
"MenuOptions": {
"items": {
"type": "object",
"properties": {
"CallTarget_MailBox": {
"type": "string",
"name": "CallTarget_MailBox",
"title": "Call Target"
},
"Greeting": {
"properties": {
"TextToSpeechPrompt": {
"type": "string",
"name": "TextToSpeechPrompt",
"title": "Text To Speech Prompt"
},
"AudioFilePrompt": {
"format": "db_filename",
"type": "string",
"name": "AudioFilePrompt",
"title": "Audio File Prompt"
},
"ActiveType": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "TextToSpeech",
"title": "Text To Speech"
},
{
"value": "AudioFile",
"title": "Audio File"
}
],
"type": "string",
"name": "ActiveType",
"title": "Active Type"
}
},
"type": "object",
"name": "Greeting",
"title": "Greeting"
},
"CallTargetEnableTranscription": {
"type": "boolean",
"name": "CallTargetEnableTranscription",
"title": "Call Target Enable Transcription"
},
"VoiceResponses": {
"type": "string",
"name": "VoiceResponses",
"title": "Voice Command"
},
"CallTarget_User": {
"target": "/api/device/msteamsonline/CsOnlineUser/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Call Target",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "UserPrincipalName",
"target_model_type": "device/msteamsonline/CsOnlineUser",
"type": "string",
"name": "CallTarget_User"
},
"DtmfResponse": {
"choices": [
{
"value": "Tone0",
"title": "Tone 0"
},
{
"value": "Tone1",
"title": "Tone 1"
},
{
"value": "Tone2",
"title": "Tone 2"
},
{
"value": "Tone3",
"title": "Tone 3"
},
{
"value": "Tone4",
"title": "Tone 4"
},
{
"value": "Tone5",
"title": "Tone 5"
},
{
"value": "Tone6",
"title": "Tone 6"
},
{
"value": "Tone7",
"title": "Tone 7"
},
{
"value": "Tone8",
"title": "Tone 8"
},
{
"value": "Tone9",
"title": "Tone 9"
},
{
"value": "Automatic",
"title": "Automatic"
}
],
"type": "string",
"name": "DtmfResponse",
"title": "Dial key"
},
"CallTarget_ApplicationEndpoint": {
"target": "/api/device/msteamsonline/CsOnlineApplicationInstance/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Call Target",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "UserPrincipalName",
"target_model_type": "device/msteamsonline/CsOnlineApplicationInstance",
"type": "string",
"name": "CallTarget_ApplicationEndpoint"
},
"CallTarget_Phone": {
"type": "string",
"name": "CallTarget_Phone",
"title": "Call Target"
},
"Action": {
"choices": [
{
"value": "Announcement",
"title": "Announcement"
},
{
"value": "DisconnectCall",
"title": "Disconnect Call"
},
{
"value": "TransferCallToOperator",
"title": "Transfer Call To Operator"
},
{
"value": "TransferCallToTarget",
"title": "Transfer Call To Target"
}
],
"type": "string",
"name": "Action",
"title": "Action"
},
"CallTargetType": {
"choices": [
{
"value": "ExternalPstn",
"title": "External phone number"
},
{
"value": "User",
"title": "Person in organization"
},
{
"value": "ApplicationEndpoint",
"title": "Resource Account"
},
{
"value": "SharedVoicemail",
"title": "Voicemail"
}
],
"type": "string",
"name": "CallTargetType",
"title": "Call Target Type"
}
}
},
"type": "array",
"name": "MenuOptions",
"title": "Menu Options"
},
"Greeting": {
"properties": {
"TextToSpeechPrompt": {
"type": "string",
"name": "TextToSpeechPrompt",
"title": "Text To Speech Prompt"
},
"AudioFilePrompt": {
"format": "db_filename",
"type": "string",
"name": "AudioFilePrompt",
"title": "Audio File Prompt"
},
"ActiveType": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "TextToSpeech",
"title": "Text To Speech"
},
{
"value": "AudioFile",
"title": "Audio File"
}
],
"type": "string",
"name": "ActiveType",
"title": "Active Type"
}
},
"type": "object",
"name": "Greeting",
"title": "Greeting"
},
"Name": {
"type": "string",
"name": "Name",
"title": "Name"
}
},
"type": "object",
"name": "Menu",
"title": "Menu"
},
"Schedule": {
"properties": {
"FixedSchedule": {
"properties": {
"DateTimeRanges": {
"items": {
"type": "object",
"properties": {
"Start": {
"title": "Start",
"type": "string",
"name": "Start",
"description": "Format should be d/M/yyyy H:mm OR d/M/yyyy"
},
"End": {
"title": "End",
"type": "string",
"name": "End",
"description": "Format should be d/M/yyyy H:mm OR d/M/yyyy"
}
}
},
"type": "array",
"name": "DateTimeRanges",
"title": "Date Time Ranges"
}
},
"type": "object",
"name": "FixedSchedule",
"title": "Fixed Schedule"
},
"WeeklyRecurrentSchedule": {
"properties": {
"SaturdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "SaturdayHours",
"title": "Saturday Hours"
},
"ThursdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "ThursdayHours",
"title": "Thursday Hours"
},
"WednesdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "WednesdayHours",
"title": "Wednesday Hours"
},
"MondayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "MondayHours",
"title": "Monday Hours"
},
"FridayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "FridayHours",
"title": "Friday Hours"
},
"SundayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "SundayHours",
"title": "Sunday Hours"
},
"TuesdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "TuesdayHours",
"title": "Tuesday Hours"
}
},
"type": "object",
"name": "WeeklyRecurrentSchedule",
"title": "Weekly Recurrent Schedule"
},
"ScheduleType": {
"type": "string",
"name": "ScheduleType",
"title": "Type"
},
"ScheduleName": {
"type": "string",
"name": "ScheduleName",
"title": "Name"
}
},
"type": "object",
"name": "Schedule",
"title": "Schedule"
},
"Greeting": {
"properties": {
"TextToSpeechPrompt": {
"type": "string",
"name": "TextToSpeechPrompt",
"title": "Text To Speech Prompt"
},
"AudioFilePrompt": {
"format": "db_filename",
"type": "string",
"name": "AudioFilePrompt",
"title": "Audio File Prompt"
},
"ActiveType": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "TextToSpeech",
"title": "Text To Speech"
},
{
"value": "AudioFile",
"title": "Audio File"
}
],
"type": "string",
"name": "ActiveType",
"title": "Active Type"
}
},
"type": "object",
"name": "Greeting",
"title": "Greeting"
},
"Name": {
"type": "string",
"name": "Name",
"title": "Name"
}
}
},
"type": "array",
"name": "HolidayCallFlows",
"title": "Holiday Call Flows"
},
"Operator": {
"type": [
"string",
"null"
],
"name": "Operator",
"title": "Operator"
},
"DefaultCallFlow": {
"properties": {
"Menu": {
"properties": {
"DialByNameEnabled": {
"type": "boolean",
"name": "DialByNameEnabled",
"title": "Dial By Name Enabled"
},
"DirectorySearchMethod": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "ByName",
"title": "By Name"
},
{
"value": "ByExtension",
"title": "By Extension"
}
],
"type": "string",
"name": "DirectorySearchMethod",
"title": "Directory Search Method"
},
"MenuOptions": {
"items": {
"type": "object",
"properties": {
"CallTarget_MailBox": {
"type": "string",
"name": "CallTarget_MailBox",
"title": "Call Target"
},
"Greeting": {
"properties": {
"TextToSpeechPrompt": {
"type": "string",
"name": "TextToSpeechPrompt",
"title": "Text To Speech Prompt"
},
"AudioFilePrompt": {
"format": "db_filename",
"type": "string",
"name": "AudioFilePrompt",
"title": "Audio File Prompt"
},
"ActiveType": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "TextToSpeech",
"title": "Text To Speech"
},
{
"value": "AudioFile",
"title": "Audio File"
}
],
"type": "string",
"name": "ActiveType",
"title": "Active Type"
}
},
"type": "object",
"name": "Greeting",
"title": "Greeting"
},
"CallTargetEnableTranscription": {
"type": "boolean",
"name": "CallTargetEnableTranscription",
"title": "Call Target Enable Transcription"
},
"VoiceResponses": {
"type": "string",
"name": "VoiceResponses",
"title": "Voice Command"
},
"CallTarget_User": {
"target": "/api/device/msteamsonline/CsOnlineUser/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Call Target",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "UserPrincipalName",
"target_model_type": "device/msteamsonline/CsOnlineUser",
"type": "string",
"name": "CallTarget_User"
},
"DtmfResponse": {
"choices": [
{
"value": "Tone0",
"title": "Tone 0"
},
{
"value": "Tone1",
"title": "Tone 1"
},
{
"value": "Tone2",
"title": "Tone 2"
},
{
"value": "Tone3",
"title": "Tone 3"
},
{
"value": "Tone4",
"title": "Tone 4"
},
{
"value": "Tone5",
"title": "Tone 5"
},
{
"value": "Tone6",
"title": "Tone 6"
},
{
"value": "Tone7",
"title": "Tone 7"
},
{
"value": "Tone8",
"title": "Tone 8"
},
{
"value": "Tone9",
"title": "Tone 9"
},
{
"value": "Automatic",
"title": "Automatic"
}
],
"type": "string",
"name": "DtmfResponse",
"title": "Dial key"
},
"CallTarget_ApplicationEndpoint": {
"target": "/api/device/msteamsonline/CsOnlineApplicationInstance/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Call Target",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "UserPrincipalName",
"target_model_type": "device/msteamsonline/CsOnlineApplicationInstance",
"type": "string",
"name": "CallTarget_ApplicationEndpoint"
},
"CallTarget_Phone": {
"type": "string",
"name": "CallTarget_Phone",
"title": "Call Target"
},
"Action": {
"choices": [
{
"value": "Announcement",
"title": "Announcement"
},
{
"value": "DisconnectCall",
"title": "Disconnect Call"
},
{
"value": "TransferCallToOperator",
"title": "Transfer Call To Operator"
},
{
"value": "TransferCallToTarget",
"title": "Transfer Call To Target"
}
],
"type": "string",
"name": "Action",
"title": "Action"
},
"CallTargetType": {
"choices": [
{
"value": "ExternalPstn",
"title": "External phone number"
},
{
"value": "User",
"title": "Person in organization"
},
{
"value": "ApplicationEndpoint",
"title": "Resource Account"
},
{
"value": "SharedVoicemail",
"title": "Voicemail"
}
],
"type": "string",
"name": "CallTargetType",
"title": "Call Target Type"
}
}
},
"type": "array",
"name": "MenuOptions",
"title": "Menu Options"
},
"Greeting": {
"properties": {
"TextToSpeechPrompt": {
"type": "string",
"name": "TextToSpeechPrompt",
"title": "Text To Speech Prompt"
},
"AudioFilePrompt": {
"format": "db_filename",
"type": "string",
"name": "AudioFilePrompt",
"title": "Audio File Prompt"
},
"ActiveType": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "TextToSpeech",
"title": "Text To Speech"
},
{
"value": "AudioFile",
"title": "Audio File"
}
],
"type": "string",
"name": "ActiveType",
"title": "Active Type"
}
},
"type": "object",
"name": "Greeting",
"title": "Greeting"
},
"Name": {
"required": true,
"type": "string",
"name": "Name",
"title": "Name"
}
},
"required": true,
"type": "object",
"name": "Menu",
"title": "Menu"
},
"Schedule": {
"properties": {
"FixedSchedule": {
"properties": {
"DateTimeRanges": {
"items": {
"type": "object",
"properties": {
"Start": {
"title": "Start",
"type": "string",
"name": "Start",
"description": "Format should be d/M/yyyy H:mm OR d/M/yyyy"
},
"End": {
"title": "End",
"type": "string",
"name": "End",
"description": "Format should be d/M/yyyy H:mm OR d/M/yyyy"
}
}
},
"type": "array",
"name": "DateTimeRanges",
"title": "Date Time Ranges"
}
},
"type": "object",
"name": "FixedSchedule",
"title": "Fixed Schedule"
},
"WeeklyRecurrentSchedule": {
"properties": {
"SaturdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "SaturdayHours",
"title": "Saturday Hours"
},
"ThursdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "ThursdayHours",
"title": "Thursday Hours"
},
"WednesdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "WednesdayHours",
"title": "Wednesday Hours"
},
"MondayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "MondayHours",
"title": "Monday Hours"
},
"FridayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "FridayHours",
"title": "Friday Hours"
},
"SundayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "SundayHours",
"title": "Sunday Hours"
},
"TuesdayHours": {
"items": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"name": "Start",
"title": "Start"
},
"End": {
"type": "string",
"name": "End",
"title": "End"
}
}
},
"type": "array",
"name": "TuesdayHours",
"title": "Tuesday Hours"
}
},
"type": "object",
"name": "WeeklyRecurrentSchedule",
"title": "Weekly Recurrent Schedule"
},
"ScheduleType": {
"type": "string",
"name": "ScheduleType",
"title": "Type"
},
"ScheduleName": {
"type": "string",
"name": "ScheduleName",
"title": "Name"
}
},
"type": "object",
"name": "Schedule",
"title": "Schedule"
},
"Greeting": {
"properties": {
"TextToSpeechPrompt": {
"type": "string",
"name": "TextToSpeechPrompt",
"title": "Text To Speech Prompt"
},
"AudioFilePrompt": {
"format": "db_filename",
"type": "string",
"name": "AudioFilePrompt",
"title": "Audio File Prompt"
},
"ActiveType": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "TextToSpeech",
"title": "Text To Speech"
},
{
"value": "AudioFile",
"title": "Audio File"
}
],
"type": "string",
"name": "ActiveType",
"title": "Active Type"
}
},
"type": "object",
"name": "Greeting",
"title": "Greeting"
},
"Name": {
"required": true,
"type": "string",
"name": "Name",
"title": "Name"
}
},
"required": true,
"type": "object",
"name": "DefaultCallFlow",
"title": "Default Call Flow"
},
"OperatorNumber": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "OperatorNumber",
"title": "Operator Number"
},
"ApplicationInstancesCount": {
"readonly": true,
"type": "integer",
"name": "ApplicationInstancesCount",
"title": "Number of Resource Accounts"
},
"FirstApplicationInstanceName": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "FirstApplicationInstanceName",
"title": "1st Resource Account Name"
},
"FirstApplicationInstanceFirstPhoneNumber": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "FirstApplicationInstanceFirstPhoneNumber",
"title": "1st Phone Number of 1st Resource Account"
},
"DialScope": {
"properties": {
"ExcludedGroups": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
],
"name": "ExcludedGroups",
"title": "Excluded Groups"
},
"IncludedGroups": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
],
"name": "IncludedGroups",
"title": "Included Groups"
}
},
"type": [
"object",
"null"
],
"name": "DialScope",
"title": "Dial Scope"
},
"Identity": {
"readonly": true,
"required": true,
"type": "string",
"name": "Identity",
"title": "Identity"
},
"Name": {
"required": true,
"type": "string",
"name": "Name",
"title": "Name"
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/msteamsonline/CsAutoAttendant/add/ |
|
The GUI Add form of device/msteamsonline/CsAutoAttendant as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/msteamsonline/CsAutoAttendant/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/msteamsonline/CsAutoAttendant/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/msteamsonline/CsAutoAttendant/[pkid1]", "/api/device/msteamsonline/CsAutoAttendant/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/msteamsonline/CsAutoAttendant/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msteamsonline/CsAutoAttendant/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msteamsonline/CsAutoAttendant/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsAutoAttendant/[pkid1]", "/api/v0/device/msteamsonline/CsAutoAttendant/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsAutoAttendant/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsAutoAttendant |
|
{"hrefs": ["/api/device/msteamsonline/CsAutoAttendant/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsAutoAttendant |
|
{"hrefs": ["/api/device/msteamsonline/CsAutoAttendant/[pkid1]", "/api/device/msteamsonline/CsAutoAttendant/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsAutoAttendant; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsAutoAttendant/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsAutoAttendant/[pkid1]", "/api/device/msteamsonline/CsAutoAttendant/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/msteamsonline/CsAutoAttendant and the JSON format can be used to import instances of device/msteamsonline/CsAutoAttendant.
GET http://[host-proxy]/api/device/msteamsonline/CsAutoAttendant/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsAutoAttendant | POST | /api/device/msteamsonline/CsAutoAttendant/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/msteamsonline/CsAutoAttendant/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/msteamsonline/CsAutoAttendant/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/msteamsonline/CsAutoAttendant/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msteamsonline/CsAutoAttendant/ |
|
The device/msteamsonline/CsAutoAttendant schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsAutoAttendant instances)
{
"operations": [
"list",
"add"
],
"pagination": {
"direction": "asc",
"order_by": "Name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/msteamsonline/CsAutoAttendant/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2019.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/msteamsonline/CsAutoAttendant/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsAutoAttendant/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/msteamsonline/CsAutoAttendant/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsAutoAttendant",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsAutoAttendant/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/msteamsonline/CsAutoAttendant/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsAutoAttendant/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsAutoAttendant/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/msteamsonline/CsAutoAttendant/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/msteamsonline/CsAutoAttendant/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/msteamsonline/CsAutoAttendant/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/msteamsonline/CsAutoAttendant/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsAutoAttendant/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsAutoAttendant/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/msteamsonline/CsAutoAttendant/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/msteamsonline/CsAutoAttendant",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"move",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"summary_attrs": [
{
"name": "Name",
"title": "Auto Attendant Name"
},
{
"name": "OperatorDisplay",
"title": "Operator Display"
},
{
"name": "OperatorNumber",
"title": "Operator Number"
},
{
"name": "ApplicationInstancesCount",
"title": "Number of Resource Accounts"
},
{
"name": "FirstApplicationInstanceName",
"title": "1st Resource Account Name"
},
{
"name": "FirstApplicationInstanceFirstPhoneNumber",
"title": "1st Phone Number of 1st Resource Account"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msteamsonline/CsAutoAttendant. | GET | /api/device/msteamsonline/CsAutoAttendant/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsAutoAttendant as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/msteamsonline/CsAutoAttendant/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/msteamsonline/CsAutoAttendant/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/CsAutoAttendant | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/msteamsonline/CsAutoAttendant; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsAutoAttendant/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/msteamsonline/CsAutoAttendant and the JSON format can be used to import instances of device/msteamsonline/CsAutoAttendant.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsAutoAttendant/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msteamsonline/CsAutoAttendant/[pkid]/ | hierarchy=[hierarchy] | The device/msteamsonline/CsAutoAttendant instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msteamsonline/CsAutoAttendant/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsAutoAttendant. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsAutoAttendant/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |