API help: Difference between revisions
API docs (generated from func=help) |
API docs regenerated from func=help (operator catalogue) |
||
| Line 1: | Line 1: | ||
{{Note|This is the '''self-discovery''' endpoint. It returns the list of functions your <code>ukey</code> can call, each fully documented. This whole wiki is generated from it.}} | {{Note|This is the '''self-discovery''' endpoint. It returns the list of functions your <code>ukey</code> can call, each fully documented. This whole wiki is generated from it.}} | ||
''7Kas VoIP REST API function. Available to: ''' | ''7Kas VoIP REST API function. Available to: '''Operator, Client'''.'' | ||
== Description == | == Description == | ||
| Line 23: | Line 23: | ||
---- | ---- | ||
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: | Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]], [[API profile Client (of operator)]], [[API profile Client (direct)]] | ||
[[Category:API Operator]][[Category:API Client]][[Category:API function]] | |||
Latest revision as of 13:47, 5 November 2026
ℹ This is the self-discovery endpoint. It returns the list of functions your
ukey can call, each fully documented. This whole wiki is generated from it.7Kas VoIP REST API function. Available to: Operator, Client.
Description
Lists the API functions available to the role of the calling ukey, with each function's description, parameters (meaning, optional/default), an example call and the response format. Optional name=<func> returns just that function.
Call
GET …/7Kas?func=help&ukey=YOUR_KEY&…
Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
name |
string | No | — | Return only this function's documentation. Omit for the full catalogue. |
Example
https://api.7kas.com:9080/7Kas?func=help&ukey=KEY
Response
Object: {api, url, authentication, response_format, role, count, functions:[{name, category, description, parameters:[{name,type,required,default,description,notes}], example, response}]}.
Back to API VoIP · ▶ Try it live · Profiles: API profile Operator, API profile Client (of operator), API profile Client (direct)