Group Custom Ringback

Retrieve the group custom ringback settings

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/custom_ringback/

Retrieve the settings of the Custom Ringback service of the group.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/custom_ringback/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
     "active": false,
     "audioSelection": "File",
     "audioFile": {
          "name": "APIO Group Test Announcement",
          "mediaType": "WAV"
     }
}
Response JSON Object:

  • active (boolean) – Specify if to enable the custom ringback service.

  • audioSelection (string) – The the selection of the file to be played : ‘File’ or ‘Default’.

  • audioFile (object) – An object as defined as Group Custom Ringback Audio File.

Status Codes:

Update the group custom ringback settings

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/custom_ringback/

Update the settings of Custom Ringback service of the group.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/custom_ringback/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "active": false,
     "audioSelection": "File",
     "audioFile": {
          "name": "APIO Group Test Announcement",
          "mediaType": "WAV"
     }
}
Request JSON Object:

  • active (boolean) – Specify if to enable the custom ringback service.

  • audioSelection (string) – The the selection of the file to be played : ‘File’ or ‘Default’.

  • audioFile (object) – An object as defined as Group Custom Ringback Audio File.

Example response:

HTTP/1.1 200 OK
Status Codes: