MOR API ivr time period update
From Kolmisoft Wiki
Jump to navigationJump to search
Description
Updates IVR time period.
Admin - can update IVR time periods.
Reseller PRO - can update his IVR time periods.
Usage
- From MOR X14 call: /api/ivr_time_period_update
- Methods: POST, GET(if allowed, not recommended)
Parameters
Parameters which are included into hash:
- u - username for authentication. Required.
- ivr_time_period_id - IVR time period id. Required.
Parameters which are not included into hash:
- name - ivr time period name
- start_hour - value from 0 till 23
- end_hour - value from 0 till 23
- start_minute - value from 0 till 59
- end_minute - value from 0 till 59
Parameters which value can be blank(parameter=):
- start_weekday - possible values: mon tue wed thu fri sat sun
- end_weekday - possible values: mon tue wed thu fri sat sun
- start_month - possible values from 1 till 12
- end_month - possible values from 1 till 12
- start_day - possible values from 1 till 31
- end_day - possible values from 1 till 31
Request
If you want to update IVR time period with id 1 and change it's name to Test Time Period, set start day Monday and end day Wednesday
You send:
HTML POST: http://SERVER_IP/billing/api/ivr_time_period_update?u=admin&ivr_time_period_id=1&name=Test Time Period&start_weekday=mon&end_weekday=wed&hash=6e79d4a82f68102f43be11d873177f47817f84df
Returns
Success: Everything is ok.IVR time period was updated.
<page> <status> <message>Time Periods successfully updated</message> </status> </page>
Errors:
- start_hour must be beetween 0 and 23
- send_hour must be beetween 0 and 23
- start_minute must be beetween 0 and 59
- send_minute must be beetween 0 and 5
- Valid start_weekday values are mon, tue, wed, thu, fri, sat, sun
- Valid end_weekday values are mon, tue, wed, thu, fri, sat, sun
- start_month must be beetween 1 and 12
- send_month must be beetween 1 and 12
- start_day must be beetween 1 and 31
- send_day must be beetween 1 and 31
- name value cannot be blank
- Time period was not updated
- Time period was not found - jei neegzistuoja toks periodas ar tam useriui nepriklauso
Example:
Time period was not found:
<status> <error>Time period was not found</error> </status> </page>