Workspace configuration
Set the phone menu
Sets the phone menu callers hear: greeting, which key goes where (options), the invalid-key message, timeout_seconds and the fallback queue. It replaces the whole menu.
Requires: desk.admin scope, workspace owner or admin.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Request Body
application/json
Response
OK
Example
{ "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "name": "Amina Wanjiru", "enabled": false, "greeting_mode": "text", "greeting": "Thank you for calling. How can we help?", "recording": { "name": "Amina Wanjiru", "play_url": "https://example.com/file", "bytes": 1, "seconds": 60 }, "invalid_message": "That option is not available. Please try again.", "timeout_seconds": 60, "fallback_queue_id": "51d4236b-6020-45d7-9447-45670c8eadf1", "options": [ { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "digit": "example", "label": "Amina Wanjiru", "queue_id": "c70c2d37-4d65-4ba4-9843-5e8aaf2dae40", "position": 1 } ]}FieldTypeDescription
idrequiredstring (uuid)namerequiredstringA name for it.enabledrequiredbooleanTrue to switch it on, false to switch it off.greeting_moderequiredstringtext to read the greeting aloud, or recording to play an uploaded recording.greetingrequiredstringThe words read to the caller or shown to the visitor first.recordinganyThe recording to play when the greeting mode is recording.namerequiredstringA name for it.play_urlrequiredstringbytesrequiredintegersecondsrequiredintegerinvalid_messagerequiredstringWhat the caller hears when they press an option that does not exist.timeout_secondsrequiredintegerHow long to wait for a key press before using the fallback queue.fallback_queue_idstring (uuid) | nullThe id of the queue that gets the call when the caller presses nothing or something invalid.optionsrequiredobject[]The keys a caller can press and where each one sends the call.idrequiredstring (uuid)digitrequiredstringlabelrequiredstringA short name to recognise it by.queue_idrequiredstring (uuid)The id of the queue that receives what arrives here.positionrequiredintegerWhere it sits in the list, starting at 0.curl -X PUT "https://api.sautidesk.com/v1/desk/menu" \ -H "Content-Type: application/json" \ -d '{ "name": "Amina Wanjiru", "enabled": false, "greeting_mode": "text", "greeting": "Thank you for calling. How can we help?", "recording": { "name": "Amina Wanjiru", "play_url": "https://example.com/file", "bytes": 1, "seconds": 60 }, "invalid_message": "That option is not available. Please try again.", "timeout_seconds": 60, "fallback_queue_id": "51d4236b-6020-45d7-9447-45670c8eadf1", "options": [ { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "digit": "example", "label": "Amina Wanjiru", "queue_id": "c70c2d37-4d65-4ba4-9843-5e8aaf2dae40", "position": 1 } ] }'