Skip to content

Commit d04cd5f

Browse files
grahambrown11github-actions[bot]
grahambrown11
authored and
github-actions[bot]
committed
ARI API Updates
1 parent c9ad8f9 commit d04cd5f

File tree

17 files changed

+6485
-6
lines changed

17 files changed

+6485
-6
lines changed

‎codegen/src/main/resources/codegen-data/ari_6_0_1/bridges.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"parameters": [
3131
{
3232
"name": "type",
33-
"description": "Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu, video_single).",
33+
"description": "Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu, video_single, sdp_label).",
3434
"paramType": "query",
3535
"required": false,
3636
"allowMultiple": false,
@@ -69,7 +69,7 @@
6969
"parameters": [
7070
{
7171
"name": "type",
72-
"description": "Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu, video_single) to set.",
72+
"description": "Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu, video_single, sdp_label) to set.",
7373
"paramType": "query",
7474
"required": false,
7575
"allowMultiple": false,

‎codegen/src/main/resources/codegen-data/ari_6_0_1/channels.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@
416416
},
417417
{
418418
"name": "reason_code",
419-
"description": "The reason code for hanging up the channel for detail use. Mutually exclusive with 'reason'. See detail hangup codes at here. https://wiki.asterisk.org/wiki/display/AST/Hangup+Cause+Mappings",
419+
"description": "The reason code for hanging up the channel for detail use. Mutually exclusive with 'reason'. See detail hangup codes at here. https://docs.asterisk.org/Configuration/Miscellaneous/Hangup-Cause-Mappings/",
420420
"paramType": "query",
421421
"required": false,
422422
"allowMultiple": false,
@@ -2187,6 +2187,10 @@
21872187
"required": false,
21882188
"type": "object",
21892189
"description": "Channel variables"
2190+
},
2191+
"caller_rdnis": {
2192+
"type": "string",
2193+
"description": "The Caller ID RDNIS"
21902194
}
21912195
}
21922196
}

‎codegen/src/main/resources/codegen-data/ari_6_0_1/endpoints.json‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,71 @@
7575
}
7676
]
7777
},
78+
{
79+
"path": "/endpoints/refer",
80+
"description": "Refer an endpoint or technology URI to some technology URI or endpoint.",
81+
"operations": [
82+
{
83+
"httpMethod": "POST",
84+
"summary": "Refer an endpoint or technology URI to some technology URI or endpoint.",
85+
"nickname": "refer",
86+
"responseClass": "void",
87+
"parameters": [
88+
{
89+
"name": "to",
90+
"description": "The endpoint resource or technology specific URI that should be referred to somewhere. Valid resource is pjsip.",
91+
"paramType": "query",
92+
"required": true,
93+
"allowMultiple": false,
94+
"dataType": "string"
95+
},
96+
{
97+
"name": "from",
98+
"description": "The endpoint resource or technology specific identity to refer from.",
99+
"paramType": "query",
100+
"required": true,
101+
"allowMultiple": false,
102+
"dataType": "string"
103+
},
104+
{
105+
"name": "refer_to",
106+
"description": "The endpoint resource or technology specific URI to refer to.",
107+
"paramType": "query",
108+
"required": true,
109+
"allowMultiple": false,
110+
"dataType": "string"
111+
},
112+
{
113+
"name": "to_self",
114+
"description": "If true and \"refer_to\" refers to an Asterisk endpoint, the \"refer_to\" value is set to point to this Asterisk endpoint - so the referee is referred to Asterisk. Otherwise, use the contact URI associated with the endpoint.",
115+
"paramType": "query",
116+
"required": false,
117+
"allowMultiple": false,
118+
"dataType": "boolean",
119+
"defaultValue": false
120+
},
121+
{
122+
"name": "variables",
123+
"description": "The \"variables\" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various resource types; for example, the pjsip resource type will add the key/value pairs as SIP headers. The \"display_name\" key is used by the PJSIP technology. Its value will be prepended as a display name to the Refer-To URI.",
124+
"paramType": "body",
125+
"required": false,
126+
"dataType": "containers",
127+
"allowMultiple": false
128+
}
129+
],
130+
"errorResponses": [
131+
{
132+
"code": 400,
133+
"reason": "Invalid parameters for referring."
134+
},
135+
{
136+
"code": 404,
137+
"reason": "Endpoint not found"
138+
}
139+
]
140+
}
141+
]
142+
},
78143
{
79144
"path": "/endpoints/{tech}",
80145
"description": "Asterisk endpoints",
@@ -196,6 +261,75 @@
196261
]
197262
}
198263
]
264+
},
265+
{
266+
"path": "/endpoints/{tech}/{resource}/refer",
267+
"description": "Refer an endpoint in a technology to some technology URI or endpoint..",
268+
"operations": [
269+
{
270+
"httpMethod": "POST",
271+
"summary": "Refer an endpoint or technology URI to some technology URI or endpoint.",
272+
"nickname": "referToEndpoint",
273+
"responseClass": "void",
274+
"parameters": [
275+
{
276+
"name": "tech",
277+
"description": "Technology of the endpoint",
278+
"paramType": "path",
279+
"dataType": "string"
280+
},
281+
{
282+
"name": "resource",
283+
"description": "ID of the endpoint",
284+
"paramType": "path",
285+
"dataType": "string"
286+
},
287+
{
288+
"name": "from",
289+
"description": "The endpoint resource or technology specific identity to refer from.",
290+
"paramType": "query",
291+
"required": true,
292+
"allowMultiple": false,
293+
"dataType": "string"
294+
},
295+
{
296+
"name": "refer_to",
297+
"description": "The endpoint resource or technology specific URI to refer to.",
298+
"paramType": "query",
299+
"required": true,
300+
"allowMultiple": false,
301+
"dataType": "string"
302+
},
303+
{
304+
"name": "to_self",
305+
"description": "If true and \"refer_to\" refers to an Asterisk endpoint, the \"refer_to\" value is set to point to this Asterisk endpoint - so the referee is referred to Asterisk. Otherwise, use the contact URI associated with the endpoint.",
306+
"paramType": "query",
307+
"required": false,
308+
"allowMultiple": false,
309+
"dataType": "boolean",
310+
"defaultValue": false
311+
},
312+
{
313+
"name": "variables",
314+
"description": "The \"variables\" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various resource types; for example, the pjsip resource type will add the key/value pairs as SIP headers,",
315+
"paramType": "body",
316+
"required": false,
317+
"dataType": "containers",
318+
"allowMultiple": false
319+
}
320+
],
321+
"errorResponses": [
322+
{
323+
"code": 400,
324+
"reason": "Invalid parameters for referring."
325+
},
326+
{
327+
"code": 404,
328+
"reason": "Endpoint not found"
329+
}
330+
]
331+
}
332+
]
199333
}
200334
],
201335
"models": {

‎codegen/src/main/resources/codegen-data/ari_8_0_0/bridges.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"parameters": [
3131
{
3232
"name": "type",
33-
"description": "Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu, video_single).",
33+
"description": "Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu, video_single, sdp_label).",
3434
"paramType": "query",
3535
"required": false,
3636
"allowMultiple": false,
@@ -69,7 +69,7 @@
6969
"parameters": [
7070
{
7171
"name": "type",
72-
"description": "Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu, video_single) to set.",
72+
"description": "Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu, video_single, sdp_label) to set.",
7373
"paramType": "query",
7474
"required": false,
7575
"allowMultiple": false,

‎codegen/src/main/resources/codegen-data/ari_8_0_0/channels.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@
416416
},
417417
{
418418
"name": "reason_code",
419-
"description": "The reason code for hanging up the channel for detail use. Mutually exclusive with 'reason'. See detail hangup codes at here. https://wiki.asterisk.org/wiki/display/AST/Hangup+Cause+Mappings",
419+
"description": "The reason code for hanging up the channel for detail use. Mutually exclusive with 'reason'. See detail hangup codes at here. https://docs.asterisk.org/Configuration/Miscellaneous/Hangup-Cause-Mappings/",
420420
"paramType": "query",
421421
"required": false,
422422
"allowMultiple": false,
@@ -2187,6 +2187,10 @@
21872187
"required": false,
21882188
"type": "object",
21892189
"description": "Channel variables"
2190+
},
2191+
"caller_rdnis": {
2192+
"type": "string",
2193+
"description": "The Caller ID RDNIS"
21902194
}
21912195
}
21922196
}

‎codegen/src/main/resources/codegen-data/ari_8_0_0/endpoints.json‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,71 @@
7575
}
7676
]
7777
},
78+
{
79+
"path": "/endpoints/refer",
80+
"description": "Refer an endpoint or technology URI to some technology URI or endpoint.",
81+
"operations": [
82+
{
83+
"httpMethod": "POST",
84+
"summary": "Refer an endpoint or technology URI to some technology URI or endpoint.",
85+
"nickname": "refer",
86+
"responseClass": "void",
87+
"parameters": [
88+
{
89+
"name": "to",
90+
"description": "The endpoint resource or technology specific URI that should be referred to somewhere. Valid resource is pjsip.",
91+
"paramType": "query",
92+
"required": true,
93+
"allowMultiple": false,
94+
"dataType": "string"
95+
},
96+
{
97+
"name": "from",
98+
"description": "The endpoint resource or technology specific identity to refer from.",
99+
"paramType": "query",
100+
"required": true,
101+
"allowMultiple": false,
102+
"dataType": "string"
103+
},
104+
{
105+
"name": "refer_to",
106+
"description": "The endpoint resource or technology specific URI to refer to.",
107+
"paramType": "query",
108+
"required": true,
109+
"allowMultiple": false,
110+
"dataType": "string"
111+
},
112+
{
113+
"name": "to_self",
114+
"description": "If true and \"refer_to\" refers to an Asterisk endpoint, the \"refer_to\" value is set to point to this Asterisk endpoint - so the referee is referred to Asterisk. Otherwise, use the contact URI associated with the endpoint.",
115+
"paramType": "query",
116+
"required": false,
117+
"allowMultiple": false,
118+
"dataType": "boolean",
119+
"defaultValue": false
120+
},
121+
{
122+
"name": "variables",
123+
"description": "The \"variables\" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various resource types; for example, the pjsip resource type will add the key/value pairs as SIP headers. The \"display_name\" key is used by the PJSIP technology. Its value will be prepended as a display name to the Refer-To URI.",
124+
"paramType": "body",
125+
"required": false,
126+
"dataType": "containers",
127+
"allowMultiple": false
128+
}
129+
],
130+
"errorResponses": [
131+
{
132+
"code": 400,
133+
"reason": "Invalid parameters for referring."
134+
},
135+
{
136+
"code": 404,
137+
"reason": "Endpoint not found"
138+
}
139+
]
140+
}
141+
]
142+
},
78143
{
79144
"path": "/endpoints/{tech}",
80145
"description": "Asterisk endpoints",
@@ -196,6 +261,75 @@
196261
]
197262
}
198263
]
264+
},
265+
{
266+
"path": "/endpoints/{tech}/{resource}/refer",
267+
"description": "Refer an endpoint in a technology to some technology URI or endpoint..",
268+
"operations": [
269+
{
270+
"httpMethod": "POST",
271+
"summary": "Refer an endpoint or technology URI to some technology URI or endpoint.",
272+
"nickname": "referToEndpoint",
273+
"responseClass": "void",
274+
"parameters": [
275+
{
276+
"name": "tech",
277+
"description": "Technology of the endpoint",
278+
"paramType": "path",
279+
"dataType": "string"
280+
},
281+
{
282+
"name": "resource",
283+
"description": "ID of the endpoint",
284+
"paramType": "path",
285+
"dataType": "string"
286+
},
287+
{
288+
"name": "from",
289+
"description": "The endpoint resource or technology specific identity to refer from.",
290+
"paramType": "query",
291+
"required": true,
292+
"allowMultiple": false,
293+
"dataType": "string"
294+
},
295+
{
296+
"name": "refer_to",
297+
"description": "The endpoint resource or technology specific URI to refer to.",
298+
"paramType": "query",
299+
"required": true,
300+
"allowMultiple": false,
301+
"dataType": "string"
302+
},
303+
{
304+
"name": "to_self",
305+
"description": "If true and \"refer_to\" refers to an Asterisk endpoint, the \"refer_to\" value is set to point to this Asterisk endpoint - so the referee is referred to Asterisk. Otherwise, use the contact URI associated with the endpoint.",
306+
"paramType": "query",
307+
"required": false,
308+
"allowMultiple": false,
309+
"dataType": "boolean",
310+
"defaultValue": false
311+
},
312+
{
313+
"name": "variables",
314+
"description": "The \"variables\" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various resource types; for example, the pjsip resource type will add the key/value pairs as SIP headers,",
315+
"paramType": "body",
316+
"required": false,
317+
"dataType": "containers",
318+
"allowMultiple": false
319+
}
320+
],
321+
"errorResponses": [
322+
{
323+
"code": 400,
324+
"reason": "Invalid parameters for referring."
325+
},
326+
{
327+
"code": 404,
328+
"reason": "Endpoint not found"
329+
}
330+
]
331+
}
332+
]
199333
}
200334
],
201335
"models": {

0 commit comments

Comments
 (0)