Skip to content

Commit 48b6dd2

Browse files
gtjosephgtjoseph
committed
Convert Asterisk 16 API documentation from dynamic to static.
Dynamic documenation requires Asterisk to be build but the 16 branch will no longer build due to gcc updates. Since 16 isn't changing any more the documentation has been addded to the repo as static files.
1 parent 30c449d commit 48b6dd2

File tree

847 files changed

+55392
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

847 files changed

+55392
-0
lines changed

‎docs/Asterisk_16_Documentation/API_Documentation/AGI_Commands/answer.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
search:
3+
boost: 0.5
4+
title: ANSWER
5+
---
6+
7+
# ANSWER
8+
9+
### Synopsis
10+
11+
Answer channel
12+
13+
### Description
14+
15+
Answers channel if not already in answer state. Returns '-1' on channel failure, or '0' if successful.<br>
16+
17+
18+
### Syntax
19+
20+
21+
```
22+
23+
ANSWER
24+
```
25+
##### Arguments
26+
27+
### See Also
28+
29+
* [AGI Commands hangup](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/hangup)
30+
* [Dialplan Applications AGI](/Asterisk_16_Documentation/API_Documentation/Dialplan_Applications/AGI)
31+
32+
33+
### Generated Version
34+
35+
This documentation was generated from Asterisk branch 16 using version GIT

‎docs/Asterisk_16_Documentation/API_Documentation/AGI_Commands/asyncagi_break.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
search:
3+
boost: 0.5
4+
title: ASYNCAGI BREAK
5+
---
6+
7+
# ASYNCAGI BREAK
8+
9+
### Synopsis
10+
11+
Interrupts Async AGI
12+
13+
### Description
14+
15+
Interrupts expected flow of Async AGI commands and returns control to previous source (typically, the PBX dialplan).<br>
16+
17+
18+
### Syntax
19+
20+
21+
```
22+
23+
ASYNCAGI BREAK
24+
```
25+
##### Arguments
26+
27+
### See Also
28+
29+
* [AGI Commands hangup](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/hangup)
30+
* [Dialplan Applications AGI](/Asterisk_16_Documentation/API_Documentation/Dialplan_Applications/AGI)
31+
32+
33+
### Generated Version
34+
35+
This documentation was generated from Asterisk branch 16 using version GIT

‎docs/Asterisk_16_Documentation/API_Documentation/AGI_Commands/channel_status.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
search:
3+
boost: 0.5
4+
title: CHANNEL STATUS
5+
---
6+
7+
# CHANNEL STATUS
8+
9+
### Synopsis
10+
11+
Returns status of the connected channel.
12+
13+
### Description
14+
15+
Returns the status of the specified _channelname_. If no channel name is given then returns the status of the current channel.<br>
16+
17+
Return values:<br>
18+
19+
20+
* `0` - Channel is down and available.<br>
21+
22+
* `1` - Channel is down, but reserved.<br>
23+
24+
* `2` - Channel is off hook.<br>
25+
26+
* `3` - Digits (or equivalent) have been dialed.<br>
27+
28+
* `4` - Line is ringing.<br>
29+
30+
* `5` - Remote end is ringing.<br>
31+
32+
* `6` - Line is up.<br>
33+
34+
* `7` - Line is busy.<br>
35+
36+
### Syntax
37+
38+
39+
```
40+
41+
CHANNEL STATUS CHANNELNAME
42+
```
43+
##### Arguments
44+
45+
46+
* `channelname`
47+
48+
### See Also
49+
50+
* [Dialplan Applications AGI](/Asterisk_16_Documentation/API_Documentation/Dialplan_Applications/AGI)
51+
52+
53+
### Generated Version
54+
55+
This documentation was generated from Asterisk branch 16 using version GIT

‎docs/Asterisk_16_Documentation/API_Documentation/AGI_Commands/control_stream_file.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
search:
3+
boost: 0.5
4+
title: CONTROL STREAM FILE
5+
---
6+
7+
# CONTROL STREAM FILE
8+
9+
### Synopsis
10+
11+
Sends audio file on channel and allows the listener to control the stream.
12+
13+
### Description
14+
15+
Send the given file, allowing playback to be controlled by the given digits, if any. Use double quotes for the digits if you wish none to be permitted. If offsetms is provided then the audio will seek to offsetms before play starts. Returns '0' if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed, or '-1' on error or if the channel was disconnected. Returns the position where playback was terminated as endpos.<br>
16+
17+
It sets the following channel variables upon completion:<br>
18+
19+
20+
* `CPLAYBACKSTATUS` - Contains the status of the attempt as a text string<br>
21+
22+
* `SUCCESS`
23+
24+
* `USERSTOPPED`
25+
26+
* `REMOTESTOPPED`
27+
28+
* `ERROR`
29+
30+
* `CPLAYBACKOFFSET` - Contains the offset in ms into the file where playback was at when it stopped. '-1' is end of file.<br>
31+
32+
* `CPLAYBACKSTOPKEY` - If the playback is stopped by the user this variable contains the key that was pressed.<br>
33+
34+
### Syntax
35+
36+
37+
```
38+
39+
CONTROL STREAM FILE FILENAME ESCAPE_DIGITS SKIPMS FFCHAR REWCHR PAUSECHR OFFSETMS
40+
```
41+
##### Arguments
42+
43+
44+
* `filename` - The file extension must not be included in the filename.<br>
45+
46+
* `escape_digits`
47+
48+
* `skipms`
49+
50+
* `ffchar` - Defaults to '#'<br>
51+
52+
* `rewchr` - Defaults to '*'<br>
53+
54+
* `pausechr`
55+
56+
* `offsetms` - Offset, in milliseconds, to start the audio playback<br>
57+
58+
### See Also
59+
60+
* [AGI Commands get_option](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/get_option)
61+
* [AGI Commands control_stream_file](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/control_stream_file)
62+
* [Dialplan Applications AGI](/Asterisk_16_Documentation/API_Documentation/Dialplan_Applications/AGI)
63+
64+
65+
### Generated Version
66+
67+
This documentation was generated from Asterisk branch 16 using version GIT

