Route Point Routing Policies¶

Routing Policies - Holiday Service¶

Retrieve configuration¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/routing_policies/¶

Retrieve a route point’s holiday service routing policy.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/routing_policies/ HTTP/1.1
Host: example.com

{
   "type": "Holiday Service"
}

Request JSON Object:

type (string) – Use Holiday Service to get holiday service routing policy.

Example response:

HTTP/1.1 200 OK

{
   "action": "Busy",
   "transferPhoneNumber": "+3267219021",
   "holidaySchedule": {
      "level": "Tenant",
      "name": "My Vacation",
      "type": "Holiday"
   },
   "playAnnouncementBeforeAction": true,
   "audioMessageSelection": "File",
   "audioFileList": [ null, { "name": "My Audio 1" }, { "name": "My Audio 2" }, null ]
}

Response JSON Object:

action (string) – Value of the action (can be None, Busy or Transfer.
transferPhoneNumber (string) – the phone number to transfer to (in case action is set to Transfer).
holidaySchedule (object) – A holiday schedule to apply as defined by Schedule attributes.
playAnnouncementBeforeAction (boolean) – Enable or disable playing an announcement before performing holiday service action.
audioMessageSelection (string) – See Announcements Config.
audioFileList (array) – See Announcements Config.

Status Codes:

200 OK –

Update configuration¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/routing_policies/¶

Update a route point’s holiday service routing policy.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/routing_policies/ HTTP/1.1
Host: example.com

{
   "type": "Holiday Service",
   "action": "Busy",
   "transferPhoneNumber": "+3267219021",
   "holidaySchedule": { "level": "Tenant", "name": "My XMAS Vacation" },
   "playAnnouncementBeforeAction": true,
   "audioMessageSelection": "File",
   "audioFileList": [ null, { "name": "My Announcement 1" }, { "name": "My Announcement 2" }, null ]
}

Request JSON Object:

type (string) – Use Holiday Service to update holiday services routing policy.
action (string) – Value of the action (can be None, Busy or Transfer.
transferPhoneNumber (string) – the phone number to transfer to (in case action is set to Transfer).
holidaySchedule (object) – A holiday schedule to apply as defined by Schedule attributes.
playAnnouncementBeforeAction (boolean) – Enable or disable playing an announcement before performing holiday service action.
audioMessageSelection (string) – See Announcements Config.
audioFileList (array) – See Announcements Config.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – instance updated

Routing Policies - Night Service¶

Retrieve configuration¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/routing_policies/¶

Retrieve a route point’s night service routing policy.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/routing_policies/ HTTP/1.1
Host: example.com

{
   "type": "Night Service"
}

Request JSON Object:

type (string) – Use Night Service to get night service routing policy.

Example response:

HTTP/1.1 200 OK

{
   "action": "Busy",
   "transferPhoneNumber": "+3267219021",
   "forceNightService": true,
   "businessHours": { "level": "Tenant", "name": "Grille3_HNO", "type": "Time" },
   "playAnnouncementBeforeAction": false,
   "announcementMode": "Normal Announcement",
   "normalAudioMessageSelection": "Default",
   "normalAudioFileList": [ null, { "name": "My Announcement 1" }, { "name": "My Announcement 2" }, null ],
   "manualAudioMessageSelection": "Default",
   "manualAudioFileList": [ { "name": "My Announcement 3" }, { "name": "My Announcement 4" }, null, null ]
}

Response JSON Object:

action (string) – Value of the action (can be None, Busy or Transfer.
transferPhoneNumber (string) – the phone number to transfer to (in case action is set to Transfer).
forceNightService (boolean) – Force night service now regardless of business hours schedule.
businessHours (object) – A time schedule to apply as defined by Schedule attributes.
playAnnouncementBeforeAction (boolean) – Enable or disable playing an announcement before performing night service action.
announcementMode (string) – Announcement to play in manual override mode. Can be Normal Announcement or Manual Announcement.
normalAudioMessageSelection (string) – See Announcements Config.
normalAudioFileList (array) – See Announcements Config.
manualAudioMessageSelection (string) – See Announcements Config.
manualAudioFileList (array) – See Announcements Config.

Status Codes:

200 OK –

Update configuration¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/route_points/(string: route_point_user_id)/routing_policies/¶

Update a rouet point’s night service routing policy.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/route_points/APIOTestRP@sip.netaxis.be/routing_policies/ HTTP/1.1
Host: example.com

{
   "type": "Night Service",
   "action": "Busy",
   "transferPhoneNumber": "+3267219021",
   "forceNightService": true,
   "businessHours": { "level": "Tenant", "name": "Grille3_HNO" },
   "playAnnouncementBeforeAction": false,
   "announcementMode": "Normal Announcement",
   "normalAudioMessageSelection": "Default",
   "normalAudioFileList": [ null, { "name": "My Announcement 1" }, { "name": "My Announcement 2" }, null ],
   "manualAudioMessageSelection": "File",
   "manualAudioFileList": [ { "name": "My Announcement 3" }, { "name": "Unmodify" }, null, null ]
}

Request JSON Object:

type (string) – Use Night Service to update night service routing policy.
action (string) – Value of the action (can be None, Busy or Transfer.
transferPhoneNumber (string) – the phone number to transfer to (in case action is set to Transfer).
forceNightService (boolean) – Force night service now regardless of business hours schedule.
businessHours (object) – A time schedule to apply as defined by Schedule attributes.
playAnnouncementBeforeAction (boolean) – Enable or disable playing an announcement before performing night service action.
announcementMode (string) – Announcement to play in manual override mode. Can be Normal Announcement or Manual Announcement.
normalAudioMessageSelection (string) – See Announcements Config.
normalAudioFileList (array) – See Announcements Config.
manualAudioMessageSelection (string) – See Announcements Config.
manualAudioFileList (array) – See Announcements Config.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – instance updated