Jump to content

TuCloudAPI updatelocution

From Wiki 7Kas

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

Description

Edit a locution (name, waitext, digit routes). loc is read-only (create-only). 404 if not in the caller's PBX. Requires a non-readonly ukey.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=updatelocution&ukey=YOUR_KEY

Requires the ukey parameter.

Parameters

Parameter Type Required Default Meaning
pbx string Yes FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
id integer Yes Locution id (_id).
name string Yes Display name (required, max 32).
waitext integer No 1 1 = allow direct-dial extension, 0 = no.
ziro integer No 0 DTMF 0 route _id (0 = none).
one integer No 0 DTMF 1 route _id.
two integer No 0 DTMF 2 route _id.
three integer No 0 DTMF 3 route _id.
four integer No 0 DTMF 4 route _id.
five integer No 0 DTMF 5 route _id.
six integer No 0 DTMF 6 route _id.
seven integer No 0 DTMF 7 route _id.
eight integer No 0 DTMF 8 route _id.
nine integer No 0 DTMF 9 route _id.
asterisk integer No 0 DTMF * route _id.

Example

https://tucloudapi.7kas.com:9087/tucloud?func=updatelocution&ukey=KEY&pbx=tucall&id=902&name=Bienvenida&one=197

Response

{ok, locution:{...}}.


Back to TuCloudAPI