Get Message Ringtones

Get the collection of ringtones that the message can be configured.

Request Format

GET https://{apigw-address}/app-portal-service/v2.0/message/enum/ringtones

Response Parameters

Name

Data Type

Description

data

data struct

List of ringtones for the message

data Struct

Name

Data Type

Description

ringings

Ringing struct

List of ringtones for the message

Ringing Struct

Name

Data Type

Description

id

int

Ringtone ID

name

I18nString

The internationalized names of the ringtone. For the structure, see Internationalized name struct

Sample

Request Sample

GET
https://{apigw-address}/app-portal-service/v2.0/message/enum/ringtones

Return Sample

{
  "code": 200,
  "message": "",
  "data": {
    "ringings": [
      {
        "id": 0,
        "name": {
          "default": "No Sound",
          "en_US": "No Sound",
          "zh_CN": "无声音"
        }
      },
      {
        "id": 1,
        "name": {
          "default": "Alarm Sound",
          "en_US": "Alarm Sound",
          "zh_CN": "警报声"
        }
      }
    ]
  }
}