Add a new Sound Configuration payload configuration to an existing profile

Create Android sound configurations payload

Endpoints

post /api/v1/mdm/profiles/{profile_id}/payloads/androidsoundconfigurationpolicy

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

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

- Request Body

application/json

JSON Object

Hide Sub-Attributes

ring_modeintegerOptional

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

ring_volumeintegerOptional

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

notification_volumeintegerOptional

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

media_volumeintegerOptional

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

alarm_volumeintegerOptional

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

system_volumeintegerOptional

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

call_volumeintegerOptional

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

allow_volume_modificationbooleanOptional

Whether the user can modify volume settings. Default: false

is_ringtone_audio_file_modifiedbooleanOptional

Whether the ringtone audio file has been modified in this request

ringtone_audio_filelongOptional

File path or ID of the custom ringtone audio file

allow_ringtone_modificationbooleanOptional

Whether the user can modify the ringtone. Default: false

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidsoundconfigurationpolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"ring_mode":-1,"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"}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidsoundconfigurationpolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"ring_mode\":-1,\"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\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"ring_mode\":-1,\"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\"}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/androidsoundconfigurationpolicy", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("ring_mode","1");
    data.put("ring_volume","1");
    data.put("notification_volume","1");
    data.put("media_volume","1");
    data.put("alarm_volume","1");
    data.put("system_volume","1");
    data.put("call_volume","1");
    data.put("allow_volume_modification",true);
    data.put("is_ringtone_audio_file_modified",true);
    data.put("ringtone_audio_file","1");
    data.put("allow_ringtone_modification",true);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidsoundconfigurationpolicy"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidsoundconfigurationpolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"ring_mode":-1,"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"}'

Sample Request Body

Add Sound Configuration payload to the profile

Copied!

  {
    "ring_mode": -1,
    "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

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier for the created 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

Sound Configuration payload successfully added

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: 30 | 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.