Retrieve the full configuration details of a Sound Configuration payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Get Android sound configuration payload

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/androidsoundconfigurationpolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidsoundconfigurationpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

ring_modeinteger

Ringer mode. -1 = Not Configured, 0 = Silent, 1 = Vibrate, 2 = Normal. Default: -1

ring_volumeinteger

Ring volume level (0-100, -1 = Not Configured). Default: -1

notification_volumeinteger

Notification volume level (0-100, -1 = Not Configured). Default: -1

media_volumeinteger

Media volume level (0-100, -1 = Not Configured). Default: -1

alarm_volumeinteger

Alarm volume level (0-100, -1 = Not Configured). Default: -1

system_volumeinteger

System volume level (0-100, -1 = Not Configured). Default: -1

call_volumeinteger

Call volume level (0-100, -1 = Not Configured). Default: -1

allow_volume_modificationboolean

Whether the user can modify volume settings. Default: false

is_ringtone_audio_file_modifiedboolean

Whether the ringtone audio file has been modified in this request

ringtone_audio_filelong

File path or ID of the custom ringtone audio file

allow_ringtone_modificationboolean

Whether the user can modify the ringtone. Default: false

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Sound Configuration payload item

Copied!
  {
    "ring_mode": -1,
    "payload_id": 9007199254741000,
    "notification_volume": -1,
    "call_volume": -1,
    "media_volume": -1,
    "allow_volume_modification": false,
    "allow_ringtone_modification": false,
    "ring_volume": -1,
    "alarm_volume": -1,
    "system_volume": -1,
    "ringtone_file_name": "Zylker User",
    "ringtone_audio_file": "value"
  }
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.