‎docs/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_del.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
search:
3+
boost: 0.5
4+
title: DATABASE DEL
5+
---
6+
7+
# DATABASE DEL
8+
9+
### Synopsis
10+
11+
Removes database key/value
12+
13+
### Description
14+
15+
Deletes an entry in the Asterisk database for a given _family_ and _key_.<br>
16+
17+
Returns '1' if successful, '0' otherwise.<br>
18+
19+
20+
### Syntax
21+
22+
23+
```
24+
25+
DATABASE DEL FAMILY KEY
26+
```
27+
##### Arguments
28+
29+
30+
* `family`
31+
32+
* `key`
33+
34+
### See Also
35+
36+
* [AGI Commands database_get](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_get)
37+
* [AGI Commands database_put](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_put)
38+
* [AGI Commands database_deltree](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_deltree)
39+
* [Dialplan Applications AGI](/Asterisk_16_Documentation/API_Documentation/Dialplan_Applications/AGI)
40+
41+
42+
### Generated Version
43+
44+
This documentation was generated from Asterisk branch 16 using version GIT

‎docs/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_deltree.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
search:
3+
boost: 0.5
4+
title: DATABASE DELTREE
5+
---
6+
7+
# DATABASE DELTREE
8+
9+
### Synopsis
10+
11+
Removes database keytree/value
12+
13+
### Description
14+
15+
Deletes a _family_ or specific _keytree_ within a _family_ in the Asterisk database.<br>
16+
17+
Returns '1' if successful, '0' otherwise.<br>
18+
19+
20+
### Syntax
21+
22+
23+
```
24+
25+
DATABASE DELTREE FAMILY KEYTREE
26+
```
27+
##### Arguments
28+
29+
30+
* `family`
31+
32+
* `keytree`
33+
34+
### See Also
35+
36+
* [AGI Commands database_get](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_get)
37+
* [AGI Commands database_put](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_put)
38+
* [AGI Commands database_del](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_del)
39+
* [Dialplan Applications AGI](/Asterisk_16_Documentation/API_Documentation/Dialplan_Applications/AGI)
40+
41+
42+
### Generated Version
43+
44+
This documentation was generated from Asterisk branch 16 using version GIT

‎docs/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_get.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
search:
3+
boost: 0.5
4+
title: DATABASE GET
5+
---
6+
7+
# DATABASE GET
8+
9+
### Synopsis
10+
11+
Gets database value
12+
13+
### Description
14+
15+
Retrieves an entry in the Asterisk database for a given _family_ and _key_.<br>
16+
17+
Returns '0' if _key_ is not set. Returns '1' if _key_ is set and returns the variable in parenthesis.<br>
18+
19+
Example return code: 200 result=1 (testvariable)<br>
20+
21+
22+
### Syntax
23+
24+
25+
```
26+
27+
DATABASE GET FAMILY KEY
28+
```
29+
##### Arguments
30+
31+
32+
* `family`
33+
34+
* `key`
35+
36+
### See Also
37+
38+
* [AGI Commands database_put](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_put)
39+
* [AGI Commands database_del](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_del)
40+
* [AGI Commands database_deltree](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_deltree)
41+
* [Dialplan Applications AGI](/Asterisk_16_Documentation/API_Documentation/Dialplan_Applications/AGI)
42+
43+
44+
### Generated Version
45+
46+
This documentation was generated from Asterisk branch 16 using version GIT

‎docs/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_put.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
search:
3+
boost: 0.5
4+
title: DATABASE PUT
5+
---
6+
7+
# DATABASE PUT
8+
9+
### Synopsis
10+
11+
Adds/updates database value
12+
13+
### Description
14+
15+
Adds or updates an entry in the Asterisk database for a given _family_, _key_, and _value_.<br>
16+
17+
Returns '1' if successful, '0' otherwise.<br>
18+
19+
20+
### Syntax
21+
22+
23+
```
24+
25+
DATABASE PUT FAMILY KEY VALUE
26+
```
27+
##### Arguments
28+
29+
30+
* `family`
31+
32+
* `key`
33+
34+
* `value`
35+
36+
### See Also
37+
38+
* [AGI Commands database_get](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_get)
39+
* [AGI Commands database_del](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_del)
40+
* [AGI Commands database_deltree](/Asterisk_16_Documentation/API_Documentation/AGI_Commands/database_deltree)
41+
* [Dialplan Applications AGI](/Asterisk_16_Documentation/API_Documentation/Dialplan_Applications/AGI)
42+
43+
44+
### Generated Version
45+
46+
This documentation was generated from Asterisk branch 16 using version GIT

0 commit comments

Comments
 (0)