View source for TuCloudAPI updatelocution

''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 <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
|-
| <code>id</code> || integer || Yes || — || Locution id (_id).
|-
| <code>name</code> || string || Yes || — || Display name (required, max 32).
|-
| <code>waitext</code> || integer || No || <code>1</code> || 1 = allow direct-dial extension, 0 = no.
|-
| <code>ziro</code> || integer || No || <code>0</code> || DTMF 0 route _id (0 = none).
|-
| <code>one</code> || integer || No || <code>0</code> || DTMF 1 route _id.
|-
| <code>two</code> || integer || No || <code>0</code> || DTMF 2 route _id.
|-
| <code>three</code> || integer || No || <code>0</code> || DTMF 3 route _id.
|-
| <code>four</code> || integer || No || <code>0</code> || DTMF 4 route _id.
|-
| <code>five</code> || integer || No || <code>0</code> || DTMF 5 route _id.
|-
| <code>six</code> || integer || No || <code>0</code> || DTMF 6 route _id.
|-
| <code>seven</code> || integer || No || <code>0</code> || DTMF 7 route _id.
|-
| <code>eight</code> || integer || No || <code>0</code> || DTMF 8 route _id.
|-
| <code>nine</code> || integer || No || <code>0</code> || DTMF 9 route _id.
|-
| <code>asterisk</code> || integer || No || <code>0</code> || DTMF * route _id.
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=updatelocution&ukey=KEY&pbx=tucall&id=902&name=Bienvenida&one=197</nowiki>

== Response ==
{ok, locution:{...}}.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]