API VoIP - Revision history

Maintenance script: API docs (generated from func=help)

2026-07-23T07:39:19Z

API docs (generated from func=help)

← Older revision		Revision as of 07:39, 23 July 2026
Line 2:		Line 2:

	== Overview ==		== Overview ==
	The 7Kas VoIP REST API exposes query and management functions over CDR, billing, incoming calls, accounts, pay-per-use services, CLIs, Tucloud PBX and WireGuard. '''HTTPS, GET, JSON.'''		The 7Kas VoIP REST API exposes query and management functions over CDR, billing, incoming calls, call recordings (audio/transcripts/certification), accounts, pay-per-use services, CLIs, Tucloud PBX and WireGuard. '''HTTPS, GET, JSON.'''

	== Self-discovery (start here) ==		== Self-discovery (start here) ==

Maintenance script: API docs (generated from func=help)

2026-07-22T22:55:14Z

API docs (generated from func=help)

← Older revision		Revision as of 22:55, 22 July 2026
Line 23:		Line 23:

	== Catalogue by profile ==		== Catalogue by profile ==
	* '''[[API profile SuperRoot]]''' — 42 functions (everything)		* '''[[API profile SuperRoot]]''' — 44 functions (everything)
	* '''[[API profile Operator]]''' — 35 functions		* '''[[API profile Operator]]''' — 37 functions
	* '''[[API profile Client (of operator)]]''' — 22 functions (client of an operator, root>0)		* '''[[API profile Client (of operator)]]''' — 24 functions (client of an operator, root>0)
	* '''[[API profile Client (direct)]]''' — 22 functions (direct 7Kas client, root=0)		* '''[[API profile Client (direct)]]''' — 24 functions (direct 7Kas client, root=0)

	== Try it ==		== Try it ==

Maintenance script: API docs: add recording transcript/summary endpoints

2026-07-22T22:25:51Z

API docs: add recording transcript/summary endpoints

← Older revision		Revision as of 22:25, 22 July 2026
Line 23:		Line 23:

	== Catalogue by profile ==		== Catalogue by profile ==
	* '''[[API profile SuperRoot]]''' — 40 functions (everything)		* '''[[API profile SuperRoot]]''' — 42 functions (everything)
	* '''[[API profile Operator]]''' — 33 functions		* '''[[API profile Operator]]''' — 35 functions
	* '''[[API profile Client (of operator)]]''' — 20 functions (client of an operator, root>0)		* '''[[API profile Client (of operator)]]''' — 22 functions (client of an operator, root>0)
	* '''[[API profile Client (direct)]]''' — 20 functions (direct 7Kas client, root=0)		* '''[[API profile Client (direct)]]''' — 22 functions (direct 7Kas client, root=0)

	== Try it ==		== Try it ==

Maintenance script: API docs (generated from func=help)

2026-07-21T22:33:41Z

API docs (generated from func=help)

