telecoms.routeplan.edit function

function telecoms.routeplan.edit

Edits an existing route plan.

This function takes the same arguments as telecoms.routeplan.create except that:

it also requires an additional routeplanID argument to identify the routeplan to edit
both the 'desc' and 'items' args are optional; this function only changes elements that are supplied, eg: if you just supply the 'desc' arg, the items remain unchanged

For further information about what goes into the items argument, see the telecoms.routeplan.create function.

arg	required?	syntax	info
`custID`	N	posint	custID of account containing the routeplan you wish to edit (defaults to your own account)
`routeplanID`	Y	posint	routeplanID of the route plan you wish to edit
`desc`	N	string	a brief textual description of your route plan
`items`	N	array	array of route plan items; this is where the routeplan can route calls to
`mode`	N	enum:sequential\|parallel\|wtd-single\|wtd-rotational\|wtd-parallel\|rr-rotational\|rr-parallel	dialling mode; eg try one destination at a time, dial all simultaneously, etc
`max_repeats`	N	unsint	Max number of times to re-try the destination list if not answered
`busy_action`	N	enum:busy\|busy-any\|redial	What to do when destinations are busy
`headstart`	N	unsint	number of seconds to prioritise one destination in wtd-parallel or rr-parallel mode