Group Night Forwarding

Retrieve configuration

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

Get the details about the group night forwarding service.

Example request:

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

Example response:

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

{
   "nightForwarding": "Off",
   "businessHours": "",
   "holidaySchedule": "",
   "forwardToPhoneNumber": ""
}

Response JSON Object:

• nightForwarding (string) – See nightForwarding from Attributes Description.

• businessHours (object) – See businessHours from Attributes Description.

• holidaySchedule (object) – See holidaySchedule from Attributes Description.

• forwardToPhoneNumber (string) – See forwardToPhoneNumber from Attributes Description.

Status Codes:

• 200 OK – no error.

Update configuration

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

Update the details about the group night forwarding service.

Example request:

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

{
   "nightForwarding": "On",
   "forwardToPhoneNumber": "+3203216448"
   "businessHours": {"name": "APIO Test Time Schedule"}
   "holidaySchedule": {"name": "APIO Test Holiday Schedule"}
}

Request JSON Object:

• nightForwarding (string) – See nightForwarding from Attributes Description.

• businessHours (object) – See businessHours from Attributes Description.

• holidaySchedule (object) – See holidaySchedule from Attributes Description.

• forwardToPhoneNumber (string) – See forwardToPhoneNumber from Attributes Description.

Example response:

Response:

Similar to GET method response.

Status Codes:

• 200 OK – no error.

• 400 Bad Request – failed to update.

• 404 Not Found – businessHours or holidaySchedule not found. TODO

Attributes Description

Name	Type	Methods		Description
		GET	PUT
nightForwarding	String	A	O	Choices for the Group Night Forwarding Service Activation. Allowed values are: “Off”, “On”, “Auto On” (i.e. based on Schedules)
businessHours	Object/String	C	O	See Schedule attributes. Empty string or null to remove.
holidaySchedule	Object/String	C	O	See Schedule attributes. Empty string or null to remove.
forwardToPhoneNumber	String	A	C	Required if nightForwarding choice is not “Off”.