← Older revision		Revision as of 22:33, 21 July 2026
Line 1:		Line 1:
	~~==Descripción==~~		{{Note\|New here? Jump to '''[[API help\|the self-discovery endpoint]]''' or open the live '''[[API Console\|▶ API Console]]''' to try any call with your own key.}}
	~~Nos va a permitir gestionar nuestros datos y servicios contratados en la plataforma VoIP de 7Kas~~.

	==~~Apartados~~==		== Overview ==
			The 7Kas VoIP REST API exposes query and management functions over CDR, billing, incoming calls, accounts, pay-per-use services, CLIs, Tucloud PBX and WireGuard. '''HTTPS, GET, JSON.'''

	=~~Autenticación~~=		== Self-discovery (start here) ==
	~~Para autenticarse en la plataforma~~, ~~es necesario disponer de una APIKey proporcionada por~~ 7Kas. ~~Si no dispones de una~~, ~~contacta con nosotros, y te facilitaremos una~~. ~~Esta APIKey debe enviarse en todas las consultas POST/GET como~~		The API documents itself, filtered by your role:
			…/7Kas?func=help&ukey=YOUR_KEY (full catalogue for your profile)
			…/7Kas?func=help&ukey=YOUR_KEY&name=getcdr (one function)
			See '''[[API help]]'''. This wiki is generated from that same source, so it never drifts.

	ukey~~=XXXXXXXXXXXXXXXXXXXXXXX~~		== Authentication ==
			Every call needs an '''API key''' (parameter <code>ukey</code>, max 40) issued by 7Kas. Clients have their identity parameters (accountcode/accountcodeid) forced server-side to their own values.

	=~~Usuarios~~=		== Response format ==
	~~Funciones que nos ayudan en la gestión de los usuarios del sistema~~. ~~Altas~~, ~~bajas~~, ~~listados~~...		'''Always HTTP 200'''; on any error (bad/missing func or ukey, validation error, unknown function, task-limit exceeded) the body is <code>{}</code>.
			Data functions use <code>FillRecords2JSON</code>:
			<nowiki>{ "RecordCount": N, "fields": [...], "1": [...], "2": [...] }</nowiki>
			Empty result ⇒ <code>{}</code>. SQL NULL ⇒ JSON <code>null</code>.

	~~[[API Recuperar el ID de un usuario]]~~		== Limits ==
	~~Recuperamos el ID interno en la plataforma~~, ~~de un usuario~~. ~~Necesario para poder llamar a otras funciones en general~~.		Up to '''10,000''' rows/request from the SHM cache; '''1,000''' from PostgreSQL. Paginate with <code>limit</code>/<code>offset</code>.

	[[API ~~Recuperar información de un usuario~~]]		== Catalogue by profile ==
	~~Nos permite recuperar información general básica de un usuario.~~		* '''[[API profile SuperRoot]]''' — 40 functions (everything)
			* '''[[API profile Operator]]''' — 33 functions
			* '''[[API profile Client (of operator)]]''' — 20 functions (client of an operator, root>0)
			* '''[[API profile Client (direct)]]''' — 20 functions (direct 7Kas client, root=0)

	[[API ~~Bloquear usuario~~]]		== Try it ==
	~~Podemos impedir que un usuario use los servicios de consumo bloqueandolo~~.		Open the '''[[API Console]]''': paste your <code>ukey</code>, pick a function, fill parameters and run a real (read-only-safe) call from your browser.

	[[API ~~Desbloquear usuario~~]]		[[Category:API]]
	~~Permitimos de nuevo el consumo de servicios tarificados en general.~~

	~~=CDR=~~
	Puedes consultar los datos del detalle de llamadas con una antigüedad de hasta 7 años. Ya sean llamadas entrantes o salientes, dispones de distintas funciones y modelos para recoger la información. Puedes ver el detalle de estas funciones yendo a

	~~[[API CDR Entrantes]]~~
	~~Recopila información sobre las llamadas recibidas en los CLIs de cliente. Tanto las tarificadas de RI como las no tarificadas.~~

	~~[[API CDR Salientes]]~~
	~~Computa el detalle de llamadas salientes tarificadas.~~

	~~[[API CDR General]]~~
	~~Es un CDR común de PBX donde se encuentra todo tipo de llamadas sin filtrar ni tarificar.~~

	~~=CLIs=~~
	~~Puedes consultar los datos de las líneas asignadas.~~

	~~[[API CLIs]]~~
	~~Recopila información sobre las líneas asignadas, tanto activas y asignadas a un cliente final, como inactivas en el stock o de baja de este como consecuencia de una portabilidad inversa.~~

	~~=IVR Tucloud=~~
	~~Puedes consultar los datos de las pulsaciones realizadas en las locuciones de las Tucloud.~~

	~~[[IVR]]~~
	~~Recopila información sobre las pulsaciones realizadas en las locuciones de las Tucloud.~~

	~~= Preguntas Frecuentes FAQ =~~

Soporte at 15:44, 21 July 2026

2026-07-21T15:44:51Z

← Older revision		Revision as of 15:44, 21 July 2026
Line 41:		Line 41:
	[[API CLIs]]		[[API CLIs]]
	Recopila información sobre las líneas asignadas, tanto activas y asignadas a un cliente final, como inactivas en el stock o de baja de este como consecuencia de una portabilidad inversa.		Recopila información sobre las líneas asignadas, tanto activas y asignadas a un cliente final, como inactivas en el stock o de baja de este como consecuencia de una portabilidad inversa.

			=IVR Tucloud=
			Puedes consultar los datos de las pulsaciones realizadas en las locuciones de las Tucloud.

			[[IVR]]
			Recopila información sobre las pulsaciones realizadas en las locuciones de las Tucloud.

	= Preguntas Frecuentes FAQ =		= Preguntas Frecuentes FAQ =

