Jump to content

TuCloudAPI getlocutions

From Wiki 7Kas

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

Description

List the PBX locutions / IVR prompts. Each row includes has_audio (whether the prompt WAV exists) and audio_url (the getaudio player URL). Tenant from (ukey, pbx).

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getlocutions&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.
q string No Optional name/number search (contains).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=getlocutions&ukey=KEY&pbx=tucall

Response

{ok, rows:[{_id,loc,name,waitext,digit_count,has_audio,audio_url}]}.


Back to TuCloudAPI