Custom Ring Back

Display user’s custom ring back

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

The API is mapped to UserCustomRingbackUserGetCriteriaListRequest

Update a user’s custom ring back

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

The API is mapped to :

• UserCustomRingbackUserModifyActiveCriteriaListRequest

• UserCustomRingbackUserAddCriteriaRequest

• UserCustomRingbackUserModifyCriteriaRequest

• UserCustomRingbackUserDeleteCriteriaRequest

Display user’s custom ring back criteria

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/custom_ringback/criteria/(string: instance_name)/

The API is mapped to UserCustomRingbackUserGetCriteriaRequest

Additional information

Response JSON Object:

• name (string) – (Required) see name from Criteria attributes.

• timeSchedule (object) – see timeSchedule from Schedule attributes.

• holidaySchedule (object) – see holidaySchedule from Schedule attributes.

• fromDnCriteria (object) – see fromDnCriteria from Criteria From DN attributes.

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

• audioFile (object) – an objects as defined as Audio File attributes.

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

• callWaitingAudioFile (object) – an objects as defined as Audio File attributes.

Assign a user’s custom ring back criteria

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/custom_ringback/criteria/

The API is mapped to UserCustomRingbackUserAddCriteriaRequest and UserCustomRingbackUserModifyActiveCriteriaListRequest

Additional restrictions

Request JSON Object:

• name (string) – (Required) see name from Criteria attributes.

• timeSchedule (object) – see timeSchedule from Schedule attributes.

• holidaySchedule (object) – see holidaySchedule from Schedule attributes.

• fromDnCriteria (object) – see fromDnCriteria from Criteria From DN attributes.

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

• audioFile (object) – an objects as defined as Audio File attributes.

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

• callWaitingAudioFile (object) – an objects as defined as Audio File attributes.

Update a user’s custom ring back criteria

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/custom_ringback/criteria/(string: instance_name)/

The API is mapped to UserCustomRingbackUserModifyCriteriaRequest

Additional restrictions

Request JSON Object:

• name (string) – (Required) see name from Criteria attributes.

• newName (string) – see newName from Criteria attributes.

• timeSchedule (object) – see timeSchedule from Schedule attributes.

• holidaySchedule (object) – see holidaySchedule from Schedule attributes.

• fromDnCriteria (object) – see fromDnCriteria from Criteria From DN attributes.

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

• audioFile (object) – an objects as defined as Audio File attributes.

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

• callWaitingAudioFile (object) – an objects as defined as Audio File attributes.

Disassign a user’s custom ring back criteria

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/custom_ringback/criteria/(string: instance_name)/

The API is mapped to UserCustomRingbackUserDeleteCriteriaRequest

Additional restrictions

Response JSON Object:

• name (string) – (Required) see name from Criteria attributes.