Soporte: /* Líneas */

2024-02-12T16:28:51Z

Líneas

← Older revision		Revision as of 16:28, 12 February 2024
Line 36:		Line 36:
	Es un CDR común de PBX donde se encuentra todo tipo de llamadas sin filtrar ni tarificar.		Es un CDR común de PBX donde se encuentra todo tipo de llamadas sin filtrar ni tarificar.

	=~~Líneas~~=		=CLIs=
	Puedes consultar los datos de las líneas asignadas.		Puedes consultar los datos de las líneas asignadas.

	[[API ~~Líneas~~]]		[[API CLIs]]
	Recopila información sobre las líneas asignadas, tanto activas y asignadas a un cliente final, como inactivas en el stock o de baja de este como consecuencia de una portabilidad inversa.		Recopila información sobre las líneas asignadas, tanto activas y asignadas a un cliente final, como inactivas en el stock o de baja de este como consecuencia de una portabilidad inversa.

	= Preguntas Frecuentes FAQ =		= Preguntas Frecuentes FAQ =

Soporte at 08:09, 9 February 2024

2024-02-09T08:09:37Z

← Older revision		Revision as of 08:09, 9 February 2024
Line 35:		Line 35:
	[[API CDR General]]		[[API CDR General]]
	Es un CDR común de PBX donde se encuentra todo tipo de llamadas sin filtrar ni tarificar.		Es un CDR común de PBX donde se encuentra todo tipo de llamadas sin filtrar ni tarificar.

			=Líneas=
			Puedes consultar los datos de las líneas asignadas.

			[[API Líneas]]
			Recopila información sobre las líneas asignadas, tanto activas y asignadas a un cliente final, como inactivas en el stock o de baja de este como consecuencia de una portabilidad inversa.

	= Preguntas Frecuentes FAQ =		= Preguntas Frecuentes FAQ =

Soporte: /* Usuarios */

2023-05-14T01:38:33Z

Usuarios

← Older revision		Revision as of 01:38, 14 May 2023
Line 13:		Line 13:

	[[API Recuperar el ID de un usuario]]		[[API Recuperar el ID de un usuario]]
	~~Nos permite recuperar~~ el ID interno en la plataforma, de un usuario. Necesario para poder llamar a otras funciones en general.		Recuperamos el ID interno en la plataforma, de un usuario. Necesario para poder llamar a otras funciones en general.

	[[API Recuperar información de un usuario]]		[[API Recuperar información de un usuario]]
	Nos permite recuperar información general básica de un usuario.		Nos permite recuperar información general básica de un usuario.

			[[API Bloquear usuario]]
			Podemos impedir que un usuario use los servicios de consumo bloqueandolo.

			[[API Desbloquear usuario]]
			Permitimos de nuevo el consumo de servicios tarificados en general.

	=CDR=		=CDR=

Soporte: /* Usuarios */

2023-05-14T01:02:08Z

Usuarios

← Older revision		Revision as of 01:02, 14 May 2023
Line 16:		Line 16:

	[[API Recuperar información de un usuario]]		[[API Recuperar información de un usuario]]
	Nos permite recuperar ~~el ID interno en la plataforma,~~ de un usuario~~. Necesario para poder llamar a otras funciones en general~~.		Nos permite recuperar información general básica de un usuario.

	=CDR=		=CDR=

Soporte: /* Usuarios */

2023-05-14T00:53:36Z

Usuarios

← Older revision		Revision as of 00:53, 14 May 2023
Line 12:		Line 12:
	Funciones que nos ayudan en la gestión de los usuarios del sistema. Altas, bajas, listados...		Funciones que nos ayudan en la gestión de los usuarios del sistema. Altas, bajas, listados...

	[[API Recuperar el id de un usuario]]		[[API Recuperar el ID de un usuario]]
	Nos permite recuperar el ID interno en la plataforma, de un usuario. Necesario para poder llamar a otras funciones en general.		Nos permite recuperar el ID interno en la plataforma, de un usuario. Necesario para poder llamar a otras funciones en general.