This API lets you retrieve a specific account phone template previously created.
Scope:
phone:write:adminorphone:write
Prerequisites:
- Business or Enterprise Account
- A Zoom Phone license
:Light
643 matches
60 actions
Zoom
60 actions
- Get a channelGETv1.0.0
- Get a channelGETv1.0.0
- Get a group's settingsGETv1.0.0
- Get a shared line groupGETv1.0.0
- Get billing informationGETv1.0.0
- Get blocked list detailsGETv1.0.0
- Get call details from call logGETv1.0.0
- Get call QoSGETv1.0.0
- Get call queue detailsGETv1.0.0
- Get call queue recordingsGETv1.0.0
- Get common area phone detailsGETv1.0.0
- Get CRC port usageGETv1.0.0
- Get device detailsGETv1.0.0
- Get IM metricsGETv1.0.0
- Get invoice detailsGETv1.0.0
- Get issues of Zoom RoomsGETv1.0.0
- Get live stream detailsGETv1.0.0
- Get location settingsGETv1.0.0
- Get locked settingsGETv1.0.0
- Get locked settingsGETv1.0.0
- Get managed domainsGETv1.0.0
- Get meeting detailsGETv1.0.0
- Get meeting participant QoSGETv1.0.0
- Get operation logs reportGETv1.0.0
- Get phone number detailsGETv1.0.0
- Get phone site detailsGETv1.0.0
- Get plan InformationGETv1.0.0
- Get plan usageGETv1.0.0
- Get role informationGETv1.0.0
- Get setting template detailsGETv1.0.0
- Get settingsGETv1.0.0
- Get sharing/recording detailsGETv1.0.0
- Get sharing/recording detailsGETv1.0.0
- Get sub account detailsGETv1.0.0
- Get top 25 issues of Zoom RoomsGETv1.0.0
- Get top 25 Zoom Rooms with issuesGETv1.0.0
- Get trusted domainsGETv1.0.0
- Get user's contact detailsGETv1.0.0
- Get webinar detailsGETv1.0.0
- Get webinar participant QoSGETv1.0.0
- Get webinar participantsGETv1.0.0
- Get webinar tracking sourcesGETv1.0.0
- Get zoom meetings client feedbackGETv1.0.0
- Get Zoom Room account profileGETv1.0.0
- Get Zoom Room account settingsGETv1.0.0
- Get Zoom Room location profileGETv1.0.0
- Get Zoom Room location structureGETv1.0.0
- Get Zoom Rooms detailsGETv1.0.0
- List billing invoicesGETv1.0.0
- List H.323/SIP devicesGETv1.0.0
- List meeting participantsGETv1.0.0
- List meeting participants QoSGETv1.0.0
- List recordings of an accountGETv1.0.0
- List sub accountsGETv1.0.0
- List user's channelsGETv1.0.0
- List user's contactsGETv1.0.0
- List webinar participant QoSGETv1.0.0
- List webinarsGETv1.0.0
- List Zoom meetings client feedbackGETv1.0.0
- List Zoom RoomsGETv1.0.0
Communication/Zoom
Get setting template details
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
{
"type": "object",
"properties": {
"custom_query_fields": {
"type": "string"
},
"templateId": {
"type": "string"
}
},
"required": [
"templateId"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The description of the template."
},
"id": {
"type": "string",
"description": "Specify the template ID."
},
"name": {
"type": "string",
"description": "Specify the name of the template."
},
"policy": {
"type": "object",
"properties": {
"ad_hoc_call_recording": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"description": "Allow current extension to record and save calls in the cloud."
},
"recording_start_prompt": {
"type": "boolean",
"description": "Play a prompt to call participants when the recording has started."
},
"recording_transcription": {
"type": "boolean",
"description": "Allow call recording transcription."
}
}
},
"auto_call_recording": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"description": "Enable automatic call recording."
},
"recording_calls": {
"type": "string",
"description": "Values: inbound, outbound, both."
},
"recording_start_prompt": {
"type": "boolean",
"description": "Play a prompt to call participants when the recording has started."
},
"recording_transcription": {
"type": "boolean",
"description": "Allow call recording transcription."
}
}
},
"sms": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"description": "Allow user to send and receive messages."
},
"international_sms": {
"type": "boolean"
}
}
},
"voicemail": {
"type": "object",
"properties": {
"allow_transcription": {
"type": "boolean",
"description": "Allow voicemail transcription."
},
"enable": {
"type": "boolean",
"description": "Allow current extension to access, receive, or share voicemail."
}
}
}
}
},
"profile": {
"type": "object",
"properties": {
"area_code": {
"type": "string",
"description": "The area code from which the phone account was created."
},
"country": {
"type": "string",
"description": "Name of the country where the template was created."
}
}
},
"type": {
"type": "string",
"description": "The type of template being queried. Values: `user`, `group`, `auto receptionist` `common area`,`zr`, `interop`.",
"enum": [
"user",
"group",
"autoReceptionist",
"commonArea",
"zr",
"interop"
]
},
"user_settings": {
"type": "object",
"properties": {
"audio_prompt_language": {
"type": "string",
"description": "Audio prompt language code.<br> American English: `en-US`<br>\nBritish English: `en-GB`<br>\nEspañol americano: `es-US`<br>\nFrançais canadien: `fr-CA`<br>\nDansk: `da-DK`<br>\nDeutsch: `de-DE`<br>\nEspañol: `es-ES`<br>\nFrançais: `fr-FR`<br>\nItaliano: `it-IT`<br>\nNederlands: `nl-NL`<br>\nPortugues portugal: `pt-PT`<br>\nJapanese: `ja-JP`<br>\nKorean: `ko-KO`<br>\nPortugues brasil: `pt-BR`<br>\nChinese: `zh-CN`<br>\nTaiwanese: `zh-TW`<br>"
},
"block_calls_without_caller_id": {
"type": "boolean",
"description": "Block Calls without Caller ID."
},
"call_handling": {
"type": "object",
"properties": {
"business_hours": {
"type": "object",
"properties": {
"business_hour_action": {
"type": "integer",
"description": "When a call is not answered:<br>\n0-Forward to voicemail;<br>\n1-Play a message, then disconnect; <br>\n9-Disconnect; <br>\n26-Forward to External Contacts; <br>\n50-Forward to another extension",
"enum": [
0,
1,
9,
26,
50
]
},
"connect_to_operator": {
"type": "object",
"description": "Allow callers to press Zero to reach an operator or press One to leave a message, or allow neither of these options.",
"properties": {
"enable": {
"type": "boolean",
"description": "Enable connect to operator."
},
"id": {
"type": "string",
"description": "Phone extension ID of the user, zoomRoom, commonAreaPhone, autoReceptionist, callQueue or sharedLineGroup."
},
"type": {
"type": "string",
"description": "Values:<br>\n1-user,<br>\n2-callQueue, <br>\n3-autoReceptionist,<br>\n4-commonAreaPhone,<br>\n5-zoomRoom, <br>\n7-sharedLineGroup",
"enum": [
"user",
"zoomRoom",
"commonAreaPhone",
"autoReceptionist",
"callQueue",
"sharedLineGroup"
]
}
}
},
"custom_hours": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "time",
"description": "Values:<br> \nhh:mm"
},
"to": {
"type": "string",
"format": "time",
"description": "Values:<br> \nhh:mm"
},
"type": {
"type": "integer",
"description": "Values:<br>\n1-24 Hours,<br>\n2-customized hours",
"enum": [
1,
2
]
},
"weekday": {
"type": "integer",
"description": "Values: 1-7 sun-sat",
"enum": [
1,
2,
3,
4,
5,
6,
7
]
}
}
}
},
"ring_type": {
"type": "string",
"description": "Call Handling Ring Mode:<br>\n0-Simultaneous,<br>\n1-Sequential",
"enum": [
0,
1
]
},
"ringing_duration": {
"type": "string",
"description": "Ringing Duration for Each Device in seconds. Values:<br>\n15,20,25,30,35,40,45,50,55,60",
"enum": [
15,
20,
25,
30,
35,
40,
45,
50,
55,
60
]
},
"type": {
"type": "integer",
"description": "Values:<br>\n1-24 Hours, 7 Days a Week;<br>\n2-Custom Hours",
"enum": [
1,
2
]
}
}
},
"close_hours": {
"type": "object",
"properties": {
"close_hour_action": {
"type": "integer",
"description": "Action to take when a call is not answered:<br>\n0-Forward to voicemail; <br>\n1-Play a message, then disconnect; <br>\n9-Disconnect; <br>\n26-Forward to External Contacts; <br>\n50-Forward to another extension\n",
"enum": [
0,
1,
9,
26,
50
]
},
"connect_to_operator": {
"type": "object",
"description": "Allow callers to press Zero to reach an operator or press One to leave a message, or allow neither of these options.",
"properties": {
"enable": {
"type": "boolean"
},
"id": {
"type": "string",
"description": "Phone extension ID of the user, zoomRoom, commonAreaPhone, autoReceptionist, callQueue or sharedLineGroup."
},
"type": {
"type": "string",
"description": "Values:<br>\n1-user,<br>\n2-callQueue, <br>\n3-autoReceptionist,<br>\n4-commonAreaPhone,<br>\n5-zoomRoom, <br>\n7-sharedLineGroup",
"enum": [
"user",
"zoomRoom",
"commonAreaPhone",
"autoReceptionist",
"callQueue",
"sharedLineGroup"
]
}
}
},
"max_wait_time": {
"type": "string",
"description": "Max Wait Time in seconds. Values:<br>\n15,20,25,30,35,40,45,50,55,60",
"enum": [
15,
20,
25,
30,
35,
40,
45,
50,
55,
60
]
}
}
}
}
},
"desk_phone": {
"type": "object",
"properties": {
"pin_code": {
"type": "string",
"description": "Pin code."
}
}
},
"hold_music": {
"type": "string",
"description": "The value of this field can be either `default` or `disable`.\n\n* `default`: This means that the hold music can be set using the [audio library](https://support.zoom.us/hc/en-us/articles/360028212652-Using-the-audio-library-to-customize-greetings-and-hold-music).\n\n* `disable`: This means that the hold music is disabled.",
"enum": [
"default",
"disable"
]
}
}
}
}
}