4 "url": "/api/actions/{id}",
5 "title": "Deletes a Action",
8 "title": "Example usage:",
9 "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
13 "name": "DeleteActions",
15 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17 "filename": "server/api/action/index.js",
18 "groupTitle": "Actions"
22 "url": "/api/actions/{id}",
23 "title": "Update an existing Action",
26 "title": "Example usage:",
27 "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31 "name": "updateActions",
33 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35 "filename": "server/api/action/index.js",
36 "groupTitle": "Actions"
40 "url": "/api/analytics/custom_reports",
41 "title": "Creates a new Analytic Custom Report",
44 "title": "Example usage:",
45 "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
49 "name": "CreateAnalytic_Custom_Reports",
50 "group": "Analytic_Custom_Reports",
65 "field": "description",
86 "field": "conditions",
99 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
101 "filename": "server/api/analyticCustomReport/index.js",
102 "groupTitle": "Analytic_Custom_Reports"
106 "url": "/api/analytics/custom_reports/{id}",
107 "title": "Deletes a Analytic Custom Report",
110 "title": "Example usage:",
111 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
115 "name": "DeleteAnalytic_Custom_Reports",
116 "group": "Analytic_Custom_Reports",
117 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
119 "filename": "server/api/analyticCustomReport/index.js",
120 "groupTitle": "Analytic_Custom_Reports"
124 "url": "/api/analytics/custom_reports",
125 "title": "Gets a list of Analytic Custom Reports",
128 "title": "Example usage:",
129 "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
133 "name": "GetAnalytic_Custom_Reports",
134 "group": "Analytic_Custom_Reports",
135 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
137 "filename": "server/api/analyticCustomReport/index.js",
138 "groupTitle": "Analytic_Custom_Reports"
142 "url": "/api/analytics/custom_reports/{id}",
143 "title": "Gets a single Analytic Custom Report",
146 "title": "Example usage:",
147 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
151 "name": "ShowAnalytic_Custom_Reports",
152 "group": "Analytic_Custom_Reports",
153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
155 "filename": "server/api/analyticCustomReport/index.js",
156 "groupTitle": "Analytic_Custom_Reports"
160 "url": "/api/analytics/custom_reports/{id}/preview",
161 "title": "Report Preview",
164 "title": "Example usage:",
165 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
170 "group": "Analytic_Custom_Reports",
171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
173 "filename": "server/api/analyticCustomReport/index.js",
174 "groupTitle": "Analytic_Custom_Reports"
178 "url": "/api/analytics/custom_reports/{id}/query",
179 "title": "Report Query SQL",
182 "title": "Example usage:",
183 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
188 "group": "Analytic_Custom_Reports",
189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
191 "filename": "server/api/analyticCustomReport/index.js",
192 "groupTitle": "Analytic_Custom_Reports"
196 "url": "/api/analytics/custom_reports/{id}/run",
197 "title": "Report Run",
200 "title": "Example usage:",
201 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
206 "group": "Analytic_Custom_Reports",
207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
209 "filename": "server/api/analyticCustomReport/index.js",
210 "groupTitle": "Analytic_Custom_Reports"
214 "url": "/api/analytics/custom_reports/{id}",
215 "title": "Update an existing Analytic Custom Report",
218 "title": "Example usage:",
219 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
223 "name": "updateAnalytic_Custom_Reports",
224 "group": "Analytic_Custom_Reports",
225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
227 "filename": "server/api/analyticCustomReport/index.js",
228 "groupTitle": "Analytic_Custom_Reports"
232 "url": "/api/analytics/default_reports",
233 "title": "Creates a new Analytic Default Report",
236 "title": "Example usage:",
237 "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
241 "name": "CreateAnalytic_Default_Reports",
242 "group": "Analytic_Default_Reports",
257 "field": "description",
278 "field": "conditions",
291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
293 "filename": "server/api/analyticDefaultReport/index.js",
294 "groupTitle": "Analytic_Default_Reports"
298 "url": "/api/analytics/default_reports/{id}",
299 "title": "Deletes a Analytic Default Report",
302 "title": "Example usage:",
303 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
307 "name": "DeleteAnalytic_Default_Reports",
308 "group": "Analytic_Default_Reports",
309 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
311 "filename": "server/api/analyticDefaultReport/index.js",
312 "groupTitle": "Analytic_Default_Reports"
316 "url": "/api/analytics/default_reports",
317 "title": "Gets a list of Analytic Default Reports",
320 "title": "Example usage:",
321 "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
325 "name": "GetAnalytic_Default_Reports",
326 "group": "Analytic_Default_Reports",
327 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
329 "filename": "server/api/analyticDefaultReport/index.js",
330 "groupTitle": "Analytic_Default_Reports"
334 "url": "/api/analytics/default_reports/{id}",
335 "title": "Gets a single Analytic Default Report",
338 "title": "Example usage:",
339 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
343 "name": "ShowAnalytic_Default_Reports",
344 "group": "Analytic_Default_Reports",
345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
347 "filename": "server/api/analyticDefaultReport/index.js",
348 "groupTitle": "Analytic_Default_Reports"
352 "url": "/api/analytics/default_reports/{id}/preview",
353 "title": "Report Preview",
356 "title": "Example usage:",
357 "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
362 "group": "Analytic_Default_Reports",
363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
365 "filename": "server/api/analyticDefaultReport/index.js",
366 "groupTitle": "Analytic_Default_Reports"
370 "url": "/api/analytics/default_reports/{id}/query",
371 "title": "Report Query SQL",
374 "title": "Example usage:",
375 "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
380 "group": "Analytic_Default_Reports",
381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
383 "filename": "server/api/analyticDefaultReport/index.js",
384 "groupTitle": "Analytic_Default_Reports"
388 "url": "/api/analytics/default_reports/{id}/run",
389 "title": "Report Run",
392 "title": "Example usage:",
393 "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
398 "group": "Analytic_Default_Reports",
399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
401 "filename": "server/api/analyticDefaultReport/index.js",
402 "groupTitle": "Analytic_Default_Reports"
406 "url": "/api/analytics/default_reports/{id}",
407 "title": "Update an existing Analytic Default Report",
410 "title": "Example usage:",
411 "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
415 "name": "updateAnalytic_Default_Reports",
416 "group": "Analytic_Default_Reports",
417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
419 "filename": "server/api/analyticDefaultReport/index.js",
420 "groupTitle": "Analytic_Default_Reports"
424 "url": "/api/analytics/extracted_reports",
425 "title": "Creates a new Analytic Extracted Report",
428 "title": "Example usage:",
429 "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
433 "name": "CreateAnalytic_Extacted_Reports",
434 "group": "Analytic_Extracted_Reports",
475 "field": "startDate",
514 "field": "reportType",
520 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
522 "filename": "server/api/analyticExtractedReport/index.js",
523 "groupTitle": "Analytic_Extracted_Reports"
527 "url": "/api/analytics/extracted_reports/{id}",
528 "title": "Deletes a Analytic Extracted Report",
531 "title": "Example usage:",
532 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
536 "name": "DeleteAnalytic_Extacted_Reports",
537 "group": "Analytic_Extracted_Reports",
538 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
540 "filename": "server/api/analyticExtractedReport/index.js",
541 "groupTitle": "Analytic_Extracted_Reports"
545 "url": "/api/analytics/extracted_reports",
546 "title": "Gets a list of Analytic Extacted Reports",
549 "title": "Example usage:",
550 "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
554 "name": "GetAnalytic_Extacted_Reports",
555 "group": "Analytic_Extracted_Reports",
556 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
558 "filename": "server/api/analyticExtractedReport/index.js",
559 "groupTitle": "Analytic_Extracted_Reports"
563 "url": "/api/analytics/extracted_reports/{id}",
564 "title": "Gets a single Analytic Extracted Report",
567 "title": "Example usage:",
568 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
572 "name": "ShowAnalytic_Extacted_Reports",
573 "group": "Analytic_Extracted_Reports",
574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
576 "filename": "server/api/analyticExtractedReport/index.js",
577 "groupTitle": "Analytic_Extracted_Reports"
581 "url": "/api/analytics/extracted_reports/{id}/download",
582 "title": "Download Extracted Report",
585 "title": "Example usage:",
586 "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
591 "group": "Analytic_Extracted_Reports",
592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
594 "filename": "server/api/analyticExtractedReport/index.js",
595 "groupTitle": "Analytic_Extracted_Reports"
599 "url": "/api/analytics/extracted_reports/{id}",
600 "title": "Update an existing Analytic Extracted Report",
603 "title": "Example usage:",
604 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
608 "name": "updateAnalytic_Extacted_Reports",
609 "group": "Analytic_Extracted_Reports",
610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
612 "filename": "server/api/analyticExtractedReport/index.js",
613 "groupTitle": "Analytic_Extracted_Reports"
617 "url": "/api/analytics/field_reports/create_many",
618 "title": "Creates many Analytic Field Reports",
621 "title": "Example usage:",
622 "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
626 "name": "BulkCreateAnalytic_Field_Reports",
627 "group": "Analytic_Field_Reports",
683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
685 "filename": "server/api/analyticFieldReport/index.js",
686 "groupTitle": "Analytic_Field_Reports"
690 "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
691 "title": "Deletes many Analytic Field Reports",
694 "title": "Example usage:",
695 "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
699 "name": "BulkDeleteAnalytic_Field_Reports",
700 "group": "Analytic_Field_Reports",
701 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
703 "filename": "server/api/analyticFieldReport/index.js",
704 "groupTitle": "Analytic_Field_Reports"
708 "url": "/api/analytics/field_reports",
709 "title": "Creates a new Analytic Field Report",
712 "title": "Example usage:",
713 "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
717 "name": "CreateAnalytic_Field_Reports",
718 "group": "Analytic_Field_Reports",
774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
776 "filename": "server/api/analyticFieldReport/index.js",
777 "groupTitle": "Analytic_Field_Reports"
781 "url": "/api/analytics/field_reports/{id}",
782 "title": "Deletes a Analytic Field Report",
785 "title": "Example usage:",
786 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
790 "name": "DeleteAnalytic_Field_Reports",
791 "group": "Analytic_Field_Reports",
792 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
794 "filename": "server/api/analyticFieldReport/index.js",
795 "groupTitle": "Analytic_Field_Reports"
799 "url": "/api/analytics/field_reports",
800 "title": "Gets a list of Analytic Field Reports",
803 "title": "Example usage:",
804 "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
808 "name": "GetAnalytic_Field_Reports",
809 "group": "Analytic_Field_Reports",
810 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
812 "filename": "server/api/analyticFieldReport/index.js",
813 "groupTitle": "Analytic_Field_Reports"
817 "url": "/api/analytics/field_reports/{id}",
818 "title": "Gets a single Analytic Field Report",
821 "title": "Example usage:",
822 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
826 "name": "ShowAnalytic_Field_Reports",
827 "group": "Analytic_Field_Reports",
828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
830 "filename": "server/api/analyticFieldReport/index.js",
831 "groupTitle": "Analytic_Field_Reports"
835 "url": "/api/analytics/field_reports/{id}/create_many",
836 "title": "Rewrite fields set",
839 "title": "Example usage:",
840 "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
845 "group": "Analytic_Field_Reports",
846 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
848 "filename": "server/api/analyticFieldReport/index.js",
849 "groupTitle": "Analytic_Field_Reports"
853 "url": "/api/analytics/field_reports/{id}",
854 "title": "Update an existing Analytic Field Report",
857 "title": "Example usage:",
858 "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
862 "name": "updateAnalytic_Field_Reports",
863 "group": "Analytic_Field_Reports",
864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
866 "filename": "server/api/analyticFieldReport/index.js",
867 "groupTitle": "Analytic_Field_Reports"
871 "url": "/api/analytics/metrics",
872 "title": "Creates a new Analytic Metrics",
875 "title": "Example usage:",
876 "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
880 "name": "CreateAnalytic_Metric",
881 "group": "Analytic_Metrics",
910 "field": "description",
916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
918 "filename": "server/api/analyticMetric/index.js",
919 "groupTitle": "Analytic_Metrics"
923 "url": "/api/analytics/metrics/{id}",
924 "title": "Deletes a Analytic Metrics",
927 "title": "Example usage:",
928 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
932 "name": "DeleteAnalytic_Metric",
933 "group": "Analytic_Metrics",
934 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
936 "filename": "server/api/analyticMetric/index.js",
937 "groupTitle": "Analytic_Metrics"
941 "url": "/api/analytics/metrics",
942 "title": "Gets a list of Analytic Metric",
945 "title": "Example usage:",
946 "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
950 "name": "GetAnalytic_Metric",
951 "group": "Analytic_Metrics",
952 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
954 "filename": "server/api/analyticMetric/index.js",
955 "groupTitle": "Analytic_Metrics"
959 "url": "/api/analytics/metrics/{id}",
960 "title": "Gets a single Analytic Metrics",
963 "title": "Example usage:",
964 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
968 "name": "ShowAnalytic_Metric",
969 "group": "Analytic_Metrics",
970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
972 "filename": "server/api/analyticMetric/index.js",
973 "groupTitle": "Analytic_Metrics"
977 "url": "/api/analytics/metrics/{id}",
978 "title": "Update an existing Analytic Metrics",
981 "title": "Example usage:",
982 "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
986 "name": "updateAnalytic_Metric",
987 "group": "Analytic_Metrics",
988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
990 "filename": "server/api/analyticMetric/index.js",
991 "groupTitle": "Analytic_Metrics"
995 "url": "/api/analytics/tree_reports",
996 "title": "Creates a new Analytic Tree Report",
999 "title": "Example usage:",
1000 "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1004 "name": "CreateAnalytic_Tree_Reports",
1005 "group": "Analytic_Tree_Reports",
1019 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1021 "filename": "server/api/analyticTreeReport/index.js",
1022 "groupTitle": "Analytic_Tree_Reports"
1026 "url": "/api/analytics/tree_reports/{id}",
1027 "title": "Deletes a Analytic Tree Report",
1030 "title": "Example usage:",
1031 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1035 "name": "DeleteAnalytic_Tree_Reports",
1036 "group": "Analytic_Tree_Reports",
1037 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1039 "filename": "server/api/analyticTreeReport/index.js",
1040 "groupTitle": "Analytic_Tree_Reports"
1044 "url": "/api/analytics/tree_reports",
1045 "title": "Gets a list of Analytic Tree Reports",
1048 "title": "Example usage:",
1049 "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1053 "name": "GetAnalytic_Tree_Reports",
1054 "group": "Analytic_Tree_Reports",
1055 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1057 "filename": "server/api/analyticTreeReport/index.js",
1058 "groupTitle": "Analytic_Tree_Reports"
1062 "url": "/api/analytics/tree_reports/{id}",
1063 "title": "Gets a single Analytic Tree Report",
1066 "title": "Example usage:",
1067 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1071 "name": "ShowAnalytic_Tree_Reports",
1072 "group": "Analytic_Tree_Reports",
1073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1075 "filename": "server/api/analyticTreeReport/index.js",
1076 "groupTitle": "Analytic_Tree_Reports"
1080 "url": "/api/analytics/tree_reports/{id}",
1081 "title": "Update an existing Analytic Tree Report",
1084 "title": "Example usage:",
1085 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1089 "name": "updateAnalytic_Tree_Reports",
1090 "group": "Analytic_Tree_Reports",
1091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1093 "filename": "server/api/analyticTreeReport/index.js",
1094 "groupTitle": "Analytic_Tree_Reports"
1098 "url": "/api/attachments/clone",
1099 "title": "Clone an existing Attachment",
1102 "title": "Example usage:",
1103 "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1107 "name": "CloneAttachments",
1108 "group": "Attachments",
1109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1111 "filename": "server/api/attachment/index.js",
1112 "groupTitle": "Attachments"
1116 "url": "/api/attachments/{id}",
1117 "title": "Deletes a Attachment",
1120 "title": "Example usage:",
1121 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1125 "name": "DeleteAttachments",
1126 "group": "Attachments",
1127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1129 "filename": "server/api/attachment/index.js",
1130 "groupTitle": "Attachments"
1134 "url": "/api/attachments",
1135 "title": "Gets a list of Attachments",
1138 "title": "Example usage:",
1139 "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1143 "name": "GetAttachments",
1144 "group": "Attachments",
1145 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1147 "filename": "server/api/attachment/index.js",
1148 "groupTitle": "Attachments"
1152 "url": "/api/attachments/{id}",
1153 "title": "Gets a single Attachment",
1156 "title": "Example usage:",
1157 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1161 "name": "ShowAttachments",
1162 "group": "Attachments",
1163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1165 "filename": "server/api/attachment/index.js",
1166 "groupTitle": "Attachments"
1170 "url": "/api/attachments",
1171 "title": "Add attachment",
1174 "title": "Example usage:",
1175 "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1180 "group": "Attachments",
1181 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1183 "filename": "server/api/attachment/index.js",
1184 "groupTitle": "Attachments"
1188 "url": "/api/attachments/:id/download",
1189 "title": "Download attachment",
1192 "title": "Example usage:",
1193 "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1198 "group": "Attachments",
1199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1201 "filename": "server/api/attachment/index.js",
1202 "groupTitle": "Attachments"
1206 "url": "/api/chat/interactions/{id}/attachment_download",
1207 "title": "Download attachment",
1210 "title": "Example usage:",
1211 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1216 "group": "Attachments",
1217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1219 "filename": "server/api/chatInteraction/index.js",
1220 "groupTitle": "Attachments"
1224 "url": "/api/attachments/{id}",
1225 "title": "Update an existing Attachment",
1228 "title": "Example usage:",
1229 "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1233 "name": "updateAttachments",
1234 "group": "Attachments",
1235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1237 "filename": "server/api/attachment/index.js",
1238 "groupTitle": "Attachments"
1242 "url": "/api/auth/local/forgot",
1243 "title": "Creates a new password reset token",
1246 "title": "Example usage:",
1247 "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1251 "name": "Local_Forgot_Password",
1252 "group": "Authentication",
1266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1268 "filename": "server/api/authLocal/index.js",
1269 "groupTitle": "Authentication"
1273 "url": "/api/auth/local/reset/:token",
1274 "title": "Reset user password",
1277 "title": "Example usage:",
1278 "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1282 "name": "Local_Reset_Password",
1283 "group": "Authentication",
1291 "field": "password",
1297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1299 "filename": "server/api/authLocal/index.js",
1300 "groupTitle": "Authentication"
1304 "url": "/api/auth/google",
1305 "title": "Creates a new User token",
1308 "title": "Example usage:",
1309 "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1313 "name": "Local_login",
1314 "group": "Authentication",
1329 "field": "password",
1335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1337 "filename": "server/api/authGoogle/index.js",
1338 "groupTitle": "Authentication"
1342 "url": "/api/auth/local",
1343 "title": "Creates a new User token",
1346 "title": "Example usage:",
1347 "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1351 "name": "Local_login",
1352 "group": "Authentication",
1367 "field": "password",
1373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1375 "filename": "server/api/authLocal/index.js",
1376 "groupTitle": "Authentication"
1380 "url": "/api/auth/activedirectory",
1381 "title": "Creates a new User token",
1384 "title": "Example usage:",
1385 "content": "curl https://{domain}/api/auth/activedirectory -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1389 "name": "Local_login",
1390 "group": "Authentication",
1405 "field": "password",
1411 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1413 "filename": "server/api/authActiveDirectory/index.js",
1414 "groupTitle": "Authentication"
1418 "url": "/api/automations",
1419 "title": "Creates a new Automation",
1422 "title": "Example usage:",
1423 "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1427 "name": "CreateAutomations",
1428 "group": "Automations",
1450 "field": "description",
1470 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1472 "filename": "server/api/automation/index.js",
1473 "groupTitle": "Automations"
1477 "url": "/api/automations/{id}",
1478 "title": "Deletes a Automation",
1481 "title": "Example usage:",
1482 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1486 "name": "DeleteAutomations",
1487 "group": "Automations",
1488 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1490 "filename": "server/api/automation/index.js",
1491 "groupTitle": "Automations"
1495 "url": "/api/automations",
1496 "title": "Gets a list of Automations",
1499 "title": "Example usage:",
1500 "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1504 "name": "GetAutomations",
1505 "group": "Automations",
1506 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1508 "filename": "server/api/automation/index.js",
1509 "groupTitle": "Automations"
1513 "url": "/api/automations/{id}",
1514 "title": "Gets a single Automation",
1517 "title": "Example usage:",
1518 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1522 "name": "ShowAutomations",
1523 "group": "Automations",
1524 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1526 "filename": "server/api/automation/index.js",
1527 "groupTitle": "Automations"
1531 "url": "/api/automations/{id}/actions",
1532 "title": "Creates new actions",
1535 "title": "Example usage:",
1536 "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1540 "name": "addActions",
1541 "group": "Automations",
1557 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1564 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1571 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1578 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1611 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1613 "filename": "server/api/automation/index.js",
1614 "groupTitle": "Automations"
1618 "url": "/api/automations/{id}/conditions",
1619 "title": "Creates new conditions",
1622 "title": "Example usage:",
1623 "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1627 "name": "addConditions",
1628 "group": "Automations",
1650 "field": "operator",
1663 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1665 "filename": "server/api/automation/index.js",
1666 "groupTitle": "Automations"
1670 "url": "/api/automations/{id}/actions",
1671 "title": "Gets Automation Actions",
1674 "title": "Example usage:",
1675 "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1679 "name": "getActions",
1680 "group": "Automations",
1681 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1683 "filename": "server/api/automation/index.js",
1684 "groupTitle": "Automations"
1688 "url": "/api/automations/{id}/conditions",
1689 "title": "Gets Automation Conditions",
1692 "title": "Example usage:",
1693 "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1697 "name": "getConditions",
1698 "group": "Automations",
1699 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1701 "filename": "server/api/automation/index.js",
1702 "groupTitle": "Automations"
1706 "url": "/api/automations/{id}",
1707 "title": "Update an existing Automation",
1710 "title": "Example usage:",
1711 "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1715 "name": "updateAutomations",
1716 "group": "Automations",
1717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1719 "filename": "server/api/automation/index.js",
1720 "groupTitle": "Automations"
1724 "url": "/api/canned_answers",
1725 "title": "Create a new canned answer",
1728 "title": "Example usage:",
1729 "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1734 "group": "Canned_Answers",
1735 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1737 "filename": "server/api/cannedAnswer/index.js",
1738 "groupTitle": "Canned_Answers"
1742 "url": "/api/canned_answers/{id}",
1743 "title": "Deletes a Canned Answer",
1746 "title": "Example usage:",
1747 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1751 "name": "DeleteCanned_Answers",
1752 "group": "Canned_Answers",
1753 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1755 "filename": "server/api/cannedAnswer/index.js",
1756 "groupTitle": "Canned_Answers"
1760 "url": "/api/canned_answers",
1761 "title": "Gets a list of Canned Answers",
1764 "title": "Example usage:",
1765 "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1769 "name": "GetCanned_Answers",
1770 "group": "Canned_Answers",
1771 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1773 "filename": "server/api/cannedAnswer/index.js",
1774 "groupTitle": "Canned_Answers"
1778 "url": "/api/canned_answers/{id}",
1779 "title": "Gets a single Canned Answer",
1782 "title": "Example usage:",
1783 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1787 "name": "ShowCanned_Answers",
1788 "group": "Canned_Answers",
1789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1791 "filename": "server/api/cannedAnswer/index.js",
1792 "groupTitle": "Canned_Answers"
1796 "url": "/api/canned_answers/{id}",
1797 "title": "Update an existing Canned Answer",
1800 "title": "Example usage:",
1801 "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1805 "name": "updateCanned_Answers",
1806 "group": "Canned_Answers",
1807 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1809 "filename": "server/api/cannedAnswer/index.js",
1810 "groupTitle": "Canned_Answers"
1814 "url": "/chat/internal/users",
1815 "title": "Gets Users Last Messages",
1818 "title": "Example usage:",
1819 "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
1823 "name": "getLastUsersMessages",
1824 "group": "ChatInternalMessage",
1825 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1827 "filename": "server/api/chatInternalMessage/index.js",
1828 "groupTitle": "ChatInternalMessage"
1832 "url": "/api/chat/applications/{id}",
1833 "title": "Deletes a Application",
1836 "title": "Example usage:",
1837 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1841 "name": "DeleteApplications",
1842 "group": "Chat_Applications",
1843 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1845 "filename": "server/api/chatApplication/index.js",
1846 "groupTitle": "Chat_Applications"
1850 "url": "/api/chat/applications/{id}",
1851 "title": "Gets a single Application",
1854 "title": "Example usage:",
1855 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1859 "name": "ShowApplications",
1860 "group": "Chat_Applications",
1861 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1863 "filename": "server/api/chatApplication/index.js",
1864 "groupTitle": "Chat_Applications"
1868 "url": "/api/chat/applications/{id}",
1869 "title": "Update an existing Application",
1872 "title": "Example usage:",
1873 "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1877 "name": "updateApplications",
1878 "group": "Chat_Applications",
1879 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1881 "filename": "server/api/chatApplication/index.js",
1882 "groupTitle": "Chat_Applications"
1886 "url": "/api/chat/groups",
1887 "title": "Creates a new Group",
1890 "title": "Example usage:",
1891 "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1895 "name": "CreateGroups",
1896 "group": "Chat_Groups",
1911 "field": "description",
1924 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1926 "filename": "server/api/chatGroup/index.js",
1927 "groupTitle": "Chat_Groups"
1931 "url": "/api/chat/groups/{id}",
1932 "title": "Deletes a Group",
1935 "title": "Example usage:",
1936 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1940 "name": "DeleteGroups",
1941 "group": "Chat_Groups",
1942 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1944 "filename": "server/api/chatGroup/index.js",
1945 "groupTitle": "Chat_Groups"
1949 "url": "/api/chat/groups/describe",
1950 "title": "Gets table info about Groups",
1953 "title": "Example usage:",
1954 "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1958 "name": "DescribeGroups",
1959 "group": "Chat_Groups",
1960 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1962 "filename": "server/api/chatGroup/index.js",
1963 "groupTitle": "Chat_Groups"
1967 "url": "/api/chat/groups",
1968 "title": "Gets a list of Groups",
1971 "title": "Example usage:",
1972 "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1976 "name": "GetGroups",
1977 "group": "Chat_Groups",
1978 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1980 "filename": "server/api/chatGroup/index.js",
1981 "groupTitle": "Chat_Groups"
1985 "url": "/api/chat/groups/{id}/members",
1986 "title": "Removes members from a group",
1989 "title": "Example usage:",
1990 "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1994 "name": "RemoveMembers",
1995 "group": "Chat_Groups",
1996 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1998 "filename": "server/api/chatGroup/index.js",
1999 "groupTitle": "Chat_Groups"
2003 "url": "/api/chat/groups/{id}",
2004 "title": "Gets a single Group",
2007 "title": "Example usage:",
2008 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
2012 "name": "ShowGroups",
2013 "group": "Chat_Groups",
2014 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2016 "filename": "server/api/chatGroup/index.js",
2017 "groupTitle": "Chat_Groups"
2021 "url": "/api/chat/groups/{id}/members",
2022 "title": "Add members to chat group",
2025 "title": "Example usage:",
2026 "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2030 "name": "addMembers",
2031 "group": "Chat_Groups",
2032 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2034 "filename": "server/api/chatGroup/index.js",
2035 "groupTitle": "Chat_Groups"
2039 "url": "/api/chat/groups/{id}/messages",
2040 "title": "Creates a new group message",
2043 "title": "Example usage:",
2044 "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2048 "name": "addMessage",
2049 "group": "Chat_Groups",
2050 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2052 "filename": "server/api/chatGroup/index.js",
2053 "groupTitle": "Chat_Groups"
2057 "url": "/api/chat/groups/{id}/members",
2058 "title": "Gets Members",
2061 "title": "Example usage:",
2062 "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2066 "name": "getMembers",
2067 "group": "Chat_Groups",
2068 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2070 "filename": "server/api/chatGroup/index.js",
2071 "groupTitle": "Chat_Groups"
2075 "url": "/api/chat/groups/{id}/messages",
2076 "title": "Gets Messages",
2079 "title": "Example usage:",
2080 "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2084 "name": "getMessages",
2085 "group": "Chat_Groups",
2086 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2088 "filename": "server/api/chatGroup/index.js",
2089 "groupTitle": "Chat_Groups"
2093 "url": "/api/chat/groups/{id}/unread",
2094 "title": "Get unread chat group messages",
2097 "title": "Example usage:",
2098 "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2103 "group": "Chat_Groups",
2104 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2106 "filename": "server/api/chatGroup/index.js",
2107 "groupTitle": "Chat_Groups"
2111 "url": "/api/chat/groups/{id}",
2112 "title": "Update an existing Group",
2115 "title": "Example usage:",
2116 "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2120 "name": "updateGroups",
2121 "group": "Chat_Groups",
2122 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2124 "filename": "server/api/chatGroup/index.js",
2125 "groupTitle": "Chat_Groups"
2129 "url": "/api/chat/interactions/{id}/tags",
2130 "title": "Add tags to the interaction",
2133 "title": "Example usage:",
2134 "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2139 "group": "Chat_Interactions",
2140 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2142 "filename": "server/api/chatInteraction/index.js",
2143 "groupTitle": "Chat_Interactions"
2147 "url": "/api/chat/interactions",
2148 "title": "Creates a new Interaction",
2151 "title": "Example usage:",
2152 "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2156 "name": "CreateInteractions",
2157 "group": "Chat_Interactions",
2172 "field": "ratingValue",
2183 "field": "ratingType",
2190 "field": "ratingMessage",
2197 "field": "pathTranscript",
2204 "field": "mailTranscript",
2211 "field": "closedAt",
2218 "field": "disposition",
2225 "field": "secondDisposition",
2232 "field": "thirdDisposition",
2246 "field": "browserName",
2253 "field": "browserVersion",
2267 "field": "osVersion",
2274 "field": "deviceModel",
2281 "field": "deviceVendor",
2288 "field": "deviceType",
2302 "field": "customerIp",
2309 "field": "formData",
2316 "field": "read1stAt",
2323 "field": "lastMsgAt",
2334 "field": "lastMsgDirection",
2341 "field": "closeReason",
2348 "field": "customerPort",
2355 "field": "vidaooSessionId",
2362 "field": "autoreplyExecuted",
2368 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2370 "filename": "server/api/chatInteraction/index.js",
2371 "groupTitle": "Chat_Interactions"
2375 "url": "/api/chat/interactions/{id}",
2376 "title": "Deletes a Interaction",
2379 "title": "Example usage:",
2380 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2384 "name": "DeleteInteractions",
2385 "group": "Chat_Interactions",
2386 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2388 "filename": "server/api/chatInteraction/index.js",
2389 "groupTitle": "Chat_Interactions"
2393 "url": "/api/chat/interactions/describe",
2394 "title": "Gets table info about Interactions",
2397 "title": "Example usage:",
2398 "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2402 "name": "DescribeInteractions",
2403 "group": "Chat_Interactions",
2404 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2406 "filename": "server/api/chatInteraction/index.js",
2407 "groupTitle": "Chat_Interactions"
2411 "url": "/api/chat/interactions",
2412 "title": "Gets a list of Interactions",
2415 "title": "Example usage:",
2416 "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2420 "name": "GetInteractions",
2421 "group": "Chat_Interactions",
2422 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2424 "filename": "server/api/chatInteraction/index.js",
2425 "groupTitle": "Chat_Interactions"
2429 "url": "/api/chat/interactions/{id}/tags",
2430 "title": "Removes tags from interaction",
2433 "title": "Example usage:",
2434 "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2438 "name": "RemoveTags",
2439 "group": "Chat_Interactions",
2440 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2442 "filename": "server/api/chatInteraction/index.js",
2443 "groupTitle": "Chat_Interactions"
2447 "url": "/api/chat/interactions/{id}",
2448 "title": "Gets a single Interaction",
2451 "title": "Example usage:",
2452 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2456 "name": "ShowInteractions",
2457 "group": "Chat_Interactions",
2458 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2460 "filename": "server/api/chatInteraction/index.js",
2461 "groupTitle": "Chat_Interactions"
2465 "url": "/api/chat/interactions/{id}/abandon",
2466 "title": "Abandon interaction",
2469 "title": "Example usage:",
2470 "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2475 "group": "Chat_Interactions",
2476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2478 "filename": "server/api/chatInteraction/index.js",
2479 "groupTitle": "Chat_Interactions"
2483 "url": "/api/chat/interactions/{id}/close",
2484 "title": "Close Interaction",
2487 "title": "Example usage:",
2488 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2492 "name": "addMessage",
2493 "group": "Chat_Interactions",
2494 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2496 "filename": "server/api/chatInteraction/index.js",
2497 "groupTitle": "Chat_Interactions"
2501 "url": "/api/chat/interactions/{id}/messages",
2502 "title": "Creates new messages",
2505 "title": "Example usage:",
2506 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2510 "name": "addMessage",
2511 "group": "Chat_Interactions",
2544 "field": "direction",
2558 "field": "providerName",
2565 "field": "providerResponse",
2571 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2573 "filename": "server/api/chatInteraction/index.js",
2574 "groupTitle": "Chat_Interactions"
2578 "url": "/api/chat/interactions/{id}/attachment_upload",
2579 "title": "Add attachment",
2582 "title": "Example usage:",
2583 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2587 "name": "attachmentUpload",
2588 "group": "Chat_Interactions",
2589 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2591 "filename": "server/api/chatInteraction/index.js",
2592 "groupTitle": "Chat_Interactions"
2596 "url": "/api/chat/interactions/{id}/vidaoo",
2597 "title": "Create Vidaoo Session",
2600 "title": "Example usage:",
2601 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2605 "name": "createVidaooSession",
2606 "group": "Chat_Interactions",
2607 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2609 "filename": "server/api/chatInteraction/index.js",
2610 "groupTitle": "Chat_Interactions"
2614 "url": "/api/chat/interactions/{id}/custom_update",
2615 "title": "Update interaction",
2618 "title": "Example usage:",
2619 "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2623 "name": "customUpdate",
2624 "group": "Chat_Interactions",
2625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2627 "filename": "server/api/chatInteraction/index.js",
2628 "groupTitle": "Chat_Interactions"
2632 "url": "/api/chat/interactions/{id}/download",
2633 "title": "Gets interaction",
2636 "title": "Example usage:",
2637 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2642 "group": "Chat_Interactions",
2643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2645 "filename": "server/api/chatInteraction/index.js",
2646 "groupTitle": "Chat_Interactions"
2650 "url": "/api/chat/interactions/{id}/messages",
2651 "title": "Gets interaction messages",
2654 "title": "Example usage:",
2655 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2659 "name": "getMessages",
2660 "group": "Chat_Interactions",
2661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2663 "filename": "server/api/chatInteraction/index.js",
2664 "groupTitle": "Chat_Interactions"
2668 "url": "/api/chat/interactions/{id}/my_messages",
2669 "title": "Gets interaction messages",
2672 "title": "Example usage:",
2673 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2677 "name": "getMyMessages",
2678 "group": "Chat_Interactions",
2679 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2681 "filename": "server/api/chatInteraction/index.js",
2682 "groupTitle": "Chat_Interactions"
2686 "url": "/api/chat/interactions/{id}",
2687 "title": "Update an existing Interaction",
2690 "title": "Example usage:",
2691 "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2695 "name": "updateInteractions",
2696 "group": "Chat_Interactions",
2697 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2699 "filename": "server/api/chatInteraction/index.js",
2700 "groupTitle": "Chat_Interactions"
2704 "url": "/api/chat/internal/messages",
2705 "title": "Creates a new Message",
2708 "title": "Example usage:",
2709 "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2713 "name": "CreateMessages",
2714 "group": "Chat_Internal_Messages",
2736 "field": "ChatInternalMessageId",
2742 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2744 "filename": "server/api/chatInternalMessage/index.js",
2745 "groupTitle": "Chat_Internal_Messages"
2749 "url": "/api/chat/internal/messages/{id}",
2750 "title": "Deletes a Message",
2753 "title": "Example usage:",
2754 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2758 "name": "DeleteMessages",
2759 "group": "Chat_Internal_Messages",
2760 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2762 "filename": "server/api/chatInternalMessage/index.js",
2763 "groupTitle": "Chat_Internal_Messages"
2767 "url": "/api/chat/internal/messages/describe",
2768 "title": "Gets table info about Messages",
2771 "title": "Example usage:",
2772 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2776 "name": "DescribeMessages",
2777 "group": "Chat_Internal_Messages",
2778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2780 "filename": "server/api/chatInternalMessage/index.js",
2781 "groupTitle": "Chat_Internal_Messages"
2785 "url": "/api/chat/internal/messages",
2786 "title": "Gets a list of Messages",
2789 "title": "Example usage:",
2790 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2794 "name": "GetMessages",
2795 "group": "Chat_Internal_Messages",
2796 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2798 "filename": "server/api/chatInternalMessage/index.js",
2799 "groupTitle": "Chat_Internal_Messages"
2803 "url": "/api/chat/internal/messages/{id}",
2804 "title": "Gets a single Message",
2807 "title": "Example usage:",
2808 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2812 "name": "ShowMessages",
2813 "group": "Chat_Internal_Messages",
2814 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2816 "filename": "server/api/chatInternalMessage/index.js",
2817 "groupTitle": "Chat_Internal_Messages"
2821 "url": "/api/chat/internal/messages/{id}",
2822 "title": "Update an existing Message",
2825 "title": "Example usage:",
2826 "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2830 "name": "updateMessages",
2831 "group": "Chat_Internal_Messages",
2832 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2834 "filename": "server/api/chatInternalMessage/index.js",
2835 "groupTitle": "Chat_Internal_Messages"
2839 "url": "/api/chat/messages",
2840 "title": "Creates a new Message",
2843 "title": "Example usage:",
2844 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2848 "name": "CreateMessages",
2849 "group": "Chat_Messages",
2882 "field": "direction",
2896 "field": "providerName",
2903 "field": "providerResponse",
2909 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2911 "filename": "server/api/chatMessage/index.js",
2912 "groupTitle": "Chat_Messages"
2916 "url": "/api/chat/messages/{id}",
2917 "title": "Deletes a Message",
2920 "title": "Example usage:",
2921 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2925 "name": "DeleteMessages",
2926 "group": "Chat_Messages",
2927 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2929 "filename": "server/api/chatMessage/index.js",
2930 "groupTitle": "Chat_Messages"
2934 "url": "/api/chat/messages/describe",
2935 "title": "Gets table info about Messages",
2938 "title": "Example usage:",
2939 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2943 "name": "DescribeMessages",
2944 "group": "Chat_Messages",
2945 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2947 "filename": "server/api/chatMessage/index.js",
2948 "groupTitle": "Chat_Messages"
2952 "url": "/api/chat/messages",
2953 "title": "Gets a list of Messages",
2956 "title": "Example usage:",
2957 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2961 "name": "GetMessages",
2962 "group": "Chat_Messages",
2963 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2965 "filename": "server/api/chatMessage/index.js",
2966 "groupTitle": "Chat_Messages"
2970 "url": "/api/chat/messages/{id}",
2971 "title": "Gets a single Message",
2974 "title": "Example usage:",
2975 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2979 "name": "ShowMessages",
2980 "group": "Chat_Messages",
2981 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2983 "filename": "server/api/chatMessage/index.js",
2984 "groupTitle": "Chat_Messages"
2988 "url": "/api/chat/messages/{id}",
2989 "title": "Update an existing Message",
2992 "title": "Example usage:",
2993 "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2997 "name": "updateMessages",
2998 "group": "Chat_Messages",
2999 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3001 "filename": "server/api/chatMessage/index.js",
3002 "groupTitle": "Chat_Messages"
3006 "url": "/api/chat/offline_messages",
3007 "title": "Creates a new OfflineMessage",
3010 "title": "Example usage:",
3011 "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3015 "name": "CreateOfflineMessages",
3016 "group": "Chat_Offline_Messages",
3030 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3032 "filename": "server/api/chatOfflineMessage/index.js",
3033 "groupTitle": "Chat_Offline_Messages"
3037 "url": "/api/chat/offline_messages/{id}",
3038 "title": "Deletes a OfflineMessage",
3041 "title": "Example usage:",
3042 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3046 "name": "DeleteOfflineMessages",
3047 "group": "Chat_Offline_Messages",
3048 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3050 "filename": "server/api/chatOfflineMessage/index.js",
3051 "groupTitle": "Chat_Offline_Messages"
3055 "url": "/api/chat/offline_messages/describe",
3056 "title": "Gets table info about OfflineMessages",
3059 "title": "Example usage:",
3060 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3064 "name": "DescribeOfflineMessages",
3065 "group": "Chat_Offline_Messages",
3066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3068 "filename": "server/api/chatOfflineMessage/index.js",
3069 "groupTitle": "Chat_Offline_Messages"
3073 "url": "/api/chat/offline_messages",
3074 "title": "Gets a list of OfflineMessages",
3077 "title": "Example usage:",
3078 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3082 "name": "GetOfflineMessages",
3083 "group": "Chat_Offline_Messages",
3084 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3086 "filename": "server/api/chatOfflineMessage/index.js",
3087 "groupTitle": "Chat_Offline_Messages"
3091 "url": "/api/chat/offline_messages/{id}",
3092 "title": "Gets a single OfflineMessage",
3095 "title": "Example usage:",
3096 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3100 "name": "ShowOfflineMessages",
3101 "group": "Chat_Offline_Messages",
3102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3104 "filename": "server/api/chatOfflineMessage/index.js",
3105 "groupTitle": "Chat_Offline_Messages"
3109 "url": "/api/chat/offline_messages/{id}",
3110 "title": "Update an existing OfflineMessage",
3113 "title": "Example usage:",
3114 "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3118 "name": "updateOfflineMessages",
3119 "group": "Chat_Offline_Messages",
3120 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3122 "filename": "server/api/chatOfflineMessage/index.js",
3123 "groupTitle": "Chat_Offline_Messages"
3127 "url": "/api/chat/proactive_actions",
3128 "title": "Creates a new Proactive Action",
3131 "title": "Example usage:",
3132 "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3136 "name": "CreateProactive_Actions",
3137 "group": "Chat_Proactive_Actions",
3163 "field": "selector",
3176 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3178 "filename": "server/api/chatProactiveAction/index.js",
3179 "groupTitle": "Chat_Proactive_Actions"
3183 "url": "/api/chat/proactive_actions/{id}",
3184 "title": "Deletes a Proactive Action",
3187 "title": "Example usage:",
3188 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3192 "name": "DeleteProactive_Actions",
3193 "group": "Chat_Proactive_Actions",
3194 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3196 "filename": "server/api/chatProactiveAction/index.js",
3197 "groupTitle": "Chat_Proactive_Actions"
3201 "url": "/api/chat/proactive_actions/{id}",
3202 "title": "Gets a single Proactive Action",
3205 "title": "Example usage:",
3206 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3210 "name": "ShowProactive_Actions",
3211 "group": "Chat_Proactive_Actions",
3212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3214 "filename": "server/api/chatProactiveAction/index.js",
3215 "groupTitle": "Chat_Proactive_Actions"
3219 "url": "/api/chat/proactive_actions/{id}",
3220 "title": "Update an existing Proactive Action",
3223 "title": "Example usage:",
3224 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3228 "name": "updateProactive_Actions",
3229 "group": "Chat_Proactive_Actions",
3230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3232 "filename": "server/api/chatProactiveAction/index.js",
3233 "groupTitle": "Chat_Proactive_Actions"
3237 "url": "/api/chat/reports/queue",
3238 "title": "Creates a new Chat Queue Report",
3241 "title": "Example usage:",
3242 "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3246 "name": "CreateChat_Queue_Reports",
3247 "group": "Chat_Queue_Reports",
3255 "field": "uniqueid",
3283 "field": "acceptAt",
3303 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3305 "filename": "server/api/chatQueueReport/index.js",
3306 "groupTitle": "Chat_Queue_Reports"
3310 "url": "/api/chat/reports/queue/{id}",
3311 "title": "Deletes a Chat Queue Report",
3314 "title": "Example usage:",
3315 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3319 "name": "DeleteChat_Queue_Reports",
3320 "group": "Chat_Queue_Reports",
3321 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3323 "filename": "server/api/chatQueueReport/index.js",
3324 "groupTitle": "Chat_Queue_Reports"
3328 "url": "/api/chat/reports/queue/describe",
3329 "title": "Gets table info about Chat Queue Reports",
3332 "title": "Example usage:",
3333 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3337 "name": "DescribeChat_Queue_Reports",
3338 "group": "Chat_Queue_Reports",
3339 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3341 "filename": "server/api/chatQueueReport/index.js",
3342 "groupTitle": "Chat_Queue_Reports"
3346 "url": "/api/chat/reports/queue",
3347 "title": "Gets a list of Chat Queue Reports",
3350 "title": "Example usage:",
3351 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3355 "name": "GetChat_Queue_Reports",
3356 "group": "Chat_Queue_Reports",
3357 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3359 "filename": "server/api/chatQueueReport/index.js",
3360 "groupTitle": "Chat_Queue_Reports"
3364 "url": "/api/chat/reports/queue/{id}",
3365 "title": "Gets a single Chat Queue Report",
3368 "title": "Example usage:",
3369 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3373 "name": "ShowChat_Queue_Reports",
3374 "group": "Chat_Queue_Reports",
3375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3377 "filename": "server/api/chatQueueReport/index.js",
3378 "groupTitle": "Chat_Queue_Reports"
3382 "url": "/api/chat/reports/queue/{id}",
3383 "title": "Update an existing Chat Queue Report",
3386 "title": "Example usage:",
3387 "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3391 "name": "updateChat_Queue_Reports",
3392 "group": "Chat_Queue_Reports",
3393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3395 "filename": "server/api/chatQueueReport/index.js",
3396 "groupTitle": "Chat_Queue_Reports"
3400 "url": "/api/chat/queues/{id}/users",
3401 "title": "Add agents to a queue",
3404 "title": "Example usage:",
3405 "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3409 "name": "AddAgents",
3410 "group": "Chat_Queues",
3411 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3413 "filename": "server/api/chatQueue/index.js",
3414 "groupTitle": "Chat_Queues"
3418 "url": "/api/chat/queues/{id}/teams",
3419 "title": "Add teams to a queue",
3422 "title": "Example usage:",
3423 "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3428 "group": "Chat_Queues",
3429 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3431 "filename": "server/api/chatQueue/index.js",
3432 "groupTitle": "Chat_Queues"
3436 "url": "/api/chat/queues",
3437 "title": "Creates a new Queue",
3440 "title": "Example usage:",
3441 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3445 "name": "CreateQueues",
3446 "group": "Chat_Queues",
3461 "field": "description",
3480 "field": "strategy",
3486 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3488 "filename": "server/api/chatQueue/index.js",
3489 "groupTitle": "Chat_Queues"
3493 "url": "/api/chat/queues/{id}",
3494 "title": "Deletes a Queue",
3497 "title": "Example usage:",
3498 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3502 "name": "DeleteQueues",
3503 "group": "Chat_Queues",
3504 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3506 "filename": "server/api/chatQueue/index.js",
3507 "groupTitle": "Chat_Queues"
3511 "url": "/api/chat/queues/describe",
3512 "title": "Gets table info about Queues",
3515 "title": "Example usage:",
3516 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3520 "name": "DescribeQueues",
3521 "group": "Chat_Queues",
3522 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3524 "filename": "server/api/chatQueue/index.js",
3525 "groupTitle": "Chat_Queues"
3529 "url": "/api/chat/queues/{id}/users",
3530 "title": "Gets queue agents",
3533 "title": "Example usage:",
3534 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3538 "name": "GetAgents",
3539 "group": "Chat_Queues",
3540 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3542 "filename": "server/api/chatQueue/index.js",
3543 "groupTitle": "Chat_Queues"
3547 "url": "/api/chat/queues/{id}/members",
3548 "title": "GetMembers",
3551 "title": "Example usage:",
3552 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3556 "name": "GetMembers",
3557 "group": "Chat_Queues",
3558 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3560 "filename": "server/api/chatQueue/index.js",
3561 "groupTitle": "Chat_Queues"
3565 "url": "/api/chat/queues",
3566 "title": "Gets a list of Queues",
3569 "title": "Example usage:",
3570 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3574 "name": "GetQueues",
3575 "group": "Chat_Queues",
3576 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3578 "filename": "server/api/chatQueue/index.js",
3579 "groupTitle": "Chat_Queues"
3583 "url": "/api/chat/queues/{id}/teams",
3584 "title": "Gets queues list",
3587 "title": "Example usage:",
3588 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3593 "group": "Chat_Queues",
3594 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3596 "filename": "server/api/chatQueue/index.js",
3597 "groupTitle": "Chat_Queues"
3601 "url": "/api/chat/queues/{id}/users",
3602 "title": "Removes agents from a queue",
3605 "title": "Example usage:",
3606 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3610 "name": "RemoveAgents",
3611 "group": "Chat_Queues",
3612 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3614 "filename": "server/api/chatQueue/index.js",
3615 "groupTitle": "Chat_Queues"
3619 "url": "/api/chat/queues/{id}",
3620 "title": "Gets a single Queue",
3623 "title": "Example usage:",
3624 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3628 "name": "ShowQueues",
3629 "group": "Chat_Queues",
3630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3632 "filename": "server/api/chatQueue/index.js",
3633 "groupTitle": "Chat_Queues"
3637 "url": "/api/chat/queues/{id}",
3638 "title": "Update an existing Queue",
3641 "title": "Example usage:",
3642 "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3646 "name": "updateQueues",
3647 "group": "Chat_Queues",
3648 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3650 "filename": "server/api/chatQueue/index.js",
3651 "groupTitle": "Chat_Queues"
3655 "url": "/api/chat/reports/transfer",
3656 "title": "Creates a new Chat Transfer Report",
3659 "title": "Example usage:",
3660 "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3664 "name": "CreateChat_Transfer_Reports",
3665 "group": "Chat_Transfer_Reports",
3673 "field": "uniqueid",
3692 "field": "transferredAt",
3698 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3700 "filename": "server/api/chatTransferReport/index.js",
3701 "groupTitle": "Chat_Transfer_Reports"
3705 "url": "/api/chat/reports/transfer/{id}",
3706 "title": "Deletes a Chat Transfer Report",
3709 "title": "Example usage:",
3710 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3714 "name": "DeleteChat_Transfer_Reports",
3715 "group": "Chat_Transfer_Reports",
3716 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3718 "filename": "server/api/chatTransferReport/index.js",
3719 "groupTitle": "Chat_Transfer_Reports"
3723 "url": "/api/chat/reports/transfer/describe",
3724 "title": "Gets table info about Chat Transfer Reports",
3727 "title": "Example usage:",
3728 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3732 "name": "DescribeChat_Transfer_Reports",
3733 "group": "Chat_Transfer_Reports",
3734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3736 "filename": "server/api/chatTransferReport/index.js",
3737 "groupTitle": "Chat_Transfer_Reports"
3741 "url": "/api/chat/reports/transfer",
3742 "title": "Gets a list of Chat Transfer Reports",
3745 "title": "Example usage:",
3746 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3750 "name": "GetChat_Transfer_Reports",
3751 "group": "Chat_Transfer_Reports",
3752 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3754 "filename": "server/api/chatTransferReport/index.js",
3755 "groupTitle": "Chat_Transfer_Reports"
3759 "url": "/api/chat/reports/transfer/{id}",
3760 "title": "Gets a single Chat Transfer Report",
3763 "title": "Example usage:",
3764 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3768 "name": "ShowChat_Transfer_Reports",
3769 "group": "Chat_Transfer_Reports",
3770 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3772 "filename": "server/api/chatTransferReport/index.js",
3773 "groupTitle": "Chat_Transfer_Reports"
3777 "url": "/api/chat/reports/transfer/{id}",
3778 "title": "Update an existing Chat Transfer Report",
3781 "title": "Example usage:",
3782 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3786 "name": "updateChat_Transfer_Reports",
3787 "group": "Chat_Transfer_Reports",
3788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3790 "filename": "server/api/chatTransferReport/index.js",
3791 "groupTitle": "Chat_Transfer_Reports"
3795 "url": "/api/chat/websites/{id}/users",
3796 "title": "Add agents to a website",
3799 "title": "Example usage:",
3800 "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3804 "name": "AddAgents",
3805 "group": "Chat_Websites",
3806 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3808 "filename": "server/api/chatWebsite/index.js",
3809 "groupTitle": "Chat_Websites"
3813 "url": "/api/chat/websites",
3814 "title": "Creates a new Website",
3817 "title": "Example usage:",
3818 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3822 "name": "CreateWebsites",
3823 "group": "Chat_Websites",
3845 "field": "description",
3859 "field": "mapKeyOffline",
3873 "field": "agentAlias",
3880 "field": "customerAlias",
3894 "field": "color_button",
3901 "field": "textColor",
3908 "field": "fontSize",
3922 "field": "animation",
3933 "field": "header_shape",
3940 "field": "header_online",
3947 "field": "start_chat_button",
3954 "field": "offline_chat_button",
3961 "field": "header_offline",
3968 "field": "download_transcript",
3982 "field": "whiteLabel",
3989 "field": "defaultWhiteLabel",
4003 "field": "closingQuestion",
4010 "field": "formSubmitSuccessMessage",
4017 "field": "formSubmitFailureMessage",
4024 "field": "noteTitle",
4031 "field": "placeholderMessage",
4038 "field": "closingMessage",
4045 "field": "closingMessageButton",
4052 "field": "skipMessageButton",
4059 "field": "conditionAgreement",
4066 "field": "enableRating",
4073 "field": "enableFeedback",
4080 "field": "enableSendButton",
4087 "field": "feedbackTitle",
4098 "field": "ratingType",
4105 "field": "ratingStarsNumber",
4112 "field": "onlineForm",
4119 "field": "offlineForm",
4133 "field": "autoclose",
4140 "field": "enableCustomerWriting",
4147 "field": "forwardTranscript",
4154 "field": "forwardTranscriptMessage",
4161 "field": "forwardOffline",
4168 "field": "forwardOfflineAddress",
4175 "field": "waitingTitle",
4182 "field": "waitingMessage",
4189 "field": "offlineMessageSubject",
4196 "field": "offlineMessageBody",
4203 "field": "enableUnmanagedNote",
4210 "field": "unmanagedMessage",
4217 "field": "skipUnmanaged",
4224 "field": "sendUnmanaged",
4231 "field": "enableCustomerAttachment",
4238 "field": "enableCustomerCheckmarks",
4245 "field": "agentAvatar",
4252 "field": "showAgentAvatar",
4259 "field": "timezone",
4266 "field": "notificationTemplate",
4273 "field": "notificationSound",
4280 "field": "notificationShake",
4287 "field": "hideWhenOffline",
4294 "field": "agentIdentifier",
4301 "field": "waitForTheAssignedAgent",
4308 "field": "alignment",
4315 "field": "verticalAlignment",
4322 "field": "labelText",
4329 "field": "messagesAlignment",
4336 "field": "defaultTitle",
4343 "field": "customerAvatar",
4350 "field": "showCustomerAvatar",
4357 "field": "messageFontSize",
4364 "field": "backgroundColor",
4371 "field": "queueTransfer",
4378 "field": "queueTransferTimeout",
4385 "field": "agentTransfer",
4392 "field": "agentTransferTimeout",
4399 "field": "systemAlias",
4406 "field": "systemAvatar",
4413 "field": "mandatoryDispositionPauseId",
4414 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4420 "field": "mandatoryDisposition",
4421 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4427 "field": "vidaooEscalation",
4434 "field": "vidaooApiKey",
4441 "field": "vidaooTopic",
4448 "field": "vidaooNote",
4455 "field": "vidaooMetadata",
4462 "field": "openNewInteraction",
4469 "field": "subjectOffline",
4475 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4477 "filename": "server/api/chatWebsite/index.js",
4478 "groupTitle": "Chat_Websites"
4482 "url": "/api/chat/websites/{id}",
4483 "title": "Deletes a Website",
4486 "title": "Example usage:",
4487 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4491 "name": "DeleteWebsites",
4492 "group": "Chat_Websites",
4493 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4495 "filename": "server/api/chatWebsite/index.js",
4496 "groupTitle": "Chat_Websites"
4500 "url": "/api/chat/websites/describe",
4501 "title": "Gets table info about Websites",
4504 "title": "Example usage:",
4505 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4509 "name": "DescribeWebsites",
4510 "group": "Chat_Websites",
4511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4513 "filename": "server/api/chatWebsite/index.js",
4514 "groupTitle": "Chat_Websites"
4518 "url": "/api/chat/websites/{id}/users",
4519 "title": "Gets agents from website",
4522 "title": "Example usage:",
4523 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4527 "name": "GetAgents",
4528 "group": "Chat_Websites",
4529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4531 "filename": "server/api/chatWebsite/index.js",
4532 "groupTitle": "Chat_Websites"
4536 "url": "/api/chat/websites",
4537 "title": "Gets a list of Websites",
4540 "title": "Example usage:",
4541 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4545 "name": "GetWebsites",
4546 "group": "Chat_Websites",
4547 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/websites?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/websites?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/websites?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/websites?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/websites?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
4549 "filename": "server/api/chatWebsite/index.js",
4550 "groupTitle": "Chat_Websites"
4554 "url": "/api/chat/websites/{id}/users",
4555 "title": "Removes agents from a website",
4558 "title": "Example usage:",
4559 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4563 "name": "RemoveAgents",
4564 "group": "Chat_Websites",
4565 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4567 "filename": "server/api/chatWebsite/index.js",
4568 "groupTitle": "Chat_Websites"
4572 "url": "/api/chat/websites/{id}/canned_answers",
4573 "title": "Removes canned answers from account",
4576 "title": "Example usage:",
4577 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4581 "name": "RemoveAnswers",
4582 "group": "Chat_Websites",
4583 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4585 "filename": "server/api/chatWebsite/index.js",
4586 "groupTitle": "Chat_Websites"
4590 "url": "/api/chat/websites/{id}/dispositions",
4591 "title": "Removes canned answers from account",
4594 "title": "Example usage:",
4595 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4599 "name": "RemoveDispositions",
4600 "group": "Chat_Websites",
4601 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4603 "filename": "server/api/chatWebsite/index.js",
4604 "groupTitle": "Chat_Websites"
4608 "url": "/api/chat/websites/{id}",
4609 "title": "Gets a single Website",
4612 "title": "Example usage:",
4613 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4617 "name": "ShowWebsites",
4618 "group": "Chat_Websites",
4619 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4621 "filename": "server/api/chatWebsite/index.js",
4622 "groupTitle": "Chat_Websites"
4626 "url": "/api/chat/messages/{id}/accept",
4627 "title": "Accepts message",
4630 "title": "Example usage:",
4631 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4635 "name": "acceptMessage",
4636 "group": "Chat_Websites",
4637 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4639 "filename": "server/api/chatMessage/index.js",
4640 "groupTitle": "Chat_Websites"
4644 "url": "/api/chat/websites/{id}/canned_answers",
4645 "title": "Creates new canned answer",
4648 "title": "Example usage:",
4649 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4653 "name": "addAnswer",
4654 "group": "Chat_Websites",
4676 "field": "description",
4689 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4691 "filename": "server/api/chatWebsite/index.js",
4692 "groupTitle": "Chat_Websites"
4696 "url": "/api/chat/websites/{id}/applications",
4697 "title": "Creates new applications",
4700 "title": "Example usage:",
4701 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4705 "name": "addApplications",
4706 "group": "Chat_Websites",
4714 "field": "priority",
4735 "field": "description",
4742 "field": "interval",
4748 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4750 "filename": "server/api/chatWebsite/index.js",
4751 "groupTitle": "Chat_Websites"
4755 "url": "/api/chat/websites/{id}/avatar",
4756 "title": "Add avatar",
4759 "title": "Example usage:",
4760 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4764 "name": "addAvatar",
4765 "group": "Chat_Websites",
4766 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4768 "filename": "server/api/chatWebsite/index.js",
4769 "groupTitle": "Chat_Websites"
4773 "url": "/api/chat/websites/{id}/customer_avatar",
4774 "title": "Add customer avatar",
4777 "title": "Example usage:",
4778 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4782 "name": "addCustomerAvatar",
4783 "group": "Chat_Websites",
4784 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4786 "filename": "server/api/chatWebsite/index.js",
4787 "groupTitle": "Chat_Websites"
4791 "url": "/api/chat/websites/{id}/dispositions",
4792 "title": "Creates new disposition",
4795 "title": "Example usage:",
4796 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4800 "name": "addDisposition",
4801 "group": "Chat_Websites",
4828 "field": "description",
4834 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4836 "filename": "server/api/chatWebsite/index.js",
4837 "groupTitle": "Chat_Websites"
4841 "url": "/api/chat/accounts/{id}/interactions",
4842 "title": "Creates new interactions",
4845 "title": "Example usage:",
4846 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4850 "name": "addInteraction",
4851 "group": "Chat_Websites",
4866 "field": "ratingValue",
4877 "field": "ratingType",
4884 "field": "ratingMessage",
4891 "field": "pathTranscript",
4898 "field": "mailTranscript",
4905 "field": "closedAt",
4912 "field": "disposition",
4919 "field": "secondDisposition",
4926 "field": "thirdDisposition",
4940 "field": "browserName",
4947 "field": "browserVersion",
4961 "field": "osVersion",
4968 "field": "deviceModel",
4975 "field": "deviceVendor",
4982 "field": "deviceType",
4996 "field": "customerIp",
5003 "field": "formData",
5010 "field": "read1stAt",
5017 "field": "lastMsgAt",
5028 "field": "lastMsgDirection",
5035 "field": "closeReason",
5042 "field": "customerPort",
5049 "field": "vidaooSessionId",
5056 "field": "autoreplyExecuted",
5062 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5064 "filename": "server/api/chatWebsite/index.js",
5065 "groupTitle": "Chat_Websites"
5069 "url": "/api/chat/websites/{id}/logo",
5070 "title": "Add logo",
5073 "title": "Example usage:",
5074 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5079 "group": "Chat_Websites",
5080 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5082 "filename": "server/api/chatWebsite/index.js",
5083 "groupTitle": "Chat_Websites"
5087 "url": "/api/chat/websites/{id}/proactive_actions",
5088 "title": "Creates new Proactive Actions",
5091 "title": "Example usage:",
5092 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5096 "name": "addProactiveActions",
5097 "group": "Chat_Websites",
5123 "field": "selector",
5136 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5138 "filename": "server/api/chatWebsite/index.js",
5139 "groupTitle": "Chat_Websites"
5143 "url": "/api/chat/websites/{id}/system_avatar",
5144 "title": "Add system avatar",
5147 "title": "Example usage:",
5148 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5152 "name": "addSystemAvatar",
5153 "group": "Chat_Websites",
5154 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5156 "filename": "server/api/chatWebsite/index.js",
5157 "groupTitle": "Chat_Websites"
5161 "url": "/api/chat/websites/{id}/canned_answers",
5162 "title": "Gets account canned answers",
5165 "title": "Example usage:",
5166 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5170 "name": "getAnswers",
5171 "group": "Chat_Websites",
5172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5174 "filename": "server/api/chatWebsite/index.js",
5175 "groupTitle": "Chat_Websites"
5179 "url": "/api/chat/websites/{id}/applications",
5180 "title": "Gets Website Applications",
5183 "title": "Example usage:",
5184 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5188 "name": "getApplications",
5189 "group": "Chat_Websites",
5190 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5192 "filename": "server/api/chatWebsite/index.js",
5193 "groupTitle": "Chat_Websites"
5197 "url": "/api/chat/websites/{id}/avatar",
5198 "title": "Get avatar",
5201 "title": "Example usage:",
5202 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5206 "name": "getAvatar",
5207 "group": "Chat_Websites",
5208 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5210 "filename": "server/api/chatWebsite/index.js",
5211 "groupTitle": "Chat_Websites"
5215 "url": "/api/chat/websites/{id}/customer_avatar",
5216 "title": "Get Customer Avatar",
5219 "title": "Example usage:",
5220 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5224 "name": "getCustomerAvatar",
5225 "group": "Chat_Websites",
5226 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5228 "filename": "server/api/chatWebsite/index.js",
5229 "groupTitle": "Chat_Websites"
5233 "url": "/api/chat/websites/{id}/dispositions",
5234 "title": "Gets account dispositions",
5237 "title": "Example usage:",
5238 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5242 "name": "getDispositions",
5243 "group": "Chat_Websites",
5244 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5246 "filename": "server/api/chatWebsite/index.js",
5247 "groupTitle": "Chat_Websites"
5251 "url": "/api/chat/websites/{id}/fields",
5252 "title": "Gets Website Fields",
5255 "title": "Example usage:",
5256 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5260 "name": "getFields",
5261 "group": "Chat_Websites",
5262 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5264 "filename": "server/api/chatWebsite/index.js",
5265 "groupTitle": "Chat_Websites"
5269 "url": "/api/chat/websites/{id}/interactions",
5270 "title": "Gets Website Interactions",
5273 "title": "Example usage:",
5274 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5278 "name": "getInteraction",
5279 "group": "Chat_Websites",
5280 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5282 "filename": "server/api/chatWebsite/index.js",
5283 "groupTitle": "Chat_Websites"
5287 "url": "/api/chat/websites/{id}/logo",
5288 "title": "Get logo",
5291 "title": "Example usage:",
5292 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5297 "group": "Chat_Websites",
5298 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5300 "filename": "server/api/chatWebsite/index.js",
5301 "groupTitle": "Chat_Websites"
5305 "url": "/api/chat/websites/{id}/offline_messages",
5306 "title": "Gets Website Offline Messages",
5309 "title": "Example usage:",
5310 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5314 "name": "getOfflineMessages",
5315 "group": "Chat_Websites",
5316 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5318 "filename": "server/api/chatWebsite/index.js",
5319 "groupTitle": "Chat_Websites"
5323 "url": "/api/chat/websites/{id}/proactive_actions",
5324 "title": "Gets Website Proactive Actions",
5327 "title": "Example usage:",
5328 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5332 "name": "getProactiveActions",
5333 "group": "Chat_Websites",
5334 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5336 "filename": "server/api/chatWebsite/index.js",
5337 "groupTitle": "Chat_Websites"
5341 "url": "/api/chat/websites/{id}/snippet",
5342 "title": "Gets Website Snippet",
5345 "title": "Example usage:",
5346 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5350 "name": "getSnippet",
5351 "group": "Chat_Websites",
5352 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5354 "filename": "server/api/chatWebsite/index.js",
5355 "groupTitle": "Chat_Websites"
5359 "url": "/api/chat/websites/{id}/system_avatar",
5360 "title": "Get System Avatar",
5363 "title": "Example usage:",
5364 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5368 "name": "getSystemAvatar",
5369 "group": "Chat_Websites",
5370 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5372 "filename": "server/api/chatWebsite/index.js",
5373 "groupTitle": "Chat_Websites"
5377 "url": "/api/chat/websites/{id}/notify",
5378 "title": "Notify new message",
5381 "title": "Example usage:",
5382 "content": "curl https://{domain}/api/chat/websites/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5387 "group": "Chat_Websites",
5388 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new chat message to be sent to the system.</p>",
5390 "filename": "server/api/chatWebsite/index.js",
5391 "groupTitle": "Chat_Websites"
5395 "url": "/api/chat/websites/{id}/offline",
5396 "title": "Offline message",
5399 "title": "Example usage:",
5400 "content": "curl https://{domain}/api/chat/websites/{id}/offline -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5405 "group": "Chat_Websites",
5406 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5408 "filename": "server/api/chatWebsite/index.js",
5409 "groupTitle": "Chat_Websites"
5413 "url": "/api/chat/messages/{id}/reject",
5414 "title": "Rejects message",
5417 "title": "Example usage:",
5418 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5422 "name": "rejectMessage",
5423 "group": "Chat_Websites",
5424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5426 "filename": "server/api/chatMessage/index.js",
5427 "groupTitle": "Chat_Websites"
5431 "url": "/api/chat/websites/{id}",
5432 "title": "Update an existing Website",
5435 "title": "Example usage:",
5436 "content": "curl https://{domain}/api/chat/websites/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5440 "name": "updateWebsites",
5441 "group": "Chat_Websites",
5442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5444 "filename": "server/api/chatWebsite/index.js",
5445 "groupTitle": "Chat_Websites"
5449 "url": "/api/cloudProviders",
5450 "title": "Creates a new CloudProvider",
5453 "title": "Example usage:",
5454 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5458 "name": "CreateCloudProviders",
5459 "group": "CloudProviders",
5498 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5500 "filename": "server/api/cloudProvider/index.js",
5501 "groupTitle": "CloudProviders"
5505 "url": "/api/cloudProviders/{id}",
5506 "title": "Deletes a CloudProvider",
5509 "title": "Example usage:",
5510 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5514 "name": "DeleteCloudProviders",
5515 "group": "CloudProviders",
5516 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5518 "filename": "server/api/cloudProvider/index.js",
5519 "groupTitle": "CloudProviders"
5523 "url": "/api/cloudProviders",
5524 "title": "Gets a list of CloudProviders",
5527 "title": "Example usage:",
5528 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5532 "name": "GetCloudProviders",
5533 "group": "CloudProviders",
5534 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cloudProviders?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cloudProviders?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cloudProviders?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cloudProviders?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cloudProviders?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5536 "filename": "server/api/cloudProvider/index.js",
5537 "groupTitle": "CloudProviders"
5541 "url": "/api/cloudProviders/oauth2/microsoft/authorize/{id}",
5542 "title": "Generates the Microsoft Identity platform authorization url",
5545 "title": "Example usage:",
5546 "content": "curl https://{domain}/api/cloudProviders/oauth2/microsoft/authorize/{id} -v -u {name}:{password}",
5550 "name": "Oauth2MicrosoftAuthorize",
5551 "group": "CloudProviders",
5552 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5554 "filename": "server/api/cloudProvider/index.js",
5555 "groupTitle": "CloudProviders"
5559 "url": "/api/cloudProviders/oauth2/microsoft/callback",
5560 "title": "Receives an authorization code from Microsoft Identity platform",
5561 "name": "Oauth2MicrosoftCallback",
5562 "group": "CloudProviders",
5563 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5565 "filename": "server/api/cloudProvider/index.js",
5566 "groupTitle": "CloudProviders"
5570 "url": "/api/cloudProviders/{id}",
5571 "title": "Gets a single CloudProvider",
5574 "title": "Example usage:",
5575 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5579 "name": "ShowCloudProviders",
5580 "group": "CloudProviders",
5581 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5583 "filename": "server/api/cloudProvider/index.js",
5584 "groupTitle": "CloudProviders"
5588 "url": "/api/cloudProviders/{id}",
5589 "title": "Update an existing CloudProvider",
5592 "title": "Example usage:",
5593 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5597 "name": "updateCloudProviders",
5598 "group": "CloudProviders",
5599 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5601 "filename": "server/api/cloudProvider/index.js",
5602 "groupTitle": "CloudProviders"
5606 "url": "/api/cm/companies",
5607 "title": "Creates a new Company",
5610 "title": "Example usage:",
5611 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5615 "name": "CreateCompanies",
5616 "group": "Cm_Companies",
5638 "field": "companyId",
5680 "field": "postalCode",
5708 "field": "emailDomain",
5722 "field": "sPostalCode",
5736 "field": "sCountry",
5743 "field": "description",
5749 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5751 "filename": "server/api/cmCompany/index.js",
5752 "groupTitle": "Cm_Companies"
5756 "url": "/api/cm/companies/{id}",
5757 "title": "Deletes a Company",
5760 "title": "Example usage:",
5761 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5765 "name": "DeleteCompanies",
5766 "group": "Cm_Companies",
5767 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5769 "filename": "server/api/cmCompany/index.js",
5770 "groupTitle": "Cm_Companies"
5774 "url": "/api/cm/companies/describe",
5775 "title": "Gets table info about Companies",
5778 "title": "Example usage:",
5779 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5783 "name": "DescribeCompanies",
5784 "group": "Cm_Companies",
5785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5787 "filename": "server/api/cmCompany/index.js",
5788 "groupTitle": "Cm_Companies"
5792 "url": "/api/cm/companies",
5793 "title": "Gets a list of Companies",
5796 "title": "Example usage:",
5797 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5801 "name": "GetCompanies",
5802 "group": "Cm_Companies",
5803 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/companies?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/companies?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/companies?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/companies?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/companies?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5805 "filename": "server/api/cmCompany/index.js",
5806 "groupTitle": "Cm_Companies"
5810 "url": "/api/cm/companies/{id}",
5811 "title": "Gets a single Company",
5814 "title": "Example usage:",
5815 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5819 "name": "ShowCompanies",
5820 "group": "Cm_Companies",
5821 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5823 "filename": "server/api/cmCompany/index.js",
5824 "groupTitle": "Cm_Companies"
5828 "url": "/api/cm/companies/{id}/contacts",
5829 "title": "Creates new contacts",
5832 "title": "Example usage:",
5833 "content": "curl https://{domain}/api/cm/companies/{id}/contacts -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5837 "name": "addContacts",
5838 "group": "Cm_Companies",
5846 "field": "firstName",
5853 "field": "lastName",
5867 "field": "postalCode",
5888 "field": "dateOfBirth",
5895 "field": "description",
5937 "field": "facebook",
5993 "field": "telegram",
6007 "field": "priority",
6014 "field": "scheduledat",
6020 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6022 "filename": "server/api/cmCompany/index.js",
6023 "groupTitle": "Cm_Companies"
6027 "url": "/api/cm/companies/{id}/contacts",
6028 "title": "Gets List Contacts",
6031 "title": "Example usage:",
6032 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6036 "name": "getContacts",
6037 "group": "Cm_Companies",
6038 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6040 "filename": "server/api/cmCompany/index.js",
6041 "groupTitle": "Cm_Companies"
6045 "url": "/api/cm/companies/{id}",
6046 "title": "Update an existing Company",
6049 "title": "Example usage:",
6050 "content": "curl https://{domain}/api/cm/companies/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6054 "name": "updateCompanies",
6055 "group": "Cm_Companies",
6056 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6058 "filename": "server/api/cmCompany/index.js",
6059 "groupTitle": "Cm_Companies"
6063 "url": "/api/cm/contacts/{id}",
6064 "title": "Deletes a Contact",
6067 "title": "Example usage:",
6068 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6072 "name": "DeleteContacts",
6073 "group": "Cm_Contacts",
6074 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6076 "filename": "server/api/cmContact/index.js",
6077 "groupTitle": "Cm_Contacts"
6081 "url": "/api/cm/contacts/describe",
6082 "title": "Gets table info about Contacts",
6085 "title": "Example usage:",
6086 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6090 "name": "DescribeContacts",
6091 "group": "Cm_Contacts",
6092 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6094 "filename": "server/api/cmContact/index.js",
6095 "groupTitle": "Cm_Contacts"
6099 "url": "/api/cm/contacts",
6100 "title": "Gets a list of Contacts",
6103 "title": "Example usage:",
6104 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6108 "name": "GetContacts",
6109 "group": "Cm_Contacts",
6110 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/contacts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/contacts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/contacts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/contacts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/contacts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6112 "filename": "server/api/cmContact/index.js",
6113 "groupTitle": "Cm_Contacts"
6117 "url": "/api/cm/contacts/{id}/finals",
6118 "title": "Gets contact hopper finals",
6121 "title": "Example usage:",
6122 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6126 "name": "GetHopperFinals",
6127 "group": "Cm_Contacts",
6128 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6130 "filename": "server/api/cmContact/index.js",
6131 "groupTitle": "Cm_Contacts"
6135 "url": "/api/cm/contacts/{id}/hopper_histories",
6136 "title": "Gets contact hopper histories",
6139 "title": "Example usage:",
6140 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6144 "name": "GetHopperHistories",
6145 "group": "Cm_Contacts",
6146 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6148 "filename": "server/api/cmContact/index.js",
6149 "groupTitle": "Cm_Contacts"
6153 "url": "/api/cm/contacts/{id}/hoppers",
6154 "title": "Gets contact hoppers",
6157 "title": "Example usage:",
6158 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6162 "name": "GetHoppers",
6163 "group": "Cm_Contacts",
6164 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6166 "filename": "server/api/cmContact/index.js",
6167 "groupTitle": "Cm_Contacts"
6171 "url": "/api/cm/contacts/create_many",
6172 "title": "Create Contacts",
6175 "title": "Example usage:",
6176 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6180 "name": "bulkCreate",
6181 "group": "Cm_Contacts",
6182 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6184 "filename": "server/api/cmContact/index.js",
6185 "groupTitle": "Cm_Contacts"
6189 "url": "/api/cm/contacts",
6190 "title": "Create Contact",
6193 "title": "Example usage:",
6194 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6199 "group": "Cm_Contacts",
6200 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6202 "filename": "server/api/cmContact/index.js",
6203 "groupTitle": "Cm_Contacts"
6207 "url": "/api/cm/contacts/{id}/journey",
6208 "title": "Gets customer journey",
6211 "title": "Example usage:",
6212 "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
6216 "name": "getJourney",
6217 "group": "Cm_Contacts",
6218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6220 "filename": "server/api/cmContact/index.js",
6221 "groupTitle": "Cm_Contacts"
6225 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6226 "title": "Gets contact hopper blacks",
6229 "title": "Example usage:",
6230 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6234 "name": "getJscriptySessions",
6235 "group": "Cm_Contacts",
6236 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6238 "filename": "server/api/cmContact/index.js",
6239 "groupTitle": "Cm_Contacts"
6243 "url": "/api/cm/contacts/{id}/tags",
6244 "title": "Gets configurations tags",
6247 "title": "Example usage:",
6248 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6253 "group": "Cm_Contacts",
6254 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6256 "filename": "server/api/cmContact/index.js",
6257 "groupTitle": "Cm_Contacts"
6261 "url": "/api/cm/contacts/merge",
6262 "title": "Merge Contact",
6265 "title": "Example usage:",
6266 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6271 "group": "Cm_Contacts",
6272 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6274 "filename": "server/api/cmContact/index.js",
6275 "groupTitle": "Cm_Contacts"
6279 "url": "/api/cm/contacts/{id}/tags",
6280 "title": "Sets new tags",
6283 "title": "Example usage:",
6284 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6289 "group": "Cm_Contacts",
6290 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6292 "filename": "server/api/cmContact/index.js",
6293 "groupTitle": "Cm_Contacts"
6297 "url": "/api/cm/contacts/{id}",
6298 "title": "Gets a single Contact",
6301 "title": "Example usage:",
6302 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6307 "group": "Cm_Contacts",
6308 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6310 "filename": "server/api/cmContact/index.js",
6311 "groupTitle": "Cm_Contacts"
6315 "url": "/api/cm/contacts/{id}",
6316 "title": "Update a single Contact",
6319 "title": "Example usage:",
6320 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6325 "group": "Cm_Contacts",
6326 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6328 "filename": "server/api/cmContact/index.js",
6329 "groupTitle": "Cm_Contacts"
6333 "url": "/api/cm/custom_fields/{id}",
6334 "title": "Deletes a Custom Field",
6337 "title": "Example usage:",
6338 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6342 "name": "DeleteCustom_Fields",
6343 "group": "Cm_Custom_Fields",
6344 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6346 "filename": "server/api/cmCustomField/index.js",
6347 "groupTitle": "Cm_Custom_Fields"
6351 "url": "/api/cm/custom_fields",
6352 "title": "Gets a list of Custom Fields",
6355 "title": "Example usage:",
6356 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6360 "name": "GetCustom_Fields",
6361 "group": "Cm_Custom_Fields",
6362 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/custom_fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/custom_fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/custom_fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/custom_fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/custom_fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6364 "filename": "server/api/cmCustomField/index.js",
6365 "groupTitle": "Cm_Custom_Fields"
6369 "url": "/api/cm/custom_fields/{id}",
6370 "title": "Gets a single Custom Field",
6373 "title": "Example usage:",
6374 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6378 "name": "ShowCustom_Fields",
6379 "group": "Cm_Custom_Fields",
6380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6382 "filename": "server/api/cmCustomField/index.js",
6383 "groupTitle": "Cm_Custom_Fields"
6387 "url": "/api/cm/custom_fields/{id}",
6388 "title": "Update an existing Custom Field",
6391 "title": "Example usage:",
6392 "content": "curl https://{domain}/api/cm/custom_fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6396 "name": "updateCustom_Fields",
6397 "group": "Cm_Custom_Fields",
6398 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6400 "filename": "server/api/cmCustomField/index.js",
6401 "groupTitle": "Cm_Custom_Fields"
6405 "url": "/api/cm/hopper",
6406 "title": "Creates a new Hopper",
6409 "title": "Example usage:",
6410 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6414 "name": "CreateHopper",
6415 "group": "Cm_Hopper",
6437 "field": "scheduledat",
6444 "field": "countbusyretry",
6451 "field": "countcongestionretry",
6458 "field": "countnoanswerretry",
6465 "field": "callback",
6472 "field": "callbackuniqueid",
6479 "field": "callbackat",
6486 "field": "priority",
6493 "field": "recallme",
6500 "field": "ContactId",
6521 "field": "VoiceQueueId",
6528 "field": "CampaignId",
6535 "field": "countnosuchnumberretry",
6542 "field": "countdropretry",
6549 "field": "countabandonedretry",
6556 "field": "countmachineretry",
6563 "field": "countagentrejectretry",
6569 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6571 "filename": "server/api/cmHopper/index.js",
6572 "groupTitle": "Cm_Hopper"
6576 "url": "/api/cm/hopper/describe",
6577 "title": "Gets table info about Hopper",
6580 "title": "Example usage:",
6581 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6585 "name": "DescribeHopper",
6586 "group": "Cm_Hopper",
6587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6589 "filename": "server/api/cmHopper/index.js",
6590 "groupTitle": "Cm_Hopper"
6594 "url": "/api/cm/hopper",
6595 "title": "Gets a list of Hopper",
6598 "title": "Example usage:",
6599 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6603 "name": "GetHopper",
6604 "group": "Cm_Hopper",
6605 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6607 "filename": "server/api/cmHopper/index.js",
6608 "groupTitle": "Cm_Hopper"
6612 "url": "/api/cm/hopper/{id}",
6613 "title": "Gets a single Hopper",
6616 "title": "Example usage:",
6617 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6621 "name": "ShowHopper",
6622 "group": "Cm_Hopper",
6623 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6625 "filename": "server/api/cmHopper/index.js",
6626 "groupTitle": "Cm_Hopper"
6630 "url": "/api/cm/hopper_black/{id}",
6631 "title": "Deletes a Hopper Black",
6634 "title": "Example usage:",
6635 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6639 "name": "DeleteHopper_Black",
6640 "group": "Cm_Hopper_Black",
6641 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6643 "filename": "server/api/cmHopperBlack/index.js",
6644 "groupTitle": "Cm_Hopper_Black"
6648 "url": "/api/cm/hopper_black/describe",
6649 "title": "Gets table info about Hopper Black",
6652 "title": "Example usage:",
6653 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6657 "name": "DescribeHopper_Black",
6658 "group": "Cm_Hopper_Black",
6659 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6661 "filename": "server/api/cmHopperBlack/index.js",
6662 "groupTitle": "Cm_Hopper_Black"
6666 "url": "/api/cm/hopper_black",
6667 "title": "Gets a list of Hopper Black",
6670 "title": "Example usage:",
6671 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6675 "name": "GetHopper_Black",
6676 "group": "Cm_Hopper_Black",
6677 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_black?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_black?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_black?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_black?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_black?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6679 "filename": "server/api/cmHopperBlack/index.js",
6680 "groupTitle": "Cm_Hopper_Black"
6684 "url": "/api/cm/hopper_black/{id}",
6685 "title": "Gets a single Hopper Black",
6688 "title": "Example usage:",
6689 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6693 "name": "ShowHopper_Black",
6694 "group": "Cm_Hopper_Black",
6695 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6697 "filename": "server/api/cmHopperBlack/index.js",
6698 "groupTitle": "Cm_Hopper_Black"
6702 "url": "/api/cm/hopper_black/{id}",
6703 "title": "Update an existing Hopper Black",
6706 "title": "Example usage:",
6707 "content": "curl https://{domain}/api/cm/hopper_black/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6711 "name": "updateHopper_Black",
6712 "group": "Cm_Hopper_Black",
6713 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6715 "filename": "server/api/cmHopperBlack/index.js",
6716 "groupTitle": "Cm_Hopper_Black"
6720 "url": "/api/cm/hopper_final/checkContactHopper",
6721 "title": "Check if contact is in hopper",
6724 "title": "Example usage:",
6725 "content": "curl https://{domain}/api/hopper_final/checkContactHopper -d '{\"VoiceQueueId\": \"VoiceQueueId\", \"CampaignId\": \"CampaignId\", \"ContactId\": \"ContactId\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6729 "name": "/checkContactHopper",
6730 "group": "Cm_Hopper_Final",
6731 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6733 "filename": "server/api/cmHopperFinal/index.js",
6734 "groupTitle": "Cm_Hopper_Final"
6738 "url": "/api/cm/hopper_final/describe",
6739 "title": "Gets table info about HopperFinal",
6742 "title": "Example usage:",
6743 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6747 "name": "DescribeHopperFinal",
6748 "group": "Cm_Hopper_Final",
6749 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6751 "filename": "server/api/cmHopperFinal/index.js",
6752 "groupTitle": "Cm_Hopper_Final"
6756 "url": "/api/cm/hopper_final",
6757 "title": "Gets a list of HopperFinal",
6760 "title": "Example usage:",
6761 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6765 "name": "GetHopperFinal",
6766 "group": "Cm_Hopper_Final",
6767 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_final?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_final?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_final?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_final?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_final?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6769 "filename": "server/api/cmHopperFinal/index.js",
6770 "groupTitle": "Cm_Hopper_Final"
6774 "url": "/api/cm/hopper_final/{id}",
6775 "title": "Gets a single HopperFinal",
6778 "title": "Example usage:",
6779 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6783 "name": "ShowHopperFinal",
6784 "group": "Cm_Hopper_Final",
6785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6787 "filename": "server/api/cmHopperFinal/index.js",
6788 "groupTitle": "Cm_Hopper_Final"
6792 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6793 "title": "Return number contacts for attributes",
6796 "title": "Example usage:",
6797 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6801 "name": "countContactsIvrCampaignHopperFinal",
6802 "group": "Cm_Hopper_Final",
6803 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6805 "filename": "server/api/cmHopperFinal/index.js",
6806 "groupTitle": "Cm_Hopper_Final"
6810 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6811 "title": "Return number contacts for attributes",
6814 "title": "Example usage:",
6815 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6819 "name": "countContactsQueueCampaignHopperFinal",
6820 "group": "Cm_Hopper_Final",
6821 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6823 "filename": "server/api/cmHopperFinal/index.js",
6824 "groupTitle": "Cm_Hopper_Final"
6828 "url": "/api/cm/hopper_final/campaign/{id}",
6829 "title": "Move contacts in hopper",
6832 "title": "Example usage:",
6833 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6837 "name": "moveContactsIvrCampaignHopperFinal",
6838 "group": "Cm_Hopper_Final",
6839 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6841 "filename": "server/api/cmHopperFinal/index.js",
6842 "groupTitle": "Cm_Hopper_Final"
6846 "url": "/api/cm/hopper_final/voice/queue/{id}",
6847 "title": "Move contacts in hopper",
6850 "title": "Example usage:",
6851 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6855 "name": "moveContactsQueueCampaignHopperFinal",
6856 "group": "Cm_Hopper_Final",
6857 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6859 "filename": "server/api/cmHopperFinal/index.js",
6860 "groupTitle": "Cm_Hopper_Final"
6864 "url": "/api/cm/hopper_final/{id}",
6865 "title": "Update a single hopper final",
6868 "title": "Example usage:",
6869 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6874 "group": "Cm_Hopper_Final",
6875 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6877 "filename": "server/api/cmHopperFinal/index.js",
6878 "groupTitle": "Cm_Hopper_Final"
6882 "url": "/api/cm/hopper_history",
6883 "title": "Creates a new HopperHistory",
6886 "title": "Example usage:",
6887 "content": "curl https://{domain}/api/cm/hopper_history -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6891 "name": "CreateHopperHistory",
6892 "group": "Cm_Hopper_History",
6907 "field": "statedesc",
6914 "field": "scheduledat",
6921 "field": "countbusyretry",
6928 "field": "countcongestionretry",
6935 "field": "countnoanswerretry",
6942 "field": "countglobal",
6949 "field": "uniqueid",
6956 "field": "originatecalleridnum",
6963 "field": "originatecalleridname",
6970 "field": "calleridnum",
6977 "field": "calleridname",
6984 "field": "starttime",
6991 "field": "responsetime",
6998 "field": "answertime",
7005 "field": "droptime",
7019 "field": "ringtime",
7026 "field": "holdtime",
7033 "field": "talktime",
7040 "field": "followuptime",
7047 "field": "dropreason",
7054 "field": "campaign",
7061 "field": "campaigntype",
7068 "field": "membername",
7096 "field": "callback",
7103 "field": "callbackuniqueid",
7110 "field": "callbackat",
7117 "field": "recallme",
7124 "field": "editedat",
7138 "field": "countnosuchnumberretry",
7145 "field": "countdropretry",
7152 "field": "countabandonedretry",
7159 "field": "countmachineretry",
7166 "field": "countagentrejectretry",
7172 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7174 "filename": "server/api/cmHopperHistory/index.js",
7175 "groupTitle": "Cm_Hopper_History"
7179 "url": "/api/cm/hopper_history/describe",
7180 "title": "Gets table info about HopperHistory",
7183 "title": "Example usage:",
7184 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7188 "name": "DescribeHopperHistory",
7189 "group": "Cm_Hopper_History",
7190 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7192 "filename": "server/api/cmHopperHistory/index.js",
7193 "groupTitle": "Cm_Hopper_History"
7197 "url": "/api/cm/hopper_history",
7198 "title": "Gets a list of HopperHistory",
7201 "title": "Example usage:",
7202 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7206 "name": "GetHopperHistory",
7207 "group": "Cm_Hopper_History",
7208 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_history?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_history?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_history?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_history?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_history?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7210 "filename": "server/api/cmHopperHistory/index.js",
7211 "groupTitle": "Cm_Hopper_History"
7215 "url": "/api/cm/hopper_history/{id}",
7216 "title": "Gets a single HopperHistory",
7219 "title": "Example usage:",
7220 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7224 "name": "ShowHopperHistory",
7225 "group": "Cm_Hopper_History",
7226 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7228 "filename": "server/api/cmHopperHistory/index.js",
7229 "groupTitle": "Cm_Hopper_History"
7233 "url": "/api/cm/hopper_history/{id}",
7234 "title": "Update a single hopper history",
7237 "title": "Example usage:",
7238 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7243 "group": "Cm_Hopper_History",
7244 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7246 "filename": "server/api/cmHopperHistory/index.js",
7247 "groupTitle": "Cm_Hopper_History"
7251 "url": "/api/cm/hopper/{id}",
7252 "title": "Delete Hopper",
7255 "title": "Example usage:",
7256 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7261 "group": "Cm_Hopper",
7262 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7264 "filename": "server/api/cmHopper/index.js",
7265 "groupTitle": "Cm_Hopper"
7269 "url": "/api/cm/hopper/opencontacts",
7270 "title": "Gets Open Contacts",
7273 "title": "Example usage:",
7274 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7278 "name": "getOpenContacts",
7279 "group": "Cm_Hopper",
7280 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7282 "filename": "server/api/cmHopper/index.js",
7283 "groupTitle": "Cm_Hopper"
7287 "url": "/api/cm/hopper/preview",
7288 "title": "Gets Preview Dialer Contacts",
7291 "title": "Example usage:",
7292 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7296 "name": "getPreview",
7297 "group": "Cm_Hopper",
7298 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7300 "filename": "server/api/cmHopper/index.js",
7301 "groupTitle": "Cm_Hopper"
7305 "url": "/api/cm/hopper/previewrecall",
7306 "title": "Gets Preview Dialer Contacts for Recall",
7309 "title": "Example usage:",
7310 "content": "curl https://{domain}/api/cm/hopper/previewrecall -d '{\"hopperId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7314 "name": "getPreviewRecall",
7315 "group": "Cm_Hopper",
7316 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7318 "filename": "server/api/cmHopper/index.js",
7319 "groupTitle": "Cm_Hopper"
7323 "url": "/api/cm/hopper/{id}",
7324 "title": "Update an existing Hopper",
7327 "title": "Example usage:",
7328 "content": "curl https://{domain}/api/cm/hopper/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7332 "name": "updateHopper",
7333 "group": "Cm_Hopper",
7334 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7336 "filename": "server/api/cmHopper/index.js",
7337 "groupTitle": "Cm_Hopper"
7341 "url": "/api/cm/lists",
7342 "title": "Creates a new List",
7345 "title": "Example usage:",
7346 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7350 "name": "CreateLists",
7351 "group": "Cm_Lists",
7366 "field": "description",
7373 "field": "dialPrefix",
7379 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7381 "filename": "server/api/cmList/index.js",
7382 "groupTitle": "Cm_Lists"
7386 "url": "/api/cm/lists/{id}",
7387 "title": "Deletes a List",
7390 "title": "Example usage:",
7391 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7395 "name": "DeleteLists",
7396 "group": "Cm_Lists",
7397 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7399 "filename": "server/api/cmList/index.js",
7400 "groupTitle": "Cm_Lists"
7404 "url": "/api/cm/lists/describe",
7405 "title": "Gets table info about Lists",
7408 "title": "Example usage:",
7409 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7413 "name": "DescribeLists",
7414 "group": "Cm_Lists",
7415 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7417 "filename": "server/api/cmList/index.js",
7418 "groupTitle": "Cm_Lists"
7422 "url": "/api/cm/lists/{id}/users",
7423 "title": "Gets agents from list",
7426 "title": "Example usage:",
7427 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7431 "name": "GetAgents",
7432 "group": "Cm_Lists",
7433 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7435 "filename": "server/api/cmList/index.js",
7436 "groupTitle": "Cm_Lists"
7440 "url": "/api/cm/lists",
7441 "title": "Gets a list of Lists",
7444 "title": "Example usage:",
7445 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7450 "group": "Cm_Lists",
7451 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/lists?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/lists?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/lists?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/lists?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/lists?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7453 "filename": "server/api/cmList/index.js",
7454 "groupTitle": "Cm_Lists"
7458 "url": "/api/cm/lists/{id}/users",
7459 "title": "Removes agents from a list",
7462 "title": "Example usage:",
7463 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7467 "name": "RemoveAgents",
7468 "group": "Cm_Lists",
7469 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7471 "filename": "server/api/cmList/index.js",
7472 "groupTitle": "Cm_Lists"
7476 "url": "/api/cm/lists/{id}/dispositions",
7477 "title": "Removes dispositions from account",
7480 "title": "Example usage:",
7481 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7485 "name": "RemoveDispositions",
7486 "group": "Cm_Lists",
7487 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7489 "filename": "server/api/cmList/index.js",
7490 "groupTitle": "Cm_Lists"
7494 "url": "/api/cm/lists/{id}",
7495 "title": "Gets a single List",
7498 "title": "Example usage:",
7499 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7503 "name": "ShowLists",
7504 "group": "Cm_Lists",
7505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7507 "filename": "server/api/cmList/index.js",
7508 "groupTitle": "Cm_Lists"
7512 "url": "/api/cm/lists/{id}/users",
7513 "title": "Adds agents to a list",
7516 "title": "Example usage:",
7517 "content": "curl https://{domain}/api/cm/lists/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7521 "name": "addAgents",
7522 "group": "Cm_Lists",
7523 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7525 "filename": "server/api/cmList/index.js",
7526 "groupTitle": "Cm_Lists"
7530 "url": "/api/cm/lists/{id}/contacts",
7531 "title": "Creates new contacts",
7534 "title": "Example usage:",
7535 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7539 "name": "addContacts",
7540 "group": "Cm_Lists",
7548 "field": "firstName",
7555 "field": "lastName",
7569 "field": "postalCode",
7590 "field": "dateOfBirth",
7597 "field": "description",
7639 "field": "facebook",
7695 "field": "telegram",
7709 "field": "priority",
7716 "field": "scheduledat",
7722 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7724 "filename": "server/api/cmList/index.js",
7725 "groupTitle": "Cm_Lists"
7729 "url": "/api/cm/lists/{id}/fields",
7730 "title": "Creates a new custom field",
7733 "title": "Example usage:",
7734 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7738 "name": "addCustomField",
7739 "group": "Cm_Lists",
7740 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7742 "filename": "server/api/cmList/index.js",
7743 "groupTitle": "Cm_Lists"
7747 "url": "/api/cm/lists/{id}/dispositions",
7748 "title": "Creates new disposition",
7751 "title": "Example usage:",
7752 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7756 "name": "addDisposition",
7757 "group": "Cm_Lists",
7784 "field": "description",
7790 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7792 "filename": "server/api/cmList/index.js",
7793 "groupTitle": "Cm_Lists"
7797 "url": "/api/cm/lists/{id}/contacts",
7798 "title": "Gets List Contacts",
7801 "title": "Example usage:",
7802 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7806 "name": "getContacts",
7807 "group": "Cm_Lists",
7808 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7810 "filename": "server/api/cmList/index.js",
7811 "groupTitle": "Cm_Lists"
7815 "url": "/api/cm/lists/{id}/fields",
7816 "title": "Gets Custom Fields",
7819 "title": "Example usage:",
7820 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7824 "name": "getCustomFields",
7825 "group": "Cm_Lists",
7826 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7828 "filename": "server/api/cmList/index.js",
7829 "groupTitle": "Cm_Lists"
7833 "url": "/api/cm/lists/{id}/dispositions",
7834 "title": "Gets list dispositions",
7837 "title": "Example usage:",
7838 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7842 "name": "getDispositions",
7843 "group": "Cm_Lists",
7844 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7846 "filename": "server/api/cmList/index.js",
7847 "groupTitle": "Cm_Lists"
7851 "url": "/api/cm/lists/{id}/contacts/csv",
7852 "title": "Gets CSV List Contacts",
7855 "title": "Example usage:",
7856 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7861 "group": "Cm_Lists",
7862 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7864 "filename": "server/api/cmList/index.js",
7865 "groupTitle": "Cm_Lists"
7869 "url": "/api/cm/lists/{id}",
7870 "title": "Update an existing List",
7873 "title": "Example usage:",
7874 "content": "curl https://{domain}/api/cm/lists/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7878 "name": "updateLists",
7879 "group": "Cm_Lists",
7880 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7882 "filename": "server/api/cmList/index.js",
7883 "groupTitle": "Cm_Lists"
7887 "url": "/api/cm/contacts/upload/:id",
7888 "title": "Import new contacts by csv",
7891 "title": "Example usage:",
7892 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7897 "group": "Cm_contacts",
7898 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7900 "filename": "server/api/cmContact/index.js",
7901 "groupTitle": "Cm_contacts"
7905 "url": "/api/cm/contacts/upload",
7906 "title": "Upload csv",
7909 "title": "Example usage:",
7910 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7915 "group": "Cm_contacts",
7916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7918 "filename": "server/api/cmContact/index.js",
7919 "groupTitle": "Cm_contacts"
7923 "url": "/api/cm/contacts/csv",
7924 "title": "Create new contacts by csv",
7927 "title": "Example usage:",
7928 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7932 "name": "uploadCsv",
7933 "group": "Cm_contacts",
7934 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7936 "filename": "server/api/cmContact/index.js",
7937 "groupTitle": "Cm_contacts"
7941 "url": "/api/conditions/{id}",
7942 "title": "Deletes a Condition",
7945 "title": "Example usage:",
7946 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7950 "name": "DeleteConditions",
7951 "group": "Conditions",
7952 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7954 "filename": "server/api/condition/index.js",
7955 "groupTitle": "Conditions"
7959 "url": "/api/conditions/{id}",
7960 "title": "Update an existing Condition",
7963 "title": "Example usage:",
7964 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7968 "name": "updateConditions",
7969 "group": "Conditions",
7970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7972 "filename": "server/api/condition/index.js",
7973 "groupTitle": "Conditions"
7977 "url": "/api/cm/custom_field",
7978 "title": "Create a new custom field",
7981 "title": "Example usage:",
7982 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7986 "name": "CreateCustomField",
7987 "group": "Custom_Fields",
7988 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7990 "filename": "server/api/cmCustomField/index.js",
7991 "groupTitle": "Custom_Fields"
7995 "url": "/api/dashboards/items",
7996 "title": "Create dasboard item",
7999 "title": "Example usage:",
8000 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8005 "group": "Dashboard_Items",
8006 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8008 "filename": "server/api/dashboardItem/index.js",
8009 "groupTitle": "Dashboard_Items"
8013 "url": "/api/dashboards/items/{id}",
8014 "title": "Deletes a Dashboard Item",
8017 "title": "Example usage:",
8018 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8022 "name": "DeleteDashboard_Items",
8023 "group": "Dashboard_Items",
8024 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8026 "filename": "server/api/dashboardItem/index.js",
8027 "groupTitle": "Dashboard_Items"
8031 "url": "/api/dashboards/items/{id}",
8032 "title": "Gets a single Dashboard Item",
8035 "title": "Example usage:",
8036 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8040 "name": "ShowDashboard_Items",
8041 "group": "Dashboard_Items",
8042 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8044 "filename": "server/api/dashboardItem/index.js",
8045 "groupTitle": "Dashboard_Items"
8049 "url": "/api/dashboards/items/{id}",
8050 "title": "Update an existing item",
8053 "title": "Example usage:",
8054 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8059 "group": "Dashboard_Items",
8060 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8062 "filename": "server/api/dashboardItem/index.js",
8063 "groupTitle": "Dashboard_Items"
8067 "url": "/api/dashboards/clone",
8068 "title": "Clone an existing Dashboard",
8071 "title": "Example usage:",
8072 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8076 "name": "CloneDashboards",
8077 "group": "Dashboards",
8078 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8080 "filename": "server/api/dashboard/index.js",
8081 "groupTitle": "Dashboards"
8085 "url": "/api/dashboards",
8086 "title": "Creates a new Dashboard",
8089 "title": "Example usage:",
8090 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8094 "name": "CreateDashboards",
8095 "group": "Dashboards",
8110 "field": "description",
8116 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8118 "filename": "server/api/dashboard/index.js",
8119 "groupTitle": "Dashboards"
8123 "url": "/api/dashboards/{id}",
8124 "title": "Deletes a Dashboard",
8127 "title": "Example usage:",
8128 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8132 "name": "DeleteDashboards",
8133 "group": "Dashboards",
8134 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8136 "filename": "server/api/dashboard/index.js",
8137 "groupTitle": "Dashboards"
8141 "url": "/api/dashboards",
8142 "title": "Gets a list of Dashboards",
8145 "title": "Example usage:",
8146 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8150 "name": "GetDashboards",
8151 "group": "Dashboards",
8152 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/dashboards?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/dashboards?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/dashboards?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/dashboards?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/dashboards?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8154 "filename": "server/api/dashboard/index.js",
8155 "groupTitle": "Dashboards"
8159 "url": "/api/dashboards/{id}",
8160 "title": "Gets a single Dashboard",
8163 "title": "Example usage:",
8164 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8168 "name": "ShowDashboards",
8169 "group": "Dashboards",
8170 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8172 "filename": "server/api/dashboard/index.js",
8173 "groupTitle": "Dashboards"
8177 "url": "/api/dashboards/{id}/items",
8178 "title": "Creates new item",
8181 "title": "Example usage:",
8182 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8187 "group": "Dashboards",
8188 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8190 "filename": "server/api/dashboard/index.js",
8191 "groupTitle": "Dashboards"
8195 "url": "/api/dashboards/{id}/items",
8196 "title": "Gets items",
8199 "title": "Example usage:",
8200 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8205 "group": "Dashboards",
8206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8208 "filename": "server/api/dashboard/index.js",
8209 "groupTitle": "Dashboards"
8213 "url": "/api/dashboards/{id}",
8214 "title": "Update an existing Dashboard",
8217 "title": "Example usage:",
8218 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8222 "name": "updateDashboards",
8223 "group": "Dashboards",
8224 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8226 "filename": "server/api/dashboard/index.js",
8227 "groupTitle": "Dashboards"
8231 "url": "/api/integrations/desk/accounts",
8232 "title": "Creates a new Desk Account",
8235 "title": "Example usage:",
8236 "content": "curl https://{domain}/api/integrations/desk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8240 "name": "CreateDesk_Accounts",
8241 "group": "Desk_Accounts",
8256 "field": "description",
8263 "field": "username",
8270 "field": "remoteUri",
8280 "field": "authType",
8287 "field": "password",
8294 "field": "consumerKey",
8301 "field": "consumerSecret",
8315 "field": "tokenSecret",
8322 "field": "serverUrl",
8329 "\"integrationTab\"",
8339 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8341 "filename": "server/api/intDeskAccount/index.js",
8342 "groupTitle": "Desk_Accounts"
8346 "url": "/api/integrations/desk/accounts/{id}",
8347 "title": "Deletes a Desk Account",
8350 "title": "Example usage:",
8351 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8355 "name": "DeleteDesk_Accounts",
8356 "group": "Desk_Accounts",
8357 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8359 "filename": "server/api/intDeskAccount/index.js",
8360 "groupTitle": "Desk_Accounts"
8364 "url": "/api/integrations/desk/accounts",
8365 "title": "Gets a list of Desk Accounts",
8368 "title": "Example usage:",
8369 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8373 "name": "GetDesk_Accounts",
8374 "group": "Desk_Accounts",
8375 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8377 "filename": "server/api/intDeskAccount/index.js",
8378 "groupTitle": "Desk_Accounts"
8382 "url": "/api/integrations/desk/accounts/{id}",
8383 "title": "Gets a single Desk Account",
8386 "title": "Example usage:",
8387 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8391 "name": "ShowDesk_Accounts",
8392 "group": "Desk_Accounts",
8393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8395 "filename": "server/api/intDeskAccount/index.js",
8396 "groupTitle": "Desk_Accounts"
8400 "url": "/api/integrations/desk/accounts/{id}/configurations",
8401 "title": "Creates new configuration",
8404 "title": "Example usage:",
8405 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8409 "name": "addConfiguration",
8410 "group": "Desk_Accounts",
8411 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8413 "filename": "server/api/intDeskAccount/index.js",
8414 "groupTitle": "Desk_Accounts"
8418 "url": "/api/integrations/desk/accounts/{id}/configurations",
8419 "title": "Gets account configurations",
8422 "title": "Example usage:",
8423 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8427 "name": "getConfigurations",
8428 "group": "Desk_Accounts",
8429 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8431 "filename": "server/api/intDeskAccount/index.js",
8432 "groupTitle": "Desk_Accounts"
8436 "url": "/api/integrations/desk/accounts/{id}/fields",
8437 "title": "Gets account fields",
8440 "title": "Example usage:",
8441 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8445 "name": "getFields",
8446 "group": "Desk_Accounts",
8447 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8449 "filename": "server/api/intDeskAccount/index.js",
8450 "groupTitle": "Desk_Accounts"
8454 "url": "/api/integrations/desk/accounts/{id}",
8455 "title": "Update an existing Desk Account",
8458 "title": "Example usage:",
8459 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8463 "name": "updateDesk_Accounts",
8464 "group": "Desk_Accounts",
8465 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8467 "filename": "server/api/intDeskAccount/index.js",
8468 "groupTitle": "Desk_Accounts"
8472 "url": "/api/integrations/desk/configurations",
8473 "title": "Creates a new Desk Configuration",
8476 "title": "Example usage:",
8477 "content": "curl https://{domain}/api/integrations/desk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8481 "name": "CreateDesk_Configurations",
8482 "group": "Desk_Configurations",
8497 "field": "description",
8503 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8505 "filename": "server/api/intDeskConfiguration/index.js",
8506 "groupTitle": "Desk_Configurations"
8510 "url": "/api/integrations/desk/configurations/{id}",
8511 "title": "Deletes a Desk Configuration",
8514 "title": "Example usage:",
8515 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8519 "name": "DeleteDesk_Configurations",
8520 "group": "Desk_Configurations",
8521 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8523 "filename": "server/api/intDeskConfiguration/index.js",
8524 "groupTitle": "Desk_Configurations"
8528 "url": "/api/integrations/desk/configurations",
8529 "title": "Gets a list of Desk Configurations",
8532 "title": "Example usage:",
8533 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8537 "name": "GetDesk_Configurations",
8538 "group": "Desk_Configurations",
8539 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8541 "filename": "server/api/intDeskConfiguration/index.js",
8542 "groupTitle": "Desk_Configurations"
8546 "url": "/api/integrations/desk/configurations/{id}",
8547 "title": "Gets a single Desk Configuration",
8550 "title": "Example usage:",
8551 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8555 "name": "ShowDesk_Configurations",
8556 "group": "Desk_Configurations",
8557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8559 "filename": "server/api/intDeskConfiguration/index.js",
8560 "groupTitle": "Desk_Configurations"
8564 "url": "/api/integrations/desk/configurations/{id}/descriptions",
8565 "title": "Gets configurations descriptions",
8568 "title": "Example usage:",
8569 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8573 "name": "getDescriptions",
8574 "group": "Desk_Configurations",
8575 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8577 "filename": "server/api/intDeskConfiguration/index.js",
8578 "groupTitle": "Desk_Configurations"
8582 "url": "/api/integrations/desk/configurations/{id}/fields",
8583 "title": "Gets configurations fields",
8586 "title": "Example usage:",
8587 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8591 "name": "getFields",
8592 "group": "Desk_Configurations",
8593 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8595 "filename": "server/api/intDeskConfiguration/index.js",
8596 "groupTitle": "Desk_Configurations"
8600 "url": "/api/integrations/desk/configurations/{id}/subjects",
8601 "title": "Gets configurations subjects",
8604 "title": "Example usage:",
8605 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8609 "name": "getSubjects",
8610 "group": "Desk_Configurations",
8611 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8613 "filename": "server/api/intDeskConfiguration/index.js",
8614 "groupTitle": "Desk_Configurations"
8618 "url": "/api/integrations/desk/configurations/{id}/tags",
8619 "title": "Gets configurations tags",
8622 "title": "Example usage:",
8623 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8628 "group": "Desk_Configurations",
8629 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8631 "filename": "server/api/intDeskConfiguration/index.js",
8632 "groupTitle": "Desk_Configurations"
8636 "url": "/api/integrations/desk/configurations/{id}/tags",
8637 "title": "Sets new tags",
8640 "title": "Example usage:",
8641 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8646 "group": "Desk_Configurations",
8647 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8649 "filename": "server/api/intDeskConfiguration/index.js",
8650 "groupTitle": "Desk_Configurations"
8654 "url": "/api/integrations/desk/configurations/{id}",
8655 "title": "Update an existing Desk Configuration",
8658 "title": "Example usage:",
8659 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8663 "name": "updateDesk_Configurations",
8664 "group": "Desk_Configurations",
8665 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8667 "filename": "server/api/intDeskConfiguration/index.js",
8668 "groupTitle": "Desk_Configurations"
8672 "url": "/api/integrations/desk/fields",
8673 "title": "Creates a new Desk Field",
8676 "title": "Example usage:",
8677 "content": "curl https://{domain}/api/integrations/desk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8681 "name": "CreateDesk_Fields",
8682 "group": "Desk_Fields",
8692 "\"customVariable\"",
8720 "\"customVariable\""
8730 "field": "keyContent",
8744 "field": "nameField",
8751 "field": "customField",
8758 "field": "variableName",
8764 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8766 "filename": "server/api/intDeskField/index.js",
8767 "groupTitle": "Desk_Fields"
8771 "url": "/api/integrations/desk/fields/{id}",
8772 "title": "Deletes a Desk Field",
8775 "title": "Example usage:",
8776 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8780 "name": "DeleteDesk_Fields",
8781 "group": "Desk_Fields",
8782 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8784 "filename": "server/api/intDeskField/index.js",
8785 "groupTitle": "Desk_Fields"
8789 "url": "/api/integrations/desk/fields",
8790 "title": "Gets a list of Desk Fields",
8793 "title": "Example usage:",
8794 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8798 "name": "GetDesk_Fields",
8799 "group": "Desk_Fields",
8800 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8802 "filename": "server/api/intDeskField/index.js",
8803 "groupTitle": "Desk_Fields"
8807 "url": "/api/integrations/desk/fields/{id}",
8808 "title": "Gets a single Desk Field",
8811 "title": "Example usage:",
8812 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8816 "name": "ShowDesk_Fields",
8817 "group": "Desk_Fields",
8818 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8820 "filename": "server/api/intDeskField/index.js",
8821 "groupTitle": "Desk_Fields"
8825 "url": "/api/integrations/desk/fields/{id}",
8826 "title": "Update an existing Desk Field",
8829 "title": "Example usage:",
8830 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8834 "name": "updateDesk_Fields",
8835 "group": "Desk_Fields",
8836 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8838 "filename": "server/api/intDeskField/index.js",
8839 "groupTitle": "Desk_Fields"
8843 "url": "/api/dispositions",
8844 "title": "Creates a new Disposition",
8847 "title": "Example usage:",
8848 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8852 "name": "CreateDispositions",
8853 "group": "Dispositions",
8880 "field": "description",
8886 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8888 "filename": "server/api/disposition/index.js",
8889 "groupTitle": "Dispositions"
8893 "url": "/api/dispositions/{id}",
8894 "title": "Deletes a Disposition",
8897 "title": "Example usage:",
8898 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8902 "name": "DeleteDispositions",
8903 "group": "Dispositions",
8904 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8906 "filename": "server/api/disposition/index.js",
8907 "groupTitle": "Dispositions"
8911 "url": "/api/dispositions",
8912 "title": "Gets a list of Dispositions",
8915 "title": "Example usage:",
8916 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8920 "name": "GetDispositions",
8921 "group": "Dispositions",
8922 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/dispositions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/dispositions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/dispositions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/dispositions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/dispositions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8924 "filename": "server/api/disposition/index.js",
8925 "groupTitle": "Dispositions"
8929 "url": "/api/dispositions/{id}",
8930 "title": "Gets a single Disposition",
8933 "title": "Example usage:",
8934 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8938 "name": "ShowDispositions",
8939 "group": "Dispositions",
8940 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8942 "filename": "server/api/disposition/index.js",
8943 "groupTitle": "Dispositions"
8947 "url": "/api/dispositions/{id}",
8948 "title": "Update an existing Disposition",
8951 "title": "Example usage:",
8952 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8956 "name": "updateDispositions",
8957 "group": "Dispositions",
8958 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8960 "filename": "server/api/disposition/index.js",
8961 "groupTitle": "Dispositions"
8965 "url": "/api/integrations/dynamics365/accounts",
8966 "title": "Creates a new Dynamics365 Account",
8969 "title": "Example usage:",
8970 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8974 "name": "CreateDynamics365_Accounts",
8975 "group": "Dynamics365_Accounts",
8990 "field": "username",
8997 "field": "password",
9004 "field": "remoteUri",
9011 "field": "tenantId",
9018 "field": "clientId",
9025 "field": "clientSecret",
9032 "field": "serverUrl",
9039 "field": "description",
9045 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9047 "filename": "server/api/intDynamics365Account/index.js",
9048 "groupTitle": "Dynamics365_Accounts"
9052 "url": "/api/integrations/dynamics365/accounts/{id}",
9053 "title": "Deletes a Dynamics365 Account",
9056 "title": "Example usage:",
9057 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9061 "name": "DeleteDynamics365_Accounts",
9062 "group": "Dynamics365_Accounts",
9063 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9065 "filename": "server/api/intDynamics365Account/index.js",
9066 "groupTitle": "Dynamics365_Accounts"
9070 "url": "/api/integrations/dynamics365/accounts",
9071 "title": "Gets a list of Dynamics365 Accounts",
9074 "title": "Example usage:",
9075 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9079 "name": "GetDynamics365_Accounts",
9080 "group": "Dynamics365_Accounts",
9081 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9083 "filename": "server/api/intDynamics365Account/index.js",
9084 "groupTitle": "Dynamics365_Accounts"
9088 "url": "/api/integrations/dynamics365/accounts/{id}",
9089 "title": "Gets a single Dynamics365 Account",
9092 "title": "Example usage:",
9093 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9097 "name": "ShowDynamics365_Accounts",
9098 "group": "Dynamics365_Accounts",
9099 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9101 "filename": "server/api/intDynamics365Account/index.js",
9102 "groupTitle": "Dynamics365_Accounts"
9106 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9107 "title": "Creates new configuration",
9110 "title": "Example usage:",
9111 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9115 "name": "addConfiguration",
9116 "group": "Dynamics365_Accounts",
9117 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9119 "filename": "server/api/intDynamics365Account/index.js",
9120 "groupTitle": "Dynamics365_Accounts"
9124 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9125 "title": "Gets account configurations",
9128 "title": "Example usage:",
9129 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9133 "name": "getConfigurations",
9134 "group": "Dynamics365_Accounts",
9135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9137 "filename": "server/api/intDynamics365Account/index.js",
9138 "groupTitle": "Dynamics365_Accounts"
9142 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9143 "title": "Gets account fields",
9146 "title": "Example usage:",
9147 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9151 "name": "getFields",
9152 "group": "Dynamics365_Accounts",
9153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9155 "filename": "server/api/intDynamics365Account/index.js",
9156 "groupTitle": "Dynamics365_Accounts"
9160 "url": "/api/integrations/dynamics365/accounts/{id}",
9161 "title": "Update an existing Dynamics365 Account",
9164 "title": "Example usage:",
9165 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9169 "name": "updateDynamics365_Accounts",
9170 "group": "Dynamics365_Accounts",
9171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9173 "filename": "server/api/intDynamics365Account/index.js",
9174 "groupTitle": "Dynamics365_Accounts"
9178 "url": "/api/integrations/dynamics365/configurations",
9179 "title": "Creates a new Dynamics365 Configuration",
9182 "title": "Example usage:",
9183 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9187 "name": "CreateDynamics365_Configurations",
9188 "group": "Dynamics365_Configurations",
9203 "field": "description",
9214 "field": "ticketType",
9220 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9222 "filename": "server/api/intDynamics365Configuration/index.js",
9223 "groupTitle": "Dynamics365_Configurations"
9227 "url": "/api/integrations/dynamics365/configurations/{id}",
9228 "title": "Deletes a Dynamics365 Configuration",
9231 "title": "Example usage:",
9232 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9236 "name": "DeleteDynamics365_Configurations",
9237 "group": "Dynamics365_Configurations",
9238 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9240 "filename": "server/api/intDynamics365Configuration/index.js",
9241 "groupTitle": "Dynamics365_Configurations"
9245 "url": "/api/integrations/dynamics365/configurations",
9246 "title": "Gets a list of Dynamics365 Configurations",
9249 "title": "Example usage:",
9250 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9254 "name": "GetDynamics365_Configurations",
9255 "group": "Dynamics365_Configurations",
9256 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9258 "filename": "server/api/intDynamics365Configuration/index.js",
9259 "groupTitle": "Dynamics365_Configurations"
9263 "url": "/api/integrations/dynamics365/configurations/{id}",
9264 "title": "Gets a single Dynamics365 Configuration",
9267 "title": "Example usage:",
9268 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9272 "name": "ShowDynamics365_Configurations",
9273 "group": "Dynamics365_Configurations",
9274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9276 "filename": "server/api/intDynamics365Configuration/index.js",
9277 "groupTitle": "Dynamics365_Configurations"
9281 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9282 "title": "Gets configurations descriptions",
9285 "title": "Example usage:",
9286 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9290 "name": "getDescriptions",
9291 "group": "Dynamics365_Configurations",
9292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9294 "filename": "server/api/intDynamics365Configuration/index.js",
9295 "groupTitle": "Dynamics365_Configurations"
9299 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9300 "title": "Gets configurations fields",
9303 "title": "Example usage:",
9304 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9308 "name": "getFields",
9309 "group": "Dynamics365_Configurations",
9310 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9312 "filename": "server/api/intDynamics365Configuration/index.js",
9313 "groupTitle": "Dynamics365_Configurations"
9317 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9318 "title": "Gets configurations subjects",
9321 "title": "Example usage:",
9322 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9326 "name": "getSubjects",
9327 "group": "Dynamics365_Configurations",
9328 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9330 "filename": "server/api/intDynamics365Configuration/index.js",
9331 "groupTitle": "Dynamics365_Configurations"
9335 "url": "/api/integrations/dynamics365/configurations/{id}",
9336 "title": "Update an existing Dynamics365 Configuration",
9339 "title": "Example usage:",
9340 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9344 "name": "updateDynamics365_Configurations",
9345 "group": "Dynamics365_Configurations",
9346 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9348 "filename": "server/api/intDynamics365Configuration/index.js",
9349 "groupTitle": "Dynamics365_Configurations"
9353 "url": "/api/integrations/dynamics365/fields",
9354 "title": "Creates a new Dynamics365 Field",
9357 "title": "Example usage:",
9358 "content": "curl https://{domain}/api/integrations/dynamics365/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9362 "name": "CreateDynamics365_Fields",
9363 "group": "Dynamics365_Fields",
9373 "\"customVariable\"",
9401 "\"customVariable\""
9411 "field": "keyContent",
9425 "field": "nameField",
9432 "field": "customField",
9439 "field": "variableName",
9445 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9447 "filename": "server/api/intDynamics365Field/index.js",
9448 "groupTitle": "Dynamics365_Fields"
9452 "url": "/api/integrations/dynamics365/fields/{id}",
9453 "title": "Deletes a Dynamics365 Field",
9456 "title": "Example usage:",
9457 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9461 "name": "DeleteDynamics365_Fields",
9462 "group": "Dynamics365_Fields",
9463 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9465 "filename": "server/api/intDynamics365Field/index.js",
9466 "groupTitle": "Dynamics365_Fields"
9470 "url": "/api/integrations/dynamics365/fields",
9471 "title": "Gets a list of Dynamics365 Fields",
9474 "title": "Example usage:",
9475 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9479 "name": "GetDynamics365_Fields",
9480 "group": "Dynamics365_Fields",
9481 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9483 "filename": "server/api/intDynamics365Field/index.js",
9484 "groupTitle": "Dynamics365_Fields"
9488 "url": "/api/integrations/dynamics365/fields/{id}",
9489 "title": "Gets a single Dynamics365 Field",
9492 "title": "Example usage:",
9493 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9497 "name": "ShowDynamics365_Fields",
9498 "group": "Dynamics365_Fields",
9499 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9501 "filename": "server/api/intDynamics365Field/index.js",
9502 "groupTitle": "Dynamics365_Fields"
9506 "url": "/api/integrations/dynamics365/fields/{id}",
9507 "title": "Update an existing Dynamics365 Field",
9510 "title": "Example usage:",
9511 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9515 "name": "updateDynamics365_Fields",
9516 "group": "Dynamics365_Fields",
9517 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9519 "filename": "server/api/intDynamics365Field/index.js",
9520 "groupTitle": "Dynamics365_Fields"
9524 "url": "/api/fax/accounts/{id}/users",
9525 "title": "Add agents to a fax account",
9528 "title": "Example usage:",
9529 "content": "curl https://{domain}/api/fax/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9533 "name": "AddAgents",
9534 "group": "Fax_Accounts",
9535 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9537 "filename": "server/api/faxAccount/index.js",
9538 "groupTitle": "Fax_Accounts"
9542 "url": "/api/fax/accounts",
9543 "title": "Creates a new Account",
9546 "title": "Example usage:",
9547 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9551 "name": "CreateAccounts",
9552 "group": "Fax_Accounts",
9567 "field": "description",
9585 "field": "headerinfo",
9592 "field": "localstationid",
9643 "field": "faxdetect",
9650 "field": "t38timeout",
9677 "field": "notificationTemplate",
9684 "field": "notificationSound",
9691 "field": "notificationShake",
9698 "field": "waitForTheAssignedAgent",
9705 "field": "queueTransfer",
9712 "field": "queueTransferTimeout",
9719 "field": "agentTransfer",
9726 "field": "agentTransferTimeout",
9733 "field": "mandatoryDispositionPauseId",
9734 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9740 "field": "mandatoryDisposition",
9741 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9746 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9748 "filename": "server/api/faxAccount/index.js",
9749 "groupTitle": "Fax_Accounts"
9753 "url": "/api/fax/accounts/{id}",
9754 "title": "Deletes a Account",
9757 "title": "Example usage:",
9758 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9762 "name": "DeleteAccounts",
9763 "group": "Fax_Accounts",
9764 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9766 "filename": "server/api/faxAccount/index.js",
9767 "groupTitle": "Fax_Accounts"
9771 "url": "/api/fax/accounts/describe",
9772 "title": "Gets table info about Accounts",
9775 "title": "Example usage:",
9776 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9780 "name": "DescribeAccounts",
9781 "group": "Fax_Accounts",
9782 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9784 "filename": "server/api/faxAccount/index.js",
9785 "groupTitle": "Fax_Accounts"
9789 "url": "/api/fax/accounts",
9790 "title": "Gets a list of Accounts",
9793 "title": "Example usage:",
9794 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9798 "name": "GetAccounts",
9799 "group": "Fax_Accounts",
9800 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9802 "filename": "server/api/faxAccount/index.js",
9803 "groupTitle": "Fax_Accounts"
9807 "url": "/api/fax/accounts/{id}/users",
9808 "title": "Gets agents from fax account",
9811 "title": "Example usage:",
9812 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9816 "name": "GetAgents",
9817 "group": "Fax_Accounts",
9818 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9820 "filename": "server/api/faxAccount/index.js",
9821 "groupTitle": "Fax_Accounts"
9825 "url": "/api/fax/accounts/{id}/users",
9826 "title": "Removes agents from a fax account",
9829 "title": "Example usage:",
9830 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9834 "name": "RemoveAgents",
9835 "group": "Fax_Accounts",
9836 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9838 "filename": "server/api/faxAccount/index.js",
9839 "groupTitle": "Fax_Accounts"
9843 "url": "/api/fax/accounts/{id}/canned_answers",
9844 "title": "Removes canned answers from account",
9847 "title": "Example usage:",
9848 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9852 "name": "RemoveAnswers",
9853 "group": "Fax_Accounts",
9854 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9856 "filename": "server/api/faxAccount/index.js",
9857 "groupTitle": "Fax_Accounts"
9861 "url": "/api/fax/accounts/{id}/dispositions",
9862 "title": "Removes dispositions from account",
9865 "title": "Example usage:",
9866 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9870 "name": "RemoveDispositions",
9871 "group": "Fax_Accounts",
9872 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9874 "filename": "server/api/faxAccount/index.js",
9875 "groupTitle": "Fax_Accounts"
9879 "url": "/api/fax/accounts/{id}",
9880 "title": "Gets a single Account",
9883 "title": "Example usage:",
9884 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9888 "name": "ShowAccounts",
9889 "group": "Fax_Accounts",
9890 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9892 "filename": "server/api/faxAccount/index.js",
9893 "groupTitle": "Fax_Accounts"
9897 "url": "/api/fax/accounts/{id}/canned_answers",
9898 "title": "Creates new canned answer",
9901 "title": "Example usage:",
9902 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9906 "name": "addAnswer",
9907 "group": "Fax_Accounts",
9929 "field": "description",
9942 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9944 "filename": "server/api/faxAccount/index.js",
9945 "groupTitle": "Fax_Accounts"
9949 "url": "/api/fax/accounts/addaccountapplications",
9950 "title": "Creates new account and applications",
9953 "title": "Example usage:",
9954 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9958 "name": "addApplications",
9959 "group": "Fax_Accounts",
9967 "field": "priority",
9988 "field": "description",
9995 "field": "interval",
10001 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10002 "version": "0.0.0",
10003 "filename": "server/api/faxAccount/index.js",
10004 "groupTitle": "Fax_Accounts"
10008 "url": "/api/fax/accounts/{id}/applications",
10009 "title": "Creates new applications",
10012 "title": "Example usage:",
10013 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10017 "name": "addApplications",
10018 "group": "Fax_Accounts",
10026 "field": "priority",
10040 "field": "appdata",
10047 "field": "description",
10054 "field": "interval",
10060 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10061 "version": "0.0.0",
10062 "filename": "server/api/faxAccount/index.js",
10063 "groupTitle": "Fax_Accounts"
10067 "url": "/api/fax/accounts/{id}/dispositions",
10068 "title": "Creates new disposition",
10071 "title": "Example usage:",
10072 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10076 "name": "addDisposition",
10077 "group": "Fax_Accounts",
10104 "field": "description",
10110 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10111 "version": "0.0.0",
10112 "filename": "server/api/faxAccount/index.js",
10113 "groupTitle": "Fax_Accounts"
10117 "url": "/api/fax/accounts/{id}/interactions",
10118 "title": "Creates new interactions",
10121 "title": "Example usage:",
10122 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -d '[{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10126 "name": "addInteraction",
10127 "group": "Fax_Accounts",
10142 "field": "closedAt",
10149 "field": "disposition",
10156 "field": "secondDisposition",
10163 "field": "thirdDisposition",
10177 "field": "read1stAt",
10195 "field": "firstMsgDirection",
10202 "field": "lastMsgAt",
10213 "field": "lastMsgDirection",
10219 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10220 "version": "0.0.0",
10221 "filename": "server/api/faxAccount/index.js",
10222 "groupTitle": "Fax_Accounts"
10226 "url": "/api/fax/accounts/{id}/canned_answers",
10227 "title": "Gets account canned answers",
10230 "title": "Example usage:",
10231 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10235 "name": "getAnswers",
10236 "group": "Fax_Accounts",
10237 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10238 "version": "0.0.0",
10239 "filename": "server/api/faxAccount/index.js",
10240 "groupTitle": "Fax_Accounts"
10244 "url": "/api/fax/accounts/{id}/applications",
10245 "title": "Gets account pplications",
10248 "title": "Example usage:",
10249 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10253 "name": "getApplications",
10254 "group": "Fax_Accounts",
10255 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10256 "version": "0.0.0",
10257 "filename": "server/api/faxAccount/index.js",
10258 "groupTitle": "Fax_Accounts"
10262 "url": "/api/fax/accounts/{id}/dispositions",
10263 "title": "Gets account dispositions",
10266 "title": "Example usage:",
10267 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10271 "name": "getDispositions",
10272 "group": "Fax_Accounts",
10273 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10274 "version": "0.0.0",
10275 "filename": "server/api/faxAccount/index.js",
10276 "groupTitle": "Fax_Accounts"
10280 "url": "/api/fax/accounts/{id}/interactions",
10281 "title": "Gets account interactions",
10284 "title": "Example usage:",
10285 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10289 "name": "getInteraction",
10290 "group": "Fax_Accounts",
10291 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10292 "version": "0.0.0",
10293 "filename": "server/api/faxAccount/index.js",
10294 "groupTitle": "Fax_Accounts"
10298 "url": "/api/fax/accounts/{id}/messages",
10299 "title": "Gets account messages",
10302 "title": "Example usage:",
10303 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10307 "name": "getMessages",
10308 "group": "Fax_Accounts",
10309 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10310 "version": "0.0.0",
10311 "filename": "server/api/faxAccount/index.js",
10312 "groupTitle": "Fax_Accounts"
10316 "url": "/api/fax/accounts/{id}/send",
10317 "title": "Send new fax",
10320 "title": "Example usage:",
10321 "content": "curl https://{domain}/api/fax/accounts/{id}/send -d '{from: '\"John Doe\" <123456>'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10326 "group": "Fax_Accounts",
10327 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10328 "version": "0.0.0",
10329 "filename": "server/api/faxAccount/index.js",
10330 "groupTitle": "Fax_Accounts"
10334 "url": "/api/fax/accounts/{id}",
10335 "title": "Update an existing Account",
10338 "title": "Example usage:",
10339 "content": "curl https://{domain}/api/fax/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10343 "name": "updateAccounts",
10344 "group": "Fax_Accounts",
10345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10346 "version": "0.0.0",
10347 "filename": "server/api/faxAccount/index.js",
10348 "groupTitle": "Fax_Accounts"
10352 "url": "/api/fax/accounts/updateaccountapplications",
10353 "title": "Update account and applications",
10356 "title": "Example usage:",
10357 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10361 "name": "updateApplications",
10362 "group": "Fax_Accounts",
10370 "field": "priority",
10384 "field": "appdata",
10391 "field": "description",
10398 "field": "interval",
10404 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10405 "version": "0.0.0",
10406 "filename": "server/api/faxAccount/index.js",
10407 "groupTitle": "Fax_Accounts"
10411 "url": "/api/fax/applications",
10412 "title": "Creates a new Application",
10415 "title": "Example usage:",
10416 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10420 "name": "CreateApplications",
10421 "group": "Fax_Applications",
10429 "field": "priority",
10443 "field": "appdata",
10450 "field": "description",
10457 "field": "interval",
10463 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10464 "version": "0.0.0",
10465 "filename": "server/api/faxApplication/index.js",
10466 "groupTitle": "Fax_Applications"
10470 "url": "/api/fax/applications/{id}",
10471 "title": "Deletes a Application",
10474 "title": "Example usage:",
10475 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10479 "name": "DeleteApplications",
10480 "group": "Fax_Applications",
10481 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10482 "version": "0.0.0",
10483 "filename": "server/api/faxApplication/index.js",
10484 "groupTitle": "Fax_Applications"
10488 "url": "/api/fax/applications",
10489 "title": "Gets a list of Applications",
10492 "title": "Example usage:",
10493 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10497 "name": "GetApplications",
10498 "group": "Fax_Applications",
10499 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/applications?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10500 "version": "0.0.0",
10501 "filename": "server/api/faxApplication/index.js",
10502 "groupTitle": "Fax_Applications"
10506 "url": "/api/fax/applications/{id}",
10507 "title": "Gets a single Application",
10510 "title": "Example usage:",
10511 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10515 "name": "ShowApplications",
10516 "group": "Fax_Applications",
10517 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10518 "version": "0.0.0",
10519 "filename": "server/api/faxApplication/index.js",
10520 "groupTitle": "Fax_Applications"
10524 "url": "/api/fax/applications/{id}",
10525 "title": "Update an existing Application",
10528 "title": "Example usage:",
10529 "content": "curl https://{domain}/api/fax/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10533 "name": "updateApplications",
10534 "group": "Fax_Applications",
10535 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10536 "version": "0.0.0",
10537 "filename": "server/api/faxApplication/index.js",
10538 "groupTitle": "Fax_Applications"
10542 "url": "/api/fax/interactions/{id}/tags",
10543 "title": "Add tags to the interaction",
10546 "title": "Example usage:",
10547 "content": "curl https://{domain}/api/fax/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10552 "group": "Fax_Interactions",
10553 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10554 "version": "0.0.0",
10555 "filename": "server/api/faxInteraction/index.js",
10556 "groupTitle": "Fax_Interactions"
10560 "url": "/api/fax/interactions",
10561 "title": "Creates a new Interaction",
10564 "title": "Example usage:",
10565 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10569 "name": "CreateInteractions",
10570 "group": "Fax_Interactions",
10585 "field": "closedAt",
10592 "field": "disposition",
10599 "field": "secondDisposition",
10606 "field": "thirdDisposition",
10620 "field": "read1stAt",
10638 "field": "firstMsgDirection",
10645 "field": "lastMsgAt",
10656 "field": "lastMsgDirection",
10662 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10663 "version": "0.0.0",
10664 "filename": "server/api/faxInteraction/index.js",
10665 "groupTitle": "Fax_Interactions"
10669 "url": "/api/fax/interactions/{id}",
10670 "title": "Deletes a Interaction",
10673 "title": "Example usage:",
10674 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10678 "name": "DeleteInteractions",
10679 "group": "Fax_Interactions",
10680 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10681 "version": "0.0.0",
10682 "filename": "server/api/faxInteraction/index.js",
10683 "groupTitle": "Fax_Interactions"
10687 "url": "/api/fax/interactions/describe",
10688 "title": "Gets table info about Interactions",
10691 "title": "Example usage:",
10692 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10696 "name": "DescribeInteractions",
10697 "group": "Fax_Interactions",
10698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10699 "version": "0.0.0",
10700 "filename": "server/api/faxInteraction/index.js",
10701 "groupTitle": "Fax_Interactions"
10705 "url": "/api/fax/interactions",
10706 "title": "Gets a list of Interactions",
10709 "title": "Example usage:",
10710 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10714 "name": "GetInteractions",
10715 "group": "Fax_Interactions",
10716 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10717 "version": "0.0.0",
10718 "filename": "server/api/faxInteraction/index.js",
10719 "groupTitle": "Fax_Interactions"
10723 "url": "/api/fax/interactions/{id}/tags",
10724 "title": "Removes tags from interaction",
10727 "title": "Example usage:",
10728 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10732 "name": "RemoveTags",
10733 "group": "Fax_Interactions",
10734 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10735 "version": "0.0.0",
10736 "filename": "server/api/faxInteraction/index.js",
10737 "groupTitle": "Fax_Interactions"
10741 "url": "/api/fax/interactions/{id}",
10742 "title": "Gets a single Interaction",
10745 "title": "Example usage:",
10746 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10750 "name": "ShowInteractions",
10751 "group": "Fax_Interactions",
10752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10753 "version": "0.0.0",
10754 "filename": "server/api/faxInteraction/index.js",
10755 "groupTitle": "Fax_Interactions"
10759 "url": "/api/fax/interactions/{id}/messages",
10760 "title": "Creates new messages",
10763 "title": "Example usage:",
10764 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10768 "name": "addMessage",
10769 "group": "Fax_Interactions",
10795 "field": "direction",
10802 "field": "failMessage",
10815 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10816 "version": "0.0.0",
10817 "filename": "server/api/faxInteraction/index.js",
10818 "groupTitle": "Fax_Interactions"
10822 "url": "/api/fax/interactions/{id}/download",
10823 "title": "Get interactions",
10826 "title": "Example usage:",
10827 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10831 "name": "download",
10832 "group": "Fax_Interactions",
10833 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10834 "version": "0.0.0",
10835 "filename": "server/api/faxInteraction/index.js",
10836 "groupTitle": "Fax_Interactions"
10840 "url": "/api/fax/interactions/{id}/messages",
10841 "title": "Gets interaction messages",
10844 "title": "Example usage:",
10845 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10849 "name": "getMessages",
10850 "group": "Fax_Interactions",
10851 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10852 "version": "0.0.0",
10853 "filename": "server/api/faxInteraction/index.js",
10854 "groupTitle": "Fax_Interactions"
10858 "url": "/api/fax/interactions/{id}",
10859 "title": "Update an existing Interaction",
10862 "title": "Example usage:",
10863 "content": "curl https://{domain}/api/fax/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10867 "name": "updateInteractions",
10868 "group": "Fax_Interactions",
10869 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10870 "version": "0.0.0",
10871 "filename": "server/api/faxInteraction/index.js",
10872 "groupTitle": "Fax_Interactions"
10876 "url": "/api/fax/messages/{id}/download",
10877 "title": "Get message",
10880 "title": "Example usage:",
10881 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10885 "name": "download",
10886 "group": "Fax_Message",
10887 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10888 "version": "0.0.0",
10889 "filename": "server/api/faxMessage/index.js",
10890 "groupTitle": "Fax_Message"
10894 "url": "/api/fax/messages/{id}",
10895 "title": "Deletes a Message",
10898 "title": "Example usage:",
10899 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10903 "name": "DeleteMessages",
10904 "group": "Fax_Messages",
10905 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10906 "version": "0.0.0",
10907 "filename": "server/api/faxMessage/index.js",
10908 "groupTitle": "Fax_Messages"
10912 "url": "/api/fax/messages/describe",
10913 "title": "Gets table info about Messages",
10916 "title": "Example usage:",
10917 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10921 "name": "DescribeMessages",
10922 "group": "Fax_Messages",
10923 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10924 "version": "0.0.0",
10925 "filename": "server/api/faxMessage/index.js",
10926 "groupTitle": "Fax_Messages"
10930 "url": "/api/fax/messages",
10931 "title": "Gets a list of Messages",
10934 "title": "Example usage:",
10935 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10939 "name": "GetMessages",
10940 "group": "Fax_Messages",
10941 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10942 "version": "0.0.0",
10943 "filename": "server/api/faxMessage/index.js",
10944 "groupTitle": "Fax_Messages"
10948 "url": "/api/fax/messages/{id}",
10949 "title": "Gets a single Message",
10952 "title": "Example usage:",
10953 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10957 "name": "ShowMessages",
10958 "group": "Fax_Messages",
10959 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10960 "version": "0.0.0",
10961 "filename": "server/api/faxMessage/index.js",
10962 "groupTitle": "Fax_Messages"
10966 "url": "/api/fax/messages/{id}/accept",
10967 "title": "Accepts message",
10970 "title": "Example usage:",
10971 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10975 "name": "acceptMessage",
10976 "group": "Fax_Messages",
10977 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10978 "version": "0.0.0",
10979 "filename": "server/api/faxMessage/index.js",
10980 "groupTitle": "Fax_Messages"
10984 "url": "/api/fax/messages/{id}/reject",
10985 "title": "Rejects message",
10988 "title": "Example usage:",
10989 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10993 "name": "rejectMessage",
10994 "group": "Fax_Messages",
10995 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10996 "version": "0.0.0",
10997 "filename": "server/api/faxMessage/index.js",
10998 "groupTitle": "Fax_Messages"
11002 "url": "/api/fax/messages",
11003 "title": "Create message and send Fax",
11006 "title": "Example usage:",
11007 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11011 "name": "rejectMessage",
11012 "group": "Fax_Messages",
11013 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11014 "version": "0.0.0",
11015 "filename": "server/api/faxMessage/index.js",
11016 "groupTitle": "Fax_Messages"
11020 "url": "/api/fax/messages/{id}",
11021 "title": "Update an existing Message",
11024 "title": "Example usage:",
11025 "content": "curl https://{domain}/api/fax/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11029 "name": "updateMessages",
11030 "group": "Fax_Messages",
11031 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11032 "version": "0.0.0",
11033 "filename": "server/api/faxMessage/index.js",
11034 "groupTitle": "Fax_Messages"
11038 "url": "/api/fax/reports/queue",
11039 "title": "Creates a new Fax Queue Report",
11042 "title": "Example usage:",
11043 "content": "curl https://{domain}/api/fax/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11047 "name": "CreateFax_Queue_Reports",
11048 "group": "Fax_Queue_Reports",
11056 "field": "uniqueid",
11077 "field": "leaveAt",
11084 "field": "acceptAt",
11104 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11105 "version": "0.0.0",
11106 "filename": "server/api/faxQueueReport/index.js",
11107 "groupTitle": "Fax_Queue_Reports"
11111 "url": "/api/fax/reports/queue/{id}",
11112 "title": "Deletes a Fax Queue Report",
11115 "title": "Example usage:",
11116 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11120 "name": "DeleteFax_Queue_Reports",
11121 "group": "Fax_Queue_Reports",
11122 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11123 "version": "0.0.0",
11124 "filename": "server/api/faxQueueReport/index.js",
11125 "groupTitle": "Fax_Queue_Reports"
11129 "url": "/api/fax/reports/queue/describe",
11130 "title": "Gets table info about Fax Queue Reports",
11133 "title": "Example usage:",
11134 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11138 "name": "DescribeFax_Queue_Reports",
11139 "group": "Fax_Queue_Reports",
11140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11141 "version": "0.0.0",
11142 "filename": "server/api/faxQueueReport/index.js",
11143 "groupTitle": "Fax_Queue_Reports"
11147 "url": "/api/fax/reports/queue",
11148 "title": "Gets a list of Fax Queue Reports",
11151 "title": "Example usage:",
11152 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11156 "name": "GetFax_Queue_Reports",
11157 "group": "Fax_Queue_Reports",
11158 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11159 "version": "0.0.0",
11160 "filename": "server/api/faxQueueReport/index.js",
11161 "groupTitle": "Fax_Queue_Reports"
11165 "url": "/api/fax/reports/queue/{id}",
11166 "title": "Gets a single Fax Queue Report",
11169 "title": "Example usage:",
11170 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11174 "name": "ShowFax_Queue_Reports",
11175 "group": "Fax_Queue_Reports",
11176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11177 "version": "0.0.0",
11178 "filename": "server/api/faxQueueReport/index.js",
11179 "groupTitle": "Fax_Queue_Reports"
11183 "url": "/api/fax/reports/queue/{id}",
11184 "title": "Update an existing Fax Queue Report",
11187 "title": "Example usage:",
11188 "content": "curl https://{domain}/api/fax/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11192 "name": "updateFax_Queue_Reports",
11193 "group": "Fax_Queue_Reports",
11194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11195 "version": "0.0.0",
11196 "filename": "server/api/faxQueueReport/index.js",
11197 "groupTitle": "Fax_Queue_Reports"
11201 "url": "/api/fax/queues/{id}/users",
11202 "title": "Add agents to a queue",
11205 "title": "Example usage:",
11206 "content": "curl https://{domain}/api/fax/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11210 "name": "AddAgents",
11211 "group": "Fax_Queues",
11212 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11213 "version": "0.0.0",
11214 "filename": "server/api/faxQueue/index.js",
11215 "groupTitle": "Fax_Queues"
11219 "url": "/api/fax/queues/{id}/teams",
11220 "title": "Add teams to a queue",
11223 "title": "Example usage:",
11224 "content": "curl https://{domain}/api/fax/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11228 "name": "AddTeams",
11229 "group": "Fax_Queues",
11230 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11231 "version": "0.0.0",
11232 "filename": "server/api/faxQueue/index.js",
11233 "groupTitle": "Fax_Queues"
11237 "url": "/api/fax/queues",
11238 "title": "Creates a new Queue",
11241 "title": "Example usage:",
11242 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11246 "name": "CreateQueues",
11247 "group": "Fax_Queues",
11262 "field": "description",
11269 "field": "timeout",
11281 "field": "strategy",
11288 "field": "lastAgent",
11294 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11295 "version": "0.0.0",
11296 "filename": "server/api/faxQueue/index.js",
11297 "groupTitle": "Fax_Queues"
11301 "url": "/api/fax/queues/{id}",
11302 "title": "Deletes a Queue",
11305 "title": "Example usage:",
11306 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11310 "name": "DeleteQueues",
11311 "group": "Fax_Queues",
11312 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11313 "version": "0.0.0",
11314 "filename": "server/api/faxQueue/index.js",
11315 "groupTitle": "Fax_Queues"
11319 "url": "/api/fax/queues/describe",
11320 "title": "Gets table info about Queues",
11323 "title": "Example usage:",
11324 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11328 "name": "DescribeQueues",
11329 "group": "Fax_Queues",
11330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11331 "version": "0.0.0",
11332 "filename": "server/api/faxQueue/index.js",
11333 "groupTitle": "Fax_Queues"
11337 "url": "/api/fax/queues/{id}/users",
11338 "title": "Gets queue agents",
11341 "title": "Example usage:",
11342 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11346 "name": "GetAgents",
11347 "group": "Fax_Queues",
11348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11349 "version": "0.0.0",
11350 "filename": "server/api/faxQueue/index.js",
11351 "groupTitle": "Fax_Queues"
11355 "url": "/api/fax/queues/{id}/members",
11356 "title": "GetMembers",
11359 "title": "Example usage:",
11360 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11364 "name": "GetMembers",
11365 "group": "Fax_Queues",
11366 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11367 "version": "0.0.0",
11368 "filename": "server/api/faxQueue/index.js",
11369 "groupTitle": "Fax_Queues"
11373 "url": "/api/fax/queues",
11374 "title": "Gets a list of Queues",
11377 "title": "Example usage:",
11378 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11382 "name": "GetQueues",
11383 "group": "Fax_Queues",
11384 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11385 "version": "0.0.0",
11386 "filename": "server/api/faxQueue/index.js",
11387 "groupTitle": "Fax_Queues"
11391 "url": "/api/fax/queues/{id}/teams",
11392 "title": "Gets queues list",
11395 "title": "Example usage:",
11396 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11400 "name": "GetTeams",
11401 "group": "Fax_Queues",
11402 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11403 "version": "0.0.0",
11404 "filename": "server/api/faxQueue/index.js",
11405 "groupTitle": "Fax_Queues"
11409 "url": "/api/fax/queues/{id}/users",
11410 "title": "Removes agents from a queue",
11413 "title": "Example usage:",
11414 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11418 "name": "RemoveAgents",
11419 "group": "Fax_Queues",
11420 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11421 "version": "0.0.0",
11422 "filename": "server/api/faxQueue/index.js",
11423 "groupTitle": "Fax_Queues"
11427 "url": "/api/fax/queues/{id}",
11428 "title": "Gets a single Queue",
11431 "title": "Example usage:",
11432 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11436 "name": "ShowQueues",
11437 "group": "Fax_Queues",
11438 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11439 "version": "0.0.0",
11440 "filename": "server/api/faxQueue/index.js",
11441 "groupTitle": "Fax_Queues"
11445 "url": "/api/fax/queues/{id}",
11446 "title": "Update an existing Queue",
11449 "title": "Example usage:",
11450 "content": "curl https://{domain}/api/fax/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11454 "name": "updateQueues",
11455 "group": "Fax_Queues",
11456 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11457 "version": "0.0.0",
11458 "filename": "server/api/faxQueue/index.js",
11459 "groupTitle": "Fax_Queues"
11463 "url": "/api/fax/reports/transfer",
11464 "title": "Creates a new Fax Transfer Report",
11467 "title": "Example usage:",
11468 "content": "curl https://{domain}/api/fax/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11472 "name": "CreateFax_Transfer_Reports",
11473 "group": "Fax_Transfer_Reports",
11481 "field": "uniqueid",
11500 "field": "transferredAt",
11506 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11507 "version": "0.0.0",
11508 "filename": "server/api/faxTransferReport/index.js",
11509 "groupTitle": "Fax_Transfer_Reports"
11513 "url": "/api/fax/reports/transfer/{id}",
11514 "title": "Deletes a Fax Transfer Report",
11517 "title": "Example usage:",
11518 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11522 "name": "DeleteFax_Transfer_Reports",
11523 "group": "Fax_Transfer_Reports",
11524 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11525 "version": "0.0.0",
11526 "filename": "server/api/faxTransferReport/index.js",
11527 "groupTitle": "Fax_Transfer_Reports"
11531 "url": "/api/fax/reports/transfer/describe",
11532 "title": "Gets table info about Fax Transfer Reports",
11535 "title": "Example usage:",
11536 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11540 "name": "DescribeFax_Transfer_Reports",
11541 "group": "Fax_Transfer_Reports",
11542 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11543 "version": "0.0.0",
11544 "filename": "server/api/faxTransferReport/index.js",
11545 "groupTitle": "Fax_Transfer_Reports"
11549 "url": "/api/fax/reports/transfer",
11550 "title": "Gets a list of Fax Transfer Reports",
11553 "title": "Example usage:",
11554 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11558 "name": "GetFax_Transfer_Reports",
11559 "group": "Fax_Transfer_Reports",
11560 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11561 "version": "0.0.0",
11562 "filename": "server/api/faxTransferReport/index.js",
11563 "groupTitle": "Fax_Transfer_Reports"
11567 "url": "/api/fax/reports/transfer/{id}",
11568 "title": "Gets a single Fax Transfer Report",
11571 "title": "Example usage:",
11572 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11576 "name": "ShowFax_Transfer_Reports",
11577 "group": "Fax_Transfer_Reports",
11578 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11579 "version": "0.0.0",
11580 "filename": "server/api/faxTransferReport/index.js",
11581 "groupTitle": "Fax_Transfer_Reports"
11585 "url": "/api/fax/reports/transfer/{id}",
11586 "title": "Update an existing Fax Transfer Report",
11589 "title": "Example usage:",
11590 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11594 "name": "updateFax_Transfer_Reports",
11595 "group": "Fax_Transfer_Reports",
11596 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11597 "version": "0.0.0",
11598 "filename": "server/api/faxTransferReport/index.js",
11599 "groupTitle": "Fax_Transfer_Reports"
11603 "url": "/api/integrations/freshdesk/accounts",
11604 "title": "Creates a new Freshdesk Account",
11607 "title": "Example usage:",
11608 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11612 "name": "CreateFreshdesk_Accounts",
11613 "group": "Freshdesk_Accounts",
11628 "field": "description",
11635 "field": "username",
11649 "field": "remoteUri",
11656 "field": "serverUrl",
11662 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11663 "version": "0.0.0",
11664 "filename": "server/api/intFreshdeskAccount/index.js",
11665 "groupTitle": "Freshdesk_Accounts"
11669 "url": "/api/integrations/freshdesk/accounts/{id}",
11670 "title": "Deletes a Freshdesk Account",
11673 "title": "Example usage:",
11674 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11678 "name": "DeleteFreshdesk_Accounts",
11679 "group": "Freshdesk_Accounts",
11680 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11681 "version": "0.0.0",
11682 "filename": "server/api/intFreshdeskAccount/index.js",
11683 "groupTitle": "Freshdesk_Accounts"
11687 "url": "/api/integrations/freshdesk/accounts",
11688 "title": "Gets a list of Freshdesk Accounts",
11691 "title": "Example usage:",
11692 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11696 "name": "GetFreshdesk_Accounts",
11697 "group": "Freshdesk_Accounts",
11698 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11699 "version": "0.0.0",
11700 "filename": "server/api/intFreshdeskAccount/index.js",
11701 "groupTitle": "Freshdesk_Accounts"
11705 "url": "/api/integrations/freshdesk/accounts/{id}",
11706 "title": "Gets a single Freshdesk Account",
11709 "title": "Example usage:",
11710 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11714 "name": "ShowFreshdesk_Accounts",
11715 "group": "Freshdesk_Accounts",
11716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11717 "version": "0.0.0",
11718 "filename": "server/api/intFreshdeskAccount/index.js",
11719 "groupTitle": "Freshdesk_Accounts"
11723 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11724 "title": "Creates new configuration",
11727 "title": "Example usage:",
11728 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11732 "name": "addConfiguration",
11733 "group": "Freshdesk_Accounts",
11734 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11735 "version": "0.0.0",
11736 "filename": "server/api/intFreshdeskAccount/index.js",
11737 "groupTitle": "Freshdesk_Accounts"
11741 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11742 "title": "Gets account configurations",
11745 "title": "Example usage:",
11746 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11750 "name": "getConfigurations",
11751 "group": "Freshdesk_Accounts",
11752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11753 "version": "0.0.0",
11754 "filename": "server/api/intFreshdeskAccount/index.js",
11755 "groupTitle": "Freshdesk_Accounts"
11759 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11760 "title": "Gets account fields",
11763 "title": "Example usage:",
11764 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11768 "name": "getFields",
11769 "group": "Freshdesk_Accounts",
11770 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11771 "version": "0.0.0",
11772 "filename": "server/api/intFreshdeskAccount/index.js",
11773 "groupTitle": "Freshdesk_Accounts"
11777 "url": "/api/integrations/freshdesk/accounts/{id}",
11778 "title": "Update an existing Freshdesk Account",
11781 "title": "Example usage:",
11782 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11786 "name": "updateFreshdesk_Accounts",
11787 "group": "Freshdesk_Accounts",
11788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11789 "version": "0.0.0",
11790 "filename": "server/api/intFreshdeskAccount/index.js",
11791 "groupTitle": "Freshdesk_Accounts"
11795 "url": "/api/integrations/freshdesk/configurations",
11796 "title": "Creates a new Freshdesk Configuration",
11799 "title": "Example usage:",
11800 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11804 "name": "CreateFreshdesk_Configurations",
11805 "group": "Freshdesk_Configurations",
11820 "field": "description",
11826 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11827 "version": "0.0.0",
11828 "filename": "server/api/intFreshdeskConfiguration/index.js",
11829 "groupTitle": "Freshdesk_Configurations"
11833 "url": "/api/integrations/freshdesk/configurations/{id}",
11834 "title": "Deletes a Freshdesk Configuration",
11837 "title": "Example usage:",
11838 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11842 "name": "DeleteFreshdesk_Configurations",
11843 "group": "Freshdesk_Configurations",
11844 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11845 "version": "0.0.0",
11846 "filename": "server/api/intFreshdeskConfiguration/index.js",
11847 "groupTitle": "Freshdesk_Configurations"
11851 "url": "/api/integrations/freshdesk/configurations",
11852 "title": "Gets a list of Freshdesk Configurations",
11855 "title": "Example usage:",
11856 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11860 "name": "GetFreshdesk_Configurations",
11861 "group": "Freshdesk_Configurations",
11862 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11863 "version": "0.0.0",
11864 "filename": "server/api/intFreshdeskConfiguration/index.js",
11865 "groupTitle": "Freshdesk_Configurations"
11869 "url": "/api/integrations/freshdesk/configurations/{id}",
11870 "title": "Gets a single Freshdesk Configuration",
11873 "title": "Example usage:",
11874 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11878 "name": "ShowFreshdesk_Configurations",
11879 "group": "Freshdesk_Configurations",
11880 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11881 "version": "0.0.0",
11882 "filename": "server/api/intFreshdeskConfiguration/index.js",
11883 "groupTitle": "Freshdesk_Configurations"
11887 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11888 "title": "Gets configurations descriptions",
11891 "title": "Example usage:",
11892 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11896 "name": "getDescriptions",
11897 "group": "Freshdesk_Configurations",
11898 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11899 "version": "0.0.0",
11900 "filename": "server/api/intFreshdeskConfiguration/index.js",
11901 "groupTitle": "Freshdesk_Configurations"
11905 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11906 "title": "Gets configurations fields",
11909 "title": "Example usage:",
11910 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11914 "name": "getFields",
11915 "group": "Freshdesk_Configurations",
11916 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11917 "version": "0.0.0",
11918 "filename": "server/api/intFreshdeskConfiguration/index.js",
11919 "groupTitle": "Freshdesk_Configurations"
11923 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11924 "title": "Gets configurations subjects",
11927 "title": "Example usage:",
11928 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11932 "name": "getSubjects",
11933 "group": "Freshdesk_Configurations",
11934 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11935 "version": "0.0.0",
11936 "filename": "server/api/intFreshdeskConfiguration/index.js",
11937 "groupTitle": "Freshdesk_Configurations"
11941 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11942 "title": "Gets configurations tags",
11945 "title": "Example usage:",
11946 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11951 "group": "Freshdesk_Configurations",
11952 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11953 "version": "0.0.0",
11954 "filename": "server/api/intFreshdeskConfiguration/index.js",
11955 "groupTitle": "Freshdesk_Configurations"
11959 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11960 "title": "Sets new tags",
11963 "title": "Example usage:",
11964 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11969 "group": "Freshdesk_Configurations",
11970 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11971 "version": "0.0.0",
11972 "filename": "server/api/intFreshdeskConfiguration/index.js",
11973 "groupTitle": "Freshdesk_Configurations"
11977 "url": "/api/integrations/freshdesk/configurations/{id}",
11978 "title": "Update an existing Freshdesk Configuration",
11981 "title": "Example usage:",
11982 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11986 "name": "updateFreshdesk_Configurations",
11987 "group": "Freshdesk_Configurations",
11988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11989 "version": "0.0.0",
11990 "filename": "server/api/intFreshdeskConfiguration/index.js",
11991 "groupTitle": "Freshdesk_Configurations"
11995 "url": "/api/integrations/freshdesk/fields",
11996 "title": "Creates a new Freshdesk Field",
11999 "title": "Example usage:",
12000 "content": "curl https://{domain}/api/integrations/freshdesk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12004 "name": "CreateFreshdesk_Fields",
12005 "group": "Freshdesk_Fields",
12015 "\"customVariable\"",
12027 "field": "content",
12043 "\"customVariable\""
12046 "field": "keyType",
12053 "field": "keyContent",
12060 "field": "idField",
12067 "field": "nameField",
12074 "field": "customField",
12081 "field": "variableName",
12087 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12088 "version": "0.0.0",
12089 "filename": "server/api/intFreshdeskField/index.js",
12090 "groupTitle": "Freshdesk_Fields"
12094 "url": "/api/integrations/freshdesk/fields/{id}",
12095 "title": "Deletes a Freshdesk Field",
12098 "title": "Example usage:",
12099 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12103 "name": "DeleteFreshdesk_Fields",
12104 "group": "Freshdesk_Fields",
12105 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12106 "version": "0.0.0",
12107 "filename": "server/api/intFreshdeskField/index.js",
12108 "groupTitle": "Freshdesk_Fields"
12112 "url": "/api/integrations/freshdesk/fields",
12113 "title": "Gets a list of Freshdesk Fields",
12116 "title": "Example usage:",
12117 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12121 "name": "GetFreshdesk_Fields",
12122 "group": "Freshdesk_Fields",
12123 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12124 "version": "0.0.0",
12125 "filename": "server/api/intFreshdeskField/index.js",
12126 "groupTitle": "Freshdesk_Fields"
12130 "url": "/api/integrations/freshdesk/fields/{id}",
12131 "title": "Gets a single Freshdesk Field",
12134 "title": "Example usage:",
12135 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12139 "name": "ShowFreshdesk_Fields",
12140 "group": "Freshdesk_Fields",
12141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12142 "version": "0.0.0",
12143 "filename": "server/api/intFreshdeskField/index.js",
12144 "groupTitle": "Freshdesk_Fields"
12148 "url": "/api/integrations/freshdesk/fields/{id}",
12149 "title": "Update an existing Freshdesk Field",
12152 "title": "Example usage:",
12153 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12157 "name": "updateFreshdesk_Fields",
12158 "group": "Freshdesk_Fields",
12159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12160 "version": "0.0.0",
12161 "filename": "server/api/intFreshdeskField/index.js",
12162 "groupTitle": "Freshdesk_Fields"
12166 "url": "/api/integrations/freshsales/accounts",
12167 "title": "Creates a new Freshsales Account",
12170 "title": "Example usage:",
12171 "content": "curl https://{domain}/api/integrations/freshsales/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12175 "name": "CreateFreshsales_Accounts",
12176 "group": "Freshsales_Accounts",
12191 "field": "description",
12198 "field": "username",
12212 "field": "remoteUri",
12219 "field": "serverUrl",
12225 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12226 "version": "0.0.0",
12227 "filename": "server/api/intFreshsalesAccount/index.js",
12228 "groupTitle": "Freshsales_Accounts"
12232 "url": "/api/integrations/freshsales/accounts/{id}",
12233 "title": "Deletes a Freshsales Account",
12236 "title": "Example usage:",
12237 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12241 "name": "DeleteFreshsales_Accounts",
12242 "group": "Freshsales_Accounts",
12243 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12244 "version": "0.0.0",
12245 "filename": "server/api/intFreshsalesAccount/index.js",
12246 "groupTitle": "Freshsales_Accounts"
12250 "url": "/api/integrations/freshsales/accounts",
12251 "title": "Gets a list of Freshsales Accounts",
12254 "title": "Example usage:",
12255 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12259 "name": "GetFreshsales_Accounts",
12260 "group": "Freshsales_Accounts",
12261 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12262 "version": "0.0.0",
12263 "filename": "server/api/intFreshsalesAccount/index.js",
12264 "groupTitle": "Freshsales_Accounts"
12268 "url": "/api/integrations/freshsales/accounts/{id}",
12269 "title": "Gets a single Freshsales Account",
12272 "title": "Example usage:",
12273 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12277 "name": "ShowFreshsales_Accounts",
12278 "group": "Freshsales_Accounts",
12279 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12280 "version": "0.0.0",
12281 "filename": "server/api/intFreshsalesAccount/index.js",
12282 "groupTitle": "Freshsales_Accounts"
12286 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12287 "title": "Creates new configuration",
12290 "title": "Example usage:",
12291 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12295 "name": "addConfiguration",
12296 "group": "Freshsales_Accounts",
12297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12298 "version": "0.0.0",
12299 "filename": "server/api/intFreshsalesAccount/index.js",
12300 "groupTitle": "Freshsales_Accounts"
12304 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12305 "title": "Gets account configurations",
12308 "title": "Example usage:",
12309 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12313 "name": "getConfigurations",
12314 "group": "Freshsales_Accounts",
12315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12316 "version": "0.0.0",
12317 "filename": "server/api/intFreshsalesAccount/index.js",
12318 "groupTitle": "Freshsales_Accounts"
12322 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12323 "title": "Gets account fields",
12326 "title": "Example usage:",
12327 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12331 "name": "getFields",
12332 "group": "Freshsales_Accounts",
12333 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12334 "version": "0.0.0",
12335 "filename": "server/api/intFreshsalesAccount/index.js",
12336 "groupTitle": "Freshsales_Accounts"
12340 "url": "/api/integrations/freshsales/accounts/{id}",
12341 "title": "Update an existing Freshsales Account",
12344 "title": "Example usage:",
12345 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12349 "name": "updateFreshsales_Accounts",
12350 "group": "Freshsales_Accounts",
12351 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12352 "version": "0.0.0",
12353 "filename": "server/api/intFreshsalesAccount/index.js",
12354 "groupTitle": "Freshsales_Accounts"
12358 "url": "/api/integrations/freshsales/configurations",
12359 "title": "Creates a new Freshsales Configuration",
12362 "title": "Example usage:",
12363 "content": "curl https://{domain}/api/integrations/freshsales/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12367 "name": "CreateFreshsales_Configurations",
12368 "group": "Freshsales_Configurations",
12383 "field": "description",
12389 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12390 "version": "0.0.0",
12391 "filename": "server/api/intFreshsalesConfiguration/index.js",
12392 "groupTitle": "Freshsales_Configurations"
12396 "url": "/api/integrations/freshsales/configurations/{id}",
12397 "title": "Deletes a Freshsales Configuration",
12400 "title": "Example usage:",
12401 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12405 "name": "DeleteFreshsales_Configurations",
12406 "group": "Freshsales_Configurations",
12407 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12408 "version": "0.0.0",
12409 "filename": "server/api/intFreshsalesConfiguration/index.js",
12410 "groupTitle": "Freshsales_Configurations"
12414 "url": "/api/integrations/freshsales/configurations",
12415 "title": "Gets a list of Freshsales Configurations",
12418 "title": "Example usage:",
12419 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12423 "name": "GetFreshsales_Configurations",
12424 "group": "Freshsales_Configurations",
12425 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12426 "version": "0.0.0",
12427 "filename": "server/api/intFreshsalesConfiguration/index.js",
12428 "groupTitle": "Freshsales_Configurations"
12432 "url": "/api/integrations/freshsales/configurations/{id}",
12433 "title": "Gets a single Freshsales Configuration",
12436 "title": "Example usage:",
12437 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12441 "name": "ShowFreshsales_Configurations",
12442 "group": "Freshsales_Configurations",
12443 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12444 "version": "0.0.0",
12445 "filename": "server/api/intFreshsalesConfiguration/index.js",
12446 "groupTitle": "Freshsales_Configurations"
12450 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12451 "title": "Gets configurations descriptions",
12454 "title": "Example usage:",
12455 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12459 "name": "getDescriptions",
12460 "group": "Freshsales_Configurations",
12461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12462 "version": "0.0.0",
12463 "filename": "server/api/intFreshsalesConfiguration/index.js",
12464 "groupTitle": "Freshsales_Configurations"
12468 "url": "/api/integrations/freshsales/configurations/{id}/fields",
12469 "title": "Gets configurations fields",
12472 "title": "Example usage:",
12473 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12477 "name": "getFields",
12478 "group": "Freshsales_Configurations",
12479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12480 "version": "0.0.0",
12481 "filename": "server/api/intFreshsalesConfiguration/index.js",
12482 "groupTitle": "Freshsales_Configurations"
12486 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12487 "title": "Gets configurations subjects",
12490 "title": "Example usage:",
12491 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12495 "name": "getSubjects",
12496 "group": "Freshsales_Configurations",
12497 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12498 "version": "0.0.0",
12499 "filename": "server/api/intFreshsalesConfiguration/index.js",
12500 "groupTitle": "Freshsales_Configurations"
12504 "url": "/api/integrations/freshsales/configurations/{id}",
12505 "title": "Update an existing Freshsales Configuration",
12508 "title": "Example usage:",
12509 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12513 "name": "updateFreshsales_Configurations",
12514 "group": "Freshsales_Configurations",
12515 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12516 "version": "0.0.0",
12517 "filename": "server/api/intFreshsalesConfiguration/index.js",
12518 "groupTitle": "Freshsales_Configurations"
12522 "url": "/api/integrations/freshsales/fields",
12523 "title": "Creates a new Freshsales Field",
12526 "title": "Example usage:",
12527 "content": "curl https://{domain}/api/integrations/freshsales/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12531 "name": "CreateFreshsales_Fields",
12532 "group": "Freshsales_Fields",
12542 "\"customVariable\"",
12554 "field": "content",
12570 "\"customVariable\""
12573 "field": "keyType",
12580 "field": "keyContent",
12587 "field": "idField",
12594 "field": "nameField",
12601 "field": "customField",
12608 "field": "variableName",
12614 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12615 "version": "0.0.0",
12616 "filename": "server/api/intFreshsalesField/index.js",
12617 "groupTitle": "Freshsales_Fields"
12621 "url": "/api/integrations/freshsales/fields/{id}",
12622 "title": "Deletes a Freshsales Field",
12625 "title": "Example usage:",
12626 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12630 "name": "DeleteFreshsales_Fields",
12631 "group": "Freshsales_Fields",
12632 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12633 "version": "0.0.0",
12634 "filename": "server/api/intFreshsalesField/index.js",
12635 "groupTitle": "Freshsales_Fields"
12639 "url": "/api/integrations/freshsales/fields",
12640 "title": "Gets a list of Freshsales Fields",
12643 "title": "Example usage:",
12644 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12648 "name": "GetFreshsales_Fields",
12649 "group": "Freshsales_Fields",
12650 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12651 "version": "0.0.0",
12652 "filename": "server/api/intFreshsalesField/index.js",
12653 "groupTitle": "Freshsales_Fields"
12657 "url": "/api/integrations/freshsales/fields/{id}",
12658 "title": "Gets a single Freshsales Field",
12661 "title": "Example usage:",
12662 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12666 "name": "ShowFreshsales_Fields",
12667 "group": "Freshsales_Fields",
12668 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12669 "version": "0.0.0",
12670 "filename": "server/api/intFreshsalesField/index.js",
12671 "groupTitle": "Freshsales_Fields"
12675 "url": "/api/integrations/freshsales/fields/{id}",
12676 "title": "Update an existing Freshsales Field",
12679 "title": "Example usage:",
12680 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12684 "name": "updateFreshsales_Fields",
12685 "group": "Freshsales_Fields",
12686 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12687 "version": "0.0.0",
12688 "filename": "server/api/intFreshsalesField/index.js",
12689 "groupTitle": "Freshsales_Fields"
12693 "url": "/api/campaigns/{id}/blacklists",
12694 "title": "Add blacklists to an IVR campaign",
12697 "title": "Example usage:",
12698 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12702 "name": "AddBlackLists",
12703 "group": "IVR_Campaigns",
12704 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12705 "version": "0.0.0",
12706 "filename": "server/api/campaign/index.js",
12707 "groupTitle": "IVR_Campaigns"
12711 "url": "/api/campaigns/{id}/lists",
12712 "title": "Add lists to an IVR campaign",
12715 "title": "Example usage:",
12716 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12720 "name": "AddLists",
12721 "group": "IVR_Campaigns",
12722 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12723 "version": "0.0.0",
12724 "filename": "server/api/campaign/index.js",
12725 "groupTitle": "IVR_Campaigns"
12729 "url": "/api/campaigns/clone",
12730 "title": "Clone an existing IVR Campaign",
12733 "title": "Example usage:",
12734 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12738 "name": "CloneIVR_Campaigns",
12739 "group": "IVR_Campaigns",
12740 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12741 "version": "0.0.0",
12742 "filename": "server/api/campaign/index.js",
12743 "groupTitle": "IVR_Campaigns"
12747 "url": "/api/campaigns",
12748 "title": "Creates a new IVR Campaign",
12751 "title": "Example usage:",
12752 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12756 "name": "CreateIVR_Campaigns",
12757 "group": "IVR_Campaigns",
12782 "field": "description",
12790 "description": "<p>Active/Disactive Campaign</p>"
12796 "field": "limitCalls",
12797 "description": "<p>Max 200 calls.</p>"
12803 "field": "dialOriginateCallerIdName",
12810 "field": "dialOriginateCallerIdNumber",
12817 "field": "dialOriginateTimeout",
12818 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12824 "field": "dialCongestionMaxRetry",
12825 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12831 "field": "dialCongestionRetryFrequency",
12832 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12838 "field": "dialBusyMaxRetry",
12839 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12845 "field": "dialBusyRetryFrequency",
12846 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12852 "field": "dialNoAnswerMaxRetry",
12853 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12859 "field": "dialNoAnswerRetryFrequency",
12860 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12866 "field": "dialGlobalMaxRetry",
12867 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12873 "field": "dialTimezone",
12880 "field": "dialGlobalInterval",
12892 "field": "dialCheckDuplicateType",
12899 "field": "dialAMDActive",
12900 "description": "<p>Active/Disactive AMD</p>"
12906 "field": "dialAMDInitialSilence",
12907 "description": "<p>#AMD Initial Silence</p>"
12913 "field": "dialAMDGreeting",
12914 "description": "<p>#AMD Greeting</p>"
12920 "field": "dialAMDAfterGreetingSilence",
12921 "description": "<p>#AMD After Greeting Silence</p>"
12927 "field": "dialAMDTotalAnalysisTime",
12928 "description": "<p>#AMD Total Analysis Time</p>"
12934 "field": "dialAMDMinWordLength",
12935 "description": "<p>#AMD Min Word Length</p>"
12941 "field": "dialAMDBetweenWordsSilence",
12942 "description": "<p>#AMD Between Words Silence</p>"
12948 "field": "dialAMDMaximumNumberOfWords",
12949 "description": "<p>#AMD Maximum Number Of Words</p>"
12955 "field": "dialAMDSilenceThreshold",
12956 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12962 "field": "dialAMDMaximumWordLength",
12963 "description": "<p>#AMD Maximum Word Length</p>"
12973 "field": "dialOrderByScheduledAt",
12980 "field": "dialPrefix",
12987 "field": "dialRandomLastDigitCallerIdNumber",
12988 "description": "<p>Random Last Digit (min:1, max:15)</p>"
12994 "field": "dialCutDigit",
12995 "description": "<p>Cut Digit (min:1, max:15)</p>"
13001 "field": "dialNoSuchNumberMaxRetry",
13002 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13008 "field": "dialNoSuchNumberRetryFrequency",
13009 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13015 "field": "dialDropMaxRetry",
13016 "description": "<p>#Drop Retry (min:1, max:999)</p>"
13022 "field": "dialDropRetryFrequency",
13023 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13029 "field": "dialAbandonedMaxRetry",
13030 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13036 "field": "dialAbandonedRetryFrequency",
13037 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13043 "field": "dialMachineMaxRetry",
13044 "description": "<p>#Machine Retry (min:1, max:999)</p>"
13050 "field": "dialMachineRetryFrequency",
13051 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13057 "field": "dialAgentRejectMaxRetry",
13058 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13064 "field": "dialAgentRejectRetryFrequency",
13065 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13070 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13071 "version": "0.0.0",
13072 "filename": "server/api/campaign/index.js",
13073 "groupTitle": "IVR_Campaigns"
13077 "url": "/api/campaigns/{id}",
13078 "title": "Deletes a IVR Campaign",
13081 "title": "Example usage:",
13082 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13086 "name": "DeleteIVR_Campaigns",
13087 "group": "IVR_Campaigns",
13088 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13089 "version": "0.0.0",
13090 "filename": "server/api/campaign/index.js",
13091 "groupTitle": "IVR_Campaigns"
13095 "url": "/api/campaigns/{id}/blacklists",
13096 "title": "Get IVR campaign blacklists",
13099 "title": "Example usage:",
13100 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13104 "name": "GetBlackLists",
13105 "group": "IVR_Campaigns",
13106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13107 "version": "0.0.0",
13108 "filename": "server/api/campaign/index.js",
13109 "groupTitle": "IVR_Campaigns"
13113 "url": "/api/campaigns/{id}/finals",
13114 "title": "Gets IVR campaign hopper finals",
13117 "title": "Example usage:",
13118 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
13122 "name": "GetHopperFinals",
13123 "group": "IVR_Campaigns",
13124 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13125 "version": "0.0.0",
13126 "filename": "server/api/campaign/index.js",
13127 "groupTitle": "IVR_Campaigns"
13131 "url": "/api/campaigns/{id}/hopper_histories",
13132 "title": "Gets IVR campaign hopper histories",
13135 "title": "Example usage:",
13136 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13140 "name": "GetHopperHistories",
13141 "group": "IVR_Campaigns",
13142 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13143 "version": "0.0.0",
13144 "filename": "server/api/campaign/index.js",
13145 "groupTitle": "IVR_Campaigns"
13149 "url": "/api/campaigns/{id}/hoppers",
13150 "title": "Gets IVR campaign hoppers",
13153 "title": "Example usage:",
13154 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13158 "name": "GetHoppers",
13159 "group": "IVR_Campaigns",
13160 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13161 "version": "0.0.0",
13162 "filename": "server/api/campaign/index.js",
13163 "groupTitle": "IVR_Campaigns"
13167 "url": "/api/campaigns",
13168 "title": "Gets a list of IVR Campaigns",
13171 "title": "Example usage:",
13172 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13176 "name": "GetIVR_Campaigns",
13177 "group": "IVR_Campaigns",
13178 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/campaigns?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/campaigns?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/campaigns?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/campaigns?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/campaigns?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13179 "version": "0.0.0",
13180 "filename": "server/api/campaign/index.js",
13181 "groupTitle": "IVR_Campaigns"
13185 "url": "/api/campaigns/{id}/lists",
13186 "title": "Get IVR campaign lists",
13189 "title": "Example usage:",
13190 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13194 "name": "GetLists",
13195 "group": "IVR_Campaigns",
13196 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13197 "version": "0.0.0",
13198 "filename": "server/api/campaign/index.js",
13199 "groupTitle": "IVR_Campaigns"
13203 "url": "/api/campaigns/{id}/blacklists",
13204 "title": "Remove blacklists from an IVR Campaign",
13207 "title": "Example usage:",
13208 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13212 "name": "RemoveBlackLists",
13213 "group": "IVR_Campaigns",
13214 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13215 "version": "0.0.0",
13216 "filename": "server/api/campaign/index.js",
13217 "groupTitle": "IVR_Campaigns"
13221 "url": "/api/campaigns/{id}/lists",
13222 "title": "Remove lists from an IVR Campaign",
13225 "title": "Example usage:",
13226 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13230 "name": "RemoveLists",
13231 "group": "IVR_Campaigns",
13232 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13233 "version": "0.0.0",
13234 "filename": "server/api/campaign/index.js",
13235 "groupTitle": "IVR_Campaigns"
13239 "url": "/api/campaigns/{id}",
13240 "title": "Gets a single IVR Campaign",
13243 "title": "Example usage:",
13244 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13248 "name": "ShowIVR_Campaigns",
13249 "group": "IVR_Campaigns",
13250 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13251 "version": "0.0.0",
13252 "filename": "server/api/campaign/index.js",
13253 "groupTitle": "IVR_Campaigns"
13257 "url": "/api/campaigns/{id}/blacks",
13258 "title": "Gets IVR campaign hopper blacks",
13261 "title": "Example usage:",
13262 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13266 "name": "getHopperBlacks",
13267 "group": "IVR_Campaigns",
13268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13269 "version": "0.0.0",
13270 "filename": "server/api/campaign/index.js",
13271 "groupTitle": "IVR_Campaigns"
13275 "url": "/api/campaigns/{id}",
13276 "title": "Update an existing IVR Campaign",
13279 "title": "Example usage:",
13280 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13284 "name": "updateIVR_Campaigns",
13285 "group": "IVR_Campaigns",
13286 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13287 "version": "0.0.0",
13288 "filename": "server/api/campaign/index.js",
13289 "groupTitle": "IVR_Campaigns"
13293 "url": "/api/integrations/reports",
13294 "title": "Creates a new Integration Report",
13297 "title": "Example usage:",
13298 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13302 "name": "CreateIntegration_Reports",
13303 "group": "Integration_Reports",
13311 "field": "integration",
13318 "field": "eventChannel",
13325 "field": "exitStatus",
13332 "field": "ticketId",
13339 "field": "integrationId",
13346 "field": "contacts",
13353 "field": "uniqueid",
13360 "field": "calleridnum",
13367 "field": "calleridname",
13381 "field": "interface",
13388 "field": "membername",
13395 "field": "agentcalledAt",
13402 "field": "agentconnectAt",
13409 "field": "holdtime",
13416 "field": "agentcomplete",
13423 "field": "agentcompleteAt",
13430 "field": "talktime",
13437 "field": "agentacw",
13444 "field": "acwtime",
13458 "field": "agentringnoanswer",
13465 "field": "agentringnoanswerAt",
13472 "field": "agentdump",
13479 "field": "agentdumpAt",
13486 "field": "lastevent",
13493 "field": "channel",
13500 "field": "channelstate",
13507 "field": "channelstatedesc",
13514 "field": "connectedlinenum",
13521 "field": "connectedlinename",
13528 "field": "language",
13535 "field": "accountcode",
13542 "field": "context",
13556 "field": "priority",
13563 "field": "destchannel",
13570 "field": "destchannelstate",
13577 "field": "destchannelstatedesc",
13584 "field": "destcalleridnum",
13591 "field": "destcalleridname",
13598 "field": "destconnectedlinenum",
13605 "field": "destconnectedlinename",
13612 "field": "destlanguage",
13619 "field": "destaccountcode",
13626 "field": "destcontext",
13633 "field": "destexten",
13640 "field": "destpriority",
13647 "field": "destuniqueid",
13654 "field": "messageId",
13661 "field": "inReplyTo",
13668 "field": "subject",
13696 "field": "attachment",
13744 "field": "appdata",
13751 "field": "projectId",
13757 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13758 "version": "0.0.0",
13759 "filename": "server/api/integrationReport/index.js",
13760 "groupTitle": "Integration_Reports"
13764 "url": "/api/integrations/reports/{id}",
13765 "title": "Deletes a Integration Report",
13768 "title": "Example usage:",
13769 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13773 "name": "DeleteIntegration_Reports",
13774 "group": "Integration_Reports",
13775 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13776 "version": "0.0.0",
13777 "filename": "server/api/integrationReport/index.js",
13778 "groupTitle": "Integration_Reports"
13782 "url": "/api/integrations/reports/describe",
13783 "title": "Gets table info about Integration Reports",
13786 "title": "Example usage:",
13787 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13791 "name": "DescribeIntegration_Reports",
13792 "group": "Integration_Reports",
13793 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13794 "version": "0.0.0",
13795 "filename": "server/api/integrationReport/index.js",
13796 "groupTitle": "Integration_Reports"
13800 "url": "/api/integrations/reports",
13801 "title": "Gets a list of Integration Reports",
13804 "title": "Example usage:",
13805 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13809 "name": "GetIntegration_Reports",
13810 "group": "Integration_Reports",
13811 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13812 "version": "0.0.0",
13813 "filename": "server/api/integrationReport/index.js",
13814 "groupTitle": "Integration_Reports"
13818 "url": "/api/integrations/reports/{id}",
13819 "title": "Gets a single Integration Report",
13822 "title": "Example usage:",
13823 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13827 "name": "ShowIntegration_Reports",
13828 "group": "Integration_Reports",
13829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13830 "version": "0.0.0",
13831 "filename": "server/api/integrationReport/index.js",
13832 "groupTitle": "Integration_Reports"
13836 "url": "/api/integrations/reports/{id}",
13837 "title": "Update an existing Integration Report",
13840 "title": "Example usage:",
13841 "content": "curl https://{domain}/api/integrations/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13845 "name": "updateIntegration_Reports",
13846 "group": "Integration_Reports",
13847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13848 "version": "0.0.0",
13849 "filename": "server/api/integrationReport/index.js",
13850 "groupTitle": "Integration_Reports"
13854 "url": "/api/intervals",
13855 "title": "Creates a new Interval",
13858 "title": "Example usage:",
13859 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13863 "name": "CreateIntervals",
13864 "group": "Intervals",
13879 "field": "description",
13886 "field": "interval",
13892 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13893 "version": "0.0.0",
13894 "filename": "server/api/interval/index.js",
13895 "groupTitle": "Intervals"
13899 "url": "/api/intervals/{id}",
13900 "title": "Deletes a Interval",
13903 "title": "Example usage:",
13904 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13908 "name": "DeleteIntervals",
13909 "group": "Intervals",
13910 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13911 "version": "0.0.0",
13912 "filename": "server/api/interval/index.js",
13913 "groupTitle": "Intervals"
13917 "url": "/api/intervals",
13918 "title": "Gets a list of Intervals",
13921 "title": "Example usage:",
13922 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13926 "name": "GetIntervals",
13927 "group": "Intervals",
13928 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/intervals?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/intervals?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/intervals?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/intervals?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/intervals?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13929 "version": "0.0.0",
13930 "filename": "server/api/interval/index.js",
13931 "groupTitle": "Intervals"
13935 "url": "/api/intervals/{id}",
13936 "title": "Gets a single Interval",
13939 "title": "Example usage:",
13940 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13944 "name": "ShowIntervals",
13945 "group": "Intervals",
13946 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13947 "version": "0.0.0",
13948 "filename": "server/api/interval/index.js",
13949 "groupTitle": "Intervals"
13953 "url": "/api/intervals/{id}/sub_intervals",
13954 "title": "Creates a new sub interval",
13957 "title": "Example usage:",
13958 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -d '{\"interval\": \"00:00-08:30,mon-fri,*,*\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13962 "name": "addInterval",
13963 "group": "Intervals",
13964 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13965 "version": "0.0.0",
13966 "filename": "server/api/interval/index.js",
13967 "groupTitle": "Intervals"
13971 "url": "/api/intervals/{id}/sub_intervals/create_many",
13972 "title": "Create new sub intervals set",
13975 "title": "Example usage:",
13976 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13980 "name": "addIntervals",
13981 "group": "Intervals",
13982 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13983 "version": "0.0.0",
13984 "filename": "server/api/interval/index.js",
13985 "groupTitle": "Intervals"
13989 "url": "/api/intervals/{id}/sub_intervals",
13990 "title": "Get sub intervals set",
13993 "title": "Example usage:",
13994 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13998 "name": "getIntervals",
13999 "group": "Intervals",
14000 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14001 "version": "0.0.0",
14002 "filename": "server/api/interval/index.js",
14003 "groupTitle": "Intervals"
14007 "url": "/api/intervals/{id}",
14008 "title": "Update an existing Interval",
14011 "title": "Example usage:",
14012 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14016 "name": "updateIntervals",
14017 "group": "Intervals",
14018 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14019 "version": "0.0.0",
14020 "filename": "server/api/interval/index.js",
14021 "groupTitle": "Intervals"
14025 "url": "/api/jira",
14026 "title": "Creates a new issue",
14029 "title": "Example usage:",
14030 "content": "curl https://{domain}/api/jira -d '{\"key\": \"Bug\", \"description\": \"I can't do it!\"}' \\\n -H \"Content-Type: application/json\" -X POST -v -u {name}:{password}",
14034 "name": "Creates_Issue",
14046 "field": "issuetype",
14053 "field": "summary",
14060 "field": "description",
14066 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14067 "version": "0.0.0",
14068 "filename": "server/api/jira/index.js",
14069 "groupTitle": "Issue"
14073 "url": "/api/jscripty/answers/reports",
14074 "title": "Creates a new Report",
14077 "title": "Example usage:",
14078 "content": "curl https://{domain}/api/jscripty/answers/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14082 "name": "CreateReports",
14083 "group": "JscriptyAnswerReport",
14091 "field": "question",
14105 "field": "membername",
14112 "field": "projectname",
14126 "field": "uniqueid",
14133 "field": "calleridname",
14140 "field": "calleridnum",
14147 "field": "questionId",
14153 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14154 "version": "0.0.0",
14155 "filename": "server/api/jscriptyAnswerReport/index.js",
14156 "groupTitle": "JscriptyAnswerReport"
14160 "url": "/api/jscripty/answers/reports/{id}",
14161 "title": "Deletes a Report",
14164 "title": "Example usage:",
14165 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14169 "name": "DeleteReports",
14170 "group": "JscriptyAnswerReport",
14171 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14172 "version": "0.0.0",
14173 "filename": "server/api/jscriptyAnswerReport/index.js",
14174 "groupTitle": "JscriptyAnswerReport"
14178 "url": "/api/jscripty/answers/reports/describe",
14179 "title": "Gets table info about Reports",
14182 "title": "Example usage:",
14183 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14187 "name": "DescribeReports",
14188 "group": "JscriptyAnswerReport",
14189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14190 "version": "0.0.0",
14191 "filename": "server/api/jscriptyAnswerReport/index.js",
14192 "groupTitle": "JscriptyAnswerReport"
14196 "url": "/api/jscripty/answers/reports",
14197 "title": "Gets a list of Reports",
14200 "title": "Example usage:",
14201 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14205 "name": "GetReports",
14206 "group": "JscriptyAnswerReport",
14207 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/answers/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/answers/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/answers/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/answers/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/answers/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14208 "version": "0.0.0",
14209 "filename": "server/api/jscriptyAnswerReport/index.js",
14210 "groupTitle": "JscriptyAnswerReport"
14214 "url": "/api/jscripty/answers/reports/{id}",
14215 "title": "Gets a single Report",
14218 "title": "Example usage:",
14219 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14223 "name": "ShowReports",
14224 "group": "JscriptyAnswerReport",
14225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14226 "version": "0.0.0",
14227 "filename": "server/api/jscriptyAnswerReport/index.js",
14228 "groupTitle": "JscriptyAnswerReport"
14232 "url": "/api/jscripty/answers/reports/{id}",
14233 "title": "Update an existing Report",
14236 "title": "Example usage:",
14237 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14241 "name": "updateReports",
14242 "group": "JscriptyAnswerReport",
14243 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14244 "version": "0.0.0",
14245 "filename": "server/api/jscriptyAnswerReport/index.js",
14246 "groupTitle": "JscriptyAnswerReport"
14250 "url": "/api/jscripty/questions/reports",
14251 "title": "Creates a new Report",
14254 "title": "Example usage:",
14255 "content": "curl https://{domain}/api/jscripty/questions/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14259 "name": "CreateReports",
14260 "group": "JscriptyQuestionReport",
14268 "field": "question",
14282 "field": "membername",
14289 "field": "projectname",
14303 "field": "uniqueid",
14310 "field": "calleridname",
14317 "field": "calleridnum",
14324 "field": "questionId",
14330 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14331 "version": "0.0.0",
14332 "filename": "server/api/jscriptyQuestionReport/index.js",
14333 "groupTitle": "JscriptyQuestionReport"
14337 "url": "/api/jscripty/questions/reports/{id}",
14338 "title": "Deletes a Report",
14341 "title": "Example usage:",
14342 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14346 "name": "DeleteReports",
14347 "group": "JscriptyQuestionReport",
14348 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14349 "version": "0.0.0",
14350 "filename": "server/api/jscriptyQuestionReport/index.js",
14351 "groupTitle": "JscriptyQuestionReport"
14355 "url": "/api/jscripty/questions/reports/describe",
14356 "title": "Gets table info about Reports",
14359 "title": "Example usage:",
14360 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14364 "name": "DescribeReports",
14365 "group": "JscriptyQuestionReport",
14366 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14367 "version": "0.0.0",
14368 "filename": "server/api/jscriptyQuestionReport/index.js",
14369 "groupTitle": "JscriptyQuestionReport"
14373 "url": "/api/jscripty/questions/reports",
14374 "title": "Gets a list of Reports",
14377 "title": "Example usage:",
14378 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14382 "name": "GetReports",
14383 "group": "JscriptyQuestionReport",
14384 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/questions/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/questions/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/questions/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/questions/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/questions/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14385 "version": "0.0.0",
14386 "filename": "server/api/jscriptyQuestionReport/index.js",
14387 "groupTitle": "JscriptyQuestionReport"
14391 "url": "/api/jscripty/questions/reports/{id}",
14392 "title": "Gets a single Report",
14395 "title": "Example usage:",
14396 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14400 "name": "ShowReports",
14401 "group": "JscriptyQuestionReport",
14402 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14403 "version": "0.0.0",
14404 "filename": "server/api/jscriptyQuestionReport/index.js",
14405 "groupTitle": "JscriptyQuestionReport"
14409 "url": "/api/jscripty/questions/reports/{id}",
14410 "title": "Update an existing Report",
14413 "title": "Example usage:",
14414 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14418 "name": "updateReports",
14419 "group": "JscriptyQuestionReport",
14420 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14421 "version": "0.0.0",
14422 "filename": "server/api/jscriptyQuestionReport/index.js",
14423 "groupTitle": "JscriptyQuestionReport"
14427 "url": "/api/jscripty/sessions/reports",
14428 "title": "Creates a new Report",
14431 "title": "Example usage:",
14432 "content": "curl https://{domain}/api/jscripty/sessions/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14436 "name": "CreateReports",
14437 "group": "JscriptySessionReport",
14445 "field": "starttime",
14452 "field": "endtime",
14459 "field": "membername",
14466 "field": "projectname",
14480 "field": "uniqueid",
14487 "field": "calleridname",
14494 "field": "calleridnum",
14501 "field": "completed",
14507 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14508 "version": "0.0.0",
14509 "filename": "server/api/jscriptySessionReport/index.js",
14510 "groupTitle": "JscriptySessionReport"
14514 "url": "/api/jscripty/sessions/reports/{id}",
14515 "title": "Deletes a Report",
14518 "title": "Example usage:",
14519 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14523 "name": "DeleteReports",
14524 "group": "JscriptySessionReport",
14525 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14526 "version": "0.0.0",
14527 "filename": "server/api/jscriptySessionReport/index.js",
14528 "groupTitle": "JscriptySessionReport"
14532 "url": "/api/jscripty/sessions/reports/describe",
14533 "title": "Gets table info about Reports",
14536 "title": "Example usage:",
14537 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14541 "name": "DescribeReports",
14542 "group": "JscriptySessionReport",
14543 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14544 "version": "0.0.0",
14545 "filename": "server/api/jscriptySessionReport/index.js",
14546 "groupTitle": "JscriptySessionReport"
14550 "url": "/api/jscripty/sessions/reports",
14551 "title": "Gets a list of Reports",
14554 "title": "Example usage:",
14555 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14559 "name": "GetReports",
14560 "group": "JscriptySessionReport",
14561 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/sessions/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/sessions/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14562 "version": "0.0.0",
14563 "filename": "server/api/jscriptySessionReport/index.js",
14564 "groupTitle": "JscriptySessionReport"
14568 "url": "/api/jscripty/sessions/reports/{id}",
14569 "title": "Gets a single Report",
14572 "title": "Example usage:",
14573 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14577 "name": "ShowReports",
14578 "group": "JscriptySessionReport",
14579 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14580 "version": "0.0.0",
14581 "filename": "server/api/jscriptySessionReport/index.js",
14582 "groupTitle": "JscriptySessionReport"
14586 "url": "/api/jscripty/sessions/reports/{id}/questions",
14587 "title": "Gets Jscripty Session questions",
14590 "title": "Example usage:",
14591 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14595 "name": "getQuestions",
14596 "group": "JscriptySessionReport",
14597 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14598 "version": "0.0.0",
14599 "filename": "server/api/jscriptySessionReport/index.js",
14600 "groupTitle": "JscriptySessionReport"
14604 "url": "/api/jscripty/sessions/reports/{id}",
14605 "title": "Update an existing Report",
14608 "title": "Example usage:",
14609 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14613 "name": "updateReports",
14614 "group": "JscriptySessionReport",
14615 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14616 "version": "0.0.0",
14617 "filename": "server/api/jscriptySessionReport/index.js",
14618 "groupTitle": "JscriptySessionReport"
14622 "url": "/api/jscripty/projects/clone",
14623 "title": "Clone an existing Project",
14626 "title": "Example usage:",
14627 "content": "curl https://{domain}/api/jscripty/projects/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14631 "name": "CloneProjects",
14632 "group": "Jscripty_Projects",
14633 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14634 "version": "0.0.0",
14635 "filename": "server/api/jscriptyProject/index.js",
14636 "groupTitle": "Jscripty_Projects"
14640 "url": "/api/jscripty/projects",
14641 "title": "Creates a new Project",
14644 "title": "Example usage:",
14645 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14649 "name": "CreateProjects",
14650 "group": "Jscripty_Projects",
14665 "field": "description",
14672 "field": "formData",
14679 "field": "enableUncompleteSave",
14686 "field": "sendUnpauseOnSubmit",
14692 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14693 "version": "0.0.0",
14694 "filename": "server/api/jscriptyProject/index.js",
14695 "groupTitle": "Jscripty_Projects"
14699 "url": "/api/jscripty/projects/{id}",
14700 "title": "Deletes a Project",
14703 "title": "Example usage:",
14704 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14708 "name": "DeleteProjects",
14709 "group": "Jscripty_Projects",
14710 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14711 "version": "0.0.0",
14712 "filename": "server/api/jscriptyProject/index.js",
14713 "groupTitle": "Jscripty_Projects"
14717 "url": "/api/jscripty/projects",
14718 "title": "Gets a list of Projects",
14721 "title": "Example usage:",
14722 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14726 "name": "GetProjects",
14727 "group": "Jscripty_Projects",
14728 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/projects?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/projects?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/projects?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/projects?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/projects?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14729 "version": "0.0.0",
14730 "filename": "server/api/jscriptyProject/index.js",
14731 "groupTitle": "Jscripty_Projects"
14735 "url": "/api/jscripty/projects/{id}",
14736 "title": "Gets a single Project",
14739 "title": "Example usage:",
14740 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14744 "name": "ShowProjects",
14745 "group": "Jscripty_Projects",
14746 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14747 "version": "0.0.0",
14748 "filename": "server/api/jscriptyProject/index.js",
14749 "groupTitle": "Jscripty_Projects"
14753 "url": "/api/jscripty/projects/{id}/answers",
14754 "title": "Gets jscripty project answers",
14757 "title": "Example usage:",
14758 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14762 "name": "getAnswers",
14763 "group": "Jscripty_Projects",
14764 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14765 "version": "0.0.0",
14766 "filename": "server/api/jscriptyProject/index.js",
14767 "groupTitle": "Jscripty_Projects"
14771 "url": "/api/jscripty/projects/{id}/sessions",
14772 "title": "Gets jscripty project sessions",
14775 "title": "Example usage:",
14776 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14780 "name": "getSessions",
14781 "group": "Jscripty_Projects",
14782 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14783 "version": "0.0.0",
14784 "filename": "server/api/jscriptyProject/index.js",
14785 "groupTitle": "Jscripty_Projects"
14789 "url": "/api/jscripty/projects/{id}/summary",
14790 "title": "Gets jscripty project summary",
14793 "title": "Example usage:",
14794 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14798 "name": "getSummary",
14799 "group": "Jscripty_Projects",
14800 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14801 "version": "0.0.0",
14802 "filename": "server/api/jscriptyProject/index.js",
14803 "groupTitle": "Jscripty_Projects"
14807 "url": "/api/jscripty/projects/{id}",
14808 "title": "Update an existing Project",
14811 "title": "Example usage:",
14812 "content": "curl https://{domain}/api/jscripty/projects/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14816 "name": "updateProjects",
14817 "group": "Jscripty_Projects",
14818 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14819 "version": "0.0.0",
14820 "filename": "server/api/jscriptyProject/index.js",
14821 "groupTitle": "Jscripty_Projects"
14825 "url": "/api/license",
14826 "title": "Gets License Info",
14829 "title": "Example usage:",
14830 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14835 "group": "License",
14836 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14837 "version": "0.0.0",
14838 "filename": "server/api/license/index.js",
14839 "groupTitle": "License"
14843 "url": "/api/license/{id}",
14844 "title": "Update License Info",
14847 "title": "Example usage:",
14848 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14853 "group": "License",
14854 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14855 "version": "0.0.0",
14856 "filename": "server/api/license/index.js",
14857 "groupTitle": "License"
14861 "url": "/api/mail/accounts/{id}/users",
14862 "title": "Add agents to a mail account",
14865 "title": "Example usage:",
14866 "content": "curl https://{domain}/api/mail/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14870 "name": "AddAgents",
14871 "group": "Mail_Accounts",
14872 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14873 "version": "0.0.0",
14874 "filename": "server/api/mailAccount/index.js",
14875 "groupTitle": "Mail_Accounts"
14879 "url": "/api/mail/accounts/{id}/in_servers",
14880 "title": "Creates a new IMAP server",
14883 "title": "Example usage:",
14884 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14889 "group": "Mail_Accounts",
14897 "field": "description",
14911 "field": "authentication",
14925 "field": "password",
14946 "field": "mailbox",
14953 "field": "connTimeout",
14960 "field": "authTimeout",
14967 "field": "service",
14973 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14974 "version": "0.0.0",
14975 "filename": "server/api/mailAccount/index.js",
14976 "groupTitle": "Mail_Accounts"
14980 "url": "/api/mail/accounts/{id}/out_servers",
14981 "title": "Creates a new SMTP server",
14984 "title": "Example usage:",
14985 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14990 "group": "Mail_Accounts",
14998 "field": "description",
15040 "field": "service",
15047 "field": "authentication",
15053 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15054 "version": "0.0.0",
15055 "filename": "server/api/mailAccount/index.js",
15056 "groupTitle": "Mail_Accounts"
15060 "url": "/api/mail/accounts/{id}",
15061 "title": "Deletes a mail account",
15064 "title": "Example usage:",
15065 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15069 "name": "DeleteMailAccounts",
15070 "group": "Mail_Accounts",
15071 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15072 "version": "0.0.0",
15073 "filename": "server/api/mailAccount/index.js",
15074 "groupTitle": "Mail_Accounts"
15078 "url": "/api/mail/accounts/describe",
15079 "title": "Gets table info about Accounts",
15082 "title": "Example usage:",
15083 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15087 "name": "DescribeAccounts",
15088 "group": "Mail_Accounts",
15089 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15090 "version": "0.0.0",
15091 "filename": "server/api/mailAccount/index.js",
15092 "groupTitle": "Mail_Accounts"
15096 "url": "/api/mail/accounts",
15097 "title": "Gets a list of Accounts",
15100 "title": "Example usage:",
15101 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15105 "name": "GetAccounts",
15106 "group": "Mail_Accounts",
15107 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15108 "version": "0.0.0",
15109 "filename": "server/api/mailAccount/index.js",
15110 "groupTitle": "Mail_Accounts"
15114 "url": "/api/mail/accounts/{id}/users",
15115 "title": "Gets agents from mail account",
15118 "title": "Example usage:",
15119 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15123 "name": "GetAgents",
15124 "group": "Mail_Accounts",
15125 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15126 "version": "0.0.0",
15127 "filename": "server/api/mailAccount/index.js",
15128 "groupTitle": "Mail_Accounts"
15132 "url": "/api/mail/accounts/{id}/in_servers",
15133 "title": "Gets account IMAP server",
15136 "title": "Example usage:",
15137 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15142 "group": "Mail_Accounts",
15143 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15144 "version": "0.0.0",
15145 "filename": "server/api/mailAccount/index.js",
15146 "groupTitle": "Mail_Accounts"
15150 "url": "/api/mail/accounts/{id}/out_servers",
15151 "title": "Gets account SMTP server",
15154 "title": "Example usage:",
15155 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15160 "group": "Mail_Accounts",
15161 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15162 "version": "0.0.0",
15163 "filename": "server/api/mailAccount/index.js",
15164 "groupTitle": "Mail_Accounts"
15168 "url": "/api/mail/accounts/{id}/users",
15169 "title": "Removes agents from a mail account",
15172 "title": "Example usage:",
15173 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15177 "name": "RemoveAgents",
15178 "group": "Mail_Accounts",
15179 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15180 "version": "0.0.0",
15181 "filename": "server/api/mailAccount/index.js",
15182 "groupTitle": "Mail_Accounts"
15186 "url": "/api/mail/accounts/{id}/canned_answers",
15187 "title": "Removes canned answers from account",
15190 "title": "Example usage:",
15191 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15195 "name": "RemoveAnswers",
15196 "group": "Mail_Accounts",
15197 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15198 "version": "0.0.0",
15199 "filename": "server/api/mailAccount/index.js",
15200 "groupTitle": "Mail_Accounts"
15204 "url": "/api/mail/accounts/{id}/dispositions",
15205 "title": "Removes dispositions from account",
15208 "title": "Example usage:",
15209 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15213 "name": "RemoveDispositions",
15214 "group": "Mail_Accounts",
15215 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15216 "version": "0.0.0",
15217 "filename": "server/api/mailAccount/index.js",
15218 "groupTitle": "Mail_Accounts"
15222 "url": "/api/mail/accounts/{id}/in_servers",
15223 "title": "Removes IMAP server from an account",
15226 "title": "Example usage:",
15227 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15231 "name": "RemoveImmap",
15232 "group": "Mail_Accounts",
15233 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15234 "version": "0.0.0",
15235 "filename": "server/api/mailAccount/index.js",
15236 "groupTitle": "Mail_Accounts"
15240 "url": "/api/mail/accounts/{id}/out_servers",
15241 "title": "Removes SMTP server from an account",
15244 "title": "Example usage:",
15245 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15249 "name": "RemoveSmtp",
15250 "group": "Mail_Accounts",
15251 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15252 "version": "0.0.0",
15253 "filename": "server/api/mailAccount/index.js",
15254 "groupTitle": "Mail_Accounts"
15258 "url": "/api/mail/accounts/{id}",
15259 "title": "Gets a single Account",
15262 "title": "Example usage:",
15263 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15267 "name": "ShowAccounts",
15268 "group": "Mail_Accounts",
15269 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15270 "version": "0.0.0",
15271 "filename": "server/api/mailAccount/index.js",
15272 "groupTitle": "Mail_Accounts"
15276 "url": "/api/mail/accounts/{id}/canned_answers",
15277 "title": "Creates new canned answer",
15280 "title": "Example usage:",
15281 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15285 "name": "addAnswer",
15286 "group": "Mail_Accounts",
15308 "field": "description",
15321 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15322 "version": "0.0.0",
15323 "filename": "server/api/mailAccount/index.js",
15324 "groupTitle": "Mail_Accounts"
15328 "url": "/api/mail/accounts/{id}/applications",
15329 "title": "Creates new applications",
15332 "title": "Example usage:",
15333 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15337 "name": "addApplications",
15338 "group": "Mail_Accounts",
15346 "field": "priority",
15360 "field": "appdata",
15367 "field": "description",
15374 "field": "interval",
15380 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15381 "version": "0.0.0",
15382 "filename": "server/api/mailAccount/index.js",
15383 "groupTitle": "Mail_Accounts"
15387 "url": "/api/mail/accounts/{id}/dispositions",
15388 "title": "Creates new disposition",
15391 "title": "Example usage:",
15392 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15396 "name": "addDisposition",
15397 "group": "Mail_Accounts",
15424 "field": "description",
15430 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15431 "version": "0.0.0",
15432 "filename": "server/api/mailAccount/index.js",
15433 "groupTitle": "Mail_Accounts"
15437 "url": "/api/mail/accounts/{id}/interactions",
15438 "title": "Creates new interactions",
15441 "title": "Example usage:",
15442 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -d '[{\"subject\": \"My printer is on fire!\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15446 "name": "addInteraction",
15447 "group": "Mail_Accounts",
15462 "field": "closedAt",
15469 "field": "disposition",
15476 "field": "secondDisposition",
15483 "field": "thirdDisposition",
15497 "field": "inReplyTo",
15518 "field": "subject",
15532 "field": "read1stAt",
15539 "field": "substatus",
15546 "field": "substatusAt",
15557 "field": "firstMsgDirection",
15564 "field": "lastMsgAt",
15575 "field": "lastMsgDirection",
15582 "field": "autoreplyExecuted",
15588 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15589 "version": "0.0.0",
15590 "filename": "server/api/mailAccount/index.js",
15591 "groupTitle": "Mail_Accounts"
15595 "url": "/api/mail/accounts",
15596 "title": "Create a mail account",
15599 "title": "Example usage:",
15600 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15605 "group": "Mail_Accounts",
15606 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15607 "version": "0.0.0",
15608 "filename": "server/api/mailAccount/index.js",
15609 "groupTitle": "Mail_Accounts"
15613 "url": "/api/mail/accounts/{id}/canned_answers",
15614 "title": "Gets account canned answers",
15617 "title": "Example usage:",
15618 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15622 "name": "getAnswers",
15623 "group": "Mail_Accounts",
15624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15625 "version": "0.0.0",
15626 "filename": "server/api/mailAccount/index.js",
15627 "groupTitle": "Mail_Accounts"
15631 "url": "/api/mail/accounts/{id}/applications",
15632 "title": "Gets account applications",
15635 "title": "Example usage:",
15636 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15640 "name": "getApplications",
15641 "group": "Mail_Accounts",
15642 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15643 "version": "0.0.0",
15644 "filename": "server/api/mailAccount/index.js",
15645 "groupTitle": "Mail_Accounts"
15649 "url": "/api/mail/accounts/{id}/dispositions",
15650 "title": "Gets account dispositions",
15653 "title": "Example usage:",
15654 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15658 "name": "getDispositions",
15659 "group": "Mail_Accounts",
15660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15661 "version": "0.0.0",
15662 "filename": "server/api/mailAccount/index.js",
15663 "groupTitle": "Mail_Accounts"
15667 "url": "/api/mail/accounts/{id}/interactions",
15668 "title": "Gets account interactions",
15671 "title": "Example usage:",
15672 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15676 "name": "getInteraction",
15677 "group": "Mail_Accounts",
15678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15679 "version": "0.0.0",
15680 "filename": "server/api/mailAccount/index.js",
15681 "groupTitle": "Mail_Accounts"
15685 "url": "/api/mail/accounts/{id}/messages",
15686 "title": "Gets account messages",
15689 "title": "Example usage:",
15690 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15694 "name": "getMessages",
15695 "group": "Mail_Accounts",
15696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15697 "version": "0.0.0",
15698 "filename": "server/api/mailAccount/index.js",
15699 "groupTitle": "Mail_Accounts"
15703 "url": "/api/mail/accounts/{id}/send",
15704 "title": "Send new mail",
15707 "title": "Example usage:",
15708 "content": "curl https://{domain}/api/mail/accounts/{id}/send -d '{from: '\"John Doe\" <john.doe@xcally.com>'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15712 "name": "sendMail",
15713 "group": "Mail_Accounts",
15714 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15715 "version": "0.0.0",
15716 "filename": "server/api/mailAccount/index.js",
15717 "groupTitle": "Mail_Accounts"
15721 "url": "/api/mail/accounts/{id}",
15722 "title": "Update an existing Account",
15725 "title": "Example usage:",
15726 "content": "curl https://{domain}/api/mail/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15730 "name": "updateAccounts",
15731 "group": "Mail_Accounts",
15732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15733 "version": "0.0.0",
15734 "filename": "server/api/mailAccount/index.js",
15735 "groupTitle": "Mail_Accounts"
15739 "url": "/api/mail/accounts/{id}/verify",
15740 "title": "Verify mail account",
15743 "title": "Example usage:",
15744 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15748 "name": "verifySmtp",
15749 "group": "Mail_Accounts",
15750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15751 "version": "0.0.0",
15752 "filename": "server/api/mailAccount/index.js",
15753 "groupTitle": "Mail_Accounts"
15757 "url": "/api/mail/applications/{id}",
15758 "title": "Deletes a Application",
15761 "title": "Example usage:",
15762 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15766 "name": "DeleteApplications",
15767 "group": "Mail_Applications",
15768 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15769 "version": "0.0.0",
15770 "filename": "server/api/mailApplication/index.js",
15771 "groupTitle": "Mail_Applications"
15775 "url": "/api/mail/applications/{id}",
15776 "title": "Gets a single Application",
15779 "title": "Example usage:",
15780 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15784 "name": "ShowApplications",
15785 "group": "Mail_Applications",
15786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15787 "version": "0.0.0",
15788 "filename": "server/api/mailApplication/index.js",
15789 "groupTitle": "Mail_Applications"
15793 "url": "/api/mail/applications/{id}",
15794 "title": "Update an existing Application",
15797 "title": "Example usage:",
15798 "content": "curl https://{domain}/api/mail/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15802 "name": "updateApplications",
15803 "group": "Mail_Applications",
15804 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15805 "version": "0.0.0",
15806 "filename": "server/api/mailApplication/index.js",
15807 "groupTitle": "Mail_Applications"
15811 "url": "/api/mail/interactions/{id}/tags",
15812 "title": "Add tags to the interaction",
15815 "title": "Example usage:",
15816 "content": "curl https://{domain}/api/mail/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15821 "group": "Mail_Interactions",
15822 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15823 "version": "0.0.0",
15824 "filename": "server/api/mailInteraction/index.js",
15825 "groupTitle": "Mail_Interactions"
15829 "url": "/api/mail/interactions",
15830 "title": "Creates a new Interaction",
15833 "title": "Example usage:",
15834 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15838 "name": "CreateInteractions",
15839 "group": "Mail_Interactions",
15854 "field": "closedAt",
15861 "field": "disposition",
15868 "field": "secondDisposition",
15875 "field": "thirdDisposition",
15889 "field": "inReplyTo",
15910 "field": "subject",
15924 "field": "read1stAt",
15931 "field": "substatus",
15938 "field": "substatusAt",
15949 "field": "firstMsgDirection",
15956 "field": "lastMsgAt",
15967 "field": "lastMsgDirection",
15974 "field": "autoreplyExecuted",
15980 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15981 "version": "0.0.0",
15982 "filename": "server/api/mailInteraction/index.js",
15983 "groupTitle": "Mail_Interactions"
15987 "url": "/api/mail/interactions/{id}",
15988 "title": "Deletes a Interaction",
15991 "title": "Example usage:",
15992 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15996 "name": "DeleteInteractions",
15997 "group": "Mail_Interactions",
15998 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15999 "version": "0.0.0",
16000 "filename": "server/api/mailInteraction/index.js",
16001 "groupTitle": "Mail_Interactions"
16005 "url": "/api/mail/interactions/describe",
16006 "title": "Gets table info about Interactions",
16009 "title": "Example usage:",
16010 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16014 "name": "DescribeInteractions",
16015 "group": "Mail_Interactions",
16016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16017 "version": "0.0.0",
16018 "filename": "server/api/mailInteraction/index.js",
16019 "groupTitle": "Mail_Interactions"
16023 "url": "/api/mail/interactions",
16024 "title": "Gets a list of Interactions",
16027 "title": "Example usage:",
16028 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16032 "name": "GetInteractions",
16033 "group": "Mail_Interactions",
16034 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16035 "version": "0.0.0",
16036 "filename": "server/api/mailInteraction/index.js",
16037 "groupTitle": "Mail_Interactions"
16041 "url": "/api/mail/interactions/{id}/tags",
16042 "title": "Removes tags from interaction",
16045 "title": "Example usage:",
16046 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16050 "name": "RemoveTags",
16051 "group": "Mail_Interactions",
16052 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16053 "version": "0.0.0",
16054 "filename": "server/api/mailInteraction/index.js",
16055 "groupTitle": "Mail_Interactions"
16059 "url": "/api/mail/interactions/{id}",
16060 "title": "Gets a single Interaction",
16063 "title": "Example usage:",
16064 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16068 "name": "ShowInteractions",
16069 "group": "Mail_Interactions",
16070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16071 "version": "0.0.0",
16072 "filename": "server/api/mailInteraction/index.js",
16073 "groupTitle": "Mail_Interactions"
16077 "url": "/api/mail/interactions/{id}/messages",
16078 "title": "Creates new message",
16081 "title": "Example usage:",
16082 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -d '[{\"to\": \"sales@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16086 "name": "addMessage",
16087 "group": "Mail_Interactions",
16102 "field": "plainBody",
16120 "field": "direction",
16127 "field": "messageId",
16162 "field": "subject",
16197 "field": "originTo",
16204 "field": "originCc",
16215 "field": "originChannel",
16221 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16222 "version": "0.0.0",
16223 "filename": "server/api/mailInteraction/index.js",
16224 "groupTitle": "Mail_Interactions"
16228 "url": "/api/mail/interactions/{id}/download",
16229 "title": "Gets interaction",
16232 "title": "Example usage:",
16233 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16237 "name": "download",
16238 "group": "Mail_Interactions",
16239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16240 "version": "0.0.0",
16241 "filename": "server/api/mailInteraction/index.js",
16242 "groupTitle": "Mail_Interactions"
16246 "url": "/api/mail/interactions/{id}/messages",
16247 "title": "Gets interaction messages",
16250 "title": "Example usage:",
16251 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16255 "name": "getMessages",
16256 "group": "Mail_Interactions",
16257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16258 "version": "0.0.0",
16259 "filename": "server/api/mailInteraction/index.js",
16260 "groupTitle": "Mail_Interactions"
16264 "url": "/api/mail/interactions/{id}",
16265 "title": "Update an existing Interaction",
16268 "title": "Example usage:",
16269 "content": "curl https://{domain}/api/mail/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16273 "name": "updateInteractions",
16274 "group": "Mail_Interactions",
16275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16276 "version": "0.0.0",
16277 "filename": "server/api/mailInteraction/index.js",
16278 "groupTitle": "Mail_Interactions"
16282 "url": "/api/mail/messages/{id}",
16283 "title": "Deletes a Message",
16286 "title": "Example usage:",
16287 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16291 "name": "DeleteMessages",
16292 "group": "Mail_Messages",
16293 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16294 "version": "0.0.0",
16295 "filename": "server/api/mailMessage/index.js",
16296 "groupTitle": "Mail_Messages"
16300 "url": "/api/mail/messages/describe",
16301 "title": "Gets table info about Messages",
16304 "title": "Example usage:",
16305 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16309 "name": "DescribeMessages",
16310 "group": "Mail_Messages",
16311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16312 "version": "0.0.0",
16313 "filename": "server/api/mailMessage/index.js",
16314 "groupTitle": "Mail_Messages"
16318 "url": "/api/mail/messages",
16319 "title": "Gets a list of Messages",
16322 "title": "Example usage:",
16323 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16327 "name": "GetMessages",
16328 "group": "Mail_Messages",
16329 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16330 "version": "0.0.0",
16331 "filename": "server/api/mailMessage/index.js",
16332 "groupTitle": "Mail_Messages"
16336 "url": "/api/mail/messages/{id}",
16337 "title": "Gets a single Message",
16340 "title": "Example usage:",
16341 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16345 "name": "ShowMessages",
16346 "group": "Mail_Messages",
16347 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16348 "version": "0.0.0",
16349 "filename": "server/api/mailMessage/index.js",
16350 "groupTitle": "Mail_Messages"
16354 "url": "/api/mail/messages/{id}/accept",
16355 "title": "Accepts message",
16358 "title": "Example usage:",
16359 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16363 "name": "acceptMessage",
16364 "group": "Mail_Messages",
16365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16366 "version": "0.0.0",
16367 "filename": "server/api/mailMessage/index.js",
16368 "groupTitle": "Mail_Messages"
16372 "url": "/api/mail/messages",
16373 "title": "Create a message",
16376 "title": "Example usage:",
16377 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16381 "name": "createMessage",
16382 "group": "Mail_Messages",
16383 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16384 "version": "0.0.0",
16385 "filename": "server/api/mailMessage/index.js",
16386 "groupTitle": "Mail_Messages"
16390 "url": "/api/mail/messages/{id}/download",
16391 "title": "Gets message",
16394 "title": "Example usage:",
16395 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16399 "name": "download",
16400 "group": "Mail_Messages",
16401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16402 "version": "0.0.0",
16403 "filename": "server/api/mailMessage/index.js",
16404 "groupTitle": "Mail_Messages"
16408 "url": "/api/mail/messages/{id}/reject",
16409 "title": "Rejects message",
16412 "title": "Example usage:",
16413 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16417 "name": "rejectMessage",
16418 "group": "Mail_Messages",
16419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16420 "version": "0.0.0",
16421 "filename": "server/api/mailMessage/index.js",
16422 "groupTitle": "Mail_Messages"
16426 "url": "/api/mail/messages/{id}",
16427 "title": "Update an existing Message",
16430 "title": "Example usage:",
16431 "content": "curl https://{domain}/api/mail/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16435 "name": "updateMessages",
16436 "group": "Mail_Messages",
16437 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16438 "version": "0.0.0",
16439 "filename": "server/api/mailMessage/index.js",
16440 "groupTitle": "Mail_Messages"
16444 "url": "/api/mail/reports/queue",
16445 "title": "Creates a new Mail Queue Report",
16448 "title": "Example usage:",
16449 "content": "curl https://{domain}/api/mail/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16453 "name": "CreateMail_Queue_Reports",
16454 "group": "Mail_Queue_Reports",
16462 "field": "uniqueid",
16483 "field": "leaveAt",
16490 "field": "acceptAt",
16510 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16511 "version": "0.0.0",
16512 "filename": "server/api/mailQueueReport/index.js",
16513 "groupTitle": "Mail_Queue_Reports"
16517 "url": "/api/mail/reports/queue/{id}",
16518 "title": "Deletes a Mail Queue Report",
16521 "title": "Example usage:",
16522 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16526 "name": "DeleteMail_Queue_Reports",
16527 "group": "Mail_Queue_Reports",
16528 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16529 "version": "0.0.0",
16530 "filename": "server/api/mailQueueReport/index.js",
16531 "groupTitle": "Mail_Queue_Reports"
16535 "url": "/api/mail/reports/queue/describe",
16536 "title": "Gets table info about Mail Queue Reports",
16539 "title": "Example usage:",
16540 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16544 "name": "DescribeMail_Queue_Reports",
16545 "group": "Mail_Queue_Reports",
16546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16547 "version": "0.0.0",
16548 "filename": "server/api/mailQueueReport/index.js",
16549 "groupTitle": "Mail_Queue_Reports"
16553 "url": "/api/mail/reports/queue",
16554 "title": "Gets a list of Mail Queue Reports",
16557 "title": "Example usage:",
16558 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16562 "name": "GetMail_Queue_Reports",
16563 "group": "Mail_Queue_Reports",
16564 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16565 "version": "0.0.0",
16566 "filename": "server/api/mailQueueReport/index.js",
16567 "groupTitle": "Mail_Queue_Reports"
16571 "url": "/api/mail/reports/queue/{id}",
16572 "title": "Gets a single Mail Queue Report",
16575 "title": "Example usage:",
16576 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16580 "name": "ShowMail_Queue_Reports",
16581 "group": "Mail_Queue_Reports",
16582 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16583 "version": "0.0.0",
16584 "filename": "server/api/mailQueueReport/index.js",
16585 "groupTitle": "Mail_Queue_Reports"
16589 "url": "/api/mail/reports/queue/{id}",
16590 "title": "Update an existing Mail Queue Report",
16593 "title": "Example usage:",
16594 "content": "curl https://{domain}/api/mail/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16598 "name": "updateMail_Queue_Reports",
16599 "group": "Mail_Queue_Reports",
16600 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16601 "version": "0.0.0",
16602 "filename": "server/api/mailQueueReport/index.js",
16603 "groupTitle": "Mail_Queue_Reports"
16607 "url": "/api/mail/queues/{id}/users",
16608 "title": "Add agents to a queue",
16611 "title": "Example usage:",
16612 "content": "curl https://{domain}/api/mail/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16616 "name": "AddAgents",
16617 "group": "Mail_Queues",
16618 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16619 "version": "0.0.0",
16620 "filename": "server/api/mailQueue/index.js",
16621 "groupTitle": "Mail_Queues"
16625 "url": "/api/mail/queues/{id}/teams",
16626 "title": "Add teams to a queue",
16629 "title": "Example usage:",
16630 "content": "curl https://{domain}/api/mail/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16634 "name": "AddTeams",
16635 "group": "Mail_Queues",
16636 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16637 "version": "0.0.0",
16638 "filename": "server/api/mailQueue/index.js",
16639 "groupTitle": "Mail_Queues"
16643 "url": "/api/mail/queues",
16644 "title": "Creates a new Queue",
16647 "title": "Example usage:",
16648 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16652 "name": "CreateQueues",
16653 "group": "Mail_Queues",
16668 "field": "description",
16675 "field": "timeout",
16687 "field": "strategy",
16693 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16694 "version": "0.0.0",
16695 "filename": "server/api/mailQueue/index.js",
16696 "groupTitle": "Mail_Queues"
16700 "url": "/api/mail/queues/{id}",
16701 "title": "Deletes a Queue",
16704 "title": "Example usage:",
16705 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16709 "name": "DeleteQueues",
16710 "group": "Mail_Queues",
16711 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16712 "version": "0.0.0",
16713 "filename": "server/api/mailQueue/index.js",
16714 "groupTitle": "Mail_Queues"
16718 "url": "/api/mail/queues/describe",
16719 "title": "Gets table info about Queues",
16722 "title": "Example usage:",
16723 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16727 "name": "DescribeQueues",
16728 "group": "Mail_Queues",
16729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16730 "version": "0.0.0",
16731 "filename": "server/api/mailQueue/index.js",
16732 "groupTitle": "Mail_Queues"
16736 "url": "/api/mail/queues/{id}/users",
16737 "title": "Gets queue agents",
16740 "title": "Example usage:",
16741 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16745 "name": "GetAgents",
16746 "group": "Mail_Queues",
16747 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16748 "version": "0.0.0",
16749 "filename": "server/api/mailQueue/index.js",
16750 "groupTitle": "Mail_Queues"
16754 "url": "/api/mail/queues/{id}/members",
16755 "title": "GetMembers",
16758 "title": "Example usage:",
16759 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16763 "name": "GetMembers",
16764 "group": "Mail_Queues",
16765 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16766 "version": "0.0.0",
16767 "filename": "server/api/mailQueue/index.js",
16768 "groupTitle": "Mail_Queues"
16772 "url": "/api/mail/queues",
16773 "title": "Gets a list of Queues",
16776 "title": "Example usage:",
16777 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16781 "name": "GetQueues",
16782 "group": "Mail_Queues",
16783 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16784 "version": "0.0.0",
16785 "filename": "server/api/mailQueue/index.js",
16786 "groupTitle": "Mail_Queues"
16790 "url": "/api/mail/queues/{id}/teams",
16791 "title": "Gets queues list",
16794 "title": "Example usage:",
16795 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16799 "name": "GetTeams",
16800 "group": "Mail_Queues",
16801 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16802 "version": "0.0.0",
16803 "filename": "server/api/mailQueue/index.js",
16804 "groupTitle": "Mail_Queues"
16808 "url": "/api/mail/queues/{id}/users",
16809 "title": "Removes agents from a queue",
16812 "title": "Example usage:",
16813 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16817 "name": "RemoveAgents",
16818 "group": "Mail_Queues",
16819 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16820 "version": "0.0.0",
16821 "filename": "server/api/mailQueue/index.js",
16822 "groupTitle": "Mail_Queues"
16826 "url": "/api/mail/queues/{id}",
16827 "title": "Gets a single Queue",
16830 "title": "Example usage:",
16831 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16835 "name": "ShowQueues",
16836 "group": "Mail_Queues",
16837 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16838 "version": "0.0.0",
16839 "filename": "server/api/mailQueue/index.js",
16840 "groupTitle": "Mail_Queues"
16844 "url": "/api/mail/queues/{id}",
16845 "title": "Update an existing Queue",
16848 "title": "Example usage:",
16849 "content": "curl https://{domain}/api/mail/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16853 "name": "updateQueues",
16854 "group": "Mail_Queues",
16855 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16856 "version": "0.0.0",
16857 "filename": "server/api/mailQueue/index.js",
16858 "groupTitle": "Mail_Queues"
16862 "url": "/api/mail/out_servers",
16863 "title": "Creates a new SMTP",
16866 "title": "Example usage:",
16867 "content": "curl https://{domain}/api/mail/out_servers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16871 "name": "CreateSMTPs",
16872 "group": "Mail_SMTP",
16880 "field": "description",
16922 "field": "service",
16929 "field": "authentication",
16935 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16936 "version": "0.0.0",
16937 "filename": "server/api/mailServerOut/index.js",
16938 "groupTitle": "Mail_SMTP"
16942 "url": "/api/mail/out_servers/{id}",
16943 "title": "Deletes a SMTP",
16946 "title": "Example usage:",
16947 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16951 "name": "DeleteSMTPs",
16952 "group": "Mail_SMTP",
16953 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16954 "version": "0.0.0",
16955 "filename": "server/api/mailServerOut/index.js",
16956 "groupTitle": "Mail_SMTP"
16960 "url": "/api/mail/out_servers",
16961 "title": "Gets a list of SMTPs",
16964 "title": "Example usage:",
16965 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16969 "name": "GetSMTPs",
16970 "group": "Mail_SMTP",
16971 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/out_servers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/out_servers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/out_servers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/out_servers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/out_servers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16972 "version": "0.0.0",
16973 "filename": "server/api/mailServerOut/index.js",
16974 "groupTitle": "Mail_SMTP"
16978 "url": "/api/mail/out_servers/{id}",
16979 "title": "Gets a single SMTP",
16982 "title": "Example usage:",
16983 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16987 "name": "ShowSMTPs",
16988 "group": "Mail_SMTP",
16989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16990 "version": "0.0.0",
16991 "filename": "server/api/mailServerOut/index.js",
16992 "groupTitle": "Mail_SMTP"
16996 "url": "/api/mail/out_servers/{id}",
16997 "title": "Update an existing SMTP",
17000 "title": "Example usage:",
17001 "content": "curl https://{domain}/api/mail/out_servers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17005 "name": "updateSMTPs",
17006 "group": "Mail_SMTP",
17007 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17008 "version": "0.0.0",
17009 "filename": "server/api/mailServerOut/index.js",
17010 "groupTitle": "Mail_SMTP"
17014 "url": "/api/mail/substatuses",
17015 "title": "Creates a new Queue",
17018 "title": "Example usage:",
17019 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17023 "name": "CreateSubstatuses",
17024 "group": "Mail_Substatuses",
17039 "field": "description",
17045 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17046 "version": "0.0.0",
17047 "filename": "server/api/mailSubstatus/index.js",
17048 "groupTitle": "Mail_Substatuses"
17052 "url": "/api/mail/substatuses/{id}",
17053 "title": "Deletes a Queue",
17056 "title": "Example usage:",
17057 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17061 "name": "DeleteSubstatuses",
17062 "group": "Mail_Substatuses",
17063 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17064 "version": "0.0.0",
17065 "filename": "server/api/mailSubstatus/index.js",
17066 "groupTitle": "Mail_Substatuses"
17070 "url": "/api/mail/substatuses/describe",
17071 "title": "Gets table info about Substatuses",
17074 "title": "Example usage:",
17075 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17079 "name": "DescribeSubstatuses",
17080 "group": "Mail_Substatuses",
17081 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17082 "version": "0.0.0",
17083 "filename": "server/api/mailSubstatus/index.js",
17084 "groupTitle": "Mail_Substatuses"
17088 "url": "/api/mail/substatuses",
17089 "title": "Gets a list of Substatuses",
17092 "title": "Example usage:",
17093 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17097 "name": "GetSubstatuses",
17098 "group": "Mail_Substatuses",
17099 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/substatuses?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/substatuses?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/substatuses?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/substatuses?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/substatuses?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17100 "version": "0.0.0",
17101 "filename": "server/api/mailSubstatus/index.js",
17102 "groupTitle": "Mail_Substatuses"
17106 "url": "/api/mail/substatuses/{id}",
17107 "title": "Gets a single Queue",
17110 "title": "Example usage:",
17111 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17115 "name": "ShowSubstatuses",
17116 "group": "Mail_Substatuses",
17117 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17118 "version": "0.0.0",
17119 "filename": "server/api/mailSubstatus/index.js",
17120 "groupTitle": "Mail_Substatuses"
17124 "url": "/api/mail/substatuses/{id}",
17125 "title": "Update an existing Queue",
17128 "title": "Example usage:",
17129 "content": "curl https://{domain}/api/mail/substatuses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17133 "name": "updateSubstatuses",
17134 "group": "Mail_Substatuses",
17135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17136 "version": "0.0.0",
17137 "filename": "server/api/mailSubstatus/index.js",
17138 "groupTitle": "Mail_Substatuses"
17142 "url": "/api/mail/reports/transfer",
17143 "title": "Creates a new Mail Transfer Report",
17146 "title": "Example usage:",
17147 "content": "curl https://{domain}/api/mail/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17151 "name": "CreateMail_Transfer_Reports",
17152 "group": "Mail_Transfer_Reports",
17160 "field": "uniqueid",
17179 "field": "transferredAt",
17185 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17186 "version": "0.0.0",
17187 "filename": "server/api/mailTransferReport/index.js",
17188 "groupTitle": "Mail_Transfer_Reports"
17192 "url": "/api/mail/reports/transfer/{id}",
17193 "title": "Deletes a Mail Transfer Report",
17196 "title": "Example usage:",
17197 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17201 "name": "DeleteMail_Transfer_Reports",
17202 "group": "Mail_Transfer_Reports",
17203 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17204 "version": "0.0.0",
17205 "filename": "server/api/mailTransferReport/index.js",
17206 "groupTitle": "Mail_Transfer_Reports"
17210 "url": "/api/mail/reports/transfer/describe",
17211 "title": "Gets table info about Mail Transfer Reports",
17214 "title": "Example usage:",
17215 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17219 "name": "DescribeMail_Transfer_Reports",
17220 "group": "Mail_Transfer_Reports",
17221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17222 "version": "0.0.0",
17223 "filename": "server/api/mailTransferReport/index.js",
17224 "groupTitle": "Mail_Transfer_Reports"
17228 "url": "/api/mail/reports/transfer",
17229 "title": "Gets a list of Mail Transfer Reports",
17232 "title": "Example usage:",
17233 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17237 "name": "GetMail_Transfer_Reports",
17238 "group": "Mail_Transfer_Reports",
17239 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17240 "version": "0.0.0",
17241 "filename": "server/api/mailTransferReport/index.js",
17242 "groupTitle": "Mail_Transfer_Reports"
17246 "url": "/api/mail/reports/transfer/{id}",
17247 "title": "Gets a single Mail Transfer Report",
17250 "title": "Example usage:",
17251 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17255 "name": "ShowMail_Transfer_Reports",
17256 "group": "Mail_Transfer_Reports",
17257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17258 "version": "0.0.0",
17259 "filename": "server/api/mailTransferReport/index.js",
17260 "groupTitle": "Mail_Transfer_Reports"
17264 "url": "/api/mail/reports/transfer/{id}",
17265 "title": "Update an existing Mail Transfer Report",
17268 "title": "Example usage:",
17269 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17273 "name": "updateMail_Transfer_Reports",
17274 "group": "Mail_Transfer_Reports",
17275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17276 "version": "0.0.0",
17277 "filename": "server/api/mailTransferReport/index.js",
17278 "groupTitle": "Mail_Transfer_Reports"
17282 "url": "/api/members/reports/describe",
17283 "title": "Gets table info about Member Reports",
17286 "title": "Example usage:",
17287 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17291 "name": "DescribeMember_Reports",
17292 "group": "Member_Reports",
17293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17294 "version": "0.0.0",
17295 "filename": "server/api/memberReport/index.js",
17296 "groupTitle": "Member_Reports"
17300 "url": "/api/members/reports",
17301 "title": "Gets a list of Member Reports",
17304 "title": "Example usage:",
17305 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17309 "name": "GetMember_Reports",
17310 "group": "Member_Reports",
17311 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/members/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/members/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/members/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/members/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/members/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17312 "version": "0.0.0",
17313 "filename": "server/api/memberReport/index.js",
17314 "groupTitle": "Member_Reports"
17318 "url": "/api/members/reports/{id}",
17319 "title": "Gets a single Member Report",
17322 "title": "Example usage:",
17323 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17327 "name": "ShowMember_Reports",
17328 "group": "Member_Reports",
17329 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17330 "version": "0.0.0",
17331 "filename": "server/api/memberReport/index.js",
17332 "groupTitle": "Member_Reports"
17336 "url": "/api/migrations",
17337 "title": "Gets a list of Migrations",
17340 "title": "Example usage:",
17341 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17345 "name": "GetMigrations",
17346 "group": "Migrations",
17347 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/migrations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/migrations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/migrations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/migrations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/migrations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17348 "version": "0.0.0",
17349 "filename": "server/api/migration/index.js",
17350 "groupTitle": "Migrations"
17354 "url": "/api/voice/networks",
17355 "title": "Create a new network",
17358 "title": "Example usage:",
17359 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17364 "group": "Networks",
17365 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17366 "version": "0.0.0",
17367 "filename": "server/api/network/index.js",
17368 "groupTitle": "Networks"
17372 "url": "/api/voice/networks/{id}",
17373 "title": "Deletes a network",
17376 "title": "Example usage:",
17377 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17382 "group": "Networks",
17383 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17384 "version": "0.0.0",
17385 "filename": "server/api/network/index.js",
17386 "groupTitle": "Networks"
17390 "url": "/api/networks",
17391 "title": "Gets a list of Networks",
17394 "title": "Example usage:",
17395 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17399 "name": "GetNetworks",
17400 "group": "Networks",
17401 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/networks?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/networks?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/networks?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/networks?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/networks?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17402 "version": "0.0.0",
17403 "filename": "server/api/network/index.js",
17404 "groupTitle": "Networks"
17408 "url": "/api/networks/{id}",
17409 "title": "Gets a single Network",
17412 "title": "Example usage:",
17413 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17417 "name": "ShowNetworks",
17418 "group": "Networks",
17419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17420 "version": "0.0.0",
17421 "filename": "server/api/network/index.js",
17422 "groupTitle": "Networks"
17426 "url": "/api/voice/networks/{id}",
17427 "title": "Update an existing network",
17430 "title": "Example usage:",
17431 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17436 "group": "Networks",
17437 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17438 "version": "0.0.0",
17439 "filename": "server/api/network/index.js",
17440 "groupTitle": "Networks"
17444 "url": "/api/openchannel/accounts/{id}/users",
17445 "title": "Add agents to a openchannel account",
17448 "title": "Example usage:",
17449 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17453 "name": "AddAgents",
17454 "group": "Openchannel_Accounts",
17455 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17456 "version": "0.0.0",
17457 "filename": "server/api/openchannelAccount/index.js",
17458 "groupTitle": "Openchannel_Accounts"
17462 "url": "/api/openchannel/accounts",
17463 "title": "Creates a new Account",
17466 "title": "Example usage:",
17467 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17471 "name": "CreateAccounts",
17472 "group": "Openchannel_Accounts",
17487 "field": "description",
17501 "field": "replyUri",
17515 "field": "notificationTemplate",
17522 "field": "notificationSound",
17529 "field": "notificationShake",
17536 "field": "waitForTheAssignedAgent",
17550 "field": "queueTransfer",
17557 "field": "queueTransferTimeout",
17564 "field": "agentTransfer",
17571 "field": "agentTransferTimeout",
17578 "field": "mandatoryDispositionPauseId",
17579 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17585 "field": "mandatoryDisposition",
17586 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17591 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17592 "version": "0.0.0",
17593 "filename": "server/api/openchannelAccount/index.js",
17594 "groupTitle": "Openchannel_Accounts"
17598 "url": "/api/openchannel/accounts/{id}",
17599 "title": "Deletes a Account",
17602 "title": "Example usage:",
17603 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17607 "name": "DeleteAccounts",
17608 "group": "Openchannel_Accounts",
17609 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17610 "version": "0.0.0",
17611 "filename": "server/api/openchannelAccount/index.js",
17612 "groupTitle": "Openchannel_Accounts"
17616 "url": "/api/openchannel/accounts/describe",
17617 "title": "Gets table info about Accounts",
17620 "title": "Example usage:",
17621 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17625 "name": "DescribeAccounts",
17626 "group": "Openchannel_Accounts",
17627 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17628 "version": "0.0.0",
17629 "filename": "server/api/openchannelAccount/index.js",
17630 "groupTitle": "Openchannel_Accounts"
17634 "url": "/api/openchannel/accounts",
17635 "title": "Gets a list of Accounts",
17638 "title": "Example usage:",
17639 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17643 "name": "GetAccounts",
17644 "group": "Openchannel_Accounts",
17645 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17646 "version": "0.0.0",
17647 "filename": "server/api/openchannelAccount/index.js",
17648 "groupTitle": "Openchannel_Accounts"
17652 "url": "/api/openchannel/accounts/{id}/users",
17653 "title": "Gets agents from openchannel account",
17656 "title": "Example usage:",
17657 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17661 "name": "GetAgents",
17662 "group": "Openchannel_Accounts",
17663 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17664 "version": "0.0.0",
17665 "filename": "server/api/openchannelAccount/index.js",
17666 "groupTitle": "Openchannel_Accounts"
17670 "url": "/api/openchannel/accounts/{id}/users",
17671 "title": "Removes agents from a openchannel account",
17674 "title": "Example usage:",
17675 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17679 "name": "RemoveAgents",
17680 "group": "Openchannel_Accounts",
17681 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17682 "version": "0.0.0",
17683 "filename": "server/api/openchannelAccount/index.js",
17684 "groupTitle": "Openchannel_Accounts"
17688 "url": "/api/openchannel/accounts/{id}/canned_answers",
17689 "title": "Removes canned answers from account",
17692 "title": "Example usage:",
17693 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17697 "name": "RemoveAnswers",
17698 "group": "Openchannel_Accounts",
17699 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17700 "version": "0.0.0",
17701 "filename": "server/api/openchannelAccount/index.js",
17702 "groupTitle": "Openchannel_Accounts"
17706 "url": "/api/openchannel/accounts/{id}/dispositions",
17707 "title": "Removes dispositions from account",
17710 "title": "Example usage:",
17711 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17715 "name": "RemoveDispositions",
17716 "group": "Openchannel_Accounts",
17717 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17718 "version": "0.0.0",
17719 "filename": "server/api/openchannelAccount/index.js",
17720 "groupTitle": "Openchannel_Accounts"
17724 "url": "/api/openchannel/accounts/{id}",
17725 "title": "Gets a single Account",
17728 "title": "Example usage:",
17729 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17733 "name": "ShowAccounts",
17734 "group": "Openchannel_Accounts",
17735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17736 "version": "0.0.0",
17737 "filename": "server/api/openchannelAccount/index.js",
17738 "groupTitle": "Openchannel_Accounts"
17742 "url": "/api/openchannel/accounts/{id}/canned_answers",
17743 "title": "Creates new canned answer",
17746 "title": "Example usage:",
17747 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17751 "name": "addAnswer",
17752 "group": "Openchannel_Accounts",
17774 "field": "description",
17787 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17788 "version": "0.0.0",
17789 "filename": "server/api/openchannelAccount/index.js",
17790 "groupTitle": "Openchannel_Accounts"
17794 "url": "/api/openchannel/accounts/{id}/applications",
17795 "title": "Creates new applications",
17798 "title": "Example usage:",
17799 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17803 "name": "addApplications",
17804 "group": "Openchannel_Accounts",
17812 "field": "priority",
17826 "field": "appdata",
17833 "field": "description",
17840 "field": "interval",
17846 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17847 "version": "0.0.0",
17848 "filename": "server/api/openchannelAccount/index.js",
17849 "groupTitle": "Openchannel_Accounts"
17853 "url": "/api/openchannel/accounts/{id}/dispositions",
17854 "title": "Creates new disposition",
17857 "title": "Example usage:",
17858 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17862 "name": "addDisposition",
17863 "group": "Openchannel_Accounts",
17890 "field": "description",
17896 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17897 "version": "0.0.0",
17898 "filename": "server/api/openchannelAccount/index.js",
17899 "groupTitle": "Openchannel_Accounts"
17903 "url": "/api/openchannel/accounts/{id}/canned_answers",
17904 "title": "Gets account canned answers",
17907 "title": "Example usage:",
17908 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17912 "name": "getAnswers",
17913 "group": "Openchannel_Accounts",
17914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17915 "version": "0.0.0",
17916 "filename": "server/api/openchannelAccount/index.js",
17917 "groupTitle": "Openchannel_Accounts"
17921 "url": "/api/openchannel/accounts/{id}/applications",
17922 "title": "Gets account applications",
17925 "title": "Example usage:",
17926 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17930 "name": "getApplications",
17931 "group": "Openchannel_Accounts",
17932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17933 "version": "0.0.0",
17934 "filename": "server/api/openchannelAccount/index.js",
17935 "groupTitle": "Openchannel_Accounts"
17939 "url": "/api/openchannel/accounts/{id}/dispositions",
17940 "title": "Gets account dispositions",
17943 "title": "Example usage:",
17944 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17948 "name": "getDispositions",
17949 "group": "Openchannel_Accounts",
17950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17951 "version": "0.0.0",
17952 "filename": "server/api/openchannelAccount/index.js",
17953 "groupTitle": "Openchannel_Accounts"
17957 "url": "/api/openchannel/accounts/{id}/interactions",
17958 "title": "Gets Openchannel Account Interactions",
17961 "title": "Example usage:",
17962 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17966 "name": "getInteractions",
17967 "group": "Openchannel_Accounts",
17968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17969 "version": "0.0.0",
17970 "filename": "server/api/openchannelAccount/index.js",
17971 "groupTitle": "Openchannel_Accounts"
17975 "url": "/api/openchannel/accounts/{id}/notify",
17976 "title": "Notify new message",
17979 "title": "Example usage:",
17980 "content": "curl https://{domain}/api/openchannel/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17985 "group": "Openchannel_Accounts",
17986 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>Follow this link to check the documentation: <pre><a target=\"_blank\" href=\"https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice\">https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice</a></pre></p>",
17987 "version": "0.0.0",
17988 "filename": "server/api/openchannelAccount/index.js",
17989 "groupTitle": "Openchannel_Accounts"
17993 "url": "/api/openchannel/accounts/{id}/send",
17994 "title": "Send new openchannel message",
17997 "title": "Example usage:",
17998 "content": "curl https://{domain}/api/openchannel/accounts/{id}/send -d '{from: 'John Doe', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18002 "name": "sendOpenchannel",
18003 "group": "Openchannel_Accounts",
18004 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18005 "version": "0.0.0",
18006 "filename": "server/api/openchannelAccount/index.js",
18007 "groupTitle": "Openchannel_Accounts"
18011 "url": "/api/openchannel/accounts/{id}",
18012 "title": "Update an existing Account",
18015 "title": "Example usage:",
18016 "content": "curl https://{domain}/api/openchannel/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18020 "name": "updateAccounts",
18021 "group": "Openchannel_Accounts",
18022 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18023 "version": "0.0.0",
18024 "filename": "server/api/openchannelAccount/index.js",
18025 "groupTitle": "Openchannel_Accounts"
18029 "url": "/api/openchannel/applications",
18030 "title": "Creates a new Application",
18033 "title": "Example usage:",
18034 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18038 "name": "CreateApplications",
18039 "group": "Openchannel_Applications",
18047 "field": "priority",
18061 "field": "appdata",
18068 "field": "description",
18075 "field": "interval",
18081 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18082 "version": "0.0.0",
18083 "filename": "server/api/openchannelApplication/index.js",
18084 "groupTitle": "Openchannel_Applications"
18088 "url": "/api/openchannel/applications/{id}",
18089 "title": "Deletes a Application",
18092 "title": "Example usage:",
18093 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18097 "name": "DeleteApplications",
18098 "group": "Openchannel_Applications",
18099 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18100 "version": "0.0.0",
18101 "filename": "server/api/openchannelApplication/index.js",
18102 "groupTitle": "Openchannel_Applications"
18106 "url": "/api/openchannel/applications",
18107 "title": "Gets a list of Applications",
18110 "title": "Example usage:",
18111 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18115 "name": "GetApplications",
18116 "group": "Openchannel_Applications",
18117 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/applications?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18118 "version": "0.0.0",
18119 "filename": "server/api/openchannelApplication/index.js",
18120 "groupTitle": "Openchannel_Applications"
18124 "url": "/api/openchannel/applications/{id}",
18125 "title": "Gets a single Application",
18128 "title": "Example usage:",
18129 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18133 "name": "ShowApplications",
18134 "group": "Openchannel_Applications",
18135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18136 "version": "0.0.0",
18137 "filename": "server/api/openchannelApplication/index.js",
18138 "groupTitle": "Openchannel_Applications"
18142 "url": "/api/openchannel/applications/{id}",
18143 "title": "Update an existing Application",
18146 "title": "Example usage:",
18147 "content": "curl https://{domain}/api/openchannel/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18151 "name": "updateApplications",
18152 "group": "Openchannel_Applications",
18153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18154 "version": "0.0.0",
18155 "filename": "server/api/openchannelApplication/index.js",
18156 "groupTitle": "Openchannel_Applications"
18160 "url": "/api/openchannel/interactions/{id}/tags",
18161 "title": "Add tags to the interaction",
18164 "title": "Example usage:",
18165 "content": "curl https://{domain}/api/openchannel/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18170 "group": "Openchannel_Interactions",
18171 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18172 "version": "0.0.0",
18173 "filename": "server/api/openchannelInteraction/index.js",
18174 "groupTitle": "Openchannel_Interactions"
18178 "url": "/api/openchannel/interactions",
18179 "title": "Creates a new Interaction",
18182 "title": "Example usage:",
18183 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18187 "name": "CreateInteractions",
18188 "group": "Openchannel_Interactions",
18203 "field": "closedAt",
18210 "field": "disposition",
18217 "field": "secondDisposition",
18224 "field": "thirdDisposition",
18238 "field": "read1stAt",
18245 "field": "threadId",
18252 "field": "externalUrl",
18259 "field": "lastMsgAt",
18270 "field": "lastMsgDirection",
18284 "field": "autoreplyExecuted",
18290 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18291 "version": "0.0.0",
18292 "filename": "server/api/openchannelInteraction/index.js",
18293 "groupTitle": "Openchannel_Interactions"
18297 "url": "/api/openchannel/interactions/{id}",
18298 "title": "Deletes a Interaction",
18301 "title": "Example usage:",
18302 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18306 "name": "DeleteInteractions",
18307 "group": "Openchannel_Interactions",
18308 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18309 "version": "0.0.0",
18310 "filename": "server/api/openchannelInteraction/index.js",
18311 "groupTitle": "Openchannel_Interactions"
18315 "url": "/api/openchannel/interactions/describe",
18316 "title": "Gets table info about Interactions",
18319 "title": "Example usage:",
18320 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18324 "name": "DescribeInteractions",
18325 "group": "Openchannel_Interactions",
18326 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18327 "version": "0.0.0",
18328 "filename": "server/api/openchannelInteraction/index.js",
18329 "groupTitle": "Openchannel_Interactions"
18333 "url": "/api/openchannel/interactions",
18334 "title": "Gets a list of Interactions",
18337 "title": "Example usage:",
18338 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18342 "name": "GetInteractions",
18343 "group": "Openchannel_Interactions",
18344 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18345 "version": "0.0.0",
18346 "filename": "server/api/openchannelInteraction/index.js",
18347 "groupTitle": "Openchannel_Interactions"
18351 "url": "/api/openchannel/interactions/{id}/tags",
18352 "title": "Removes tags from interaction",
18355 "title": "Example usage:",
18356 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18360 "name": "RemoveTags",
18361 "group": "Openchannel_Interactions",
18362 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18363 "version": "0.0.0",
18364 "filename": "server/api/openchannelInteraction/index.js",
18365 "groupTitle": "Openchannel_Interactions"
18369 "url": "/api/openchannel/interactions/{id}",
18370 "title": "Gets a single Interaction",
18373 "title": "Example usage:",
18374 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18378 "name": "ShowInteractions",
18379 "group": "Openchannel_Interactions",
18380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18381 "version": "0.0.0",
18382 "filename": "server/api/openchannelInteraction/index.js",
18383 "groupTitle": "Openchannel_Interactions"
18387 "url": "/api/openchannel/interactions/{id}/messages",
18388 "title": "Creates new messages",
18391 "title": "Example usage:",
18392 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18396 "name": "addMessage",
18397 "group": "Openchannel_Interactions",
18430 "field": "direction",
18444 "field": "providerName",
18451 "field": "providerResponse",
18457 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18458 "version": "0.0.0",
18459 "filename": "server/api/openchannelInteraction/index.js",
18460 "groupTitle": "Openchannel_Interactions"
18464 "url": "/api/openchannel/interactions/{id}/download",
18465 "title": "Gets interaction",
18468 "title": "Example usage:",
18469 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18473 "name": "download",
18474 "group": "Openchannel_Interactions",
18475 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18476 "version": "0.0.0",
18477 "filename": "server/api/openchannelInteraction/index.js",
18478 "groupTitle": "Openchannel_Interactions"
18482 "url": "/api/openchannel/interactions/{id}/messages",
18483 "title": "Gets interaction messages",
18486 "title": "Example usage:",
18487 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18491 "name": "getMessages",
18492 "group": "Openchannel_Interactions",
18493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18494 "version": "0.0.0",
18495 "filename": "server/api/openchannelInteraction/index.js",
18496 "groupTitle": "Openchannel_Interactions"
18500 "url": "/api/openchannel/interactions/{id}",
18501 "title": "Update an existing Interaction",
18504 "title": "Example usage:",
18505 "content": "curl https://{domain}/api/openchannel/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18509 "name": "updateInteractions",
18510 "group": "Openchannel_Interactions",
18511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18512 "version": "0.0.0",
18513 "filename": "server/api/openchannelInteraction/index.js",
18514 "groupTitle": "Openchannel_Interactions"
18518 "url": "/api/openchannel/messages",
18519 "title": "Creates a new Message",
18522 "title": "Example usage:",
18523 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18527 "name": "CreateMessages",
18528 "group": "Openchannel_Messages",
18561 "field": "direction",
18575 "field": "providerName",
18582 "field": "providerResponse",
18588 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18589 "version": "0.0.0",
18590 "filename": "server/api/openchannelMessage/index.js",
18591 "groupTitle": "Openchannel_Messages"
18595 "url": "/api/openchannel/messages/{id}",
18596 "title": "Deletes a Message",
18599 "title": "Example usage:",
18600 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18604 "name": "DeleteMessages",
18605 "group": "Openchannel_Messages",
18606 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18607 "version": "0.0.0",
18608 "filename": "server/api/openchannelMessage/index.js",
18609 "groupTitle": "Openchannel_Messages"
18613 "url": "/api/openchannel/messages/describe",
18614 "title": "Gets table info about Messages",
18617 "title": "Example usage:",
18618 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18622 "name": "DescribeMessages",
18623 "group": "Openchannel_Messages",
18624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18625 "version": "0.0.0",
18626 "filename": "server/api/openchannelMessage/index.js",
18627 "groupTitle": "Openchannel_Messages"
18631 "url": "/api/openchannel/messages",
18632 "title": "Gets a list of Messages",
18635 "title": "Example usage:",
18636 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18640 "name": "GetMessages",
18641 "group": "Openchannel_Messages",
18642 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18643 "version": "0.0.0",
18644 "filename": "server/api/openchannelMessage/index.js",
18645 "groupTitle": "Openchannel_Messages"
18649 "url": "/api/openchannel/messages/{id}",
18650 "title": "Gets a single Message",
18653 "title": "Example usage:",
18654 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18658 "name": "ShowMessages",
18659 "group": "Openchannel_Messages",
18660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18661 "version": "0.0.0",
18662 "filename": "server/api/openchannelMessage/index.js",
18663 "groupTitle": "Openchannel_Messages"
18667 "url": "/api/openchannel/messages/{id}/accept",
18668 "title": "Accepts message",
18671 "title": "Example usage:",
18672 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18676 "name": "acceptMessage",
18677 "group": "Openchannel_Messages",
18678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18679 "version": "0.0.0",
18680 "filename": "server/api/openchannelMessage/index.js",
18681 "groupTitle": "Openchannel_Messages"
18685 "url": "/api/openchannel/messages/{id}/reject",
18686 "title": "Rejects message",
18689 "title": "Example usage:",
18690 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18694 "name": "rejectMessage",
18695 "group": "Openchannel_Messages",
18696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18697 "version": "0.0.0",
18698 "filename": "server/api/openchannelMessage/index.js",
18699 "groupTitle": "Openchannel_Messages"
18703 "url": "/api/openchannel/messages/{id}",
18704 "title": "Update an existing Message",
18707 "title": "Example usage:",
18708 "content": "curl https://{domain}/api/openchannel/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18712 "name": "updateMessages",
18713 "group": "Openchannel_Messages",
18714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18715 "version": "0.0.0",
18716 "filename": "server/api/openchannelMessage/index.js",
18717 "groupTitle": "Openchannel_Messages"
18721 "url": "/api/openchannel/reports/queue",
18722 "title": "Creates a new Openchannel Queue Report",
18725 "title": "Example usage:",
18726 "content": "curl https://{domain}/api/openchannel/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18730 "name": "CreateOpenchannel_Queue_Reports",
18731 "group": "Openchannel_Queue_Reports",
18739 "field": "uniqueid",
18760 "field": "leaveAt",
18767 "field": "acceptAt",
18787 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18788 "version": "0.0.0",
18789 "filename": "server/api/openchannelQueueReport/index.js",
18790 "groupTitle": "Openchannel_Queue_Reports"
18794 "url": "/api/openchannel/reports/queue/{id}",
18795 "title": "Deletes a Openchannel Queue Report",
18798 "title": "Example usage:",
18799 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18803 "name": "DeleteOpenchannel_Queue_Reports",
18804 "group": "Openchannel_Queue_Reports",
18805 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18806 "version": "0.0.0",
18807 "filename": "server/api/openchannelQueueReport/index.js",
18808 "groupTitle": "Openchannel_Queue_Reports"
18812 "url": "/api/openchannel/reports/queue/describe",
18813 "title": "Gets table info about Openchannel Queue Reports",
18816 "title": "Example usage:",
18817 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18821 "name": "DescribeOpenchannel_Queue_Reports",
18822 "group": "Openchannel_Queue_Reports",
18823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18824 "version": "0.0.0",
18825 "filename": "server/api/openchannelQueueReport/index.js",
18826 "groupTitle": "Openchannel_Queue_Reports"
18830 "url": "/api/openchannel/reports/queue",
18831 "title": "Gets a list of Openchannel Queue Reports",
18834 "title": "Example usage:",
18835 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18839 "name": "GetOpenchannel_Queue_Reports",
18840 "group": "Openchannel_Queue_Reports",
18841 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18842 "version": "0.0.0",
18843 "filename": "server/api/openchannelQueueReport/index.js",
18844 "groupTitle": "Openchannel_Queue_Reports"
18848 "url": "/api/openchannel/reports/queue/{id}",
18849 "title": "Gets a single Openchannel Queue Report",
18852 "title": "Example usage:",
18853 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18857 "name": "ShowOpenchannel_Queue_Reports",
18858 "group": "Openchannel_Queue_Reports",
18859 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18860 "version": "0.0.0",
18861 "filename": "server/api/openchannelQueueReport/index.js",
18862 "groupTitle": "Openchannel_Queue_Reports"
18866 "url": "/api/openchannel/reports/queue/{id}",
18867 "title": "Update an existing Openchannel Queue Report",
18870 "title": "Example usage:",
18871 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18875 "name": "updateOpenchannel_Queue_Reports",
18876 "group": "Openchannel_Queue_Reports",
18877 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18878 "version": "0.0.0",
18879 "filename": "server/api/openchannelQueueReport/index.js",
18880 "groupTitle": "Openchannel_Queue_Reports"
18884 "url": "/api/openchannel/queues/{id}/users",
18885 "title": "Add agents to a queue",
18888 "title": "Example usage:",
18889 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18893 "name": "AddAgents",
18894 "group": "Openchannel_Queues",
18895 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18896 "version": "0.0.0",
18897 "filename": "server/api/openchannelQueue/index.js",
18898 "groupTitle": "Openchannel_Queues"
18902 "url": "/api/openchannel/queues/{id}/teams",
18903 "title": "Add teams to a queue",
18906 "title": "Example usage:",
18907 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18911 "name": "AddTeams",
18912 "group": "Openchannel_Queues",
18913 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18914 "version": "0.0.0",
18915 "filename": "server/api/openchannelQueue/index.js",
18916 "groupTitle": "Openchannel_Queues"
18920 "url": "/api/openchannel/queues",
18921 "title": "Creates a new Queue",
18924 "title": "Example usage:",
18925 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18929 "name": "CreateQueues",
18930 "group": "Openchannel_Queues",
18945 "field": "description",
18952 "field": "timeout",
18964 "field": "strategy",
18970 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18971 "version": "0.0.0",
18972 "filename": "server/api/openchannelQueue/index.js",
18973 "groupTitle": "Openchannel_Queues"
18977 "url": "/api/openchannel/queues/{id}",
18978 "title": "Deletes a Queue",
18981 "title": "Example usage:",
18982 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18986 "name": "DeleteQueues",
18987 "group": "Openchannel_Queues",
18988 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18989 "version": "0.0.0",
18990 "filename": "server/api/openchannelQueue/index.js",
18991 "groupTitle": "Openchannel_Queues"
18995 "url": "/api/openchannel/queues/describe",
18996 "title": "Gets table info about Queues",
18999 "title": "Example usage:",
19000 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19004 "name": "DescribeQueues",
19005 "group": "Openchannel_Queues",
19006 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19007 "version": "0.0.0",
19008 "filename": "server/api/openchannelQueue/index.js",
19009 "groupTitle": "Openchannel_Queues"
19013 "url": "/api/openchannel/queues/{id}/users",
19014 "title": "Gets queue agents",
19017 "title": "Example usage:",
19018 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19022 "name": "GetAgents",
19023 "group": "Openchannel_Queues",
19024 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19025 "version": "0.0.0",
19026 "filename": "server/api/openchannelQueue/index.js",
19027 "groupTitle": "Openchannel_Queues"
19031 "url": "/api/openchannel/queues/{id}/members",
19032 "title": "GetMembers",
19035 "title": "Example usage:",
19036 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
19040 "name": "GetMembers",
19041 "group": "Openchannel_Queues",
19042 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19043 "version": "0.0.0",
19044 "filename": "server/api/openchannelQueue/index.js",
19045 "groupTitle": "Openchannel_Queues"
19049 "url": "/api/openchannel/queues",
19050 "title": "Gets a list of Queues",
19053 "title": "Example usage:",
19054 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19058 "name": "GetQueues",
19059 "group": "Openchannel_Queues",
19060 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19061 "version": "0.0.0",
19062 "filename": "server/api/openchannelQueue/index.js",
19063 "groupTitle": "Openchannel_Queues"
19067 "url": "/api/openchannel/queues/{id}/teams",
19068 "title": "Gets queues list",
19071 "title": "Example usage:",
19072 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19076 "name": "GetTeams",
19077 "group": "Openchannel_Queues",
19078 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19079 "version": "0.0.0",
19080 "filename": "server/api/openchannelQueue/index.js",
19081 "groupTitle": "Openchannel_Queues"
19085 "url": "/api/openchannel/queues/{id}/users",
19086 "title": "Removes agents from a queue",
19089 "title": "Example usage:",
19090 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19094 "name": "RemoveAgents",
19095 "group": "Openchannel_Queues",
19096 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19097 "version": "0.0.0",
19098 "filename": "server/api/openchannelQueue/index.js",
19099 "groupTitle": "Openchannel_Queues"
19103 "url": "/api/openchannel/queues/{id}",
19104 "title": "Gets a single Queue",
19107 "title": "Example usage:",
19108 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19112 "name": "ShowQueues",
19113 "group": "Openchannel_Queues",
19114 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19115 "version": "0.0.0",
19116 "filename": "server/api/openchannelQueue/index.js",
19117 "groupTitle": "Openchannel_Queues"
19121 "url": "/api/openchannel/queues/{id}",
19122 "title": "Update an existing Queue",
19125 "title": "Example usage:",
19126 "content": "curl https://{domain}/api/openchannel/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19130 "name": "updateQueues",
19131 "group": "Openchannel_Queues",
19132 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19133 "version": "0.0.0",
19134 "filename": "server/api/openchannelQueue/index.js",
19135 "groupTitle": "Openchannel_Queues"
19139 "url": "/api/openchannel/reports/transfer",
19140 "title": "Creates a new Openchannel Transfer Report",
19143 "title": "Example usage:",
19144 "content": "curl https://{domain}/api/openchannel/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19148 "name": "CreateOpenchannel_Transfer_Reports",
19149 "group": "Openchannel_Transfer_Reports",
19157 "field": "uniqueid",
19176 "field": "transferredAt",
19182 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19183 "version": "0.0.0",
19184 "filename": "server/api/openchannelTransferReport/index.js",
19185 "groupTitle": "Openchannel_Transfer_Reports"
19189 "url": "/api/openchannel/reports/transfer/{id}",
19190 "title": "Deletes a Openchannel Transfer Report",
19193 "title": "Example usage:",
19194 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19198 "name": "DeleteOpenchannel_Transfer_Reports",
19199 "group": "Openchannel_Transfer_Reports",
19200 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19201 "version": "0.0.0",
19202 "filename": "server/api/openchannelTransferReport/index.js",
19203 "groupTitle": "Openchannel_Transfer_Reports"
19207 "url": "/api/openchannel/reports/transfer/describe",
19208 "title": "Gets table info about Openchannel Transfer Reports",
19211 "title": "Example usage:",
19212 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19216 "name": "DescribeOpenchannel_Transfer_Reports",
19217 "group": "Openchannel_Transfer_Reports",
19218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19219 "version": "0.0.0",
19220 "filename": "server/api/openchannelTransferReport/index.js",
19221 "groupTitle": "Openchannel_Transfer_Reports"
19225 "url": "/api/openchannel/reports/transfer",
19226 "title": "Gets a list of Openchannel Transfer Reports",
19229 "title": "Example usage:",
19230 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19234 "name": "GetOpenchannel_Transfer_Reports",
19235 "group": "Openchannel_Transfer_Reports",
19236 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19237 "version": "0.0.0",
19238 "filename": "server/api/openchannelTransferReport/index.js",
19239 "groupTitle": "Openchannel_Transfer_Reports"
19243 "url": "/api/openchannel/reports/transfer/{id}",
19244 "title": "Gets a single Openchannel Transfer Report",
19247 "title": "Example usage:",
19248 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19252 "name": "ShowOpenchannel_Transfer_Reports",
19253 "group": "Openchannel_Transfer_Reports",
19254 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19255 "version": "0.0.0",
19256 "filename": "server/api/openchannelTransferReport/index.js",
19257 "groupTitle": "Openchannel_Transfer_Reports"
19261 "url": "/api/openchannel/reports/transfer/{id}",
19262 "title": "Update an existing Openchannel Transfer Report",
19265 "title": "Example usage:",
19266 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19270 "name": "updateOpenchannel_Transfer_Reports",
19271 "group": "Openchannel_Transfer_Reports",
19272 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19273 "version": "0.0.0",
19274 "filename": "server/api/openchannelTransferReport/index.js",
19275 "groupTitle": "Openchannel_Transfer_Reports"
19279 "url": "/api/pauses",
19280 "title": "Creates a new Pause",
19283 "title": "Example usage:",
19284 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19288 "name": "CreatePauses",
19304 "field": "description",
19310 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19311 "version": "0.0.0",
19312 "filename": "server/api/pause/index.js",
19313 "groupTitle": "Pauses"
19317 "url": "/api/pauses/{id}",
19318 "title": "Deletes a Pause",
19321 "title": "Example usage:",
19322 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19326 "name": "DeletePauses",
19328 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19329 "version": "0.0.0",
19330 "filename": "server/api/pause/index.js",
19331 "groupTitle": "Pauses"
19335 "url": "/api/pauses",
19336 "title": "Gets a list of Pauses",
19339 "title": "Example usage:",
19340 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19344 "name": "GetPauses",
19346 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/pauses?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/pauses?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/pauses?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/pauses?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/pauses?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19347 "version": "0.0.0",
19348 "filename": "server/api/pause/index.js",
19349 "groupTitle": "Pauses"
19353 "url": "/api/pauses/{id}",
19354 "title": "Gets a single Pause",
19357 "title": "Example usage:",
19358 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19362 "name": "ShowPauses",
19364 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19365 "version": "0.0.0",
19366 "filename": "server/api/pause/index.js",
19367 "groupTitle": "Pauses"
19371 "url": "/api/pauses/{id}",
19372 "title": "Update an existing Pause",
19375 "title": "Example usage:",
19376 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19380 "name": "updatePauses",
19382 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19383 "version": "0.0.0",
19384 "filename": "server/api/pause/index.js",
19385 "groupTitle": "Pauses"
19389 "url": "/api/plugins",
19390 "title": "Gets a list of Plugins",
19393 "title": "Example usage:",
19394 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19398 "name": "GetPlugins",
19399 "group": "Plugins",
19400 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/plugins?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/plugins?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/plugins?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/plugins?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/plugins?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19401 "version": "0.0.0",
19402 "filename": "server/api/plugin/index.js",
19403 "groupTitle": "Plugins"
19407 "url": "/api/plugins/{id}",
19408 "title": "Gets a single Plugin",
19411 "title": "Example usage:",
19412 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19416 "name": "ShowPlugins",
19417 "group": "Plugins",
19418 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19419 "version": "0.0.0",
19420 "filename": "server/api/plugin/index.js",
19421 "groupTitle": "Plugins"
19425 "url": "/api/plugins/{id}",
19426 "title": "Delete a plugin",
19429 "title": "Example usage:",
19430 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19434 "name": "destroyPlugin",
19435 "group": "Plugins",
19436 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19437 "version": "0.0.0",
19438 "filename": "server/api/plugin/index.js",
19439 "groupTitle": "Plugins"
19443 "url": "/api/plugins/{id}/download",
19444 "title": "Download plugin source code",
19447 "title": "Example usage:",
19448 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19452 "name": "download",
19453 "group": "Plugins",
19454 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19455 "version": "0.0.0",
19456 "filename": "server/api/plugin/index.js",
19457 "groupTitle": "Plugins"
19461 "url": "/api/plugins/{id}",
19462 "title": "Update an existing plugin",
19465 "title": "Example usage:",
19466 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19470 "name": "updatePlugin",
19471 "group": "Plugins",
19472 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19473 "version": "0.0.0",
19474 "filename": "server/api/plugin/index.js",
19475 "groupTitle": "Plugins"
19479 "url": "/api/plugins",
19480 "title": "Upload new plugin",
19483 "title": "Example usage:",
19484 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19488 "name": "uploadPlugin",
19489 "group": "Plugins",
19490 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19491 "version": "0.0.0",
19492 "filename": "server/api/plugin/index.js",
19493 "groupTitle": "Plugins"
19497 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19498 "title": "Redirect a plugin request to the specified path",
19501 "title": "Example usage:",
19502 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19506 "name": "webhookPlugin",
19507 "group": "Plugins",
19508 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19509 "version": "0.0.0",
19510 "filename": "server/api/plugin/index.js",
19511 "groupTitle": "Plugins"
19515 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19516 "title": "Redirect a plugin request to the specified path",
19519 "title": "Example usage:",
19520 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19524 "name": "webhookPlugin",
19525 "group": "Plugins",
19526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19527 "version": "0.0.0",
19528 "filename": "server/api/plugin/index.js",
19529 "groupTitle": "Plugins"
19533 "url": "/api/pm2/{id}",
19534 "title": "Deletes an existing process",
19537 "title": "Example usage:",
19538 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19542 "name": "DeletePm2Process",
19544 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19545 "version": "0.0.0",
19546 "filename": "server/api/pm2/index.js",
19547 "groupTitle": "Pm2"
19551 "url": "/api/pm2/{id}",
19552 "title": "Gets a single pm2 process",
19555 "title": "Example usage:",
19556 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19560 "name": "GetPm2Process",
19562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19563 "version": "0.0.0",
19564 "filename": "server/api/pm2/index.js",
19565 "groupTitle": "Pm2"
19570 "title": "Gets pm2 processes",
19573 "title": "Example usage:",
19574 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19578 "name": "GetPm2Processes",
19580 "description": "<p>Motion returns the pm2 processes list.</p>",
19581 "version": "0.0.0",
19582 "filename": "server/api/pm2/index.js",
19583 "groupTitle": "Pm2"
19588 "title": "Start a single pm2 process",
19591 "title": "Example usage:",
19592 "content": "curl https://{domain}/api/pm2 -d '{\"name\": \"process_name\", \"script\": \"/index.js\"}'\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19596 "name": "StartPm2Process",
19618 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19619 "version": "0.0.0",
19620 "filename": "server/api/pm2/index.js",
19621 "groupTitle": "Pm2"
19625 "url": "/api/pm2/{id}",
19626 "title": "Update an existing process",
19629 "title": "Example usage:",
19630 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19634 "name": "UpdatePm2Process",
19636 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19637 "version": "0.0.0",
19638 "filename": "server/api/pm2/index.js",
19639 "groupTitle": "Pm2"
19643 "url": "/api/rpc/campaigns/",
19644 "title": "Gets a list of campaigns",
19647 "title": "Example usage:",
19648 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19652 "name": "Campaigns",
19653 "group": "RPC_Realtime",
19654 "description": "<p>Motion will return a list of realtime campaigns parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19655 "version": "0.0.0",
19656 "filename": "server/api/rpc/index.js",
19657 "groupTitle": "RPC_Realtime"
19661 "url": "/api/rpc/fax/accounts",
19662 "title": "Gets a list of FaxAccounts",
19665 "title": "Example usage:",
19666 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19670 "name": "FaxAccounts",
19671 "group": "RPC_Realtime",
19672 "description": "<p>Motion will return a list of realtime fax account parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19673 "version": "0.0.0",
19674 "filename": "server/api/rpc/index.js",
19675 "groupTitle": "RPC_Realtime"
19679 "url": "/api/rpc/agents/:id/capacity",
19680 "title": "Sets agent capacity",
19683 "title": "Example usage:",
19684 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19688 "name": "RTAgentCapacity",
19689 "group": "RPC_Realtime",
19690 "description": "<p>Motion will return the current agent capacity.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19691 "version": "0.0.0",
19692 "filename": "server/api/rpc/index.js",
19693 "groupTitle": "RPC_Realtime"
19697 "url": "/api/rpc/agents",
19698 "title": "Gets a list of RTAgents",
19701 "title": "Example usage:",
19702 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19706 "name": "RTAgents",
19707 "group": "RPC_Realtime",
19708 "description": "<p>Motion will return a list of realtime agents parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19709 "version": "0.0.0",
19710 "filename": "server/api/rpc/index.js",
19711 "groupTitle": "RPC_Realtime"
19715 "url": "/api/rpc/chat/queues",
19716 "title": "Gets a list of RTChatQueues",
19719 "title": "Example usage:",
19720 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19724 "name": "RTChatQueues",
19725 "group": "RPC_Realtime",
19726 "description": "<p>Motion will return a list of realtime chat queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19727 "version": "0.0.0",
19728 "filename": "server/api/rpc/index.js",
19729 "groupTitle": "RPC_Realtime"
19733 "url": "/api/rpc/fax/queues",
19734 "title": "Gets a list of RTFaxQueues",
19737 "title": "Example usage:",
19738 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19742 "name": "RTFaxQueues",
19743 "group": "RPC_Realtime",
19744 "description": "<p>Motion will return a list of realtime fax queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19745 "version": "0.0.0",
19746 "filename": "server/api/rpc/index.js",
19747 "groupTitle": "RPC_Realtime"
19751 "url": "/api/rpc/mail/accounts",
19752 "title": "Gets a list of RTMailAccounts",
19755 "title": "Example usage:",
19756 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19760 "name": "RTMailAccounts",
19761 "group": "RPC_Realtime",
19762 "description": "<p>Motion will return a list of realtime mail account parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19763 "version": "0.0.0",
19764 "filename": "server/api/rpc/index.js",
19765 "groupTitle": "RPC_Realtime"
19769 "url": "/api/rpc/mail/queues",
19770 "title": "Gets a list of RTMailQueues",
19773 "title": "Example usage:",
19774 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19778 "name": "RTMailQueues",
19779 "group": "RPC_Realtime",
19780 "description": "<p>Motion will return a list of realtime mail queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19781 "version": "0.0.0",
19782 "filename": "server/api/rpc/index.js",
19783 "groupTitle": "RPC_Realtime"
19787 "url": "/api/rpc/openchannel/queues",
19788 "title": "Gets a list of RTOpenchannelQueues",
19791 "title": "Example usage:",
19792 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19796 "name": "RTOpenchannelQueues",
19797 "group": "RPC_Realtime",
19798 "description": "<p>Motion will return a list of realtime openchannel queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19799 "version": "0.0.0",
19800 "filename": "server/api/rpc/index.js",
19801 "groupTitle": "RPC_Realtime"
19805 "url": "/api/rpc/outbound/channels",
19806 "title": "Gets a list of RTOutboundChannels",
19809 "title": "Example usage:",
19810 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19814 "name": "RTOutboundChannels",
19815 "group": "RPC_Realtime",
19816 "description": "<p>Motion will return a list of realtime outbound channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19817 "version": "0.0.0",
19818 "filename": "server/api/rpc/index.js",
19819 "groupTitle": "RPC_Realtime"
19823 "url": "/api/rpc/sms/queues",
19824 "title": "Gets a list of RTSmsQueues",
19827 "title": "Example usage:",
19828 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19832 "name": "RTSmsQueues",
19833 "group": "RPC_Realtime",
19834 "description": "<p>Motion will return a list of realtime sms queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19835 "version": "0.0.0",
19836 "filename": "server/api/rpc/index.js",
19837 "groupTitle": "RPC_Realtime"
19841 "url": "/api/rpc/telephones",
19842 "title": "Gets a list of RTTelephones",
19845 "title": "Example usage:",
19846 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19850 "name": "RTTelephones",
19851 "group": "RPC_Realtime",
19852 "description": "<p>Motion will return a list of telephones parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19853 "version": "0.0.0",
19854 "filename": "server/api/rpc/index.js",
19855 "groupTitle": "RPC_Realtime"
19859 "url": "/api/rpc/trunks",
19860 "title": "Gets a list of RTTrunks",
19863 "title": "Example usage:",
19864 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19868 "name": "RTTrunks",
19869 "group": "RPC_Realtime",
19870 "description": "<p>Motion will return a list of realtime trunks parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19871 "version": "0.0.0",
19872 "filename": "server/api/rpc/index.js",
19873 "groupTitle": "RPC_Realtime"
19877 "url": "/api/rpc/voice/channels",
19878 "title": "Gets a list of RTVoiceChannelMixMonitor",
19881 "title": "Example usage:",
19882 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19886 "name": "RTVoiceChannelMixMonitor",
19887 "group": "RPC_Realtime",
19888 "description": "<p>Motion will return a list of realtime voice channel mixmonitor.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19889 "version": "0.0.0",
19890 "filename": "server/api/rpc/index.js",
19891 "groupTitle": "RPC_Realtime"
19895 "url": "/api/rpc/voice/channels",
19896 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19899 "title": "Example usage:",
19900 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19904 "name": "RTVoiceChannelStopMixMonitor",
19905 "group": "RPC_Realtime",
19906 "description": "<p>Motion will return a list of realtime voice channel stopmixmonitor.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19907 "version": "0.0.0",
19908 "filename": "server/api/rpc/index.js",
19909 "groupTitle": "RPC_Realtime"
19913 "url": "/api/rpc/voice/channels",
19914 "title": "Gets a list of RTVoiceChannels",
19917 "title": "Example usage:",
19918 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19922 "name": "RTVoiceChannels",
19923 "group": "RPC_Realtime",
19924 "description": "<p>Motion will return a list of realtime voice channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19925 "version": "0.0.0",
19926 "filename": "server/api/rpc/index.js",
19927 "groupTitle": "RPC_Realtime"
19931 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19932 "title": "Gets a single RTVoiceQueueChannel",
19935 "title": "Example usage:",
19936 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19940 "name": "RTVoiceQueueChannel",
19941 "group": "RPC_Realtime",
19942 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19943 "version": "0.0.0",
19944 "filename": "server/api/rpc/index.js",
19945 "groupTitle": "RPC_Realtime"
19949 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19950 "title": "Hangup a single RTVoiceQueueChannel",
19953 "title": "Example usage:",
19954 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19958 "name": "RTVoiceQueueChannelHangup",
19959 "group": "RPC_Realtime",
19960 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19961 "version": "0.0.0",
19962 "filename": "server/api/rpc/index.js",
19963 "groupTitle": "RPC_Realtime"
19967 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19968 "title": "Hangup a single RTVoiceQueueChannel",
19971 "title": "Example usage:",
19972 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19976 "name": "RTVoiceQueueChannelRedirect",
19977 "group": "RPC_Realtime",
19978 "description": "<p>Motion will redirect a specific realtime voice queue channel to a specific extension.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19979 "version": "0.0.0",
19980 "filename": "server/api/rpc/index.js",
19981 "groupTitle": "RPC_Realtime"
19985 "url": "/api/rpc/voice/queues/preview/{id}",
19986 "title": "Gets a single preview contact",
19989 "title": "Example usage:",
19990 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19994 "name": "RTVoiceQueuePreview",
19995 "group": "RPC_Realtime",
19996 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19997 "version": "0.0.0",
19998 "filename": "server/api/rpc/index.js",
19999 "groupTitle": "RPC_Realtime"
20003 "url": "/api/rpc/outbound",
20004 "title": "Gets a list of RTOutbound",
20007 "title": "Example usage:",
20008 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20012 "name": "RTVoiceQueues",
20013 "group": "RPC_Realtime",
20014 "description": "<p>Motion will return a list of realtime outbound parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20015 "version": "0.0.0",
20016 "filename": "server/api/rpc/index.js",
20017 "groupTitle": "RPC_Realtime"
20021 "url": "/api/rpc/voice/queues",
20022 "title": "Gets a list of RTVoiceQueues",
20025 "title": "Example usage:",
20026 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20030 "name": "RTVoiceQueues",
20031 "group": "RPC_Realtime",
20032 "description": "<p>Motion will return a list of realtime voice queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20033 "version": "0.0.0",
20034 "filename": "server/api/rpc/index.js",
20035 "groupTitle": "RPC_Realtime"
20039 "url": "/api/rpc/voice/queues/channels",
20040 "title": "Gets a list of RTVoiceQueuesChannels",
20043 "title": "Example usage:",
20044 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20048 "name": "RTVoiceQueuesChannels",
20049 "group": "RPC_Realtime",
20050 "description": "<p>Motion will return a list of realtime voice queues channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20051 "version": "0.0.0",
20052 "filename": "server/api/rpc/index.js",
20053 "groupTitle": "RPC_Realtime"
20057 "url": "/api/rpc/chat/queues/{id}",
20058 "title": "Gets a single RTChatQueue",
20061 "title": "Example usage:",
20062 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20066 "name": "ShowRTChatQueues",
20067 "group": "RPC_Realtime",
20068 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20069 "version": "0.0.0",
20070 "filename": "server/api/rpc/index.js",
20071 "groupTitle": "RPC_Realtime"
20075 "url": "/api/rpc/fax/queues/{id}",
20076 "title": "Gets a single RTFaxQueue",
20079 "title": "Example usage:",
20080 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20084 "name": "ShowRTFaxQueues",
20085 "group": "RPC_Realtime",
20086 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20087 "version": "0.0.0",
20088 "filename": "server/api/rpc/index.js",
20089 "groupTitle": "RPC_Realtime"
20093 "url": "/api/rpc/mail/queues/{id}",
20094 "title": "Gets a single RTMailQueue",
20097 "title": "Example usage:",
20098 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20102 "name": "ShowRTMailQueues",
20103 "group": "RPC_Realtime",
20104 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20105 "version": "0.0.0",
20106 "filename": "server/api/rpc/index.js",
20107 "groupTitle": "RPC_Realtime"
20111 "url": "/api/rpc/openchannel/queues/{id}",
20112 "title": "Gets a single RTOpenchannelQueue",
20115 "title": "Example usage:",
20116 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20120 "name": "ShowRTOpenchannelQueues",
20121 "group": "RPC_Realtime",
20122 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20123 "version": "0.0.0",
20124 "filename": "server/api/rpc/index.js",
20125 "groupTitle": "RPC_Realtime"
20129 "url": "/api/rpc/sms/queues/{id}",
20130 "title": "Gets a single RTSmsQueue",
20133 "title": "Example usage:",
20134 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20138 "name": "ShowRTSmsQueues",
20139 "group": "RPC_Realtime",
20140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20141 "version": "0.0.0",
20142 "filename": "server/api/rpc/index.js",
20143 "groupTitle": "RPC_Realtime"
20147 "url": "/api/rpc/voice/queues/{id}",
20148 "title": "Gets a single RTVoiceQueue",
20151 "title": "Example usage:",
20152 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20156 "name": "ShowRTVoiceQueues",
20157 "group": "RPC_Realtime",
20158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20159 "version": "0.0.0",
20160 "filename": "server/api/rpc/index.js",
20161 "groupTitle": "RPC_Realtime"
20165 "url": "/api/rpc/voice/{id}/queues",
20166 "title": "Updates a single VoiceQueue",
20169 "title": "Example usage:",
20170 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20174 "name": "UpdateVoiceQueues",
20175 "group": "RPC_Realtime",
20176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20177 "version": "0.0.0",
20178 "filename": "server/api/rpc/index.js",
20179 "groupTitle": "RPC_Realtime"
20183 "url": "/api/rpc/agents/:id/notify",
20184 "title": "Notify message to a specific agent",
20187 "title": "Example usage:",
20188 "content": "curl https://{domain}/api/rpc/agents/:id/notify -d '{\"messageId\": \"5080\", \"channel\": \"mail\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20192 "name": "agentNotify",
20193 "group": "RPC_Realtime",
20194 "description": "<p>Notify message to a specific agent.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20195 "version": "0.0.0",
20196 "filename": "server/api/rpc/index.js",
20197 "groupTitle": "RPC_Realtime"
20201 "url": "/api/rpc/chat/queues/:id/notify",
20202 "title": "Notify message to a specific queue",
20205 "title": "Example usage:",
20206 "content": "curl https://{domain}/api/rpc/chat/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20210 "name": "chatQueueNotify",
20211 "group": "RPC_Realtime",
20212 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20213 "version": "0.0.0",
20214 "filename": "server/api/rpc/index.js",
20215 "groupTitle": "RPC_Realtime"
20219 "url": "/api/rpc/chat/queues/waitinginteractions",
20220 "title": "Gets a list of chatQueuesWaitingInteractions",
20223 "title": "Example usage:",
20224 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20228 "name": "chatQueuesWaitingInteractions",
20229 "group": "RPC_Realtime",
20230 "description": "<p>Motion will return a list of realtime waiting chat queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20231 "version": "0.0.0",
20232 "filename": "server/api/rpc/index.js",
20233 "groupTitle": "RPC_Realtime"
20237 "url": "/api/rpc/fax/queues/:id/notify",
20238 "title": "Notify message to a specific queue",
20241 "title": "Example usage:",
20242 "content": "curl https://{domain}/api/rpc/fax/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20246 "name": "faxQueueNotify",
20247 "group": "RPC_Realtime",
20248 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20249 "version": "0.0.0",
20250 "filename": "server/api/rpc/index.js",
20251 "groupTitle": "RPC_Realtime"
20255 "url": "/api/rpc/fax/queues/waitinginteractions",
20256 "title": "Gets a list of faxQueuesWaitingInteractions",
20259 "title": "Example usage:",
20260 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20264 "name": "faxQueuesWaitingInteractions",
20265 "group": "RPC_Realtime",
20266 "description": "<p>Motion will return a list of realtime waiting fax queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20267 "version": "0.0.0",
20268 "filename": "server/api/rpc/index.js",
20269 "groupTitle": "RPC_Realtime"
20273 "url": "/api/rpc/mail/queues/:id/notify",
20274 "title": "Notify message to a specific queue",
20277 "title": "Example usage:",
20278 "content": "curl https://{domain}/api/rpc/mail/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20282 "name": "mailQueueNotify",
20283 "group": "RPC_Realtime",
20284 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20285 "version": "0.0.0",
20286 "filename": "server/api/rpc/index.js",
20287 "groupTitle": "RPC_Realtime"
20291 "url": "/api/rpc/mail/queues/waitinginteractions",
20292 "title": "Gets a list of mailQueuesWaitingInteractions",
20295 "title": "Example usage:",
20296 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20300 "name": "mailQueuesWaitingInteractions",
20301 "group": "RPC_Realtime",
20302 "description": "<p>Motion will return a list of realtime waiting mail queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20303 "version": "0.0.0",
20304 "filename": "server/api/rpc/index.js",
20305 "groupTitle": "RPC_Realtime"
20309 "url": "/api/rpc/openchannel/queues/:id/notify",
20310 "title": "Notify message to a specific queue",
20313 "title": "Example usage:",
20314 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20318 "name": "openchannelQueueNotify",
20319 "group": "RPC_Realtime",
20320 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20321 "version": "0.0.0",
20322 "filename": "server/api/rpc/index.js",
20323 "groupTitle": "RPC_Realtime"
20327 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20328 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20331 "title": "Example usage:",
20332 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20336 "name": "openchannelQueuesIdWaitingInteractions",
20337 "group": "RPC_Realtime",
20338 "description": "<p>Motion will return a list of realtime waiting openchannel queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20339 "version": "0.0.0",
20340 "filename": "server/api/rpc/index.js",
20341 "groupTitle": "RPC_Realtime"
20345 "url": "/api/rpc/openchannel/queues/waitinginteractions",
20346 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20349 "title": "Example usage:",
20350 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20354 "name": "openchannelQueuesWaitingInteractions",
20355 "group": "RPC_Realtime",
20356 "description": "<p>Motion will return a list of realtime waiting openchannel queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20357 "version": "0.0.0",
20358 "filename": "server/api/rpc/index.js",
20359 "groupTitle": "RPC_Realtime"
20363 "url": "/api/rpc/sms/queues/:id/notify",
20364 "title": "Notify message to a specific queue",
20367 "title": "Example usage:",
20368 "content": "curl https://{domain}/api/rpc/sms/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20372 "name": "smsQueueNotify",
20373 "group": "RPC_Realtime",
20374 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20375 "version": "0.0.0",
20376 "filename": "server/api/rpc/index.js",
20377 "groupTitle": "RPC_Realtime"
20381 "url": "/api/rpc/sms/queues/waitinginteractions",
20382 "title": "Gets a list of smsQueuesWaitingInteractions",
20385 "title": "Example usage:",
20386 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20390 "name": "smsQueuesWaitingInteractions",
20391 "group": "RPC_Realtime",
20392 "description": "<p>Motion will return a list of realtime waiting sms queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20393 "version": "0.0.0",
20394 "filename": "server/api/rpc/index.js",
20395 "groupTitle": "RPC_Realtime"
20399 "url": "/api/realtime/agents",
20400 "title": "Gets realtime agents info",
20403 "title": "Example usage:",
20404 "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password} -X GET",
20408 "name": "getAgents",
20409 "group": "Realtime",
20410 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20411 "version": "0.0.0",
20412 "filename": "server/api/realtime/index.js",
20413 "groupTitle": "Realtime"
20417 "url": "/api/realtime/queues",
20418 "title": "Gets realtime queues info",
20421 "title": "Example usage:",
20422 "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password} -X GET",
20426 "name": "getQueues",
20427 "group": "Realtime",
20428 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20429 "version": "0.0.0",
20430 "filename": "server/api/realtime/index.js",
20431 "groupTitle": "Realtime"
20435 "url": "/api/integrations/salesforce/accounts",
20436 "title": "Creates a new Salesforce Account",
20439 "title": "Example usage:",
20440 "content": "curl https://{domain}/api/integrations/salesforce/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20444 "name": "CreateSalesforce_Accounts",
20445 "group": "Salesforce_Accounts",
20460 "field": "description",
20467 "field": "username",
20474 "field": "remoteUri",
20481 "field": "password",
20488 "field": "clientId",
20495 "field": "clientSecret",
20502 "field": "securityToken",
20509 "field": "serverUrl",
20516 "\"integrationTab\"",
20526 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20527 "version": "0.0.0",
20528 "filename": "server/api/intSalesforceAccount/index.js",
20529 "groupTitle": "Salesforce_Accounts"
20533 "url": "/api/integrations/salesforce/accounts/{id}",
20534 "title": "Deletes a Salesforce Account",
20537 "title": "Example usage:",
20538 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20542 "name": "DeleteSalesforce_Accounts",
20543 "group": "Salesforce_Accounts",
20544 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20545 "version": "0.0.0",
20546 "filename": "server/api/intSalesforceAccount/index.js",
20547 "groupTitle": "Salesforce_Accounts"
20551 "url": "/api/integrations/salesforce/accounts",
20552 "title": "Gets a list of Salesforce Accounts",
20555 "title": "Example usage:",
20556 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20560 "name": "GetSalesforce_Accounts",
20561 "group": "Salesforce_Accounts",
20562 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20563 "version": "0.0.0",
20564 "filename": "server/api/intSalesforceAccount/index.js",
20565 "groupTitle": "Salesforce_Accounts"
20569 "url": "/api/integrations/salesforce/accounts/{id}",
20570 "title": "Gets a single Salesforce Account",
20573 "title": "Example usage:",
20574 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20578 "name": "ShowSalesforce_Accounts",
20579 "group": "Salesforce_Accounts",
20580 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20581 "version": "0.0.0",
20582 "filename": "server/api/intSalesforceAccount/index.js",
20583 "groupTitle": "Salesforce_Accounts"
20587 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20588 "title": "Creates new configuration",
20591 "title": "Example usage:",
20592 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
20596 "name": "addConfiguration",
20597 "group": "Salesforce_Accounts",
20598 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20599 "version": "0.0.0",
20600 "filename": "server/api/intSalesforceAccount/index.js",
20601 "groupTitle": "Salesforce_Accounts"
20605 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20606 "title": "Gets account configurations",
20609 "title": "Example usage:",
20610 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20614 "name": "getConfigurations",
20615 "group": "Salesforce_Accounts",
20616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20617 "version": "0.0.0",
20618 "filename": "server/api/intSalesforceAccount/index.js",
20619 "groupTitle": "Salesforce_Accounts"
20623 "url": "/api/integrations/salesforce/accounts/{id}/fields",
20624 "title": "Gets account fields",
20627 "title": "Example usage:",
20628 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20632 "name": "getFields",
20633 "group": "Salesforce_Accounts",
20634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20635 "version": "0.0.0",
20636 "filename": "server/api/intSalesforceAccount/index.js",
20637 "groupTitle": "Salesforce_Accounts"
20641 "url": "/api/integrations/salesforce/accounts/{id}",
20642 "title": "Update an existing Salesforce Account",
20645 "title": "Example usage:",
20646 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20650 "name": "updateSalesforce_Accounts",
20651 "group": "Salesforce_Accounts",
20652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20653 "version": "0.0.0",
20654 "filename": "server/api/intSalesforceAccount/index.js",
20655 "groupTitle": "Salesforce_Accounts"
20659 "url": "/api/integrations/salesforce/configurations",
20660 "title": "Creates a new Salesforce Configuration",
20663 "title": "Example usage:",
20664 "content": "curl https://{domain}/api/integrations/salesforce/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20668 "name": "CreateSalesforce_Configurations",
20669 "group": "Salesforce_Configurations",
20684 "field": "description",
20695 "field": "ticketType",
20702 "\"contact_lead\"",
20705 "\"account_contact_lead\"",
20709 "field": "moduleSearch",
20722 "field": "moduleCreate",
20736 "field": "additionalSearchAccount",
20743 "field": "additionalSearchContact",
20750 "field": "additionalSearchLead",
20756 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20757 "version": "0.0.0",
20758 "filename": "server/api/intSalesforceConfiguration/index.js",
20759 "groupTitle": "Salesforce_Configurations"
20763 "url": "/api/integrations/salesforce/configurations/{id}",
20764 "title": "Deletes a Salesforce Configuration",
20767 "title": "Example usage:",
20768 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20772 "name": "DeleteSalesforce_Configurations",
20773 "group": "Salesforce_Configurations",
20774 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20775 "version": "0.0.0",
20776 "filename": "server/api/intSalesforceConfiguration/index.js",
20777 "groupTitle": "Salesforce_Configurations"
20781 "url": "/api/integrations/salesforce/configurations",
20782 "title": "Gets a list of Salesforce Configurations",
20785 "title": "Example usage:",
20786 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20790 "name": "GetSalesforce_Configurations",
20791 "group": "Salesforce_Configurations",
20792 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20793 "version": "0.0.0",
20794 "filename": "server/api/intSalesforceConfiguration/index.js",
20795 "groupTitle": "Salesforce_Configurations"
20799 "url": "/api/integrations/salesforce/configurations/{id}",
20800 "title": "Gets a single Salesforce Configuration",
20803 "title": "Example usage:",
20804 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20808 "name": "ShowSalesforce_Configurations",
20809 "group": "Salesforce_Configurations",
20810 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20811 "version": "0.0.0",
20812 "filename": "server/api/intSalesforceConfiguration/index.js",
20813 "groupTitle": "Salesforce_Configurations"
20817 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20818 "title": "Gets configurations descriptions",
20821 "title": "Example usage:",
20822 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20826 "name": "getDescriptions",
20827 "group": "Salesforce_Configurations",
20828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20829 "version": "0.0.0",
20830 "filename": "server/api/intSalesforceConfiguration/index.js",
20831 "groupTitle": "Salesforce_Configurations"
20835 "url": "/api/integrations/salesforce/configurations/{id}/fields",
20836 "title": "Gets configurations fields",
20839 "title": "Example usage:",
20840 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20844 "name": "getFields",
20845 "group": "Salesforce_Configurations",
20846 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20847 "version": "0.0.0",
20848 "filename": "server/api/intSalesforceConfiguration/index.js",
20849 "groupTitle": "Salesforce_Configurations"
20853 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20854 "title": "Gets configurations subjects",
20857 "title": "Example usage:",
20858 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20862 "name": "getSubjects",
20863 "group": "Salesforce_Configurations",
20864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20865 "version": "0.0.0",
20866 "filename": "server/api/intSalesforceConfiguration/index.js",
20867 "groupTitle": "Salesforce_Configurations"
20871 "url": "/api/integrations/salesforce/configurations/{id}",
20872 "title": "Update an existing Salesforce Configuration",
20875 "title": "Example usage:",
20876 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20880 "name": "updateSalesforce_Configurations",
20881 "group": "Salesforce_Configurations",
20882 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20883 "version": "0.0.0",
20884 "filename": "server/api/intSalesforceConfiguration/index.js",
20885 "groupTitle": "Salesforce_Configurations"
20889 "url": "/api/integrations/salesforce/fields",
20890 "title": "Creates a new Salesforce Field",
20893 "title": "Example usage:",
20894 "content": "curl https://{domain}/api/integrations/salesforce/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20898 "name": "CreateSalesforce_Fields",
20899 "group": "Salesforce_Fields",
20909 "\"customVariable\"",
20921 "field": "content",
20937 "\"customVariable\""
20940 "field": "keyType",
20947 "field": "keyContent",
20954 "field": "idField",
20961 "field": "variableName",
20967 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20968 "version": "0.0.0",
20969 "filename": "server/api/intSalesforceField/index.js",
20970 "groupTitle": "Salesforce_Fields"
20974 "url": "/api/integrations/salesforce/fields/{id}",
20975 "title": "Deletes a Salesforce Field",
20978 "title": "Example usage:",
20979 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20983 "name": "DeleteSalesforce_Fields",
20984 "group": "Salesforce_Fields",
20985 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20986 "version": "0.0.0",
20987 "filename": "server/api/intSalesforceField/index.js",
20988 "groupTitle": "Salesforce_Fields"
20992 "url": "/api/integrations/salesforce/fields",
20993 "title": "Gets a list of Salesforce Fields",
20996 "title": "Example usage:",
20997 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
21001 "name": "GetSalesforce_Fields",
21002 "group": "Salesforce_Fields",
21003 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21004 "version": "0.0.0",
21005 "filename": "server/api/intSalesforceField/index.js",
21006 "groupTitle": "Salesforce_Fields"
21010 "url": "/api/integrations/salesforce/fields/{id}",
21011 "title": "Gets a single Salesforce Field",
21014 "title": "Example usage:",
21015 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21019 "name": "ShowSalesforce_Fields",
21020 "group": "Salesforce_Fields",
21021 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21022 "version": "0.0.0",
21023 "filename": "server/api/intSalesforceField/index.js",
21024 "groupTitle": "Salesforce_Fields"
21028 "url": "/api/integrations/salesforce/fields/{id}",
21029 "title": "Update an existing Salesforce Field",
21032 "title": "Example usage:",
21033 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21037 "name": "updateSalesforce_Fields",
21038 "group": "Salesforce_Fields",
21039 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21040 "version": "0.0.0",
21041 "filename": "server/api/intSalesforceField/index.js",
21042 "groupTitle": "Salesforce_Fields"
21046 "url": "/api/schedules",
21047 "title": "Creates a new Schedule",
21050 "title": "Example usage:",
21051 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21055 "name": "CreateSchedules",
21056 "group": "Schedules",
21071 "field": "description",
21092 "field": "startAt",
21106 "field": "subtractNumber",
21122 "field": "subtractUnit",
21152 "field": "sendMail",
21180 "field": "sendIfEmpty",
21186 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21187 "version": "0.0.0",
21188 "filename": "server/api/schedule/index.js",
21189 "groupTitle": "Schedules"
21193 "url": "/api/schedules/{id}",
21194 "title": "Deletes a Schedule",
21197 "title": "Example usage:",
21198 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21202 "name": "DeleteSchedules",
21203 "group": "Schedules",
21204 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21205 "version": "0.0.0",
21206 "filename": "server/api/schedule/index.js",
21207 "groupTitle": "Schedules"
21211 "url": "/api/schedules",
21212 "title": "Gets a list of Schedules",
21215 "title": "Example usage:",
21216 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21220 "name": "GetSchedules",
21221 "group": "Schedules",
21222 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/schedules?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/schedules?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/schedules?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/schedules?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/schedules?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21223 "version": "0.0.0",
21224 "filename": "server/api/schedule/index.js",
21225 "groupTitle": "Schedules"
21229 "url": "/api/schedules/{id}",
21230 "title": "Gets a single Schedule",
21233 "title": "Example usage:",
21234 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21238 "name": "ShowSchedules",
21239 "group": "Schedules",
21240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21241 "version": "0.0.0",
21242 "filename": "server/api/schedule/index.js",
21243 "groupTitle": "Schedules"
21247 "url": "/api/schedules/{id}/run",
21248 "title": "Run Scheduler",
21251 "title": "Example usage:",
21252 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21257 "group": "Schedules",
21258 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21259 "version": "0.0.0",
21260 "filename": "server/api/schedule/index.js",
21261 "groupTitle": "Schedules"
21265 "url": "/api/schedules/{id}",
21266 "title": "Update an existing Schedule",
21269 "title": "Example usage:",
21270 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21274 "name": "updateSchedules",
21275 "group": "Schedules",
21276 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21277 "version": "0.0.0",
21278 "filename": "server/api/schedule/index.js",
21279 "groupTitle": "Schedules"
21283 "url": "/api/screen/recordings",
21284 "title": "Creates a new Recording",
21287 "title": "Example usage:",
21288 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21292 "name": "CreateRecordings",
21293 "group": "Screen_Recordings",
21308 "field": "interactionid",
21315 "field": "channel",
21336 "field": "duration",
21343 "field": "startedAt",
21350 "field": "closedAt",
21357 "field": "createdAt",
21364 "field": "updatedAt",
21370 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21371 "version": "0.0.0",
21372 "filename": "server/api/screenRecording/index.js",
21373 "groupTitle": "Screen_Recordings"
21377 "url": "/api/screen/recordings/describe",
21378 "title": "Gets table info about Recordings",
21381 "title": "Example usage:",
21382 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21386 "name": "DescribeRecordings",
21387 "group": "Screen_Recordings",
21388 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21389 "version": "0.0.0",
21390 "filename": "server/api/screenRecording/index.js",
21391 "groupTitle": "Screen_Recordings"
21395 "url": "/api/screen/recordings",
21396 "title": "Gets a list of Recordings",
21399 "title": "Example usage:",
21400 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21404 "name": "GetRecordings",
21405 "group": "Screen_Recordings",
21406 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/screen/recordings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/screen/recordings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/screen/recordings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/screen/recordings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/screen/recordings?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21407 "version": "0.0.0",
21408 "filename": "server/api/screenRecording/index.js",
21409 "groupTitle": "Screen_Recordings"
21413 "url": "/api/screen/recordings/{id}",
21414 "title": "Gets a single Recording",
21417 "title": "Example usage:",
21418 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21422 "name": "ShowRecordings",
21423 "group": "Screen_Recordings",
21424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21425 "version": "0.0.0",
21426 "filename": "server/api/screenRecording/index.js",
21427 "groupTitle": "Screen_Recordings"
21431 "url": "/api/screen/recordings/{id}",
21432 "title": "Delete screen recording",
21435 "title": "Example usage:",
21436 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21441 "group": "Screen_Recordings",
21442 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21443 "version": "0.0.0",
21444 "filename": "server/api/screenRecording/index.js",
21445 "groupTitle": "Screen_Recordings"
21449 "url": "/api/screen/recordings/{id}/download",
21450 "title": "Download Recording",
21453 "title": "Example usage:",
21454 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21458 "name": "download",
21459 "group": "Screen_Recordings",
21460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21461 "version": "0.0.0",
21462 "filename": "server/api/screenRecording/index.js",
21463 "groupTitle": "Screen_Recordings"
21467 "url": "/api/screen/recordings/{id}",
21468 "title": "Update an existing Recording",
21471 "title": "Example usage:",
21472 "content": "curl https://{domain}/api/screen/recordings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21476 "name": "updateRecordings",
21477 "group": "Screen_Recordings",
21478 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21479 "version": "0.0.0",
21480 "filename": "server/api/screenRecording/index.js",
21481 "groupTitle": "Screen_Recordings"
21485 "url": "/api/integrations/servicenow/accounts",
21486 "title": "Creates a new Servicenow Account",
21489 "title": "Example usage:",
21490 "content": "curl https://{domain}/api/integrations/servicenow/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21494 "name": "CreateServicenow_Accounts",
21495 "group": "Servicenow_Accounts",
21510 "field": "description",
21517 "field": "username",
21524 "field": "password",
21538 "field": "remoteUri",
21545 "field": "serverUrl",
21551 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21552 "version": "0.0.0",
21553 "filename": "server/api/intServicenowAccount/index.js",
21554 "groupTitle": "Servicenow_Accounts"
21558 "url": "/api/integrations/servicenow/accounts/{id}",
21559 "title": "Deletes a Servicenow Account",
21562 "title": "Example usage:",
21563 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21567 "name": "DeleteServicenow_Accounts",
21568 "group": "Servicenow_Accounts",
21569 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21570 "version": "0.0.0",
21571 "filename": "server/api/intServicenowAccount/index.js",
21572 "groupTitle": "Servicenow_Accounts"
21576 "url": "/api/integrations/servicenow/accounts",
21577 "title": "Gets a list of Servicenow Accounts",
21580 "title": "Example usage:",
21581 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21585 "name": "GetServicenow_Accounts",
21586 "group": "Servicenow_Accounts",
21587 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21588 "version": "0.0.0",
21589 "filename": "server/api/intServicenowAccount/index.js",
21590 "groupTitle": "Servicenow_Accounts"
21594 "url": "/api/integrations/servicenow/accounts/{id}",
21595 "title": "Gets a single Servicenow Account",
21598 "title": "Example usage:",
21599 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21603 "name": "ShowServicenow_Accounts",
21604 "group": "Servicenow_Accounts",
21605 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21606 "version": "0.0.0",
21607 "filename": "server/api/intServicenowAccount/index.js",
21608 "groupTitle": "Servicenow_Accounts"
21612 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21613 "title": "Creates new configuration",
21616 "title": "Example usage:",
21617 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
21621 "name": "addConfiguration",
21622 "group": "Servicenow_Accounts",
21623 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21624 "version": "0.0.0",
21625 "filename": "server/api/intServicenowAccount/index.js",
21626 "groupTitle": "Servicenow_Accounts"
21630 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21631 "title": "Gets account configurations",
21634 "title": "Example usage:",
21635 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21639 "name": "getConfigurations",
21640 "group": "Servicenow_Accounts",
21641 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21642 "version": "0.0.0",
21643 "filename": "server/api/intServicenowAccount/index.js",
21644 "groupTitle": "Servicenow_Accounts"
21648 "url": "/api/integrations/servicenow/accounts/{id}/fields",
21649 "title": "Gets account fields",
21652 "title": "Example usage:",
21653 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21657 "name": "getFields",
21658 "group": "Servicenow_Accounts",
21659 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21660 "version": "0.0.0",
21661 "filename": "server/api/intServicenowAccount/index.js",
21662 "groupTitle": "Servicenow_Accounts"
21666 "url": "/api/integrations/servicenow/accounts/{id}",
21667 "title": "Update an existing Servicenow Account",
21670 "title": "Example usage:",
21671 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21675 "name": "updateServicenow_Accounts",
21676 "group": "Servicenow_Accounts",
21677 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21678 "version": "0.0.0",
21679 "filename": "server/api/intServicenowAccount/index.js",
21680 "groupTitle": "Servicenow_Accounts"
21684 "url": "/api/integrations/servicenow/configurations",
21685 "title": "Creates a new Servicenow Configuration",
21688 "title": "Example usage:",
21689 "content": "curl https://{domain}/api/integrations/servicenow/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21693 "name": "CreateServicenow_Configurations",
21694 "group": "Servicenow_Configurations",
21709 "field": "description",
21715 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21716 "version": "0.0.0",
21717 "filename": "server/api/intServicenowConfiguration/index.js",
21718 "groupTitle": "Servicenow_Configurations"
21722 "url": "/api/integrations/servicenow/configurations/{id}",
21723 "title": "Deletes a Servicenow Configuration",
21726 "title": "Example usage:",
21727 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21731 "name": "DeleteServicenow_Configurations",
21732 "group": "Servicenow_Configurations",
21733 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21734 "version": "0.0.0",
21735 "filename": "server/api/intServicenowConfiguration/index.js",
21736 "groupTitle": "Servicenow_Configurations"
21740 "url": "/api/integrations/servicenow/configurations",
21741 "title": "Gets a list of Servicenow Configurations",
21744 "title": "Example usage:",
21745 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21749 "name": "GetServicenow_Configurations",
21750 "group": "Servicenow_Configurations",
21751 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21752 "version": "0.0.0",
21753 "filename": "server/api/intServicenowConfiguration/index.js",
21754 "groupTitle": "Servicenow_Configurations"
21758 "url": "/api/integrations/servicenow/configurations/{id}",
21759 "title": "Gets a single Servicenow Configuration",
21762 "title": "Example usage:",
21763 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21767 "name": "ShowServicenow_Configurations",
21768 "group": "Servicenow_Configurations",
21769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21770 "version": "0.0.0",
21771 "filename": "server/api/intServicenowConfiguration/index.js",
21772 "groupTitle": "Servicenow_Configurations"
21776 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21777 "title": "Gets configurations descriptions",
21780 "title": "Example usage:",
21781 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21785 "name": "getDescriptions",
21786 "group": "Servicenow_Configurations",
21787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21788 "version": "0.0.0",
21789 "filename": "server/api/intServicenowConfiguration/index.js",
21790 "groupTitle": "Servicenow_Configurations"
21794 "url": "/api/integrations/servicenow/configurations/{id}/fields",
21795 "title": "Gets configurations fields",
21798 "title": "Example usage:",
21799 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21803 "name": "getFields",
21804 "group": "Servicenow_Configurations",
21805 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21806 "version": "0.0.0",
21807 "filename": "server/api/intServicenowConfiguration/index.js",
21808 "groupTitle": "Servicenow_Configurations"
21812 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21813 "title": "Gets configurations subjects",
21816 "title": "Example usage:",
21817 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21821 "name": "getSubjects",
21822 "group": "Servicenow_Configurations",
21823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21824 "version": "0.0.0",
21825 "filename": "server/api/intServicenowConfiguration/index.js",
21826 "groupTitle": "Servicenow_Configurations"
21830 "url": "/api/integrations/servicenow/configurations/{id}",
21831 "title": "Update an existing Servicenow Configuration",
21834 "title": "Example usage:",
21835 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21839 "name": "updateServicenow_Configurations",
21840 "group": "Servicenow_Configurations",
21841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21842 "version": "0.0.0",
21843 "filename": "server/api/intServicenowConfiguration/index.js",
21844 "groupTitle": "Servicenow_Configurations"
21848 "url": "/api/integrations/servicenow/fields",
21849 "title": "Creates a new Servicenow Field",
21852 "title": "Example usage:",
21853 "content": "curl https://{domain}/api/integrations/servicenow/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21857 "name": "CreateServicenow_Fields",
21858 "group": "Servicenow_Fields",
21868 "\"customVariable\"",
21880 "field": "content",
21896 "\"customVariable\""
21899 "field": "keyType",
21906 "field": "keyContent",
21913 "field": "idField",
21920 "field": "nameField",
21927 "field": "customField",
21934 "field": "variableName",
21940 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21941 "version": "0.0.0",
21942 "filename": "server/api/intServicenowField/index.js",
21943 "groupTitle": "Servicenow_Fields"
21947 "url": "/api/integrations/servicenow/fields/{id}",
21948 "title": "Deletes a Servicenow Field",
21951 "title": "Example usage:",
21952 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21956 "name": "DeleteServicenow_Fields",
21957 "group": "Servicenow_Fields",
21958 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21959 "version": "0.0.0",
21960 "filename": "server/api/intServicenowField/index.js",
21961 "groupTitle": "Servicenow_Fields"
21965 "url": "/api/integrations/servicenow/fields",
21966 "title": "Gets a list of Servicenow Fields",
21969 "title": "Example usage:",
21970 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21974 "name": "GetServicenow_Fields",
21975 "group": "Servicenow_Fields",
21976 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21977 "version": "0.0.0",
21978 "filename": "server/api/intServicenowField/index.js",
21979 "groupTitle": "Servicenow_Fields"
21983 "url": "/api/integrations/servicenow/fields/{id}",
21984 "title": "Gets a single Servicenow Field",
21987 "title": "Example usage:",
21988 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21992 "name": "ShowServicenow_Fields",
21993 "group": "Servicenow_Fields",
21994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21995 "version": "0.0.0",
21996 "filename": "server/api/intServicenowField/index.js",
21997 "groupTitle": "Servicenow_Fields"
22001 "url": "/api/integrations/servicenow/fields/{id}",
22002 "title": "Update an existing Servicenow Field",
22005 "title": "Example usage:",
22006 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22010 "name": "updateServicenow_Fields",
22011 "group": "Servicenow_Fields",
22012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22013 "version": "0.0.0",
22014 "filename": "server/api/intServicenowField/index.js",
22015 "groupTitle": "Servicenow_Fields"
22019 "url": "/api/settings",
22020 "title": "Gets a list of Settings",
22023 "title": "Example usage:",
22024 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22028 "name": "GetSettings",
22029 "group": "Settings",
22030 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/settings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/settings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/settings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/settings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/settings?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22031 "version": "0.0.0",
22032 "filename": "server/api/setting/index.js",
22033 "groupTitle": "Settings"
22037 "url": "/api/settings/{id}",
22038 "title": "Gets a single Setting",
22041 "title": "Example usage:",
22042 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22046 "name": "ShowSettings",
22047 "group": "Settings",
22048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22049 "version": "0.0.0",
22050 "filename": "server/api/setting/index.js",
22051 "groupTitle": "Settings"
22055 "url": "/api/settings/{id}/favicon",
22056 "title": "Add Favicon",
22059 "title": "Example usage:",
22060 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22064 "name": "addFavicon",
22065 "group": "Settings",
22066 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22067 "version": "0.0.0",
22068 "filename": "server/api/setting/index.js",
22069 "groupTitle": "Settings"
22073 "url": "/api/settings/{id}/logo",
22074 "title": "Add logo",
22077 "title": "Example usage:",
22078 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22083 "group": "Settings",
22084 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22085 "version": "0.0.0",
22086 "filename": "server/api/setting/index.js",
22087 "groupTitle": "Settings"
22091 "url": "/api/settings/{id}/logo_login",
22092 "title": "Add logo login",
22095 "title": "Example usage:",
22096 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22100 "name": "addLogoLogin",
22101 "group": "Settings",
22102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22103 "version": "0.0.0",
22104 "filename": "server/api/setting/index.js",
22105 "groupTitle": "Settings"
22109 "url": "/api/settings/{id}/preferred",
22110 "title": "Add Preferred",
22113 "title": "Example usage:",
22114 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22118 "name": "addPreferred",
22119 "group": "Settings",
22120 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22121 "version": "0.0.0",
22122 "filename": "server/api/setting/index.js",
22123 "groupTitle": "Settings"
22127 "url": "/api/settings/now",
22128 "title": "Get Server Current Date",
22131 "title": "Example usage:",
22132 "content": "curl https://{domain}/api/settings/now -v -X GET",
22137 "group": "Settings",
22138 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22139 "version": "0.0.0",
22140 "filename": "server/api/setting/index.js",
22141 "groupTitle": "Settings"
22145 "url": "/api/settings/{id}/favicon",
22146 "title": "Get Favicon",
22149 "title": "Example usage:",
22150 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22154 "name": "getFavicon",
22155 "group": "Settings",
22156 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22157 "version": "0.0.0",
22158 "filename": "server/api/setting/index.js",
22159 "groupTitle": "Settings"
22163 "url": "/api/settings/{id}/gdpr",
22164 "title": "Get gdpr settings",
22167 "title": "Example usage:",
22168 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22173 "group": "Settings",
22174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22175 "version": "0.0.0",
22176 "filename": "server/api/setting/index.js",
22177 "groupTitle": "Settings"
22181 "url": "/api/settings/{id}/logo",
22182 "title": "Get logo",
22185 "title": "Example usage:",
22186 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22191 "group": "Settings",
22192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22193 "version": "0.0.0",
22194 "filename": "server/api/setting/index.js",
22195 "groupTitle": "Settings"
22199 "url": "/api/settings/{id}/logo_login",
22200 "title": "Get logo login",
22203 "title": "Example usage:",
22204 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22208 "name": "getLogoLogin",
22209 "group": "Settings",
22210 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22211 "version": "0.0.0",
22212 "filename": "server/api/setting/index.js",
22213 "groupTitle": "Settings"
22217 "url": "/api/settings/{id}/preferred",
22218 "title": "Get Preferred",
22221 "title": "Example usage:",
22222 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22226 "name": "getPreferred",
22227 "group": "Settings",
22228 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22229 "version": "0.0.0",
22230 "filename": "server/api/setting/index.js",
22231 "groupTitle": "Settings"
22235 "url": "/api/settings/{id}",
22236 "title": "Update an existing Setting",
22239 "title": "Example usage:",
22240 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22244 "name": "updateSettings",
22245 "group": "Settings",
22246 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22247 "version": "0.0.0",
22248 "filename": "server/api/setting/index.js",
22249 "groupTitle": "Settings"
22253 "url": "/api/sms/accounts/{id}/users",
22254 "title": "Add agents to a sms account",
22257 "title": "Example usage:",
22258 "content": "curl https://{domain}/api/sms/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22262 "name": "AddAgents",
22263 "group": "Sms_Accounts",
22264 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22265 "version": "0.0.0",
22266 "filename": "server/api/smsAccount/index.js",
22267 "groupTitle": "Sms_Accounts"
22271 "url": "/api/sms/accounts",
22272 "title": "Creates a new Account",
22275 "title": "Example usage:",
22276 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22280 "name": "CreateAccounts",
22281 "group": "Sms_Accounts",
22343 "field": "accountSid",
22357 "field": "authToken",
22369 "field": "smsMethod",
22376 "field": "username",
22383 "field": "password",
22397 "field": "applicationId",
22404 "field": "accountId",
22411 "field": "senderString",
22418 "field": "deliveryReport",
22425 "field": "description",
22432 "field": "notificationTemplate",
22439 "field": "notificationSound",
22446 "field": "notificationShake",
22453 "field": "waitForTheAssignedAgent",
22460 "field": "queueTransfer",
22467 "field": "queueTransferTimeout",
22474 "field": "agentTransfer",
22481 "field": "agentTransferTimeout",
22488 "field": "baseUrl",
22495 "field": "mandatoryDispositionPauseId",
22496 "description": "<p>Status to put when mandatory disposition is enabled</p>"
22502 "field": "mandatoryDisposition",
22503 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22508 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22509 "version": "0.0.0",
22510 "filename": "server/api/smsAccount/index.js",
22511 "groupTitle": "Sms_Accounts"
22515 "url": "/api/sms/accounts/{id}",
22516 "title": "Deletes a Account",
22519 "title": "Example usage:",
22520 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22524 "name": "DeleteAccounts",
22525 "group": "Sms_Accounts",
22526 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22527 "version": "0.0.0",
22528 "filename": "server/api/smsAccount/index.js",
22529 "groupTitle": "Sms_Accounts"
22533 "url": "/api/sms/accounts/describe",
22534 "title": "Gets table info about Accounts",
22537 "title": "Example usage:",
22538 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22542 "name": "DescribeAccounts",
22543 "group": "Sms_Accounts",
22544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22545 "version": "0.0.0",
22546 "filename": "server/api/smsAccount/index.js",
22547 "groupTitle": "Sms_Accounts"
22551 "url": "/api/sms/accounts",
22552 "title": "Gets a list of Accounts",
22555 "title": "Example usage:",
22556 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22560 "name": "GetAccounts",
22561 "group": "Sms_Accounts",
22562 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22563 "version": "0.0.0",
22564 "filename": "server/api/smsAccount/index.js",
22565 "groupTitle": "Sms_Accounts"
22569 "url": "/api/sms/accounts/{id}/users",
22570 "title": "Gets agents from sms account",
22573 "title": "Example usage:",
22574 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22578 "name": "GetAgents",
22579 "group": "Sms_Accounts",
22580 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22581 "version": "0.0.0",
22582 "filename": "server/api/smsAccount/index.js",
22583 "groupTitle": "Sms_Accounts"
22587 "url": "/api/sms/accounts/{id}/users",
22588 "title": "Removes agents from a sms account",
22591 "title": "Example usage:",
22592 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22596 "name": "RemoveAgents",
22597 "group": "Sms_Accounts",
22598 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22599 "version": "0.0.0",
22600 "filename": "server/api/smsAccount/index.js",
22601 "groupTitle": "Sms_Accounts"
22605 "url": "/api/sms/accounts/{id}/canned_answers",
22606 "title": "Removes canned answers from account",
22609 "title": "Example usage:",
22610 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22614 "name": "RemoveAnswers",
22615 "group": "Sms_Accounts",
22616 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22617 "version": "0.0.0",
22618 "filename": "server/api/smsAccount/index.js",
22619 "groupTitle": "Sms_Accounts"
22623 "url": "/api/sms/accounts/{id}/dispositions",
22624 "title": "Removes dispositions from account",
22627 "title": "Example usage:",
22628 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22632 "name": "RemoveDispositions",
22633 "group": "Sms_Accounts",
22634 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22635 "version": "0.0.0",
22636 "filename": "server/api/smsAccount/index.js",
22637 "groupTitle": "Sms_Accounts"
22641 "url": "/api/sms/accounts/{id}",
22642 "title": "Gets a single Account",
22645 "title": "Example usage:",
22646 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22650 "name": "ShowAccounts",
22651 "group": "Sms_Accounts",
22652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22653 "version": "0.0.0",
22654 "filename": "server/api/smsAccount/index.js",
22655 "groupTitle": "Sms_Accounts"
22659 "url": "/api/sms/messages/{id}/accept",
22660 "title": "Accepts message",
22663 "title": "Example usage:",
22664 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22668 "name": "acceptMessage",
22669 "group": "Sms_Accounts",
22670 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22671 "version": "0.0.0",
22672 "filename": "server/api/smsMessage/index.js",
22673 "groupTitle": "Sms_Accounts"
22677 "url": "/api/sms/accounts/{id}/canned_answers",
22678 "title": "Creates new canned answer",
22681 "title": "Example usage:",
22682 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22686 "name": "addAnswer",
22687 "group": "Sms_Accounts",
22709 "field": "description",
22722 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22723 "version": "0.0.0",
22724 "filename": "server/api/smsAccount/index.js",
22725 "groupTitle": "Sms_Accounts"
22729 "url": "/api/sms/accounts/{id}/applications",
22730 "title": "Creates new applications",
22733 "title": "Example usage:",
22734 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22738 "name": "addApplications",
22739 "group": "Sms_Accounts",
22747 "field": "priority",
22761 "field": "appdata",
22768 "field": "description",
22775 "field": "interval",
22781 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22782 "version": "0.0.0",
22783 "filename": "server/api/smsAccount/index.js",
22784 "groupTitle": "Sms_Accounts"
22788 "url": "/api/sms/accounts/{id}/dispositions",
22789 "title": "Creates new disposition",
22792 "title": "Example usage:",
22793 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22797 "name": "addDisposition",
22798 "group": "Sms_Accounts",
22825 "field": "description",
22831 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22832 "version": "0.0.0",
22833 "filename": "server/api/smsAccount/index.js",
22834 "groupTitle": "Sms_Accounts"
22838 "url": "/api/sms/accounts/{id}/canned_answers",
22839 "title": "Gets account canned answers",
22842 "title": "Example usage:",
22843 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22847 "name": "getAnswers",
22848 "group": "Sms_Accounts",
22849 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22850 "version": "0.0.0",
22851 "filename": "server/api/smsAccount/index.js",
22852 "groupTitle": "Sms_Accounts"
22856 "url": "/api/sms/accounts/{id}/applications",
22857 "title": "Gets account applications",
22860 "title": "Example usage:",
22861 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22865 "name": "getApplications",
22866 "group": "Sms_Accounts",
22867 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22868 "version": "0.0.0",
22869 "filename": "server/api/smsAccount/index.js",
22870 "groupTitle": "Sms_Accounts"
22874 "url": "/api/sms/accounts/{id}/dispositions",
22875 "title": "Gets account dispositions",
22878 "title": "Example usage:",
22879 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22883 "name": "getDispositions",
22884 "group": "Sms_Accounts",
22885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22886 "version": "0.0.0",
22887 "filename": "server/api/smsAccount/index.js",
22888 "groupTitle": "Sms_Accounts"
22892 "url": "/api/sms/accounts/{id}/interactions",
22893 "title": "Gets Sms Account interactions",
22896 "title": "Example usage:",
22897 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22901 "name": "getInteractions",
22902 "group": "Sms_Accounts",
22903 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22904 "version": "0.0.0",
22905 "filename": "server/api/smsAccount/index.js",
22906 "groupTitle": "Sms_Accounts"
22910 "url": "/api/sms/accounts/{id}/notify",
22911 "title": "Notify new message",
22914 "title": "Example usage:",
22915 "content": "curl https://{domain}/api/sms/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22920 "group": "Sms_Accounts",
22921 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new sms message to be sent to the system.</p>",
22922 "version": "0.0.0",
22923 "filename": "server/api/smsAccount/index.js",
22924 "groupTitle": "Sms_Accounts"
22928 "url": "/api/sms/messages/{id}/reject",
22929 "title": "Rejects message",
22932 "title": "Example usage:",
22933 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22937 "name": "rejectMessage",
22938 "group": "Sms_Accounts",
22939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22940 "version": "0.0.0",
22941 "filename": "server/api/smsMessage/index.js",
22942 "groupTitle": "Sms_Accounts"
22946 "url": "/api/sms/accounts/{id}/send",
22947 "title": "Send new sms message",
22950 "title": "Example usage:",
22951 "content": "curl https://{domain}/api/sms/accounts/{id}/send -d '{from: '+39333123456', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22956 "group": "Sms_Accounts",
22957 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22958 "version": "0.0.0",
22959 "filename": "server/api/smsAccount/index.js",
22960 "groupTitle": "Sms_Accounts"
22964 "url": "/api/sms/accounts/{id}/status",
22965 "title": "Receive message status as get request",
22968 "title": "Example usage:",
22969 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22973 "name": "statusMessage",
22974 "group": "Sms_Accounts",
22975 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22976 "version": "0.0.0",
22977 "filename": "server/api/smsAccount/index.js",
22978 "groupTitle": "Sms_Accounts"
22982 "url": "/api/sms/messages/{id}/status",
22983 "title": "Receive message status",
22986 "title": "Example usage:",
22987 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22991 "name": "statusMessage",
22992 "group": "Sms_Accounts",
22993 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22994 "version": "0.0.0",
22995 "filename": "server/api/smsMessage/index.js",
22996 "groupTitle": "Sms_Accounts"
23000 "url": "/api/sms/accounts/{id}/status",
23001 "title": "Receive message status",
23004 "title": "Example usage:",
23005 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23009 "name": "statusMessage",
23010 "group": "Sms_Accounts",
23011 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23012 "version": "0.0.0",
23013 "filename": "server/api/smsAccount/index.js",
23014 "groupTitle": "Sms_Accounts"
23018 "url": "/api/sms/accounts/{id}",
23019 "title": "Update an existing Account",
23022 "title": "Example usage:",
23023 "content": "curl https://{domain}/api/sms/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23027 "name": "updateAccounts",
23028 "group": "Sms_Accounts",
23029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23030 "version": "0.0.0",
23031 "filename": "server/api/smsAccount/index.js",
23032 "groupTitle": "Sms_Accounts"
23036 "url": "/api/sms/applications",
23037 "title": "Creates a new Application",
23040 "title": "Example usage:",
23041 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23045 "name": "CreateApplications",
23046 "group": "Sms_Applications",
23054 "field": "priority",
23068 "field": "appdata",
23075 "field": "description",
23082 "field": "interval",
23088 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23089 "version": "0.0.0",
23090 "filename": "server/api/smsApplication/index.js",
23091 "groupTitle": "Sms_Applications"
23095 "url": "/api/sms/applications/{id}",
23096 "title": "Deletes a Application",
23099 "title": "Example usage:",
23100 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23104 "name": "DeleteApplications",
23105 "group": "Sms_Applications",
23106 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23107 "version": "0.0.0",
23108 "filename": "server/api/smsApplication/index.js",
23109 "groupTitle": "Sms_Applications"
23113 "url": "/api/sms/applications",
23114 "title": "Gets a list of Applications",
23117 "title": "Example usage:",
23118 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23122 "name": "GetApplications",
23123 "group": "Sms_Applications",
23124 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/applications?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23125 "version": "0.0.0",
23126 "filename": "server/api/smsApplication/index.js",
23127 "groupTitle": "Sms_Applications"
23131 "url": "/api/sms/applications/{id}",
23132 "title": "Gets a single Application",
23135 "title": "Example usage:",
23136 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23140 "name": "ShowApplications",
23141 "group": "Sms_Applications",
23142 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23143 "version": "0.0.0",
23144 "filename": "server/api/smsApplication/index.js",
23145 "groupTitle": "Sms_Applications"
23149 "url": "/api/sms/applications/{id}",
23150 "title": "Update an existing Application",
23153 "title": "Example usage:",
23154 "content": "curl https://{domain}/api/sms/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23158 "name": "updateApplications",
23159 "group": "Sms_Applications",
23160 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23161 "version": "0.0.0",
23162 "filename": "server/api/smsApplication/index.js",
23163 "groupTitle": "Sms_Applications"
23167 "url": "/api/sms/interactions/{id}/tags",
23168 "title": "Add tags to the interaction",
23171 "title": "Example usage:",
23172 "content": "curl https://{domain}/api/sms/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23177 "group": "Sms_Interactions",
23178 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23179 "version": "0.0.0",
23180 "filename": "server/api/smsInteraction/index.js",
23181 "groupTitle": "Sms_Interactions"
23185 "url": "/api/sms/interactions",
23186 "title": "Creates a new Interaction",
23189 "title": "Example usage:",
23190 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23194 "name": "CreateInteractions",
23195 "group": "Sms_Interactions",
23210 "field": "closedAt",
23217 "field": "disposition",
23224 "field": "secondDisposition",
23231 "field": "thirdDisposition",
23252 "field": "read1stAt",
23263 "field": "firstMsgDirection",
23270 "field": "lastMsgAt",
23281 "field": "lastMsgDirection",
23288 "field": "autoreplyExecuted",
23294 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23295 "version": "0.0.0",
23296 "filename": "server/api/smsInteraction/index.js",
23297 "groupTitle": "Sms_Interactions"
23301 "url": "/api/sms/interactions/{id}",
23302 "title": "Deletes a Interaction",
23305 "title": "Example usage:",
23306 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23310 "name": "DeleteInteractions",
23311 "group": "Sms_Interactions",
23312 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23313 "version": "0.0.0",
23314 "filename": "server/api/smsInteraction/index.js",
23315 "groupTitle": "Sms_Interactions"
23319 "url": "/api/sms/interactions/describe",
23320 "title": "Gets table info about Interactions",
23323 "title": "Example usage:",
23324 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23328 "name": "DescribeInteractions",
23329 "group": "Sms_Interactions",
23330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23331 "version": "0.0.0",
23332 "filename": "server/api/smsInteraction/index.js",
23333 "groupTitle": "Sms_Interactions"
23337 "url": "/api/sms/interactions",
23338 "title": "Gets a list of Interactions",
23341 "title": "Example usage:",
23342 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23346 "name": "GetInteractions",
23347 "group": "Sms_Interactions",
23348 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23349 "version": "0.0.0",
23350 "filename": "server/api/smsInteraction/index.js",
23351 "groupTitle": "Sms_Interactions"
23355 "url": "/api/sms/interactions/{id}/tags",
23356 "title": "Removes tags from interaction",
23359 "title": "Example usage:",
23360 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23364 "name": "RemoveTags",
23365 "group": "Sms_Interactions",
23366 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23367 "version": "0.0.0",
23368 "filename": "server/api/smsInteraction/index.js",
23369 "groupTitle": "Sms_Interactions"
23373 "url": "/api/sms/interactions/{id}",
23374 "title": "Gets a single Interaction",
23377 "title": "Example usage:",
23378 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23382 "name": "ShowInteractions",
23383 "group": "Sms_Interactions",
23384 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23385 "version": "0.0.0",
23386 "filename": "server/api/smsInteraction/index.js",
23387 "groupTitle": "Sms_Interactions"
23391 "url": "/api/sms/interactions/{id}/messages",
23392 "title": "Creates new messages",
23395 "title": "Example usage:",
23396 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23400 "name": "addMessage",
23401 "group": "Sms_Interactions",
23427 "field": "direction",
23434 "field": "messageId",
23462 "field": "providerName",
23469 "field": "providerResponse",
23475 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23476 "version": "0.0.0",
23477 "filename": "server/api/smsInteraction/index.js",
23478 "groupTitle": "Sms_Interactions"
23482 "url": "/api/sms/interactions/{id}/download",
23483 "title": "Gets interaction",
23486 "title": "Example usage:",
23487 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23491 "name": "download",
23492 "group": "Sms_Interactions",
23493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23494 "version": "0.0.0",
23495 "filename": "server/api/smsInteraction/index.js",
23496 "groupTitle": "Sms_Interactions"
23500 "url": "/api/sms/interactions/{id}/messages",
23501 "title": "Gets interaction messages",
23504 "title": "Example usage:",
23505 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23509 "name": "getMessages",
23510 "group": "Sms_Interactions",
23511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23512 "version": "0.0.0",
23513 "filename": "server/api/smsInteraction/index.js",
23514 "groupTitle": "Sms_Interactions"
23518 "url": "/api/sms/interactions/{id}",
23519 "title": "Update an existing Interaction",
23522 "title": "Example usage:",
23523 "content": "curl https://{domain}/api/sms/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23527 "name": "updateInteractions",
23528 "group": "Sms_Interactions",
23529 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23530 "version": "0.0.0",
23531 "filename": "server/api/smsInteraction/index.js",
23532 "groupTitle": "Sms_Interactions"
23536 "url": "/api/sms/messages",
23537 "title": "Creates a new Message",
23540 "title": "Example usage:",
23541 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23545 "name": "CreateMessages",
23546 "group": "Sms_Messages",
23572 "field": "direction",
23579 "field": "messageId",
23607 "field": "providerName",
23614 "field": "providerResponse",
23620 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23621 "version": "0.0.0",
23622 "filename": "server/api/smsMessage/index.js",
23623 "groupTitle": "Sms_Messages"
23627 "url": "/api/sms/messages/{id}",
23628 "title": "Deletes a Message",
23631 "title": "Example usage:",
23632 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23636 "name": "DeleteMessages",
23637 "group": "Sms_Messages",
23638 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23639 "version": "0.0.0",
23640 "filename": "server/api/smsMessage/index.js",
23641 "groupTitle": "Sms_Messages"
23645 "url": "/api/sms/messages/describe",
23646 "title": "Gets table info about Messages",
23649 "title": "Example usage:",
23650 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23654 "name": "DescribeMessages",
23655 "group": "Sms_Messages",
23656 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23657 "version": "0.0.0",
23658 "filename": "server/api/smsMessage/index.js",
23659 "groupTitle": "Sms_Messages"
23663 "url": "/api/sms/messages",
23664 "title": "Gets a list of Messages",
23667 "title": "Example usage:",
23668 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23672 "name": "GetMessages",
23673 "group": "Sms_Messages",
23674 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23675 "version": "0.0.0",
23676 "filename": "server/api/smsMessage/index.js",
23677 "groupTitle": "Sms_Messages"
23681 "url": "/api/sms/messages/{id}",
23682 "title": "Gets a single Message",
23685 "title": "Example usage:",
23686 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23690 "name": "ShowMessages",
23691 "group": "Sms_Messages",
23692 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23693 "version": "0.0.0",
23694 "filename": "server/api/smsMessage/index.js",
23695 "groupTitle": "Sms_Messages"
23699 "url": "/api/sms/messages/{id}",
23700 "title": "Update an existing Message",
23703 "title": "Example usage:",
23704 "content": "curl https://{domain}/api/sms/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23708 "name": "updateMessages",
23709 "group": "Sms_Messages",
23710 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23711 "version": "0.0.0",
23712 "filename": "server/api/smsMessage/index.js",
23713 "groupTitle": "Sms_Messages"
23717 "url": "/api/sms/reports/queue",
23718 "title": "Creates a new Sms Queue Report",
23721 "title": "Example usage:",
23722 "content": "curl https://{domain}/api/sms/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23726 "name": "CreateSms_Queue_Reports",
23727 "group": "Sms_Queue_Reports",
23735 "field": "uniqueid",
23756 "field": "leaveAt",
23763 "field": "acceptAt",
23783 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23784 "version": "0.0.0",
23785 "filename": "server/api/smsQueueReport/index.js",
23786 "groupTitle": "Sms_Queue_Reports"
23790 "url": "/api/sms/reports/queue/{id}",
23791 "title": "Deletes a Sms Queue Report",
23794 "title": "Example usage:",
23795 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23799 "name": "DeleteSms_Queue_Reports",
23800 "group": "Sms_Queue_Reports",
23801 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23802 "version": "0.0.0",
23803 "filename": "server/api/smsQueueReport/index.js",
23804 "groupTitle": "Sms_Queue_Reports"
23808 "url": "/api/sms/reports/queue/describe",
23809 "title": "Gets table info about Sms Queue Reports",
23812 "title": "Example usage:",
23813 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23817 "name": "DescribeSms_Queue_Reports",
23818 "group": "Sms_Queue_Reports",
23819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23820 "version": "0.0.0",
23821 "filename": "server/api/smsQueueReport/index.js",
23822 "groupTitle": "Sms_Queue_Reports"
23826 "url": "/api/sms/reports/queue",
23827 "title": "Gets a list of Sms Queue Reports",
23830 "title": "Example usage:",
23831 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23835 "name": "GetSms_Queue_Reports",
23836 "group": "Sms_Queue_Reports",
23837 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23838 "version": "0.0.0",
23839 "filename": "server/api/smsQueueReport/index.js",
23840 "groupTitle": "Sms_Queue_Reports"
23844 "url": "/api/sms/reports/queue/{id}",
23845 "title": "Gets a single Sms Queue Report",
23848 "title": "Example usage:",
23849 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23853 "name": "ShowSms_Queue_Reports",
23854 "group": "Sms_Queue_Reports",
23855 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23856 "version": "0.0.0",
23857 "filename": "server/api/smsQueueReport/index.js",
23858 "groupTitle": "Sms_Queue_Reports"
23862 "url": "/api/sms/reports/queue/{id}",
23863 "title": "Update an existing Sms Queue Report",
23866 "title": "Example usage:",
23867 "content": "curl https://{domain}/api/sms/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
23871 "name": "updateSms_Queue_Reports",
23872 "group": "Sms_Queue_Reports",
23873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23874 "version": "0.0.0",
23875 "filename": "server/api/smsQueueReport/index.js",
23876 "groupTitle": "Sms_Queue_Reports"
23880 "url": "/api/sms/queues/{id}/users",
23881 "title": "Add agents to a queue",
23884 "title": "Example usage:",
23885 "content": "curl https://{domain}/api/sms/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23889 "name": "AddAgents",
23890 "group": "Sms_Queues",
23891 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23892 "version": "0.0.0",
23893 "filename": "server/api/smsQueue/index.js",
23894 "groupTitle": "Sms_Queues"
23898 "url": "/api/sms/queues/{id}/teams",
23899 "title": "Add teams to a queue",
23902 "title": "Example usage:",
23903 "content": "curl https://{domain}/api/sms/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23907 "name": "AddTeams",
23908 "group": "Sms_Queues",
23909 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23910 "version": "0.0.0",
23911 "filename": "server/api/smsQueue/index.js",
23912 "groupTitle": "Sms_Queues"
23916 "url": "/api/sms/queues",
23917 "title": "Creates a new Queue",
23920 "title": "Example usage:",
23921 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23925 "name": "CreateQueues",
23926 "group": "Sms_Queues",
23941 "field": "description",
23948 "field": "timeout",
23960 "field": "strategy",
23966 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23967 "version": "0.0.0",
23968 "filename": "server/api/smsQueue/index.js",
23969 "groupTitle": "Sms_Queues"
23973 "url": "/api/sms/queues/{id}",
23974 "title": "Deletes a Queue",
23977 "title": "Example usage:",
23978 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23982 "name": "DeleteQueues",
23983 "group": "Sms_Queues",
23984 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23985 "version": "0.0.0",
23986 "filename": "server/api/smsQueue/index.js",
23987 "groupTitle": "Sms_Queues"
23991 "url": "/api/sms/queues/describe",
23992 "title": "Gets table info about Queues",
23995 "title": "Example usage:",
23996 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
24000 "name": "DescribeQueues",
24001 "group": "Sms_Queues",
24002 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24003 "version": "0.0.0",
24004 "filename": "server/api/smsQueue/index.js",
24005 "groupTitle": "Sms_Queues"
24009 "url": "/api/sms/queues/{id}/users",
24010 "title": "Gets queue agents",
24013 "title": "Example usage:",
24014 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24018 "name": "GetAgents",
24019 "group": "Sms_Queues",
24020 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24021 "version": "0.0.0",
24022 "filename": "server/api/smsQueue/index.js",
24023 "groupTitle": "Sms_Queues"
24027 "url": "/api/sms/queues/{id}/members",
24028 "title": "GetMembers",
24031 "title": "Example usage:",
24032 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
24036 "name": "GetMembers",
24037 "group": "Sms_Queues",
24038 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24039 "version": "0.0.0",
24040 "filename": "server/api/smsQueue/index.js",
24041 "groupTitle": "Sms_Queues"
24045 "url": "/api/sms/queues",
24046 "title": "Gets a list of Queues",
24049 "title": "Example usage:",
24050 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24054 "name": "GetQueues",
24055 "group": "Sms_Queues",
24056 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24057 "version": "0.0.0",
24058 "filename": "server/api/smsQueue/index.js",
24059 "groupTitle": "Sms_Queues"
24063 "url": "/api/sms/queues/{id}/teams",
24064 "title": "Gets queues list",
24067 "title": "Example usage:",
24068 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24072 "name": "GetTeams",
24073 "group": "Sms_Queues",
24074 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24075 "version": "0.0.0",
24076 "filename": "server/api/smsQueue/index.js",
24077 "groupTitle": "Sms_Queues"
24081 "url": "/api/sms/queues/{id}/users",
24082 "title": "Removes agents from a queue",
24085 "title": "Example usage:",
24086 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24090 "name": "RemoveAgents",
24091 "group": "Sms_Queues",
24092 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24093 "version": "0.0.0",
24094 "filename": "server/api/smsQueue/index.js",
24095 "groupTitle": "Sms_Queues"
24099 "url": "/api/sms/queues/{id}",
24100 "title": "Gets a single Queue",
24103 "title": "Example usage:",
24104 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24108 "name": "ShowQueues",
24109 "group": "Sms_Queues",
24110 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24111 "version": "0.0.0",
24112 "filename": "server/api/smsQueue/index.js",
24113 "groupTitle": "Sms_Queues"
24117 "url": "/api/sms/queues/{id}",
24118 "title": "Update an existing Queue",
24121 "title": "Example usage:",
24122 "content": "curl https://{domain}/api/sms/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24126 "name": "updateQueues",
24127 "group": "Sms_Queues",
24128 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24129 "version": "0.0.0",
24130 "filename": "server/api/smsQueue/index.js",
24131 "groupTitle": "Sms_Queues"
24135 "url": "/api/sms/reports/transfer",
24136 "title": "Creates a new Sms Transfer Report",
24139 "title": "Example usage:",
24140 "content": "curl https://{domain}/api/sms/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24144 "name": "CreateSms_Transfer_Reports",
24145 "group": "Sms_Transfer_Reports",
24153 "field": "uniqueid",
24172 "field": "transferredAt",
24178 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24179 "version": "0.0.0",
24180 "filename": "server/api/smsTransferReport/index.js",
24181 "groupTitle": "Sms_Transfer_Reports"
24185 "url": "/api/sms/reports/transfer/{id}",
24186 "title": "Deletes a Sms Transfer Report",
24189 "title": "Example usage:",
24190 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24194 "name": "DeleteSms_Transfer_Reports",
24195 "group": "Sms_Transfer_Reports",
24196 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24197 "version": "0.0.0",
24198 "filename": "server/api/smsTransferReport/index.js",
24199 "groupTitle": "Sms_Transfer_Reports"
24203 "url": "/api/sms/reports/transfer/describe",
24204 "title": "Gets table info about Sms Transfer Reports",
24207 "title": "Example usage:",
24208 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24212 "name": "DescribeSms_Transfer_Reports",
24213 "group": "Sms_Transfer_Reports",
24214 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24215 "version": "0.0.0",
24216 "filename": "server/api/smsTransferReport/index.js",
24217 "groupTitle": "Sms_Transfer_Reports"
24221 "url": "/api/sms/reports/transfer",
24222 "title": "Gets a list of Sms Transfer Reports",
24225 "title": "Example usage:",
24226 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24230 "name": "GetSms_Transfer_Reports",
24231 "group": "Sms_Transfer_Reports",
24232 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sms/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sms/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sms/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sms/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sms/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24233 "version": "0.0.0",
24234 "filename": "server/api/smsTransferReport/index.js",
24235 "groupTitle": "Sms_Transfer_Reports"
24239 "url": "/api/sms/reports/transfer/{id}",
24240 "title": "Gets a single Sms Transfer Report",
24243 "title": "Example usage:",
24244 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24248 "name": "ShowSms_Transfer_Reports",
24249 "group": "Sms_Transfer_Reports",
24250 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24251 "version": "0.0.0",
24252 "filename": "server/api/smsTransferReport/index.js",
24253 "groupTitle": "Sms_Transfer_Reports"
24257 "url": "/api/sms/reports/transfer/{id}",
24258 "title": "Update an existing Sms Transfer Report",
24261 "title": "Example usage:",
24262 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24266 "name": "updateSms_Transfer_Reports",
24267 "group": "Sms_Transfer_Reports",
24268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24269 "version": "0.0.0",
24270 "filename": "server/api/smsTransferReport/index.js",
24271 "groupTitle": "Sms_Transfer_Reports"
24275 "url": "/api/sounds",
24276 "title": "Gets a list of Sounds",
24279 "title": "Example usage:",
24280 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24284 "name": "GetSounds",
24286 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/sounds?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/sounds?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/sounds?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/sounds?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/sounds?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24287 "version": "0.0.0",
24288 "filename": "server/api/sound/index.js",
24289 "groupTitle": "Sounds"
24293 "url": "/api/sounds/{id}",
24294 "title": "Gets a single Sound",
24297 "title": "Example usage:",
24298 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24302 "name": "ShowSounds",
24304 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24305 "version": "0.0.0",
24306 "filename": "server/api/sound/index.js",
24307 "groupTitle": "Sounds"
24311 "url": "/api/sounds",
24312 "title": "Create a new sound",
24315 "title": "Example usage:",
24316 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24320 "name": "addSound",
24322 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24323 "version": "0.0.0",
24324 "filename": "server/api/sound/index.js",
24325 "groupTitle": "Sounds"
24329 "url": "/api/sounds/{id}",
24330 "title": "Deletes a sound",
24333 "title": "Example usage:",
24334 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24338 "name": "destroySound",
24340 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24341 "version": "0.0.0",
24342 "filename": "server/api/sound/index.js",
24343 "groupTitle": "Sounds"
24347 "url": "/api/sounds/{id}/download",
24348 "title": "Download Sound",
24351 "title": "Example usage:",
24352 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24356 "name": "download",
24358 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24359 "version": "0.0.0",
24360 "filename": "server/api/sound/index.js",
24361 "groupTitle": "Sounds"
24365 "url": "/api/sounds",
24366 "title": "Update an existing new sound",
24369 "title": "Example usage:",
24370 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24374 "name": "updateSound",
24376 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24377 "version": "0.0.0",
24378 "filename": "server/api/sound/index.js",
24379 "groupTitle": "Sounds"
24383 "url": "/api/square/details/reports",
24384 "title": "Creates a new Square Detail Report",
24387 "title": "Example usage:",
24388 "content": "curl https://{domain}/api/square/details/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24392 "name": "CreateSquare_Detail_Reports",
24393 "group": "Square_Details_Reports",
24401 "field": "uniqueid",
24415 "field": "application",
24429 "field": "project_name",
24436 "field": "callerid",
24442 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24443 "version": "0.0.0",
24444 "filename": "server/api/squareReportDetail/index.js",
24445 "groupTitle": "Square_Details_Reports"
24449 "url": "/api/square/details/reports/{id}",
24450 "title": "Deletes a Square Detail Report",
24453 "title": "Example usage:",
24454 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24458 "name": "DeleteSquare_Detail_Reports",
24459 "group": "Square_Details_Reports",
24460 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24461 "version": "0.0.0",
24462 "filename": "server/api/squareReportDetail/index.js",
24463 "groupTitle": "Square_Details_Reports"
24467 "url": "/api/square/details/reports/describe",
24468 "title": "Gets table info about Square Detail Reports",
24471 "title": "Example usage:",
24472 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24476 "name": "DescribeSquare_Detail_Reports",
24477 "group": "Square_Details_Reports",
24478 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24479 "version": "0.0.0",
24480 "filename": "server/api/squareReportDetail/index.js",
24481 "groupTitle": "Square_Details_Reports"
24485 "url": "/api/square/details/reports",
24486 "title": "Gets a list of Square Detail Reports",
24489 "title": "Example usage:",
24490 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24494 "name": "GetSquare_Detail_Reports",
24495 "group": "Square_Details_Reports",
24496 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/details/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/details/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/details/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/details/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/details/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24497 "version": "0.0.0",
24498 "filename": "server/api/squareReportDetail/index.js",
24499 "groupTitle": "Square_Details_Reports"
24503 "url": "/api/square/details/reports/{id}",
24504 "title": "Gets a single Square Detail Report",
24507 "title": "Example usage:",
24508 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24512 "name": "ShowSquare_Detail_Reports",
24513 "group": "Square_Details_Reports",
24514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24515 "version": "0.0.0",
24516 "filename": "server/api/squareReportDetail/index.js",
24517 "groupTitle": "Square_Details_Reports"
24521 "url": "/api/square/details/reports/{id}",
24522 "title": "Update an existing Square Detail Report",
24525 "title": "Example usage:",
24526 "content": "curl https://{domain}/api/square/details/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24530 "name": "updateSquare_Detail_Reports",
24531 "group": "Square_Details_Reports",
24532 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24533 "version": "0.0.0",
24534 "filename": "server/api/squareReportDetail/index.js",
24535 "groupTitle": "Square_Details_Reports"
24539 "url": "/api/square/messages",
24540 "title": "Creates a new Message",
24543 "title": "Example usage:",
24544 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24548 "name": "CreateMessages",
24549 "group": "Square_Messages",
24557 "field": "uniqueid",
24575 "field": "direction",
24582 "field": "providerName",
24589 "field": "providerResponse",
24595 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24596 "version": "0.0.0",
24597 "filename": "server/api/squareMessage/index.js",
24598 "groupTitle": "Square_Messages"
24602 "url": "/api/square/messages/{id}",
24603 "title": "Deletes a Message",
24606 "title": "Example usage:",
24607 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24611 "name": "DeleteMessages",
24612 "group": "Square_Messages",
24613 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24614 "version": "0.0.0",
24615 "filename": "server/api/squareMessage/index.js",
24616 "groupTitle": "Square_Messages"
24620 "url": "/api/square/messages",
24621 "title": "Gets a list of Messages",
24624 "title": "Example usage:",
24625 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24629 "name": "GetMessages",
24630 "group": "Square_Messages",
24631 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24632 "version": "0.0.0",
24633 "filename": "server/api/squareMessage/index.js",
24634 "groupTitle": "Square_Messages"
24638 "url": "/api/square/messages/{id}",
24639 "title": "Gets a single Message",
24642 "title": "Example usage:",
24643 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24647 "name": "ShowMessages",
24648 "group": "Square_Messages",
24649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24650 "version": "0.0.0",
24651 "filename": "server/api/squareMessage/index.js",
24652 "groupTitle": "Square_Messages"
24656 "url": "/api/square/messages/{id}",
24657 "title": "Update an existing Message",
24660 "title": "Example usage:",
24661 "content": "curl https://{domain}/api/square/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24665 "name": "updateMessages",
24666 "group": "Square_Messages",
24667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24668 "version": "0.0.0",
24669 "filename": "server/api/squareMessage/index.js",
24670 "groupTitle": "Square_Messages"
24674 "url": "/api/square/odbc",
24675 "title": "Creates a new ODBC",
24678 "title": "Example usage:",
24679 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24683 "name": "CreateODBCs",
24684 "group": "Square_ODBC",
24706 "field": "description",
24712 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24713 "version": "0.0.0",
24714 "filename": "server/api/squareOdbc/index.js",
24715 "groupTitle": "Square_ODBC"
24719 "url": "/api/square/odbc/{id}",
24720 "title": "Deletes a ODBC",
24723 "title": "Example usage:",
24724 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24728 "name": "DeleteODBCs",
24729 "group": "Square_ODBC",
24730 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24731 "version": "0.0.0",
24732 "filename": "server/api/squareOdbc/index.js",
24733 "groupTitle": "Square_ODBC"
24737 "url": "/api/square/odbc",
24738 "title": "Gets a list of ODBCs",
24741 "title": "Example usage:",
24742 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24746 "name": "GetODBCs",
24747 "group": "Square_ODBC",
24748 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/odbc?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/odbc?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/odbc?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/odbc?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/odbc?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24749 "version": "0.0.0",
24750 "filename": "server/api/squareOdbc/index.js",
24751 "groupTitle": "Square_ODBC"
24755 "url": "/api/square/odbc/{id}",
24756 "title": "Gets a single ODBC",
24759 "title": "Example usage:",
24760 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24764 "name": "ShowODBCs",
24765 "group": "Square_ODBC",
24766 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24767 "version": "0.0.0",
24768 "filename": "server/api/squareOdbc/index.js",
24769 "groupTitle": "Square_ODBC"
24773 "url": "/api/square/odbc/{id}/test",
24774 "title": "Test Odbc",
24777 "title": "Example usage:",
24778 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24783 "group": "Square_ODBC",
24784 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24785 "version": "0.0.0",
24786 "filename": "server/api/squareOdbc/index.js",
24787 "groupTitle": "Square_ODBC"
24791 "url": "/api/square/odbc/{id}",
24792 "title": "Update an existing ODBC",
24795 "title": "Example usage:",
24796 "content": "curl https://{domain}/api/square/odbc/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24800 "name": "updateODBCs",
24801 "group": "Square_ODBC",
24802 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24803 "version": "0.0.0",
24804 "filename": "server/api/squareOdbc/index.js",
24805 "groupTitle": "Square_ODBC"
24809 "url": "/api/square/projects",
24810 "title": "Creates a new Project",
24813 "title": "Example usage:",
24814 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24818 "name": "CreateProjects",
24819 "group": "Square_Projects",
24834 "field": "description",
24848 "field": "preproduction",
24855 "field": "production",
24862 "field": "savedAt",
24869 "field": "publishedAt",
24875 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24876 "version": "0.0.0",
24877 "filename": "server/api/squareProject/index.js",
24878 "groupTitle": "Square_Projects"
24882 "url": "/api/square/projects/{id}",
24883 "title": "Deletes a Project",
24886 "title": "Example usage:",
24887 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24891 "name": "DeleteProjects",
24892 "group": "Square_Projects",
24893 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24894 "version": "0.0.0",
24895 "filename": "server/api/squareProject/index.js",
24896 "groupTitle": "Square_Projects"
24900 "url": "/api/square/projects",
24901 "title": "Gets a list of Projects",
24904 "title": "Example usage:",
24905 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24909 "name": "GetProjects",
24910 "group": "Square_Projects",
24911 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/projects?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/projects?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/projects?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/projects?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/projects?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24912 "version": "0.0.0",
24913 "filename": "server/api/squareProject/index.js",
24914 "groupTitle": "Square_Projects"
24918 "url": "/api/square/projects/{id}",
24919 "title": "Gets a single Project",
24922 "title": "Example usage:",
24923 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24927 "name": "ShowProjects",
24928 "group": "Square_Projects",
24929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24930 "version": "0.0.0",
24931 "filename": "server/api/squareProject/index.js",
24932 "groupTitle": "Square_Projects"
24936 "url": "/api/square/projects/{id}/users",
24937 "title": "Adds user permissions to a Project",
24940 "title": "Example usage:",
24941 "content": "curl https://{domain}/api/square/projects/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24945 "name": "addUsers",
24946 "group": "Square_Projects",
24947 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24948 "version": "0.0.0",
24949 "filename": "server/api/squareProject/index.js",
24950 "groupTitle": "Square_Projects"
24954 "url": "/api/square/projects/{id}/users",
24955 "title": "Gets users permissions from Project",
24958 "title": "Example usage:",
24959 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24963 "name": "getUsers",
24964 "group": "Square_Projects",
24965 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24966 "version": "0.0.0",
24967 "filename": "server/api/squareProject/index.js",
24968 "groupTitle": "Square_Projects"
24972 "url": "/api/square/projects/{id}/users",
24973 "title": "Removes user permissions from a Project",
24976 "title": "Example usage:",
24977 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24981 "name": "removeUsers",
24982 "group": "Square_Projects",
24983 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24984 "version": "0.0.0",
24985 "filename": "server/api/squareProject/index.js",
24986 "groupTitle": "Square_Projects"
24990 "url": "/api/square/projects/{id}",
24991 "title": "Update an existing Project",
24994 "title": "Example usage:",
24995 "content": "curl https://{domain}/api/square/projects/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
24999 "name": "updateProjects",
25000 "group": "Square_Projects",
25001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25002 "version": "0.0.0",
25003 "filename": "server/api/squareProject/index.js",
25004 "groupTitle": "Square_Projects"
25008 "url": "/api/square/recordings",
25009 "title": "Creates a new Recording",
25012 "title": "Example usage:",
25013 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25017 "name": "CreateRecordings",
25018 "group": "Square_Recordings",
25026 "field": "uniqueid",
25033 "field": "callerid",
25040 "field": "calleridname",
25047 "field": "context",
25054 "field": "extension",
25061 "field": "priority",
25068 "field": "accountcode",
25082 "field": "projectName",
25089 "field": "saveName",
25096 "field": "filename",
25103 "field": "savePath",
25116 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25117 "version": "0.0.0",
25118 "filename": "server/api/squareRecording/index.js",
25119 "groupTitle": "Square_Recordings"
25123 "url": "/api/square/recordings",
25124 "title": "Gets a list of Recordings",
25127 "title": "Example usage:",
25128 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25132 "name": "GetRecordings",
25133 "group": "Square_Recordings",
25134 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/recordings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/recordings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/recordings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/recordings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/recordings?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25135 "version": "0.0.0",
25136 "filename": "server/api/squareRecording/index.js",
25137 "groupTitle": "Square_Recordings"
25141 "url": "/api/square/recordings/{id}",
25142 "title": "Gets a single Recording",
25145 "title": "Example usage:",
25146 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25150 "name": "ShowRecordings",
25151 "group": "Square_Recordings",
25152 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25153 "version": "0.0.0",
25154 "filename": "server/api/squareRecording/index.js",
25155 "groupTitle": "Square_Recordings"
25159 "url": "/api/square/recordings/{id}",
25160 "title": "Delete recording",
25163 "title": "Example usage:",
25164 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25169 "group": "Square_Recordings",
25170 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25171 "version": "0.0.0",
25172 "filename": "server/api/squareRecording/index.js",
25173 "groupTitle": "Square_Recordings"
25177 "url": "/api/square/recordings/{id}/download",
25178 "title": "Download Recording",
25181 "title": "Example usage:",
25182 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25186 "name": "download",
25187 "group": "Square_Recordings",
25188 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25189 "version": "0.0.0",
25190 "filename": "server/api/squareRecording/index.js",
25191 "groupTitle": "Square_Recordings"
25195 "url": "/api/square/recordings/{id}",
25196 "title": "Update an existing Recording",
25199 "title": "Example usage:",
25200 "content": "curl https://{domain}/api/square/recordings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25204 "name": "updateRecordings",
25205 "group": "Square_Recordings",
25206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25207 "version": "0.0.0",
25208 "filename": "server/api/squareRecording/index.js",
25209 "groupTitle": "Square_Recordings"
25213 "url": "/api/square/reports",
25214 "title": "Creates a new Square Report",
25217 "title": "Example usage:",
25218 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25222 "name": "CreateSquare_Reports",
25223 "group": "Square_Reports",
25231 "field": "network",
25238 "field": "network_script",
25245 "field": "request",
25252 "field": "channel",
25259 "field": "language",
25273 "field": "uniqueid",
25280 "field": "version",
25287 "field": "callerid",
25294 "field": "calleridname",
25301 "field": "callingpres",
25308 "field": "callingani2",
25315 "field": "callington",
25322 "field": "callingtns",
25343 "field": "context",
25350 "field": "extension",
25357 "field": "priority",
25364 "field": "enhanced",
25371 "field": "accountcode",
25378 "field": "threadid",
25385 "field": "project_name",
25399 "field": "leaveAt",
25412 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25413 "version": "0.0.0",
25414 "filename": "server/api/squareReport/index.js",
25415 "groupTitle": "Square_Reports"
25419 "url": "/api/square/reports/{id}",
25420 "title": "Deletes a Square Report",
25423 "title": "Example usage:",
25424 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25428 "name": "DeleteSquare_Reports",
25429 "group": "Square_Reports",
25430 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25431 "version": "0.0.0",
25432 "filename": "server/api/squareReport/index.js",
25433 "groupTitle": "Square_Reports"
25437 "url": "/api/square/reports/describe",
25438 "title": "Gets table info about Square Reports",
25441 "title": "Example usage:",
25442 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25446 "name": "DescribeSquare_Reports",
25447 "group": "Square_Reports",
25448 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25449 "version": "0.0.0",
25450 "filename": "server/api/squareReport/index.js",
25451 "groupTitle": "Square_Reports"
25455 "url": "/api/square/reports",
25456 "title": "Gets a list of Square Reports",
25459 "title": "Example usage:",
25460 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25464 "name": "GetSquare_Reports",
25465 "group": "Square_Reports",
25466 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/square/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/square/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/square/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/square/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/square/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25467 "version": "0.0.0",
25468 "filename": "server/api/squareReport/index.js",
25469 "groupTitle": "Square_Reports"
25473 "url": "/api/square/reports/{id}",
25474 "title": "Gets a single Square Report",
25477 "title": "Example usage:",
25478 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25482 "name": "ShowSquare_Reports",
25483 "group": "Square_Reports",
25484 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25485 "version": "0.0.0",
25486 "filename": "server/api/squareReport/index.js",
25487 "groupTitle": "Square_Reports"
25491 "url": "/api/square/reports/{id}",
25492 "title": "Update an existing Square Report",
25495 "title": "Example usage:",
25496 "content": "curl https://{domain}/api/square/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25500 "name": "updateSquare_Reports",
25501 "group": "Square_Reports",
25502 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25503 "version": "0.0.0",
25504 "filename": "server/api/squareReport/index.js",
25505 "groupTitle": "Square_Reports"
25509 "url": "/api/integrations/sugarcrm/configurations",
25510 "title": "Creates a new SugarCRM Configuration",
25513 "title": "Example usage:",
25514 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25518 "name": "CreateSugarCRM_Configurations",
25519 "group": "SugarCRM_Configurations",
25534 "field": "description",
25540 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25541 "version": "0.0.0",
25542 "filename": "server/api/intSugarcrmConfiguration/index.js",
25543 "groupTitle": "SugarCRM_Configurations"
25547 "url": "/api/integrations/sugarcrm/configurations/{id}",
25548 "title": "Deletes a SugarCRM Configuration",
25551 "title": "Example usage:",
25552 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25556 "name": "DeleteSugarCRM_Configurations",
25557 "group": "SugarCRM_Configurations",
25558 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25559 "version": "0.0.0",
25560 "filename": "server/api/intSugarcrmConfiguration/index.js",
25561 "groupTitle": "SugarCRM_Configurations"
25565 "url": "/api/integrations/sugarcrm/configurations",
25566 "title": "Gets a list of SugarCRM Configurations",
25569 "title": "Example usage:",
25570 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25574 "name": "GetSugarCRM_Configurations",
25575 "group": "SugarCRM_Configurations",
25576 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/sugarcrm/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/sugarcrm/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/sugarcrm/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/sugarcrm/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/sugarcrm/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25577 "version": "0.0.0",
25578 "filename": "server/api/intSugarcrmConfiguration/index.js",
25579 "groupTitle": "SugarCRM_Configurations"
25583 "url": "/api/integrations/sugarcrm/configurations/{id}",
25584 "title": "Gets a single SugarCRM Configuration",
25587 "title": "Example usage:",
25588 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25592 "name": "ShowSugarCRM_Configurations",
25593 "group": "SugarCRM_Configurations",
25594 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25595 "version": "0.0.0",
25596 "filename": "server/api/intSugarcrmConfiguration/index.js",
25597 "groupTitle": "SugarCRM_Configurations"
25601 "url": "/api/integrations/sugarcrm/configurations/{id}",
25602 "title": "Update an existing SugarCRM Configuration",
25605 "title": "Example usage:",
25606 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25610 "name": "updateSugarCRM_Configurations",
25611 "group": "SugarCRM_Configurations",
25612 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25613 "version": "0.0.0",
25614 "filename": "server/api/intSugarcrmConfiguration/index.js",
25615 "groupTitle": "SugarCRM_Configurations"
25619 "url": "/api/integrations/sugarcrm/accounts",
25620 "title": "Creates a new Sugarcrm Account",
25623 "title": "Example usage:",
25624 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25628 "name": "CreateSugarcrm_Accounts",
25629 "group": "Sugarcrm_Accounts",
25644 "field": "description",
25651 "field": "username",
25658 "field": "password",
25665 "field": "remoteUri",
25672 "field": "serverUrl",
25678 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25679 "version": "0.0.0",
25680 "filename": "server/api/intSugarcrmAccount/index.js",
25681 "groupTitle": "Sugarcrm_Accounts"
25685 "url": "/api/integrations/sugarcrm/accounts/{id}",
25686 "title": "Deletes a Sugarcrm Account",
25689 "title": "Example usage:",
25690 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25694 "name": "DeleteSugarcrm_Accounts",
25695 "group": "Sugarcrm_Accounts",
25696 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25697 "version": "0.0.0",
25698 "filename": "server/api/intSugarcrmAccount/index.js",
25699 "groupTitle": "Sugarcrm_Accounts"
25703 "url": "/api/integrations/sugarcrm/accounts",
25704 "title": "Gets a list of Sugarcrm Accounts",
25707 "title": "Example usage:",
25708 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25712 "name": "GetSugarcrm_Accounts",
25713 "group": "Sugarcrm_Accounts",
25714 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/sugarcrm/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/sugarcrm/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/sugarcrm/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/sugarcrm/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/sugarcrm/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25715 "version": "0.0.0",
25716 "filename": "server/api/intSugarcrmAccount/index.js",
25717 "groupTitle": "Sugarcrm_Accounts"
25721 "url": "/api/integrations/sugarcrm/accounts/{id}",
25722 "title": "Gets a single Sugarcrm Account",
25725 "title": "Example usage:",
25726 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25730 "name": "ShowSugarcrm_Accounts",
25731 "group": "Sugarcrm_Accounts",
25732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25733 "version": "0.0.0",
25734 "filename": "server/api/intSugarcrmAccount/index.js",
25735 "groupTitle": "Sugarcrm_Accounts"
25739 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25740 "title": "Creates new configuration",
25743 "title": "Example usage:",
25744 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25748 "name": "addConfiguration",
25749 "group": "Sugarcrm_Accounts",
25750 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25751 "version": "0.0.0",
25752 "filename": "server/api/intSugarcrmAccount/index.js",
25753 "groupTitle": "Sugarcrm_Accounts"
25757 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25758 "title": "Gets account configurations",
25761 "title": "Example usage:",
25762 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25766 "name": "getConfigurations",
25767 "group": "Sugarcrm_Accounts",
25768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25769 "version": "0.0.0",
25770 "filename": "server/api/intSugarcrmAccount/index.js",
25771 "groupTitle": "Sugarcrm_Accounts"
25775 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25776 "title": "Gets account fields",
25779 "title": "Example usage:",
25780 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25784 "name": "getFields",
25785 "group": "Sugarcrm_Accounts",
25786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25787 "version": "0.0.0",
25788 "filename": "server/api/intSugarcrmAccount/index.js",
25789 "groupTitle": "Sugarcrm_Accounts"
25793 "url": "/api/integrations/sugarcrm/accounts/{id}",
25794 "title": "Update an existing Sugarcrm Account",
25797 "title": "Example usage:",
25798 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25802 "name": "updateSugarcrm_Accounts",
25803 "group": "Sugarcrm_Accounts",
25804 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25805 "version": "0.0.0",
25806 "filename": "server/api/intSugarcrmAccount/index.js",
25807 "groupTitle": "Sugarcrm_Accounts"
25811 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25812 "title": "Gets configurations descriptions",
25815 "title": "Example usage:",
25816 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25820 "name": "getDescriptions",
25821 "group": "Sugarcrm_Configurations",
25822 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25823 "version": "0.0.0",
25824 "filename": "server/api/intSugarcrmConfiguration/index.js",
25825 "groupTitle": "Sugarcrm_Configurations"
25829 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25830 "title": "Gets configurations fields",
25833 "title": "Example usage:",
25834 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25838 "name": "getFields",
25839 "group": "Sugarcrm_Configurations",
25840 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25841 "version": "0.0.0",
25842 "filename": "server/api/intSugarcrmConfiguration/index.js",
25843 "groupTitle": "Sugarcrm_Configurations"
25847 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25848 "title": "Gets configurations subjects",
25851 "title": "Example usage:",
25852 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25856 "name": "getSubjects",
25857 "group": "Sugarcrm_Configurations",
25858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25859 "version": "0.0.0",
25860 "filename": "server/api/intSugarcrmConfiguration/index.js",
25861 "groupTitle": "Sugarcrm_Configurations"
25865 "url": "/api/integrations/sugarcrm/fields",
25866 "title": "Creates a new Sugarcrm Field",
25869 "title": "Example usage:",
25870 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25874 "name": "CreateSugarcrm_Fields",
25875 "group": "Sugarcrm_Fields",
25885 "\"customVariable\"",
25897 "field": "content",
25913 "\"customVariable\""
25916 "field": "keyType",
25923 "field": "keyContent",
25930 "field": "idField",
25937 "field": "nameField",
25944 "field": "customField",
25951 "field": "variableName",
25957 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25958 "version": "0.0.0",
25959 "filename": "server/api/intSugarcrmField/index.js",
25960 "groupTitle": "Sugarcrm_Fields"
25964 "url": "/api/integrations/sugarcrm/fields/{id}",
25965 "title": "Deletes a Sugarcrm Field",
25968 "title": "Example usage:",
25969 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25973 "name": "DeleteSugarcrm_Fields",
25974 "group": "Sugarcrm_Fields",
25975 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25976 "version": "0.0.0",
25977 "filename": "server/api/intSugarcrmField/index.js",
25978 "groupTitle": "Sugarcrm_Fields"
25982 "url": "/api/integrations/sugarcrm/fields",
25983 "title": "Gets a list of Sugarcrm Fields",
25986 "title": "Example usage:",
25987 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25991 "name": "GetSugarcrm_Fields",
25992 "group": "Sugarcrm_Fields",
25993 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/sugarcrm/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/sugarcrm/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/sugarcrm/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/sugarcrm/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/sugarcrm/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25994 "version": "0.0.0",
25995 "filename": "server/api/intSugarcrmField/index.js",
25996 "groupTitle": "Sugarcrm_Fields"
26000 "url": "/api/integrations/sugarcrm/fields/{id}",
26001 "title": "Gets a single Sugarcrm Field",
26004 "title": "Example usage:",
26005 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26009 "name": "ShowSugarcrm_Fields",
26010 "group": "Sugarcrm_Fields",
26011 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26012 "version": "0.0.0",
26013 "filename": "server/api/intSugarcrmField/index.js",
26014 "groupTitle": "Sugarcrm_Fields"
26018 "url": "/api/integrations/sugarcrm/fields/{id}",
26019 "title": "Update an existing Sugarcrm Field",
26022 "title": "Example usage:",
26023 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26027 "name": "updateSugarcrm_Fields",
26028 "group": "Sugarcrm_Fields",
26029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26030 "version": "0.0.0",
26031 "filename": "server/api/intSugarcrmField/index.js",
26032 "groupTitle": "Sugarcrm_Fields"
26036 "url": "/api/system",
26037 "title": "Gets system information",
26040 "title": "Example usage:",
26041 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26045 "name": "GetSystemInformation",
26046 "group": "System_Information",
26047 "description": "<p>Motion returns the system information.</p>",
26048 "version": "0.0.0",
26049 "filename": "server/api/system/index.js",
26050 "groupTitle": "System_Information"
26054 "url": "/api/system/process",
26055 "title": "Gets system information",
26058 "title": "Example usage:",
26059 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26063 "name": "GetSystemInformation",
26064 "group": "System_Information",
26065 "description": "<p>Motion returns the system information.</p>",
26066 "version": "0.0.0",
26067 "filename": "server/api/system/index.js",
26068 "groupTitle": "System_Information"
26072 "url": "/api/tags",
26073 "title": "Creates a new Tag",
26076 "title": "Example usage:",
26077 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26081 "name": "CreateTags",
26104 "field": "description",
26110 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26111 "version": "0.0.0",
26112 "filename": "server/api/tag/index.js",
26113 "groupTitle": "Tags"
26117 "url": "/api/tags/{id}",
26118 "title": "Deletes a Tag",
26121 "title": "Example usage:",
26122 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26126 "name": "DeleteTags",
26128 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26129 "version": "0.0.0",
26130 "filename": "server/api/tag/index.js",
26131 "groupTitle": "Tags"
26135 "url": "/api/tags",
26136 "title": "Gets a list of Tags",
26139 "title": "Example usage:",
26140 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26146 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/tags?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/tags?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/tags?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/tags?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/tags?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26147 "version": "0.0.0",
26148 "filename": "server/api/tag/index.js",
26149 "groupTitle": "Tags"
26153 "url": "/api/tags/{id}",
26154 "title": "Gets a single Tag",
26157 "title": "Example usage:",
26158 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26162 "name": "ShowTags",
26164 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26165 "version": "0.0.0",
26166 "filename": "server/api/tag/index.js",
26167 "groupTitle": "Tags"
26171 "url": "/api/tags/{id}",
26172 "title": "Update an existing Tag",
26175 "title": "Example usage:",
26176 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26180 "name": "updateTags",
26182 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26183 "version": "0.0.0",
26184 "filename": "server/api/tag/index.js",
26185 "groupTitle": "Tags"
26189 "url": "/api/teams/{id}/queues",
26190 "title": "Add queues to a team",
26193 "title": "Example usage:",
26194 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26198 "name": "AddQueues",
26200 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26201 "version": "0.0.0",
26202 "filename": "server/api/team/index.js",
26203 "groupTitle": "Teams"
26207 "url": "/api/teams",
26208 "title": "Creates a new Team",
26211 "title": "Example usage:",
26212 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26216 "name": "CreateTeams",
26232 "field": "description",
26238 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26239 "version": "0.0.0",
26240 "filename": "server/api/team/index.js",
26241 "groupTitle": "Teams"
26245 "url": "/api/teams/{id}",
26246 "title": "Deletes a Team",
26249 "title": "Example usage:",
26250 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26254 "name": "DeleteTeams",
26256 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26257 "version": "0.0.0",
26258 "filename": "server/api/team/index.js",
26259 "groupTitle": "Teams"
26263 "url": "/api/teams/{id}/users",
26264 "title": "Gets agents from team",
26267 "title": "Example usage:",
26268 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26272 "name": "GetAgents",
26274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26275 "version": "0.0.0",
26276 "filename": "server/api/team/index.js",
26277 "groupTitle": "Teams"
26281 "url": "/api/teams/{id}/queues?channel={channel}",
26282 "title": "Gets Queues list",
26285 "title": "Example usage:",
26286 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26290 "name": "GetQueues",
26292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26293 "version": "0.0.0",
26294 "filename": "server/api/team/index.js",
26295 "groupTitle": "Teams"
26299 "url": "/api/teams",
26300 "title": "Gets a list of Teams",
26303 "title": "Example usage:",
26304 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26308 "name": "GetTeams",
26310 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/teams?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/teams?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/teams?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/teams?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/teams?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26311 "version": "0.0.0",
26312 "filename": "server/api/team/index.js",
26313 "groupTitle": "Teams"
26317 "url": "/api/teams/{id}/users",
26318 "title": "Removes agents from a team",
26321 "title": "Example usage:",
26322 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26326 "name": "RemoveAgents",
26328 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26329 "version": "0.0.0",
26330 "filename": "server/api/team/index.js",
26331 "groupTitle": "Teams"
26335 "url": "/api/teams/{id}/queues",
26336 "title": "Remove queues to a team",
26339 "title": "Example usage:",
26340 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26344 "name": "RemoveQueues",
26346 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26347 "version": "0.0.0",
26348 "filename": "server/api/team/index.js",
26349 "groupTitle": "Teams"
26353 "url": "/api/openchannel/queues/{id}/teams",
26354 "title": "Remove teams from a queue",
26357 "title": "Example usage:",
26358 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26362 "name": "RemoveTeams",
26364 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26365 "version": "0.0.0",
26366 "filename": "server/api/openchannelQueue/index.js",
26367 "groupTitle": "Teams"
26371 "url": "/api/voice/queues/{id}/teams",
26372 "title": "Remove teams from a queue",
26375 "title": "Example usage:",
26376 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26380 "name": "RemoveTeams",
26382 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26383 "version": "0.0.0",
26384 "filename": "server/api/voiceQueue/index.js",
26385 "groupTitle": "Teams"
26389 "url": "/api/voice/Prefixes/{id}/teams",
26390 "title": "Remove teams from a voice prefix",
26393 "title": "Example usage:",
26394 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26398 "name": "RemoveTeams",
26400 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26401 "version": "0.0.0",
26402 "filename": "server/api/voicePrefix/index.js",
26403 "groupTitle": "Teams"
26407 "url": "/api/sms/queues/{id}/teams",
26408 "title": "Remove teams from a queue",
26411 "title": "Example usage:",
26412 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26416 "name": "RemoveTeams",
26418 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26419 "version": "0.0.0",
26420 "filename": "server/api/smsQueue/index.js",
26421 "groupTitle": "Teams"
26425 "url": "/api/whatsapp/queues/{id}/teams",
26426 "title": "Remove teams from a queue",
26429 "title": "Example usage:",
26430 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26434 "name": "RemoveTeams",
26436 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26437 "version": "0.0.0",
26438 "filename": "server/api/whatsappQueue/index.js",
26439 "groupTitle": "Teams"
26443 "url": "/api/mail/queues/{id}/teams",
26444 "title": "Remove teams from a queue",
26447 "title": "Example usage:",
26448 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26452 "name": "RemoveTeams",
26454 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26455 "version": "0.0.0",
26456 "filename": "server/api/mailQueue/index.js",
26457 "groupTitle": "Teams"
26461 "url": "/api/chat/queues/{id}/teams",
26462 "title": "Remove teams from a queue",
26465 "title": "Example usage:",
26466 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26470 "name": "RemoveTeams",
26472 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26473 "version": "0.0.0",
26474 "filename": "server/api/chatQueue/index.js",
26475 "groupTitle": "Teams"
26479 "url": "/api/fax/queues/{id}/teams",
26480 "title": "Remove teams from a queue",
26483 "title": "Example usage:",
26484 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26488 "name": "RemoveTeams",
26490 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26491 "version": "0.0.0",
26492 "filename": "server/api/faxQueue/index.js",
26493 "groupTitle": "Teams"
26497 "url": "/api/teams/{id}",
26498 "title": "Gets a single Team",
26501 "title": "Example usage:",
26502 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26506 "name": "ShowTeams",
26508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26509 "version": "0.0.0",
26510 "filename": "server/api/team/index.js",
26511 "groupTitle": "Teams"
26515 "url": "/api/teams/{id}/users",
26516 "title": "Adds agents to a team",
26519 "title": "Example usage:",
26520 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26524 "name": "addAgents",
26526 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26527 "version": "0.0.0",
26528 "filename": "server/api/team/index.js",
26529 "groupTitle": "Teams"
26533 "url": "/api/teams/{id}",
26534 "title": "Update an existing Team",
26537 "title": "Example usage:",
26538 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26542 "name": "updateTeams",
26544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26545 "version": "0.0.0",
26546 "filename": "server/api/team/index.js",
26547 "groupTitle": "Teams"
26551 "url": "/api/templates",
26552 "title": "Creates a new Template",
26555 "title": "Example usage:",
26556 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26560 "name": "CreateTemplates",
26561 "group": "Templates",
26576 "field": "description",
26589 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26590 "version": "0.0.0",
26591 "filename": "server/api/template/index.js",
26592 "groupTitle": "Templates"
26596 "url": "/api/templates/{id}",
26597 "title": "Deletes a Template",
26600 "title": "Example usage:",
26601 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26605 "name": "DeleteTemplates",
26606 "group": "Templates",
26607 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26608 "version": "0.0.0",
26609 "filename": "server/api/template/index.js",
26610 "groupTitle": "Templates"
26614 "url": "/api/templates",
26615 "title": "Gets a list of Templates",
26618 "title": "Example usage:",
26619 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26623 "name": "GetTemplates",
26624 "group": "Templates",
26625 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/templates?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/templates?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/templates?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/templates?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/templates?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26626 "version": "0.0.0",
26627 "filename": "server/api/template/index.js",
26628 "groupTitle": "Templates"
26632 "url": "/api/templates/{id}",
26633 "title": "Gets a single Template",
26636 "title": "Example usage:",
26637 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26641 "name": "ShowTemplates",
26642 "group": "Templates",
26643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26644 "version": "0.0.0",
26645 "filename": "server/api/template/index.js",
26646 "groupTitle": "Templates"
26650 "url": "/api/templates/{id}",
26651 "title": "Update an existing Template",
26654 "title": "Example usage:",
26655 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26659 "name": "updateTemplates",
26660 "group": "Templates",
26661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26662 "version": "0.0.0",
26663 "filename": "server/api/template/index.js",
26664 "groupTitle": "Templates"
26668 "url": "/api/triggers",
26669 "title": "Creates a new Trigger",
26672 "title": "Example usage:",
26673 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26677 "name": "CreateTriggers",
26678 "group": "Triggers",
26693 "field": "channel",
26700 "field": "description",
26713 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26714 "version": "0.0.0",
26715 "filename": "server/api/trigger/index.js",
26716 "groupTitle": "Triggers"
26720 "url": "/api/triggers/{id}",
26721 "title": "Deletes a Trigger",
26724 "title": "Example usage:",
26725 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26729 "name": "DeleteTriggers",
26730 "group": "Triggers",
26731 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26732 "version": "0.0.0",
26733 "filename": "server/api/trigger/index.js",
26734 "groupTitle": "Triggers"
26738 "url": "/api/triggers",
26739 "title": "Gets a list of Triggers",
26742 "title": "Example usage:",
26743 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26747 "name": "GetTriggers",
26748 "group": "Triggers",
26749 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/triggers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/triggers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/triggers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/triggers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/triggers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26750 "version": "0.0.0",
26751 "filename": "server/api/trigger/index.js",
26752 "groupTitle": "Triggers"
26756 "url": "/api/triggers/{id}",
26757 "title": "Gets a single Trigger",
26760 "title": "Example usage:",
26761 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26765 "name": "ShowTriggers",
26766 "group": "Triggers",
26767 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26768 "version": "0.0.0",
26769 "filename": "server/api/trigger/index.js",
26770 "groupTitle": "Triggers"
26774 "url": "/api/triggers/{id}/actions",
26775 "title": "Creates new actions",
26778 "title": "Example usage:",
26779 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26783 "name": "addAction",
26784 "group": "Triggers",
26800 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26807 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26814 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26821 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26854 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26855 "version": "0.0.0",
26856 "filename": "server/api/trigger/index.js",
26857 "groupTitle": "Triggers"
26861 "url": "/api/triggers/{id}/all_conditions",
26862 "title": "Creates a new \"AND\"condition",
26865 "title": "Example usage:",
26866 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -d '{\"field\": \"name\", \"operator\": \"equal\", \"value\": \"John Doe\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26870 "name": "addAllCondition",
26871 "group": "Triggers",
26893 "field": "operator",
26906 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26907 "version": "0.0.0",
26908 "filename": "server/api/trigger/index.js",
26909 "groupTitle": "Triggers"
26913 "url": "/api/triggers/{id}/any_conditions",
26914 "title": "Creates a new \"OR\"condition",
26917 "title": "Example usage:",
26918 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -d '{\"field\": \"name\", \"operator\": \"equal\", \"value\": \"John Doe\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26922 "name": "addAnyCondition",
26923 "group": "Triggers",
26945 "field": "operator",
26958 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26959 "version": "0.0.0",
26960 "filename": "server/api/trigger/index.js",
26961 "groupTitle": "Triggers"
26965 "url": "/api/triggers/{id}/actions",
26966 "title": "Gets Trigger Actions",
26969 "title": "Example usage:",
26970 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26974 "name": "getActions",
26975 "group": "Triggers",
26976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26977 "version": "0.0.0",
26978 "filename": "server/api/trigger/index.js",
26979 "groupTitle": "Triggers"
26983 "url": "/api/triggers/{id}/all_conditions",
26984 "title": "Gets \"AND\" Trigger Conditions",
26987 "title": "Example usage:",
26988 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26992 "name": "getAllConditions",
26993 "group": "Triggers",
26994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26995 "version": "0.0.0",
26996 "filename": "server/api/trigger/index.js",
26997 "groupTitle": "Triggers"
27001 "url": "/api/triggers/{id}/any_conditions",
27002 "title": "Gets \"OR\" Trigger Conditions",
27005 "title": "Example usage:",
27006 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27010 "name": "getAnyConditions",
27011 "group": "Triggers",
27012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27013 "version": "0.0.0",
27014 "filename": "server/api/trigger/index.js",
27015 "groupTitle": "Triggers"
27019 "url": "/api/triggers/{id}",
27020 "title": "Update an existing Trigger",
27023 "title": "Example usage:",
27024 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27028 "name": "updateTriggers",
27029 "group": "Triggers",
27030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27031 "version": "0.0.0",
27032 "filename": "server/api/trigger/index.js",
27033 "groupTitle": "Triggers"
27037 "url": "/api/trunks/clone",
27038 "title": "Clone an existing Trunk",
27041 "title": "Example usage:",
27042 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27046 "name": "CloneTrunks",
27048 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27049 "version": "0.0.0",
27050 "filename": "server/api/trunk/index.js",
27051 "groupTitle": "Trunks"
27055 "url": "/api/trunks",
27056 "title": "Create a new trunk",
27059 "title": "Example usage:",
27060 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27092 "field": "context",
27099 "\"ALLOWED_NOT_SCREENED\"",
27100 "\"ALLOWED_PASSED_SCREEN\"",
27101 "\"ALLOWED_FAILED_SCREEN\"",
27103 "\"PROHIB_NOT_SCREENED\"",
27104 "\"PROHIB_PASSED_SCREEN\"",
27105 "\"PROHIB_FAILED_SCREEN\"",
27109 "field": "callingpres",
27137 "field": "md5secret",
27144 "field": "remotesecret",
27151 "field": "transport",
27152 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
27165 "field": "dtmfmode",
27179 "field": "directmedia",
27190 "field": "directrtpsetup",
27197 "field": "directmediapermit",
27204 "field": "directmediadeny",
27212 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
27218 "field": "callgroup",
27225 "field": "namedcallgroup",
27232 "field": "pickupgroup",
27239 "field": "namedpickupgroup",
27246 "field": "language",
27253 "field": "tonezone",
27260 "field": "disallow",
27268 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
27278 "field": "autoframing",
27285 "field": "insecure",
27286 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27296 "field": "trustrpid",
27307 "field": "trust_id_outbound",
27319 "field": "progressinband",
27330 "field": "promiscredir",
27341 "field": "useclientcode",
27348 "field": "accountcode",
27362 "field": "callerid",
27369 "field": "amaflags",
27380 "field": "callcounter",
27387 "field": "busylevel",
27398 "field": "allowoverlap",
27409 "field": "allowsubscribe",
27420 "field": "allowtransfer",
27431 "field": "ignoresdpversion",
27438 "field": "subscribecontext",
27445 "field": "template",
27457 "field": "videosupport",
27464 "field": "maxcallbitrate",
27475 "field": "rfc2833compensate",
27482 "field": "mailbox",
27494 "field": "session_timers",
27501 "field": "session_expires",
27508 "field": "session_minse",
27519 "field": "session_refresher",
27526 "field": "t38pt_usertpsource",
27533 "field": "regexten",
27540 "field": "fromdomain",
27547 "field": "fromuser",
27565 "field": "qualify",
27572 "field": "keepalive",
27579 "field": "defaultip",
27586 "field": "defaultuser",
27593 "field": "rtptimeout",
27600 "field": "rtpholdtimeout",
27607 "field": "rtpkeepalive",
27619 "field": "sendrpid",
27626 "field": "outboundproxy",
27633 "field": "callbackextension",
27640 "field": "timert1",
27654 "field": "qualifyfreq",
27661 "field": "contactpermit",
27668 "field": "contactdeny",
27675 "field": "contactacl",
27682 "field": "unsolicited_mailbox",
27689 "field": "use_q850_reason",
27696 "field": "maxforwards",
27707 "field": "encryption",
27729 "field": "force_avp",
27740 "field": "icesupport",
27751 "field": "dtlsenable",
27764 "field": "dtlsverify",
27771 "field": "dtlsrekey",
27778 "field": "dtlscertfile",
27785 "field": "dtlsprivatekey",
27792 "field": "dtlscipher",
27799 "field": "dtlscafile",
27806 "field": "dtlscapath",
27818 "field": "dtlssetup",
27825 "field": "dtlsfingerprint",
27836 "field": "usereqphone",
27843 "field": "recordonfeature",
27850 "field": "recordofffeature",
27857 "field": "call_limit",
27868 "field": "registertrying",
27879 "field": "subscribemwi",
27886 "field": "vmexten",
27893 "field": "mohinterpret",
27900 "field": "mohsuggest",
27907 "field": "parkinglot",
27914 "field": "description",
27935 "field": "canreinvite",
27942 "field": "registry",
27949 "field": "otherFields",
27963 "field": "t38pt_udptl",
27969 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27970 "version": "0.0.0",
27971 "filename": "server/api/trunk/index.js",
27972 "groupTitle": "Trunks"
27976 "url": "/api/trunks/{id}",
27977 "title": "Deletes a trunk",
27980 "title": "Example usage:",
27981 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27987 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27988 "version": "0.0.0",
27989 "filename": "server/api/trunk/index.js",
27990 "groupTitle": "Trunks"
27994 "url": "/api/trunks",
27995 "title": "Gets a list of Trunks",
27998 "title": "Example usage:",
27999 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28003 "name": "GetTrunks",
28005 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/trunks?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/trunks?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/trunks?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/trunks?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/trunks?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28006 "version": "0.0.0",
28007 "filename": "server/api/trunk/index.js",
28008 "groupTitle": "Trunks"
28012 "url": "/api/trunks/{id}",
28013 "title": "Gets a single Trunk",
28016 "title": "Example usage:",
28017 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28021 "name": "ShowTrunks",
28023 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28024 "version": "0.0.0",
28025 "filename": "server/api/trunk/index.js",
28026 "groupTitle": "Trunks"
28030 "url": "/api/trunks/{id}",
28031 "title": "Update an existing trunk",
28034 "title": "Example usage:",
28035 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28041 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28042 "version": "0.0.0",
28043 "filename": "server/api/trunk/index.js",
28044 "groupTitle": "Trunks"
28048 "url": "/api/userNotifications",
28049 "title": "Send notification to user",
28052 "title": "Example usage:",
28053 "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28058 "group": "UserNotifications",
28059 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28060 "version": "0.0.0",
28061 "filename": "server/api/userNotification/index.js",
28062 "groupTitle": "UserNotifications"
28066 "url": "/api/userProfile/resources",
28067 "title": "Creates a new User Profile Resource",
28070 "title": "Example usage:",
28071 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28075 "name": "CreateUser_Profile_Resources",
28076 "group": "User_Profile_Resources",
28091 "field": "resourceId",
28104 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28105 "version": "0.0.0",
28106 "filename": "server/api/userProfileResource/index.js",
28107 "groupTitle": "User_Profile_Resources"
28111 "url": "/api/userProfile/resources/{id}",
28112 "title": "Deletes a User Profile Resource",
28115 "title": "Example usage:",
28116 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28120 "name": "DeleteUser_Profile_Resources",
28121 "group": "User_Profile_Resources",
28122 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28123 "version": "0.0.0",
28124 "filename": "server/api/userProfileResource/index.js",
28125 "groupTitle": "User_Profile_Resources"
28129 "url": "/api/userProfile/resources/describe",
28130 "title": "Gets table info about User Profile Resources",
28133 "title": "Example usage:",
28134 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28138 "name": "DescribeUser_Profile_Resources",
28139 "group": "User_Profile_Resources",
28140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28141 "version": "0.0.0",
28142 "filename": "server/api/userProfileResource/index.js",
28143 "groupTitle": "User_Profile_Resources"
28147 "url": "/api/userProfile/resources",
28148 "title": "Gets a list of User Profile Resources",
28151 "title": "Example usage:",
28152 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28156 "name": "GetUser_Profile_Resources",
28157 "group": "User_Profile_Resources",
28158 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/userProfile/resources?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/userProfile/resources?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/userProfile/resources?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/userProfile/resources?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/userProfile/resources?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28159 "version": "0.0.0",
28160 "filename": "server/api/userProfileResource/index.js",
28161 "groupTitle": "User_Profile_Resources"
28165 "url": "/api/userProfile/resources/{id}",
28166 "title": "Gets a single User Profile Resource",
28169 "title": "Example usage:",
28170 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28174 "name": "ShowUser_Profile_Resources",
28175 "group": "User_Profile_Resources",
28176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28177 "version": "0.0.0",
28178 "filename": "server/api/userProfileResource/index.js",
28179 "groupTitle": "User_Profile_Resources"
28183 "url": "/api/userProfile/resources/{id}",
28184 "title": "Update an existing User Profile Resource",
28187 "title": "Example usage:",
28188 "content": "curl https://{domain}/api/userProfile/resources/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28192 "name": "updateUser_Profile_Resources",
28193 "group": "User_Profile_Resources",
28194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28195 "version": "0.0.0",
28196 "filename": "server/api/userProfileResource/index.js",
28197 "groupTitle": "User_Profile_Resources"
28201 "url": "/api/userProfile/sections",
28202 "title": "Creates a new User Profile Section",
28205 "title": "Example usage:",
28206 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28210 "name": "CreateUser_Profile_Sections",
28211 "group": "User_Profile_Sections",
28226 "field": "category",
28233 "field": "sectionId",
28240 "field": "enabled",
28247 "field": "autoAssociation",
28254 "field": "crudPermissions",
28260 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28261 "version": "0.0.0",
28262 "filename": "server/api/userProfileSection/index.js",
28263 "groupTitle": "User_Profile_Sections"
28267 "url": "/api/userProfile/sections/{id}",
28268 "title": "Deletes a User Profile Section",
28271 "title": "Example usage:",
28272 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28276 "name": "DeleteUser_Profile_Sections",
28277 "group": "User_Profile_Sections",
28278 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28279 "version": "0.0.0",
28280 "filename": "server/api/userProfileSection/index.js",
28281 "groupTitle": "User_Profile_Sections"
28285 "url": "/api/userProfile/sections/describe",
28286 "title": "Gets table info about User Profile Sections",
28289 "title": "Example usage:",
28290 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28294 "name": "DescribeUser_Profile_Sections",
28295 "group": "User_Profile_Sections",
28296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28297 "version": "0.0.0",
28298 "filename": "server/api/userProfileSection/index.js",
28299 "groupTitle": "User_Profile_Sections"
28303 "url": "/api/userProfile/sections",
28304 "title": "Gets a list of User Profile Sections",
28307 "title": "Example usage:",
28308 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28312 "name": "GetUser_Profile_Sections",
28313 "group": "User_Profile_Sections",
28314 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/userProfile/sections?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/userProfile/sections?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/userProfile/sections?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/userProfile/sections?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/userProfile/sections?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28315 "version": "0.0.0",
28316 "filename": "server/api/userProfileSection/index.js",
28317 "groupTitle": "User_Profile_Sections"
28321 "url": "/api/userProfile/sections/{id}",
28322 "title": "Gets a single User Profile Section",
28325 "title": "Example usage:",
28326 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28330 "name": "ShowUser_Profile_Sections",
28331 "group": "User_Profile_Sections",
28332 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28333 "version": "0.0.0",
28334 "filename": "server/api/userProfileSection/index.js",
28335 "groupTitle": "User_Profile_Sections"
28339 "url": "/api/userProfile/sections/{id}",
28340 "title": "Update an existing User Profile Section",
28343 "title": "Example usage:",
28344 "content": "curl https://{domain}/api/userProfile/sections/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28348 "name": "updateUser_Profile_Sections",
28349 "group": "User_Profile_Sections",
28350 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28351 "version": "0.0.0",
28352 "filename": "server/api/userProfileSection/index.js",
28353 "groupTitle": "User_Profile_Sections"
28357 "url": "/api/userProfiles/{id}/resources",
28358 "title": "Add resources' permissions to User Profile",
28361 "title": "Example usage:",
28362 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28366 "name": "AddResources",
28367 "group": "User_Profiles",
28368 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28369 "version": "0.0.0",
28370 "filename": "server/api/userProfile/index.js",
28371 "groupTitle": "User_Profiles"
28375 "url": "/api/userProfiles/{id}/sections",
28376 "title": "Add sections' permissions to User Profile",
28379 "title": "Example usage:",
28380 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28384 "name": "AddSections",
28385 "group": "User_Profiles",
28386 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28387 "version": "0.0.0",
28388 "filename": "server/api/userProfile/index.js",
28389 "groupTitle": "User_Profiles"
28393 "url": "/api/userProfiles/clone",
28394 "title": "Clone an existing User Profile",
28397 "title": "Example usage:",
28398 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28402 "name": "CloneUser_Profiles",
28403 "group": "User_Profiles",
28404 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28405 "version": "0.0.0",
28406 "filename": "server/api/userProfile/index.js",
28407 "groupTitle": "User_Profiles"
28411 "url": "/api/userProfiles",
28412 "title": "Creates a new User Profile",
28415 "title": "Example usage:",
28416 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28420 "name": "CreateUser_Profiles",
28421 "group": "User_Profiles",
28436 "field": "crudPermissions",
28443 "field": "description",
28450 "field": "privacyEnabled",
28457 "field": "downloadAttachments",
28464 "field": "downloadCallySquareRecordings",
28471 "field": "downloadContactManagerLists",
28478 "field": "downloadJscriptySessions",
28485 "field": "downloadOmnichannelInteractions",
28492 "field": "downloadScreenRecordings",
28499 "field": "downloadVoiceRecordings",
28505 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28506 "version": "0.0.0",
28507 "filename": "server/api/userProfile/index.js",
28508 "groupTitle": "User_Profiles"
28512 "url": "/api/userProfiles/{id}",
28513 "title": "Deletes a User Profile",
28516 "title": "Example usage:",
28517 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28521 "name": "DeleteUser_Profiles",
28522 "group": "User_Profiles",
28523 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28524 "version": "0.0.0",
28525 "filename": "server/api/userProfile/index.js",
28526 "groupTitle": "User_Profiles"
28530 "url": "/api/userProfiles/describe",
28531 "title": "Gets table info about User Profiles",
28534 "title": "Example usage:",
28535 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28539 "name": "DescribeUser_Profiles",
28540 "group": "User_Profiles",
28541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28542 "version": "0.0.0",
28543 "filename": "server/api/userProfile/index.js",
28544 "groupTitle": "User_Profiles"
28548 "url": "/api/userProfiles/{id}/resources?section={section}",
28549 "title": "Get Resources assigned to a Section",
28552 "title": "Example usage:",
28553 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28557 "name": "GetResources",
28558 "group": "User_Profiles",
28559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28560 "version": "0.0.0",
28561 "filename": "server/api/userProfile/index.js",
28562 "groupTitle": "User_Profiles"
28566 "url": "/api/userProfiles/{id}/sections",
28567 "title": "Get sections associated to a User Profile",
28570 "title": "Example usage:",
28571 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28575 "name": "GetSections",
28576 "group": "User_Profiles",
28577 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28578 "version": "0.0.0",
28579 "filename": "server/api/userProfile/index.js",
28580 "groupTitle": "User_Profiles"
28584 "url": "/api/userProfiles",
28585 "title": "Gets a list of User Profiles",
28588 "title": "Example usage:",
28589 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28593 "name": "GetUser_Profiles",
28594 "group": "User_Profiles",
28595 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/userProfiles?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/userProfiles?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/userProfiles?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/userProfiles?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/userProfiles?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28596 "version": "0.0.0",
28597 "filename": "server/api/userProfile/index.js",
28598 "groupTitle": "User_Profiles"
28602 "url": "/api/userProfiles/{id}/resources",
28603 "title": "Removes resources' permissions from User Profile",
28606 "title": "Example usage:",
28607 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28611 "name": "RemoveResources",
28612 "group": "User_Profiles",
28613 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28614 "version": "0.0.0",
28615 "filename": "server/api/userProfile/index.js",
28616 "groupTitle": "User_Profiles"
28620 "url": "/api/userProfiles/{id}/sections",
28621 "title": "Removes sections' permissions from User Profile",
28624 "title": "Example usage:",
28625 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28629 "name": "RemoveSections",
28630 "group": "User_Profiles",
28631 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28632 "version": "0.0.0",
28633 "filename": "server/api/userProfile/index.js",
28634 "groupTitle": "User_Profiles"
28638 "url": "/api/userProfiles/{id}",
28639 "title": "Gets a single User Profile",
28642 "title": "Example usage:",
28643 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28647 "name": "ShowUser_Profiles",
28648 "group": "User_Profiles",
28649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28650 "version": "0.0.0",
28651 "filename": "server/api/userProfile/index.js",
28652 "groupTitle": "User_Profiles"
28656 "url": "/api/userProfiles/{id}",
28657 "title": "Update an existing User Profile",
28660 "title": "Example usage:",
28661 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28665 "name": "updateUser_Profiles",
28666 "group": "User_Profiles",
28667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28668 "version": "0.0.0",
28669 "filename": "server/api/userProfile/index.js",
28670 "groupTitle": "User_Profiles"
28674 "url": "/api/users/{id}/chat_interactions",
28675 "title": "Add chat interaction tabs to an agent",
28678 "title": "Example usage:",
28679 "content": "curl https://{domain}/api/users/{id}/chat_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28683 "name": "AddChatInteractions",
28685 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28686 "version": "0.0.0",
28687 "filename": "server/api/user/index.js",
28688 "groupTitle": "Users"
28692 "url": "/api/users/{id}/chat_websites",
28693 "title": "Add a Chat Website to a user",
28696 "title": "Example usage:",
28697 "content": "curl https://{domain}/api/users/{id}/chat_websites -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28701 "name": "AddChatWebsites",
28703 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28704 "version": "0.0.0",
28705 "filename": "server/api/user/index.js",
28706 "groupTitle": "Users"
28710 "url": "/api/users/{id}/contacts",
28711 "title": "Add contacts to a user",
28714 "title": "Example usage:",
28715 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28719 "name": "AddContacts",
28721 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28722 "version": "0.0.0",
28723 "filename": "server/api/user/index.js",
28724 "groupTitle": "Users"
28728 "url": "/api/users/{id}/fax_accounts",
28729 "title": "Add a Fax Account to a user",
28732 "title": "Example usage:",
28733 "content": "curl https://{domain}/api/users/{id}/fax_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28737 "name": "AddFaxAccounts",
28739 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28740 "version": "0.0.0",
28741 "filename": "server/api/user/index.js",
28742 "groupTitle": "Users"
28746 "url": "/api/users/{id}/fax_interactions",
28747 "title": "Add fax interaction tabs to an agent",
28750 "title": "Example usage:",
28751 "content": "curl https://{domain}/api/users/{id}/fax_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28755 "name": "AddFaxInteractions",
28757 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28758 "version": "0.0.0",
28759 "filename": "server/api/user/index.js",
28760 "groupTitle": "Users"
28764 "url": "/api/users/{id}/mail_accounts",
28765 "title": "Add a Mail Account to a user",
28768 "title": "Example usage:",
28769 "content": "curl https://{domain}/api/users/{id}/mail_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28773 "name": "AddMailAccounts",
28775 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28776 "version": "0.0.0",
28777 "filename": "server/api/user/index.js",
28778 "groupTitle": "Users"
28782 "url": "/api/users/{id}/mail_interactions",
28783 "title": "Add mail interaction tabs to an agent",
28786 "title": "Example usage:",
28787 "content": "curl https://{domain}/api/users/{id}/mail_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28791 "name": "AddMailInteractions",
28793 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28794 "version": "0.0.0",
28795 "filename": "server/api/user/index.js",
28796 "groupTitle": "Users"
28800 "url": "/api/users/{id}/openchannel_accounts",
28801 "title": "Add a Open Channel Account to a user",
28804 "title": "Example usage:",
28805 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28809 "name": "AddOpenchannelAccounts",
28811 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28812 "version": "0.0.0",
28813 "filename": "server/api/user/index.js",
28814 "groupTitle": "Users"
28818 "url": "/api/users/{id}/openchannel_interactions",
28819 "title": "Add openchannel interaction tabs to an agent",
28822 "title": "Example usage:",
28823 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28827 "name": "AddOpenchannelInteractions",
28829 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28830 "version": "0.0.0",
28831 "filename": "server/api/user/index.js",
28832 "groupTitle": "Users"
28836 "url": "/api/users/{id}/queues",
28837 "title": "Add queues to an agent",
28840 "title": "Example usage:",
28841 "content": "curl https://{domain}/api/users/{id}/queues -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28845 "name": "AddQueues",
28847 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28848 "version": "0.0.0",
28849 "filename": "server/api/user/index.js",
28850 "groupTitle": "Users"
28854 "url": "/api/users/{id}/sms_accounts",
28855 "title": "Add a Sms Account to a user",
28858 "title": "Example usage:",
28859 "content": "curl https://{domain}/api/users/{id}/sms_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28863 "name": "AddSmsAccounts",
28865 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28866 "version": "0.0.0",
28867 "filename": "server/api/user/index.js",
28868 "groupTitle": "Users"
28872 "url": "/api/users/{id}/sms_interactions",
28873 "title": "Add sms interaction tabs to an agent",
28876 "title": "Example usage:",
28877 "content": "curl https://{domain}/api/users/{id}/sms_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28881 "name": "AddSmsInteractions",
28883 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28884 "version": "0.0.0",
28885 "filename": "server/api/user/index.js",
28886 "groupTitle": "Users"
28890 "url": "/api/users/{id}/square_projects",
28891 "title": "Add a Square Project to a user",
28894 "title": "Example usage:",
28895 "content": "curl https://{domain}/api/users/{id}/square_projects -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28899 "name": "AddSquareProjects",
28901 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28902 "version": "0.0.0",
28903 "filename": "server/api/user/index.js",
28904 "groupTitle": "Users"
28908 "url": "/api/users/{id}/teams",
28909 "title": "Add teams to an agent",
28912 "title": "Example usage:",
28913 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28917 "name": "AddTeams",
28919 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28920 "version": "0.0.0",
28921 "filename": "server/api/user/index.js",
28922 "groupTitle": "Users"
28926 "url": "/api/users/{id}/whatsapp_accounts",
28927 "title": "Add a Whatsapp Account to a user",
28930 "title": "Example usage:",
28931 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28935 "name": "AddWhatsappAccounts",
28937 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28938 "version": "0.0.0",
28939 "filename": "server/api/user/index.js",
28940 "groupTitle": "Users"
28944 "url": "/api/users/{id}/whatsapp_interactions",
28945 "title": "Add Whatsapp interaction tabs to an agent",
28948 "title": "Example usage:",
28949 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28953 "name": "AddWhatsappInteractions",
28955 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28956 "version": "0.0.0",
28957 "filename": "server/api/user/index.js",
28958 "groupTitle": "Users"
28962 "url": "/api/users/{id}/password",
28963 "title": "Change user password",
28966 "title": "Example usage:",
28967 "content": "curl https://{domain}/api/users/{id}/password -d '{\"oldPassword\": \"1234\", \"newPassword\": \"5678\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
28971 "name": "ChangePwd",
28973 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28974 "version": "0.0.0",
28975 "filename": "server/api/user/index.js",
28976 "groupTitle": "Users"
28980 "url": "/api/users",
28981 "title": "Create a new user",
28984 "title": "Example usage:",
28985 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28991 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28992 "version": "0.0.0",
28993 "filename": "server/api/user/index.js",
28994 "groupTitle": "Users"
28998 "url": "/api/users/{id}/api_key",
28999 "title": "Create a new API access key for the user",
29002 "title": "Example usage:",
29003 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29007 "name": "CreateApiKey",
29009 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29010 "version": "0.0.0",
29011 "filename": "server/api/user/index.js",
29012 "groupTitle": "Users"
29016 "url": "/api/users/{id}",
29017 "title": "Deletes a user",
29020 "title": "Example usage:",
29021 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29027 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29028 "version": "0.0.0",
29029 "filename": "server/api/user/index.js",
29030 "groupTitle": "Users"
29034 "url": "/api/users/describe",
29035 "title": "Gets table info about Users",
29038 "title": "Example usage:",
29039 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29043 "name": "DescribeUsers",
29045 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29046 "version": "0.0.0",
29047 "filename": "server/api/user/index.js",
29048 "groupTitle": "Users"
29052 "url": "/api/users/{id}/agents",
29053 "title": "GetAgents",
29056 "title": "Example usage:",
29057 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29061 "name": "GetAgents",
29063 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29064 "version": "0.0.0",
29065 "filename": "server/api/user/index.js",
29066 "groupTitle": "Users"
29070 "url": "/api/users/{id}/api_key",
29071 "title": "Get the API access key for the user",
29074 "title": "Example usage:",
29075 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29079 "name": "GetApiKey",
29081 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29082 "version": "0.0.0",
29083 "filename": "server/api/user/index.js",
29084 "groupTitle": "Users"
29088 "url": "/api/users/{id}/groups",
29089 "title": "GetChatGroups",
29092 "title": "Example usage:",
29093 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29097 "name": "GetChatGroups",
29099 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29100 "version": "0.0.0",
29101 "filename": "server/api/user/index.js",
29102 "groupTitle": "Users"
29106 "url": "/api/users/{id}/chat/interactions",
29107 "title": "GetChatInteractions",
29110 "title": "Example usage:",
29111 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29115 "name": "GetChatInteractions",
29117 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29118 "version": "0.0.0",
29119 "filename": "server/api/user/index.js",
29120 "groupTitle": "Users"
29124 "url": "/api/users/{id}/chat_websites",
29125 "title": "GetChatWebsites",
29128 "title": "Example usage:",
29129 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29133 "name": "GetChatWebsites",
29135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29136 "version": "0.0.0",
29137 "filename": "server/api/user/index.js",
29138 "groupTitle": "Users"
29142 "url": "/api/users/{id}/contacts",
29143 "title": "GetContacts",
29146 "title": "Example usage:",
29147 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29151 "name": "GetContacts",
29153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29154 "version": "0.0.0",
29155 "filename": "server/api/user/index.js",
29156 "groupTitle": "Users"
29160 "url": "/api/users/{id}/fax_accounts",
29161 "title": "GetFaxAccounts",
29164 "title": "Example usage:",
29165 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29169 "name": "GetFaxAccounts",
29171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29172 "version": "0.0.0",
29173 "filename": "server/api/user/index.js",
29174 "groupTitle": "Users"
29178 "url": "/api/users/{id}/fax/interactions",
29179 "title": "GetFaxInteractions",
29182 "title": "Example usage:",
29183 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29187 "name": "GetFaxInteractions",
29189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29190 "version": "0.0.0",
29191 "filename": "server/api/user/index.js",
29192 "groupTitle": "Users"
29196 "url": "/api/users/{id}/lists",
29197 "title": "GetLists",
29200 "title": "Example usage:",
29201 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29205 "name": "GetLists",
29207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29208 "version": "0.0.0",
29209 "filename": "server/api/user/index.js",
29210 "groupTitle": "Users"
29214 "url": "/api/users/{id}/mail_accounts",
29215 "title": "GetMailAccounts",
29218 "title": "Example usage:",
29219 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29223 "name": "GetMailAccounts",
29225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29226 "version": "0.0.0",
29227 "filename": "server/api/user/index.js",
29228 "groupTitle": "Users"
29232 "url": "/api/users/{id}/mail/interactions",
29233 "title": "GetMailInteractions",
29236 "title": "Example usage:",
29237 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29241 "name": "GetMailInteractions",
29243 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29244 "version": "0.0.0",
29245 "filename": "server/api/user/index.js",
29246 "groupTitle": "Users"
29250 "url": "/api/users/{id}/openchannel_accounts",
29251 "title": "GetOpenchannelAccounts",
29254 "title": "Example usage:",
29255 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29259 "name": "GetOpenchannelAccounts",
29261 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29262 "version": "0.0.0",
29263 "filename": "server/api/user/index.js",
29264 "groupTitle": "Users"
29268 "url": "/api/users/{id}/openchannel/interactions",
29269 "title": "GetOpenchannelInteractions",
29272 "title": "Example usage:",
29273 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29277 "name": "GetOpenchannelInteractions",
29279 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29280 "version": "0.0.0",
29281 "filename": "server/api/user/index.js",
29282 "groupTitle": "Users"
29286 "url": "/api/users/{id}/prefixes",
29287 "title": "GetPrefixes",
29290 "title": "Example usage:",
29291 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29295 "name": "GetPrefixes",
29297 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29298 "version": "0.0.0",
29299 "filename": "server/api/user/index.js",
29300 "groupTitle": "Users"
29304 "url": "/api/users/{id}/queues?channel={channel}",
29305 "title": "Gets Queues list",
29308 "title": "Example usage:",
29309 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29313 "name": "GetQueues",
29315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29316 "version": "0.0.0",
29317 "filename": "server/api/user/index.js",
29318 "groupTitle": "Users"
29322 "url": "/api/users/{id}/recordings",
29323 "title": "GetRecordings",
29326 "title": "Example usage:",
29327 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29331 "name": "GetRecordings",
29333 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29334 "version": "0.0.0",
29335 "filename": "server/api/user/index.js",
29336 "groupTitle": "Users"
29340 "url": "/api/users/{id}/scheduled_calls",
29341 "title": "GetScheduledCalls",
29344 "title": "Example usage:",
29345 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29349 "name": "GetScheduledCalls",
29351 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29352 "version": "0.0.0",
29353 "filename": "server/api/user/index.js",
29354 "groupTitle": "Users"
29358 "url": "/api/users/{id}/screen_recordings",
29359 "title": "GetScreenRecordings",
29362 "title": "Example usage:",
29363 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29367 "name": "GetScreenRecordings",
29369 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29370 "version": "0.0.0",
29371 "filename": "server/api/user/index.js",
29372 "groupTitle": "Users"
29376 "url": "/api/users/{id}/sms_accounts",
29377 "title": "GetSmsAccounts",
29380 "title": "Example usage:",
29381 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29385 "name": "GetSmsAccounts",
29387 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29388 "version": "0.0.0",
29389 "filename": "server/api/user/index.js",
29390 "groupTitle": "Users"
29394 "url": "/api/users/{id}/sms/interactions",
29395 "title": "GetSmsInteractions",
29398 "title": "Example usage:",
29399 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29403 "name": "GetSmsInteractions",
29405 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29406 "version": "0.0.0",
29407 "filename": "server/api/user/index.js",
29408 "groupTitle": "Users"
29412 "url": "/api/users/{id}/square_projects",
29413 "title": "GetSquareProjects",
29416 "title": "Example usage:",
29417 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29421 "name": "GetSquareProjects",
29423 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29424 "version": "0.0.0",
29425 "filename": "server/api/user/index.js",
29426 "groupTitle": "Users"
29430 "url": "/api/users/{id}/teams",
29431 "title": "GetTeams",
29434 "title": "Example usage:",
29435 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29439 "name": "GetTeams",
29441 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29442 "version": "0.0.0",
29443 "filename": "server/api/user/index.js",
29444 "groupTitle": "Users"
29448 "url": "/api/users",
29449 "title": "Gets a list of Users",
29452 "title": "Example usage:",
29453 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29457 "name": "GetUsers",
29459 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/users?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/users?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/users?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/users?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/users?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
29460 "version": "0.0.0",
29461 "filename": "server/api/user/index.js",
29462 "groupTitle": "Users"
29466 "url": "/api/users/{id}/queues_rt",
29467 "title": "GetVoiceQueuesRt",
29470 "title": "Example usage:",
29471 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29475 "name": "GetVoiceQueuesRt",
29477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29478 "version": "0.0.0",
29479 "filename": "server/api/user/index.js",
29480 "groupTitle": "Users"
29484 "url": "/api/users/{id}/whatsapp_accounts",
29485 "title": "GetWhatsappAccounts",
29488 "title": "Example usage:",
29489 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29493 "name": "GetWhatsappAccounts",
29495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29496 "version": "0.0.0",
29497 "filename": "server/api/user/index.js",
29498 "groupTitle": "Users"
29502 "url": "/api/users/{id}/whatsapp/interactions",
29503 "title": "GetWhatsappInteractions",
29506 "title": "Example usage:",
29507 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29511 "name": "GetWhatsappInteractions",
29513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29514 "version": "0.0.0",
29515 "filename": "server/api/user/index.js",
29516 "groupTitle": "Users"
29520 "url": "/api/users/{id}/login",
29524 "title": "Example usage:",
29525 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
29531 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29532 "version": "0.0.0",
29533 "filename": "server/api/user/index.js",
29534 "groupTitle": "Users"
29538 "url": "/api/users/{id}/logout",
29542 "title": "Example usage:",
29543 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29549 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29550 "version": "0.0.0",
29551 "filename": "server/api/user/index.js",
29552 "groupTitle": "Users"
29556 "url": "/api/users/{id}/pause",
29560 "title": "Example usage:",
29561 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29567 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29568 "version": "0.0.0",
29569 "filename": "server/api/user/index.js",
29570 "groupTitle": "Users"
29574 "url": "/api/users/{id}/api_key",
29575 "title": "Remove API access key for the user",
29578 "title": "Example usage:",
29579 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29583 "name": "RemoveApiKey",
29585 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29586 "version": "0.0.0",
29587 "filename": "server/api/user/index.js",
29588 "groupTitle": "Users"
29592 "url": "/api/users/{id}/chat_interactions",
29593 "title": "Removes interactions from an agent",
29596 "title": "Example usage:",
29597 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29601 "name": "RemoveChatInteractions",
29603 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29604 "version": "0.0.0",
29605 "filename": "server/api/user/index.js",
29606 "groupTitle": "Users"
29610 "url": "/api/users/{id}/chat_websites",
29611 "title": "Removes a Chat Website from a user",
29614 "title": "Example usage:",
29615 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29619 "name": "RemoveChatWebsites",
29621 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29622 "version": "0.0.0",
29623 "filename": "server/api/user/index.js",
29624 "groupTitle": "Users"
29628 "url": "/api/users/{id}/fax_accounts",
29629 "title": "Removes a Fax Account from a user",
29632 "title": "Example usage:",
29633 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29637 "name": "RemoveFaxAccounts",
29639 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29640 "version": "0.0.0",
29641 "filename": "server/api/user/index.js",
29642 "groupTitle": "Users"
29646 "url": "/api/users/{id}/fax_interactions",
29647 "title": "Removes interactions from an agent",
29650 "title": "Example usage:",
29651 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29655 "name": "RemoveFaxInteractions",
29657 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29658 "version": "0.0.0",
29659 "filename": "server/api/user/index.js",
29660 "groupTitle": "Users"
29664 "url": "/api/users/{id}/mail_accounts",
29665 "title": "Removes a Mail Account from a user",
29668 "title": "Example usage:",
29669 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29673 "name": "RemoveMailAccounts",
29675 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29676 "version": "0.0.0",
29677 "filename": "server/api/user/index.js",
29678 "groupTitle": "Users"
29682 "url": "/api/users/{id}/mail_interactions",
29683 "title": "Removes interactions from an agent",
29686 "title": "Example usage:",
29687 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29691 "name": "RemoveMailInteractions",
29693 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29694 "version": "0.0.0",
29695 "filename": "server/api/user/index.js",
29696 "groupTitle": "Users"
29700 "url": "/api/users/{id}/openchannel_accounts",
29701 "title": "Removes a Open Channel Account from a user",
29704 "title": "Example usage:",
29705 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29709 "name": "RemoveOpenchannelAccounts",
29711 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29712 "version": "0.0.0",
29713 "filename": "server/api/user/index.js",
29714 "groupTitle": "Users"
29718 "url": "/api/users/{id}/openchannel_interactions",
29719 "title": "Removes openchannel interactions from an agent",
29722 "title": "Example usage:",
29723 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29727 "name": "RemoveOpenchannelInteractions",
29729 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29730 "version": "0.0.0",
29731 "filename": "server/api/user/index.js",
29732 "groupTitle": "Users"
29736 "url": "/api/users/{id}/queues",
29737 "title": "Remove queues to an agent",
29740 "title": "Example usage:",
29741 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29745 "name": "RemoveQueues",
29747 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29748 "version": "0.0.0",
29749 "filename": "server/api/user/index.js",
29750 "groupTitle": "Users"
29754 "url": "/api/users/{id}/sms_accounts",
29755 "title": "Removes a Sms Account from a user",
29758 "title": "Example usage:",
29759 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29763 "name": "RemoveSmsAccounts",
29765 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29766 "version": "0.0.0",
29767 "filename": "server/api/user/index.js",
29768 "groupTitle": "Users"
29772 "url": "/api/users/{id}/sms_interactions",
29773 "title": "Removes interactions from an agent",
29776 "title": "Example usage:",
29777 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29781 "name": "RemoveSmsInteractions",
29783 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29784 "version": "0.0.0",
29785 "filename": "server/api/user/index.js",
29786 "groupTitle": "Users"
29790 "url": "/api/users/{id}/square_projects",
29791 "title": "Removes a Square Project from a user",
29794 "title": "Example usage:",
29795 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29799 "name": "RemoveSquareProjects",
29801 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29802 "version": "0.0.0",
29803 "filename": "server/api/user/index.js",
29804 "groupTitle": "Users"
29808 "url": "/api/users/{id}/teams",
29809 "title": "Removes teams from an agent",
29812 "title": "Example usage:",
29813 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29817 "name": "RemoveTeams",
29819 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29820 "version": "0.0.0",
29821 "filename": "server/api/user/index.js",
29822 "groupTitle": "Users"
29826 "url": "/api/users/{id}/whatsapp_accounts",
29827 "title": "Removes a Whatsapp Account from a user",
29830 "title": "Example usage:",
29831 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29835 "name": "RemoveWhatsappAccounts",
29837 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29838 "version": "0.0.0",
29839 "filename": "server/api/user/index.js",
29840 "groupTitle": "Users"
29844 "url": "/api/users/{id}/whatsapp_interactions",
29845 "title": "Removes Whatsapp interactions from an agent",
29848 "title": "Example usage:",
29849 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29853 "name": "RemoveWhatsappInteractions",
29855 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29856 "version": "0.0.0",
29857 "filename": "server/api/user/index.js",
29858 "groupTitle": "Users"
29862 "url": "/api/users/{id}",
29863 "title": "Gets a single User",
29866 "title": "Example usage:",
29867 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29871 "name": "ShowUsers",
29873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29874 "version": "0.0.0",
29875 "filename": "server/api/user/index.js",
29876 "groupTitle": "Users"
29880 "url": "/api/users/{id}/unpause",
29881 "title": "Unpause",
29884 "title": "Example usage:",
29885 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29891 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29892 "version": "0.0.0",
29893 "filename": "server/api/user/index.js",
29894 "groupTitle": "Users"
29898 "url": "/api/users/whoami",
29902 "title": "Example usage:",
29903 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29909 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29910 "version": "0.0.0",
29911 "filename": "server/api/user/index.js",
29912 "groupTitle": "Users"
29916 "url": "/api/users/{id}/avatar",
29917 "title": "Add avatar",
29920 "title": "Example usage:",
29921 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29925 "name": "addAvatar",
29927 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29928 "version": "0.0.0",
29929 "filename": "server/api/user/index.js",
29930 "groupTitle": "Users"
29934 "url": "/api/users/create_many",
29935 "title": "Create Users",
29938 "title": "Example usage:",
29939 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29943 "name": "bulkCreate",
29945 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29946 "version": "0.0.0",
29947 "filename": "server/api/user/index.js",
29948 "groupTitle": "Users"
29952 "url": "/api/users/{id}/avatar",
29953 "title": "Get avatar",
29956 "title": "Example usage:",
29957 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29961 "name": "getAvatar",
29963 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29964 "version": "0.0.0",
29965 "filename": "server/api/user/index.js",
29966 "groupTitle": "Users"
29970 "url": "/api/users/{id}/open_tabs",
29971 "title": "Get interactions opened tabs",
29974 "title": "Example usage:",
29975 "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
29979 "name": "getOpenTabs",
29981 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29982 "version": "0.0.0",
29983 "filename": "server/api/user/index.js",
29984 "groupTitle": "Users"
29988 "url": "/api/users/presence",
29989 "title": "Gets agent presence",
29992 "title": "Example usage:",
29993 "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
29997 "name": "getPresence",
29999 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30000 "version": "0.0.0",
30001 "filename": "server/api/user/index.js",
30002 "groupTitle": "Users"
30006 "url": "/api/users/{id}",
30007 "title": "Update an existing User",
30010 "title": "Example usage:",
30011 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30015 "name": "updateUsers",
30017 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30018 "version": "0.0.0",
30019 "filename": "server/api/user/index.js",
30020 "groupTitle": "Users"
30024 "url": "/api/variables",
30025 "title": "Creates a new Variable",
30028 "title": "Example usage:",
30029 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30033 "name": "CreateVariables",
30034 "group": "Variables",
30049 "field": "description",
30055 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30056 "version": "0.0.0",
30057 "filename": "server/api/variable/index.js",
30058 "groupTitle": "Variables"
30062 "url": "/api/variables/{id}",
30063 "title": "Deletes a Variable",
30066 "title": "Example usage:",
30067 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30071 "name": "DeleteVariables",
30072 "group": "Variables",
30073 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30074 "version": "0.0.0",
30075 "filename": "server/api/variable/index.js",
30076 "groupTitle": "Variables"
30080 "url": "/api/variables",
30081 "title": "Gets a list of Variables",
30084 "title": "Example usage:",
30085 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30089 "name": "GetVariables",
30090 "group": "Variables",
30091 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/variables?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/variables?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/variables?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/variables?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/variables?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30092 "version": "0.0.0",
30093 "filename": "server/api/variable/index.js",
30094 "groupTitle": "Variables"
30098 "url": "/api/variables/{id}",
30099 "title": "Gets a single Variable",
30102 "title": "Example usage:",
30103 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30107 "name": "ShowVariables",
30108 "group": "Variables",
30109 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30110 "version": "0.0.0",
30111 "filename": "server/api/variable/index.js",
30112 "groupTitle": "Variables"
30116 "url": "/api/variables/{id}",
30117 "title": "Update an existing Variable",
30120 "title": "Example usage:",
30121 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30125 "name": "updateVariables",
30126 "group": "Variables",
30127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30128 "version": "0.0.0",
30129 "filename": "server/api/variable/index.js",
30130 "groupTitle": "Variables"
30134 "url": "/api/version/fetch",
30135 "title": "Fetch git version",
30138 "title": "Example usage:",
30139 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30143 "name": "FetchVersion",
30144 "group": "Version",
30145 "description": "<p>Motion run the following command: git fetch origin master</p>",
30146 "version": "0.0.0",
30147 "filename": "server/api/version/index.js",
30148 "groupTitle": "Version"
30152 "url": "/api/version",
30153 "title": "Gets version",
30156 "title": "Example usage:",
30157 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30161 "name": "GetVersion",
30162 "group": "Version",
30163 "description": "<p>Motion returns the current and latest motion version.</p>",
30164 "version": "0.0.0",
30165 "filename": "server/api/version/index.js",
30166 "groupTitle": "Version"
30170 "url": "/api/version/migrations",
30171 "title": "Launch database migrations",
30174 "title": "Example usage:",
30175 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30179 "name": "MigrateVersion",
30180 "group": "Version",
30181 "description": "<p>Motion launch the database migrations, according to the application version</p>",
30182 "version": "0.0.0",
30183 "filename": "server/api/version/index.js",
30184 "groupTitle": "Version"
30188 "url": "/api/version/pull",
30189 "title": "Pull git version",
30192 "title": "Example usage:",
30193 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30197 "name": "PullVersion",
30198 "group": "Version",
30199 "description": "<p>Motion run the following command: git pull</p>",
30200 "version": "0.0.0",
30201 "filename": "server/api/version/index.js",
30202 "groupTitle": "Version"
30206 "url": "/api/version/reset",
30207 "title": "Reset git version",
30210 "title": "Example usage:",
30211 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30215 "name": "ResetVersion",
30216 "group": "Version",
30217 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30218 "version": "0.0.0",
30219 "filename": "server/api/version/index.js",
30220 "groupTitle": "Version"
30224 "url": "/api/version/restart",
30225 "title": "Restart motion2 after update",
30228 "title": "Example usage:",
30229 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30233 "name": "RestartVersion",
30234 "group": "Version",
30235 "description": "<p>Motion run the following command: pm2 restart motion</p>",
30236 "version": "0.0.0",
30237 "filename": "server/api/version/index.js",
30238 "groupTitle": "Version"
30242 "url": "/api/voice/agents/reports/describe",
30243 "title": "Gets table info about Agent Reports",
30246 "title": "Example usage:",
30247 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30251 "name": "DescribeAgent_Reports",
30252 "group": "Voice_Agent_Reports",
30253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30254 "version": "0.0.0",
30255 "filename": "server/api/voiceAgentReport/index.js",
30256 "groupTitle": "Voice_Agent_Reports"
30260 "url": "/api/voice/agents/reports",
30261 "title": "Gets a list of Agent Reports",
30264 "title": "Example usage:",
30265 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30269 "name": "GetAgent_Reports",
30270 "group": "Voice_Agent_Reports",
30271 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/agents/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/agents/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/agents/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/agents/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/agents/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30272 "version": "0.0.0",
30273 "filename": "server/api/voiceAgentReport/index.js",
30274 "groupTitle": "Voice_Agent_Reports"
30278 "url": "/api/voice/agents/reports/{id}",
30279 "title": "Gets a single Agent Report",
30282 "title": "Example usage:",
30283 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30287 "name": "ShowAgent_Reports",
30288 "group": "Voice_Agent_Reports",
30289 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30290 "version": "0.0.0",
30291 "filename": "server/api/voiceAgentReport/index.js",
30292 "groupTitle": "Voice_Agent_Reports"
30296 "url": "/api/voice/calls/reports/describe",
30297 "title": "Gets table info about Call Reports",
30300 "title": "Example usage:",
30301 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30305 "name": "DescribeCall_Reports",
30306 "group": "Voice_Call_Reports",
30307 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30308 "version": "0.0.0",
30309 "filename": "server/api/voiceCallReport/index.js",
30310 "groupTitle": "Voice_Call_Reports"
30314 "url": "/api/voice/calls/reports",
30315 "title": "Gets a list of Call Reports",
30318 "title": "Example usage:",
30319 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30323 "name": "GetCall_Reports",
30324 "group": "Voice_Call_Reports",
30325 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/calls/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/calls/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/calls/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/calls/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/calls/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30326 "version": "0.0.0",
30327 "filename": "server/api/voiceCallReport/index.js",
30328 "groupTitle": "Voice_Call_Reports"
30332 "url": "/api/voice/calls/reports/{id}",
30333 "title": "Gets a single Call Report",
30336 "title": "Example usage:",
30337 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30341 "name": "ShowCall_Reports",
30342 "group": "Voice_Call_Reports",
30343 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30344 "version": "0.0.0",
30345 "filename": "server/api/voiceCallReport/index.js",
30346 "groupTitle": "Voice_Call_Reports"
30350 "url": "/api/voice/calls/reports/{id}",
30351 "title": "Update a single cdr",
30354 "title": "Example usage:",
30355 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30360 "group": "Voice_Call_Reports",
30361 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30362 "version": "0.0.0",
30363 "filename": "server/api/voiceCallReport/index.js",
30364 "groupTitle": "Voice_Call_Reports"
30368 "url": "/api/voice/chanspy",
30369 "title": "Creates a new ChanSpy",
30372 "title": "Example usage:",
30373 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30377 "name": "CreateChanSpy",
30378 "group": "Voice_ChanSpy",
30400 "field": "options",
30414 "field": "password",
30428 "field": "recordingFormat",
30435 "field": "description",
30441 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30442 "version": "0.0.0",
30443 "filename": "server/api/voiceChanSpy/index.js",
30444 "groupTitle": "Voice_ChanSpy"
30448 "url": "/api/voice/chanspy/{id}",
30449 "title": "Deletes a ChanSpy",
30452 "title": "Example usage:",
30453 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30457 "name": "DeleteChanSpy",
30458 "group": "Voice_ChanSpy",
30459 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30460 "version": "0.0.0",
30461 "filename": "server/api/voiceChanSpy/index.js",
30462 "groupTitle": "Voice_ChanSpy"
30466 "url": "/api/voice/chanspy",
30467 "title": "Gets a list of ChanSpy",
30470 "title": "Example usage:",
30471 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30475 "name": "GetChanSpy",
30476 "group": "Voice_ChanSpy",
30477 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/chanspy?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/chanspy?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/chanspy?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/chanspy?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/chanspy?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30478 "version": "0.0.0",
30479 "filename": "server/api/voiceChanSpy/index.js",
30480 "groupTitle": "Voice_ChanSpy"
30484 "url": "/api/voice/chanspy/{id}",
30485 "title": "Gets a single ChanSpy",
30488 "title": "Example usage:",
30489 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30493 "name": "ShowChanSpy",
30494 "group": "Voice_ChanSpy",
30495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30496 "version": "0.0.0",
30497 "filename": "server/api/voiceChanSpy/index.js",
30498 "groupTitle": "Voice_ChanSpy"
30502 "url": "/api/voice/chanspy/{id}",
30503 "title": "Update an existing ChanSpy",
30506 "title": "Example usage:",
30507 "content": "curl https://{domain}/api/voice/chanspy/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30511 "name": "updateChanSpy",
30512 "group": "Voice_ChanSpy",
30513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30514 "version": "0.0.0",
30515 "filename": "server/api/voiceChanSpy/index.js",
30516 "groupTitle": "Voice_ChanSpy"
30520 "url": "/api/voice/contexts",
30521 "title": "Create a new context",
30524 "title": "Example usage:",
30525 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30530 "group": "Voice_Contexts",
30545 "field": "description",
30552 "field": "defaultEntry",
30558 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30559 "version": "0.0.0",
30560 "filename": "server/api/voiceContext/index.js",
30561 "groupTitle": "Voice_Contexts"
30565 "url": "/api/voice/contexts/{id}",
30566 "title": "Deletes a context",
30569 "title": "Example usage:",
30570 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30575 "group": "Voice_Contexts",
30576 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30577 "version": "0.0.0",
30578 "filename": "server/api/voiceContext/index.js",
30579 "groupTitle": "Voice_Contexts"
30583 "url": "/api/voice/contexts",
30584 "title": "Gets a list of Contexts",
30587 "title": "Example usage:",
30588 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30592 "name": "GetContexts",
30593 "group": "Voice_Contexts",
30594 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/contexts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/contexts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/contexts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/contexts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/contexts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30595 "version": "0.0.0",
30596 "filename": "server/api/voiceContext/index.js",
30597 "groupTitle": "Voice_Contexts"
30601 "url": "/api/voice/contexts/{id}",
30602 "title": "Gets a single Context",
30605 "title": "Example usage:",
30606 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30610 "name": "ShowContexts",
30611 "group": "Voice_Contexts",
30612 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30613 "version": "0.0.0",
30614 "filename": "server/api/voiceContext/index.js",
30615 "groupTitle": "Voice_Contexts"
30619 "url": "/api/voice/contexts/{id}",
30620 "title": "Update an existing context",
30623 "title": "Example usage:",
30624 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30629 "group": "Voice_Contexts",
30630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30631 "version": "0.0.0",
30632 "filename": "server/api/voiceContext/index.js",
30633 "groupTitle": "Voice_Contexts"
30637 "url": "/api/voice/dials/reports/describe",
30638 "title": "Gets table info about Dial Reports",
30641 "title": "Example usage:",
30642 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30646 "name": "DescribeDial_Reports",
30647 "group": "Voice_Dial_Reports",
30648 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30649 "version": "0.0.0",
30650 "filename": "server/api/voiceDialReport/index.js",
30651 "groupTitle": "Voice_Dial_Reports"
30655 "url": "/api/voice/dials/reports",
30656 "title": "Gets a list of Dial Reports",
30659 "title": "Example usage:",
30660 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30664 "name": "GetDial_Reports",
30665 "group": "Voice_Dial_Reports",
30666 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/dials/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/dials/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/dials/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/dials/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/dials/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30667 "version": "0.0.0",
30668 "filename": "server/api/voiceDialReport/index.js",
30669 "groupTitle": "Voice_Dial_Reports"
30673 "url": "/api/voice/dials/reports/{id}",
30674 "title": "Gets a single Dial Report",
30677 "title": "Example usage:",
30678 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30682 "name": "ShowDial_Reports",
30683 "group": "Voice_Dial_Reports",
30684 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30685 "version": "0.0.0",
30686 "filename": "server/api/voiceDialReport/index.js",
30687 "groupTitle": "Voice_Dial_Reports"
30691 "url": "/api/voice/extensions/{id}",
30692 "title": "Deletes a Extension",
30695 "title": "Example usage:",
30696 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30700 "name": "DeleteExtensions",
30701 "group": "Voice_Extensions",
30702 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30703 "version": "0.0.0",
30704 "filename": "server/api/voiceExtension/index.js",
30705 "groupTitle": "Voice_Extensions"
30709 "url": "/api/voice/extensions",
30710 "title": "Gets a list of Extensions",
30713 "title": "Example usage:",
30714 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30718 "name": "GetExtensions",
30719 "group": "Voice_Extensions",
30720 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/extensions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/extensions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/extensions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/extensions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/extensions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30721 "version": "0.0.0",
30722 "filename": "server/api/voiceExtension/index.js",
30723 "groupTitle": "Voice_Extensions"
30727 "url": "/api/voice/extensions/{id}",
30728 "title": "Gets a single Extension",
30731 "title": "Example usage:",
30732 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30736 "name": "ShowExtensions",
30737 "group": "Voice_Extensions",
30738 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30739 "version": "0.0.0",
30740 "filename": "server/api/voiceExtension/index.js",
30741 "groupTitle": "Voice_Extensions"
30745 "url": "/api/voice/extensions",
30746 "title": "Create new applications",
30749 "title": "Example usage:",
30750 "content": "curl https://{domain}/api/voice/extensions/{id}/applications -d '[{\"app\": \"Set\", \"appdata\": \"CALLERDNID=${CALLER(dnid)}\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30754 "name": "addApplications",
30755 "group": "Voice_Extensions",
30756 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30757 "version": "0.0.0",
30758 "filename": "server/api/voiceExtension/index.js",
30759 "groupTitle": "Voice_Extensions"
30763 "url": "/api/voice/extensions",
30764 "title": "Create an extension",
30767 "title": "Example usage:",
30768 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30773 "group": "Voice_Extensions",
30774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30775 "version": "0.0.0",
30776 "filename": "server/api/voiceExtension/index.js",
30777 "groupTitle": "Voice_Extensions"
30781 "url": "/api/voice/extensions/{id}",
30782 "title": "Update an extension",
30785 "title": "Example usage:",
30786 "content": "curl https://{domain}/api/voice/extensions/{id} -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
30791 "group": "Voice_Extensions",
30792 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30793 "version": "0.0.0",
30794 "filename": "server/api/voiceExtension/index.js",
30795 "groupTitle": "Voice_Extensions"
30799 "url": "/api/voice/mohs",
30800 "title": "Create a new a new MOH",
30803 "title": "Example usage:",
30804 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30809 "group": "Voice_MOHs",
30810 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30811 "version": "0.0.0",
30812 "filename": "server/api/voiceMusicOnHold/index.js",
30813 "groupTitle": "Voice_MOHs"
30817 "url": "/api/voice/mohs/{id}/sounds",
30818 "title": "Add sound to MOH",
30821 "title": "Example usage:",
30822 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30826 "name": "AddSound",
30827 "group": "Voice_MOHs",
30828 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30829 "version": "0.0.0",
30830 "filename": "server/api/voiceMusicOnHold/index.js",
30831 "groupTitle": "Voice_MOHs"
30835 "url": "/api/voice/mohs/{id}",
30836 "title": "Deletes an MOH",
30839 "title": "Example usage:",
30840 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30844 "name": "DestroyMoh",
30845 "group": "Voice_MOHs",
30846 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30847 "version": "0.0.0",
30848 "filename": "server/api/voiceMusicOnHold/index.js",
30849 "groupTitle": "Voice_MOHs"
30853 "url": "/api/voice/mohs",
30854 "title": "Gets a list of Music On Holds",
30857 "title": "Example usage:",
30858 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30862 "name": "GetMusic_On_Holds",
30863 "group": "Voice_MOHs",
30864 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/mohs?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/mohs?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/mohs?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/mohs?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/mohs?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30865 "version": "0.0.0",
30866 "filename": "server/api/voiceMusicOnHold/index.js",
30867 "groupTitle": "Voice_MOHs"
30871 "url": "/api/voice/mohs/{id}/sounds",
30872 "title": "Gets sounds from MOH",
30875 "title": "Example usage:",
30876 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30880 "name": "GetSounds",
30881 "group": "Voice_MOHs",
30882 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30883 "version": "0.0.0",
30884 "filename": "server/api/voiceMusicOnHold/index.js",
30885 "groupTitle": "Voice_MOHs"
30889 "url": "/api/voice/mohs/{id}/sounds/{id2}",
30890 "title": "Remove sound from MOH",
30893 "title": "Example usage:",
30894 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30898 "name": "RemoveSound",
30899 "group": "Voice_MOHs",
30900 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30901 "version": "0.0.0",
30902 "filename": "server/api/voiceMusicOnHold/index.js",
30903 "groupTitle": "Voice_MOHs"
30907 "url": "/api/voice/mohs/{id}",
30908 "title": "Gets a single Music On Hold",
30911 "title": "Example usage:",
30912 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30916 "name": "ShowMusic_On_Holds",
30917 "group": "Voice_MOHs",
30918 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30919 "version": "0.0.0",
30920 "filename": "server/api/voiceMusicOnHold/index.js",
30921 "groupTitle": "Voice_MOHs"
30925 "url": "/api/voice/mohs/{id}",
30926 "title": "Update an existing Music On Hold",
30929 "title": "Example usage:",
30930 "content": "curl https://{domain}/api/voice/mohs/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30934 "name": "updateMusic_On_Holds",
30935 "group": "Voice_MOHs",
30936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30937 "version": "0.0.0",
30938 "filename": "server/api/voiceMusicOnHold/index.js",
30939 "groupTitle": "Voice_MOHs"
30943 "url": "/api/voice/mails",
30944 "title": "Creates a new Mail",
30947 "title": "Example usage:",
30948 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30952 "name": "CreateMails",
30953 "group": "Voice_Mails",
30961 "field": "customer_id",
30968 "field": "context",
30975 "field": "mailbox",
30982 "field": "password",
30989 "field": "fullname",
31039 "field": "dialout",
31046 "field": "callback",
31068 "field": "operator",
31079 "field": "envelope",
31090 "field": "sayduration",
31097 "field": "saydurationm",
31108 "field": "sendvoicemail",
31130 "field": "nextaftercmd",
31141 "field": "forcename",
31152 "field": "forcegreetings",
31163 "field": "hidefromdir",
31177 "field": "emailsubject",
31184 "field": "emailbody",
31191 "field": "maxsecs",
31211 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31212 "version": "0.0.0",
31213 "filename": "server/api/voiceMail/index.js",
31214 "groupTitle": "Voice_Mails"
31218 "url": "/api/voice/mails/{id}",
31219 "title": "Deletes a Mail",
31222 "title": "Example usage:",
31223 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31227 "name": "DeleteMails",
31228 "group": "Voice_Mails",
31229 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31230 "version": "0.0.0",
31231 "filename": "server/api/voiceMail/index.js",
31232 "groupTitle": "Voice_Mails"
31236 "url": "/api/voice/mails",
31237 "title": "Gets a list of Mails",
31240 "title": "Example usage:",
31241 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31245 "name": "GetMails",
31246 "group": "Voice_Mails",
31247 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/mails?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/mails?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/mails?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/mails?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/mails?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31248 "version": "0.0.0",
31249 "filename": "server/api/voiceMail/index.js",
31250 "groupTitle": "Voice_Mails"
31254 "url": "/api/voice/mails/{id}",
31255 "title": "Gets a single Mail",
31258 "title": "Example usage:",
31259 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31263 "name": "ShowMails",
31264 "group": "Voice_Mails",
31265 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31266 "version": "0.0.0",
31267 "filename": "server/api/voiceMail/index.js",
31268 "groupTitle": "Voice_Mails"
31272 "url": "/api/voice/mails/{id}/messages",
31273 "title": "Gets voice mail messages",
31276 "title": "Example usage:",
31277 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31281 "name": "getMessages",
31282 "group": "Voice_Mails",
31283 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31284 "version": "0.0.0",
31285 "filename": "server/api/voiceMail/index.js",
31286 "groupTitle": "Voice_Mails"
31290 "url": "/api/voice/mails/{id}",
31291 "title": "Update an existing Mail",
31294 "title": "Example usage:",
31295 "content": "curl https://{domain}/api/voice/mails/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31299 "name": "updateMails",
31300 "group": "Voice_Mails",
31301 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31302 "version": "0.0.0",
31303 "filename": "server/api/voiceMail/index.js",
31304 "groupTitle": "Voice_Mails"
31308 "url": "/api/voice/mails/messages",
31309 "title": "Creates a new Message",
31312 "title": "Example usage:",
31313 "content": "curl https://{domain}/api/voice/mails/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31317 "name": "CreateMessages",
31318 "group": "Voice_Messages",
31347 "field": "context",
31354 "field": "macrocontext",
31361 "field": "callerid",
31368 "field": "origtime",
31375 "field": "duration",
31382 "field": "mailboxuser",
31389 "field": "mailboxcontext",
31396 "field": "recording",
31423 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31424 "version": "0.0.0",
31425 "filename": "server/api/voiceMailMessage/index.js",
31426 "groupTitle": "Voice_Messages"
31430 "url": "/api/voice/mails/messages/{id}",
31431 "title": "Deletes a Message",
31434 "title": "Example usage:",
31435 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31439 "name": "DeleteMessages",
31440 "group": "Voice_Messages",
31441 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31442 "version": "0.0.0",
31443 "filename": "server/api/voiceMailMessage/index.js",
31444 "groupTitle": "Voice_Messages"
31448 "url": "/api/voice/mails/messages",
31449 "title": "Gets a list of Messages",
31452 "title": "Example usage:",
31453 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31457 "name": "GetMessages",
31458 "group": "Voice_Messages",
31459 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/mails/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/mails/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/mails/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/mails/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/mails/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31460 "version": "0.0.0",
31461 "filename": "server/api/voiceMailMessage/index.js",
31462 "groupTitle": "Voice_Messages"
31466 "url": "/api/voice/mails/messages/{id}",
31467 "title": "Gets a single Message",
31470 "title": "Example usage:",
31471 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31475 "name": "ShowMessages",
31476 "group": "Voice_Messages",
31477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31478 "version": "0.0.0",
31479 "filename": "server/api/voiceMailMessage/index.js",
31480 "groupTitle": "Voice_Messages"
31484 "url": "voice/mails/messages/{id}/download",
31485 "title": "Download Voice Message",
31488 "title": "Example usage:",
31489 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31493 "name": "download",
31494 "group": "Voice_Messages",
31495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31496 "version": "0.0.0",
31497 "filename": "server/api/voiceMailMessage/index.js",
31498 "groupTitle": "Voice_Messages"
31502 "url": "/api/voice/mails/messages/{id}",
31503 "title": "Update an existing Message",
31506 "title": "Example usage:",
31507 "content": "curl https://{domain}/api/voice/mails/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31511 "name": "updateMessages",
31512 "group": "Voice_Messages",
31513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31514 "version": "0.0.0",
31515 "filename": "server/api/voiceMailMessage/index.js",
31516 "groupTitle": "Voice_Messages"
31520 "url": "/api/voice/prefixes/{id}/teams",
31521 "title": "Add teams to voice prefix",
31524 "title": "Example usage:",
31525 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31529 "name": "AddTeams",
31530 "group": "Voice_Prefix",
31531 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31532 "version": "0.0.0",
31533 "filename": "server/api/voicePrefix/index.js",
31534 "groupTitle": "Voice_Prefix"
31538 "url": "/api/voice/prefixes/{id}/teams",
31539 "title": "Gets voice prefix team",
31542 "title": "Example usage:",
31543 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X GET",
31547 "name": "GetTeams",
31548 "group": "Voice_Prefix",
31549 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31550 "version": "0.0.0",
31551 "filename": "server/api/voicePrefix/index.js",
31552 "groupTitle": "Voice_Prefix"
31556 "url": "/api/voice/prefixes/{id}/users",
31557 "title": "Add agents to a prefix",
31560 "title": "Example usage:",
31561 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31565 "name": "AddAgents",
31566 "group": "Voice_Prefixes",
31567 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31568 "version": "0.0.0",
31569 "filename": "server/api/voicePrefix/index.js",
31570 "groupTitle": "Voice_Prefixes"
31574 "url": "/api/voice/prefixes/{id}",
31575 "title": "Deletes a Prefix",
31578 "title": "Example usage:",
31579 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31583 "name": "DeletePrefixes",
31584 "group": "Voice_Prefixes",
31585 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31586 "version": "0.0.0",
31587 "filename": "server/api/voicePrefix/index.js",
31588 "groupTitle": "Voice_Prefixes"
31592 "url": "/api/voice/prefixes/describe",
31593 "title": "Gets table info about Prefixes",
31596 "title": "Example usage:",
31597 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31601 "name": "DescribePrefixes",
31602 "group": "Voice_Prefixes",
31603 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31604 "version": "0.0.0",
31605 "filename": "server/api/voicePrefix/index.js",
31606 "groupTitle": "Voice_Prefixes"
31610 "url": "/api/voice/prefixes/{id}/users",
31611 "title": "Gets agents from prefix",
31614 "title": "Example usage:",
31615 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31619 "name": "GetAgents",
31620 "group": "Voice_Prefixes",
31621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31622 "version": "0.0.0",
31623 "filename": "server/api/voicePrefix/index.js",
31624 "groupTitle": "Voice_Prefixes"
31628 "url": "/api/voice/prefixes",
31629 "title": "Gets a list of Prefixes",
31632 "title": "Example usage:",
31633 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31637 "name": "GetPrefixes",
31638 "group": "Voice_Prefixes",
31639 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/prefixes?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/prefixes?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/prefixes?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/prefixes?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/prefixes?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31640 "version": "0.0.0",
31641 "filename": "server/api/voicePrefix/index.js",
31642 "groupTitle": "Voice_Prefixes"
31646 "url": "/api/voice/prefixes/{id}/users",
31647 "title": "Removes agents from a prefix",
31650 "title": "Example usage:",
31651 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31655 "name": "RemoveAgents",
31656 "group": "Voice_Prefixes",
31657 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31658 "version": "0.0.0",
31659 "filename": "server/api/voicePrefix/index.js",
31660 "groupTitle": "Voice_Prefixes"
31664 "url": "/api/voice/prefixes/{id}",
31665 "title": "Gets a single Prefix",
31668 "title": "Example usage:",
31669 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31673 "name": "ShowPrefixes",
31674 "group": "Voice_Prefixes",
31675 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31676 "version": "0.0.0",
31677 "filename": "server/api/voicePrefix/index.js",
31678 "groupTitle": "Voice_Prefixes"
31682 "url": "/api/voice/prefixes/{id}",
31683 "title": "Update an existing prefix",
31686 "title": "Example usage:",
31687 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31692 "group": "Voice_Prefixes",
31693 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31694 "version": "0.0.0",
31695 "filename": "server/api/voicePrefix/index.js",
31696 "groupTitle": "Voice_Prefixes"
31700 "url": "/api/voice/prefixes",
31701 "title": "Create a prefix",
31704 "title": "Example usage:",
31705 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31710 "group": "Voice_Prefixes",
31711 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31712 "version": "0.0.0",
31713 "filename": "server/api/voicePrefix/index.js",
31714 "groupTitle": "Voice_Prefixes"
31718 "url": "/api/voice/queues/reports/describe",
31719 "title": "Gets table info about Queue Reports",
31722 "title": "Example usage:",
31723 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31727 "name": "DescribeQueue_Reports",
31728 "group": "Voice_Queue_Reports",
31729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31730 "version": "0.0.0",
31731 "filename": "server/api/voiceQueueReport/index.js",
31732 "groupTitle": "Voice_Queue_Reports"
31736 "url": "/api/voice/queues/reports",
31737 "title": "Gets a list of Queue Reports",
31740 "title": "Example usage:",
31741 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31745 "name": "GetQueue_Reports",
31746 "group": "Voice_Queue_Reports",
31747 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/queues/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/queues/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/queues/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/queues/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/queues/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31748 "version": "0.0.0",
31749 "filename": "server/api/voiceQueueReport/index.js",
31750 "groupTitle": "Voice_Queue_Reports"
31754 "url": "/api/voice/queues/reports/{id}",
31755 "title": "Gets a single Queue Report",
31758 "title": "Example usage:",
31759 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31763 "name": "ShowQueue_Reports",
31764 "group": "Voice_Queue_Reports",
31765 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31766 "version": "0.0.0",
31767 "filename": "server/api/voiceQueueReport/index.js",
31768 "groupTitle": "Voice_Queue_Reports"
31772 "url": "/api/voice/queues/reports/index",
31773 "title": "Get Voice Queues Report",
31776 "title": "Example usage:",
31777 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31781 "name": "getVoiceQueuesReport",
31782 "group": "Voice_Queue_Reports",
31783 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31784 "version": "0.0.0",
31785 "filename": "server/api/voiceQueueReport/index.js",
31786 "groupTitle": "Voice_Queue_Reports"
31790 "url": "/api/voice/queues/{id}/users",
31791 "title": "Add agents to queue",
31794 "title": "Example usage:",
31795 "content": "curl https://{domain}/api/voice/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31799 "name": "AddAgents",
31800 "group": "Voice_Queues",
31801 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31802 "version": "0.0.0",
31803 "filename": "server/api/voiceQueue/index.js",
31804 "groupTitle": "Voice_Queues"
31808 "url": "/api/voice/queues/{id}/blacklists",
31809 "title": "Add blacklists to a queue",
31812 "title": "Example usage:",
31813 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31817 "name": "AddBlackLists",
31818 "group": "Voice_Queues",
31819 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31820 "version": "0.0.0",
31821 "filename": "server/api/voiceQueue/index.js",
31822 "groupTitle": "Voice_Queues"
31826 "url": "/api/voice/queues/{id}/lists",
31827 "title": "Add lists to a queue",
31830 "title": "Example usage:",
31831 "content": "curl https://{domain}/api/voice/queues/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31835 "name": "AddLists",
31836 "group": "Voice_Queues",
31837 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31838 "version": "0.0.0",
31839 "filename": "server/api/voiceQueue/index.js",
31840 "groupTitle": "Voice_Queues"
31844 "url": "/api/voice/queues/{id}/teams",
31845 "title": "Add teams to queue",
31848 "title": "Example usage:",
31849 "content": "curl https://{domain}/api/voice/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31853 "name": "AddTeams",
31854 "group": "Voice_Queues",
31855 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31856 "version": "0.0.0",
31857 "filename": "server/api/voiceQueue/index.js",
31858 "groupTitle": "Voice_Queues"
31862 "url": "/api/voice/queues/clone",
31863 "title": "Clone an existing Queue",
31866 "title": "Example usage:",
31867 "content": "curl https://{domain}/api/voice/queues/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31871 "name": "CloneQueues",
31872 "group": "Voice_Queues",
31873 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31874 "version": "0.0.0",
31875 "filename": "server/api/voiceQueue/index.js",
31876 "groupTitle": "Voice_Queues"
31880 "url": "/api/voice/queues",
31881 "title": "Creates a new Queue",
31884 "title": "Example usage:",
31885 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31889 "name": "CreateQueues",
31890 "group": "Voice_Queues",
31916 "field": "musiconhold",
31923 "field": "announce",
31941 "field": "strategy",
31948 "field": "servicelevel",
31955 "field": "context",
31962 "field": "penaltymemberslimit",
31969 "field": "timeout",
31983 "field": "timeoutpriority",
31997 "field": "wrapuptime",
32008 "field": "autofill",
32020 "field": "autopause",
32027 "field": "autopausedelay",
32038 "field": "autopausebusy",
32049 "field": "autopauseunavail",
32067 "field": "setinterfacevar",
32078 "field": "setqueueentryvar",
32089 "field": "setqueuevar",
32100 "field": "eventmemberstatus",
32107 "field": "membermacro",
32114 "field": "membergosub",
32121 "field": "announce_frequency",
32128 "field": "min_announce_frequency",
32135 "field": "periodic_announce_frequency",
32146 "field": "random_periodic_announce",
32157 "field": "relative_periodic_announce",
32169 "field": "announce_holdtime",
32176 "field": "announce_position",
32187 "field": "announce_to_first_user",
32194 "field": "announce_position_limit",
32209 "field": "announce_round_seconds",
32216 "field": "monitor_format",
32223 "field": "monitor_type",
32230 "field": "queue_youarenext",
32237 "field": "queue_thereare",
32244 "field": "queue_callswaiting",
32251 "field": "queue_holdtime",
32258 "field": "queue_minute",
32265 "field": "queue_minutes",
32272 "field": "queue_seconds",
32279 "field": "queue_thankyou",
32286 "field": "queue_reporthold",
32293 "field": "queue_quantity1",
32300 "field": "queue_quantity2",
32307 "field": "queue_periodic_announce",
32314 "field": "queue_less_than",
32321 "field": "periodic_announce",
32328 "field": "joinempty",
32335 "field": "leavewhenempty",
32346 "field": "reportholdtime",
32357 "field": "ringinuse",
32364 "field": "memberdelay",
32375 "field": "timeoutrestart",
32382 "field": "defaultrule",
32389 "field": "description",
32403 "field": "acwTimeout",
32410 "field": "dialActive",
32411 "description": "<p>Active/Disactive Campaign</p>"
32424 "field": "dialMethod",
32425 "description": "<p>Dial Method.</p>"
32431 "field": "dialLimitChannel",
32432 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32438 "field": "dialLimitQueue",
32439 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32445 "field": "dialPowerLevel",
32446 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32452 "\"agentBusyFactor\"",
32456 "field": "dialPredictiveOptimization",
32457 "description": "<p>Only for predictive method.</p>"
32463 "field": "dialPredictiveOptimizationPercentage",
32464 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32470 "field": "dialPredictiveInterval",
32471 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32477 "field": "dialOriginateCallerIdName",
32484 "field": "dialOriginateCallerIdNumber",
32491 "field": "dialOriginateTimeout",
32492 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32498 "field": "dialQueueOptions",
32499 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32505 "field": "dialQueueTimeout",
32506 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32512 "field": "dialQueueProject",
32513 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32519 "field": "dialCongestionMaxRetry",
32520 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32526 "field": "dialCongestionRetryFrequency",
32527 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32533 "field": "dialBusyMaxRetry",
32534 "description": "<p>#Busy Retry (min:1, max:999)</p>"
32540 "field": "dialBusyRetryFrequency",
32541 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32547 "field": "dialNoAnswerMaxRetry",
32548 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32554 "field": "dialNoAnswerRetryFrequency",
32555 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32561 "field": "dialGlobalMaxRetry",
32562 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32568 "field": "dialTimezone",
32575 "field": "dialGlobalInterval",
32582 "field": "dialPrefix",
32594 "field": "dialCheckDuplicateType",
32601 "field": "dialAMDActive",
32602 "description": "<p>Active/Disactive AMD</p>"
32608 "field": "dialAMDInitialSilence",
32609 "description": "<p>#AMD Initial Silence</p>"
32615 "field": "dialAMDGreeting",
32616 "description": "<p>#AMD Greeting</p>"
32622 "field": "dialAMDAfterGreetingSilence",
32623 "description": "<p>#AMD After Greeting Silence</p>"
32629 "field": "dialAMDTotalAnalysisTime",
32630 "description": "<p>#AMD Total Analysis Time</p>"
32636 "field": "dialAMDMinWordLength",
32637 "description": "<p>#AMD Min Word Length</p>"
32643 "field": "dialAMDBetweenWordsSilence",
32644 "description": "<p>#AMD Between Words Silence</p>"
32650 "field": "dialAMDMaximumNumberOfWords",
32651 "description": "<p>#AMD Maximum Number Of Words</p>"
32657 "field": "dialAMDSilenceThreshold",
32658 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32664 "field": "dialAMDMaximumWordLength",
32665 "description": "<p>#AMD Maximum Word Length</p>"
32671 "field": "dialRecallMeTimeout",
32672 "description": "<p>#RecallMe Timeout (min:1)</p>"
32678 "field": "dialRecallInQueue",
32679 "description": "<p>Active/Disactive Recall In Queue</p>"
32689 "field": "dialOrderByScheduledAt",
32696 "field": "dialQueueProject2",
32697 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32703 "field": "dialAgiAfterHangupClient",
32710 "field": "dialAgiAfterHangupAgent",
32717 "field": "dialRandomLastDigitCallerIdNumber",
32718 "description": "<p>Random Last Digit (min:1, max:15)</p>"
32724 "field": "dialCutDigit",
32725 "description": "<p>Cut Digit (min:1, max:15)</p>"
32731 "field": "dialNoSuchNumberMaxRetry",
32732 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32738 "field": "dialNoSuchNumberRetryFrequency",
32739 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32745 "field": "dialDropMaxRetry",
32746 "description": "<p>#Drop Retry (min:1, max:999)</p>"
32752 "field": "dialDropRetryFrequency",
32753 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32759 "field": "dialAbandonedMaxRetry",
32760 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32766 "field": "dialAbandonedRetryFrequency",
32767 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32773 "field": "dialMachineMaxRetry",
32774 "description": "<p>#Machine Retry (min:1, max:999)</p>"
32780 "field": "dialMachineRetryFrequency",
32781 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32787 "field": "dialAgentRejectMaxRetry",
32788 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32794 "field": "dialAgentRejectRetryFrequency",
32795 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32801 "field": "mandatoryDispositionPauseId",
32802 "description": "<p>Status to put when mandatory disposition is enabled</p>"
32808 "field": "mandatoryDisposition",
32809 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32815 "field": "dialPredictiveIntervalMaxThreshold",
32822 "field": "dialPredictiveIntervalMinThreshold",
32829 "field": "dialPreviewAutoRecallMe",
32835 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32836 "version": "0.0.0",
32837 "filename": "server/api/voiceQueue/index.js",
32838 "groupTitle": "Voice_Queues"
32842 "url": "/api/voice/queues/{id}",
32843 "title": "Deletes a Queue",
32846 "title": "Example usage:",
32847 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32851 "name": "DeleteQueues",
32852 "group": "Voice_Queues",
32853 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32854 "version": "0.0.0",
32855 "filename": "server/api/voiceQueue/index.js",
32856 "groupTitle": "Voice_Queues"
32860 "url": "/api/voice/queues/{id}/users",
32861 "title": "Gets queue agents",
32864 "title": "Example usage:",
32865 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32869 "name": "GetAgents",
32870 "group": "Voice_Queues",
32871 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32872 "version": "0.0.0",
32873 "filename": "server/api/voiceQueue/index.js",
32874 "groupTitle": "Voice_Queues"
32878 "url": "/api/voice/queues/{id}/blacklists",
32879 "title": "Get queue blacklists",
32882 "title": "Example usage:",
32883 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32887 "name": "GetBlackLists",
32888 "group": "Voice_Queues",
32889 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32890 "version": "0.0.0",
32891 "filename": "server/api/voiceQueue/index.js",
32892 "groupTitle": "Voice_Queues"
32896 "url": "/api/voice/queues/{id}/finals",
32897 "title": "Gets queue hopper finals",
32900 "title": "Example usage:",
32901 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
32905 "name": "GetHopperFinals",
32906 "group": "Voice_Queues",
32907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32908 "version": "0.0.0",
32909 "filename": "server/api/voiceQueue/index.js",
32910 "groupTitle": "Voice_Queues"
32914 "url": "/api/voice/queues/{id}/hopper_histories",
32915 "title": "Gets queue hopper histories",
32918 "title": "Example usage:",
32919 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32923 "name": "GetHopperHistories",
32924 "group": "Voice_Queues",
32925 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32926 "version": "0.0.0",
32927 "filename": "server/api/voiceQueue/index.js",
32928 "groupTitle": "Voice_Queues"
32932 "url": "/api/voice/queues/{id}/hoppers",
32933 "title": "Gets queue hoppers",
32936 "title": "Example usage:",
32937 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32941 "name": "GetHoppers",
32942 "group": "Voice_Queues",
32943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32944 "version": "0.0.0",
32945 "filename": "server/api/voiceQueue/index.js",
32946 "groupTitle": "Voice_Queues"
32950 "url": "/api/voice/queues/{id}/lists",
32951 "title": "Get queue lists",
32954 "title": "Example usage:",
32955 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32959 "name": "GetLists",
32960 "group": "Voice_Queues",
32961 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32962 "version": "0.0.0",
32963 "filename": "server/api/voiceQueue/index.js",
32964 "groupTitle": "Voice_Queues"
32968 "url": "/api/voice/queues/{id}/members",
32969 "title": "Gets queue members",
32972 "title": "Example usage:",
32973 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32977 "name": "GetMembers",
32978 "group": "Voice_Queues",
32979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32980 "version": "0.0.0",
32981 "filename": "server/api/voiceQueue/index.js",
32982 "groupTitle": "Voice_Queues"
32986 "url": "/api/voice/queues",
32987 "title": "Gets a list of Queues",
32990 "title": "Example usage:",
32991 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32995 "name": "GetQueues",
32996 "group": "Voice_Queues",
32997 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
32998 "version": "0.0.0",
32999 "filename": "server/api/voiceQueue/index.js",
33000 "groupTitle": "Voice_Queues"
33004 "url": "/api/voice/queues/{id}/teams",
33005 "title": "Gets queue team",
33008 "title": "Example usage:",
33009 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
33013 "name": "GetTeams",
33014 "group": "Voice_Queues",
33015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33016 "version": "0.0.0",
33017 "filename": "server/api/voiceQueue/index.js",
33018 "groupTitle": "Voice_Queues"
33022 "url": "/api/voice/queues/{id}/users",
33023 "title": "Removes agents from a queue",
33026 "title": "Example usage:",
33027 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33031 "name": "RemoveAgents",
33032 "group": "Voice_Queues",
33033 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33034 "version": "0.0.0",
33035 "filename": "server/api/voiceQueue/index.js",
33036 "groupTitle": "Voice_Queues"
33040 "url": "/api/voice/queues/{id}/blacklists",
33041 "title": "Remove blacklists from a queue",
33044 "title": "Example usage:",
33045 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33049 "name": "RemoveBlackLists",
33050 "group": "Voice_Queues",
33051 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33052 "version": "0.0.0",
33053 "filename": "server/api/voiceQueue/index.js",
33054 "groupTitle": "Voice_Queues"
33058 "url": "/api/voice/queues/{id}/lists",
33059 "title": "Remove lists from a queue",
33062 "title": "Example usage:",
33063 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33067 "name": "RemoveLists",
33068 "group": "Voice_Queues",
33069 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33070 "version": "0.0.0",
33071 "filename": "server/api/voiceQueue/index.js",
33072 "groupTitle": "Voice_Queues"
33076 "url": "/api/voice/queues/{id}",
33077 "title": "Gets a single Queue",
33080 "title": "Example usage:",
33081 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33085 "name": "ShowQueues",
33086 "group": "Voice_Queues",
33087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33088 "version": "0.0.0",
33089 "filename": "server/api/voiceQueue/index.js",
33090 "groupTitle": "Voice_Queues"
33094 "url": "/api/voice/queues/{id}/blacks",
33095 "title": "Gets queue hopper blacks",
33098 "title": "Example usage:",
33099 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
33103 "name": "getHopperBlacks",
33104 "group": "Voice_Queues",
33105 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33106 "version": "0.0.0",
33107 "filename": "server/api/voiceQueue/index.js",
33108 "groupTitle": "Voice_Queues"
33112 "url": "/api/voice/queues/{id}",
33113 "title": "Update an existing Queue",
33116 "title": "Example usage:",
33117 "content": "curl https://{domain}/api/voice/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
33121 "name": "updateQueues",
33122 "group": "Voice_Queues",
33123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33124 "version": "0.0.0",
33125 "filename": "server/api/voiceQueue/index.js",
33126 "groupTitle": "Voice_Queues"
33130 "url": "/api/voice/recordings",
33131 "title": "Creates a new Recording",
33134 "title": "Example usage:",
33135 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33139 "name": "CreateRecordings",
33140 "group": "Voice_Recordings",
33155 "field": "uniqueid",
33162 "field": "channel",
33169 "field": "membername",
33176 "field": "calleridnum",
33183 "field": "calleridname",
33190 "field": "connectedlinenum",
33197 "field": "connectedlinename",
33204 "field": "accountcode",
33211 "field": "context",
33253 "field": "userDisposition",
33260 "field": "userSecondDisposition",
33267 "field": "userThirdDisposition",
33274 "field": "location",
33281 "field": "transcribeName",
33288 "field": "transcribeStatus",
33295 "field": "fileUri",
33302 "field": "fileText",
33309 "field": "failureReason",
33316 "field": "sentiment",
33323 "field": "sPositive",
33330 "field": "sNegative",
33337 "field": "sNeutral",
33351 "field": "tempSentiment",
33358 "field": "createdAt",
33365 "field": "updatedAt",
33371 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33372 "version": "0.0.0",
33373 "filename": "server/api/voiceRecording/index.js",
33374 "groupTitle": "Voice_Recordings"
33378 "url": "/api/voice/recordings/describe",
33379 "title": "Gets table info about Recordings",
33382 "title": "Example usage:",
33383 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33387 "name": "DescribeRecordings",
33388 "group": "Voice_Recordings",
33389 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33390 "version": "0.0.0",
33391 "filename": "server/api/voiceRecording/index.js",
33392 "groupTitle": "Voice_Recordings"
33396 "url": "/api/voice/recordings",
33397 "title": "Gets a list of Recordings",
33400 "title": "Example usage:",
33401 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33405 "name": "GetRecordings",
33406 "group": "Voice_Recordings",
33407 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/recordings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/recordings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/recordings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/recordings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/recordings?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33408 "version": "0.0.0",
33409 "filename": "server/api/voiceRecording/index.js",
33410 "groupTitle": "Voice_Recordings"
33414 "url": "/api/voice/recordings/{id}",
33415 "title": "Gets a single Recording",
33418 "title": "Example usage:",
33419 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33423 "name": "ShowRecordings",
33424 "group": "Voice_Recordings",
33425 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33426 "version": "0.0.0",
33427 "filename": "server/api/voiceRecording/index.js",
33428 "groupTitle": "Voice_Recordings"
33432 "url": "/api/voice/recordings/{id}",
33433 "title": "Delete voice recording",
33436 "title": "Example usage:",
33437 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33442 "group": "Voice_Recordings",
33443 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33444 "version": "0.0.0",
33445 "filename": "server/api/voiceRecording/index.js",
33446 "groupTitle": "Voice_Recordings"
33450 "url": "/api/voice/recordings/{id}/download",
33451 "title": "Download Recording",
33454 "title": "Example usage:",
33455 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33459 "name": "download",
33460 "group": "Voice_Recordings",
33461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33462 "version": "0.0.0",
33463 "filename": "server/api/voiceRecording/index.js",
33464 "groupTitle": "Voice_Recordings"
33468 "url": "/api/voice/recordings/{id}/downloads",
33469 "title": "Download Recording",
33472 "title": "Example usage:",
33473 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33477 "name": "downloads",
33478 "group": "Voice_Recordings",
33479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33480 "version": "0.0.0",
33481 "filename": "server/api/voiceRecording/index.js",
33482 "groupTitle": "Voice_Recordings"
33486 "url": "/api/voice/recordings/{id}/transcribe",
33487 "title": "Run Transcribe Recording",
33490 "title": "Example usage:",
33491 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33495 "name": "transcribe",
33496 "group": "Voice_Recordings",
33497 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33498 "version": "0.0.0",
33499 "filename": "server/api/voiceRecording/index.js",
33500 "groupTitle": "Voice_Recordings"
33504 "url": "/api/voice/recordings/{id}/transcribe",
33505 "title": "Run Transcribe Recording",
33508 "title": "Example usage:",
33509 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33513 "name": "transcribe",
33514 "group": "Voice_Recordings",
33515 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33516 "version": "0.0.0",
33517 "filename": "server/api/voiceRecording/index.js",
33518 "groupTitle": "Voice_Recordings"
33522 "url": "/api/voice/recordings/{id}",
33523 "title": "Update an existing Recording",
33526 "title": "Example usage:",
33527 "content": "curl https://{domain}/api/voice/recordings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
33531 "name": "updateRecordings",
33532 "group": "Voice_Recordings",
33533 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33534 "version": "0.0.0",
33535 "filename": "server/api/voiceRecording/index.js",
33536 "groupTitle": "Voice_Recordings"
33540 "url": "/api/voice/transfers/reports",
33541 "title": "Creates a new Transfer Report",
33544 "title": "Example usage:",
33545 "content": "curl https://{domain}/api/voice/transfers/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33549 "name": "CreateTransfer_Reports",
33550 "group": "Voice_Transfer_Reports",
33576 "field": "transfererchannel",
33583 "field": "transferercalleridnum",
33590 "field": "transferercalleridname",
33597 "field": "transfererconnectedlinenum",
33604 "field": "transfererconnectedlinename",
33611 "field": "transfereraccountcode",
33618 "field": "transferercontext",
33625 "field": "transfererexten",
33632 "field": "transfererlinkedid",
33639 "field": "transfereechannel",
33646 "field": "transfereecalleridnum",
33653 "field": "transfereecalleridname",
33660 "field": "transfereeconnectedlinenum",
33667 "field": "transfereeconnectedlinename",
33674 "field": "transfereeaccountcode",
33681 "field": "transfereecontext",
33688 "field": "transfereeexten",
33695 "field": "transfereelinkedid",
33706 "field": "isexternal",
33713 "field": "context",
33720 "field": "extension",
33726 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33727 "version": "0.0.0",
33728 "filename": "server/api/voiceTransferReport/index.js",
33729 "groupTitle": "Voice_Transfer_Reports"
33733 "url": "/api/voice/transfers/reports/{id}",
33734 "title": "Deletes a Transfer Report",
33737 "title": "Example usage:",
33738 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33742 "name": "DeleteTransfer_Reports",
33743 "group": "Voice_Transfer_Reports",
33744 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33745 "version": "0.0.0",
33746 "filename": "server/api/voiceTransferReport/index.js",
33747 "groupTitle": "Voice_Transfer_Reports"
33751 "url": "/api/voice/transfers/reports/describe",
33752 "title": "Gets table info about Transfer Reports",
33755 "title": "Example usage:",
33756 "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33760 "name": "DescribeTransfer_Reports",
33761 "group": "Voice_Transfer_Reports",
33762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33763 "version": "0.0.0",
33764 "filename": "server/api/voiceTransferReport/index.js",
33765 "groupTitle": "Voice_Transfer_Reports"
33769 "url": "/api/voice/transfers/reports",
33770 "title": "Gets a list of Transfer Reports",
33773 "title": "Example usage:",
33774 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33778 "name": "GetTransfer_Reports",
33779 "group": "Voice_Transfer_Reports",
33780 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/transfers/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voice/transfers/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voice/transfers/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voice/transfers/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voice/transfers/reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33781 "version": "0.0.0",
33782 "filename": "server/api/voiceTransferReport/index.js",
33783 "groupTitle": "Voice_Transfer_Reports"
33787 "url": "/api/voice/transfers/reports/{id}",
33788 "title": "Gets a single Transfer Report",
33791 "title": "Example usage:",
33792 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33796 "name": "ShowTransfer_Reports",
33797 "group": "Voice_Transfer_Reports",
33798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33799 "version": "0.0.0",
33800 "filename": "server/api/voiceTransferReport/index.js",
33801 "groupTitle": "Voice_Transfer_Reports"
33805 "url": "/api/voice/transfers/reports/{id}",
33806 "title": "Update an existing Transfer Report",
33809 "title": "Example usage:",
33810 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
33814 "name": "updateTransfer_Reports",
33815 "group": "Voice_Transfer_Reports",
33816 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33817 "version": "0.0.0",
33818 "filename": "server/api/voiceTransferReport/index.js",
33819 "groupTitle": "Voice_Transfer_Reports"
33823 "url": "/api/integrations/vtiger/accounts",
33824 "title": "Creates a new Vtiger Account",
33827 "title": "Example usage:",
33828 "content": "curl https://{domain}/api/integrations/vtiger/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33832 "name": "CreateVtiger_Accounts",
33833 "group": "Vtiger_Accounts",
33848 "field": "description",
33855 "field": "username",
33862 "field": "moduleName",
33869 "field": "remoteUri",
33876 "field": "serverUrl",
33883 "field": "accessKey",
33889 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33890 "version": "0.0.0",
33891 "filename": "server/api/intVtigerAccount/index.js",
33892 "groupTitle": "Vtiger_Accounts"
33896 "url": "/api/integrations/vtiger/accounts/{id}",
33897 "title": "Deletes a Vtiger Account",
33900 "title": "Example usage:",
33901 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33905 "name": "DeleteVtiger_Accounts",
33906 "group": "Vtiger_Accounts",
33907 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33908 "version": "0.0.0",
33909 "filename": "server/api/intVtigerAccount/index.js",
33910 "groupTitle": "Vtiger_Accounts"
33914 "url": "/api/integrations/vtiger/accounts",
33915 "title": "Gets a list of Vtiger Accounts",
33918 "title": "Example usage:",
33919 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33923 "name": "GetVtiger_Accounts",
33924 "group": "Vtiger_Accounts",
33925 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/vtiger/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/vtiger/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/vtiger/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/vtiger/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/vtiger/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33926 "version": "0.0.0",
33927 "filename": "server/api/intVtigerAccount/index.js",
33928 "groupTitle": "Vtiger_Accounts"
33932 "url": "/api/integrations/vtiger/accounts/{id}",
33933 "title": "Gets a single Vtiger Account",
33936 "title": "Example usage:",
33937 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33941 "name": "ShowVtiger_Accounts",
33942 "group": "Vtiger_Accounts",
33943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33944 "version": "0.0.0",
33945 "filename": "server/api/intVtigerAccount/index.js",
33946 "groupTitle": "Vtiger_Accounts"
33950 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33951 "title": "Creates new configuration",
33954 "title": "Example usage:",
33955 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
33959 "name": "addConfiguration",
33960 "group": "Vtiger_Accounts",
33961 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33962 "version": "0.0.0",
33963 "filename": "server/api/intVtigerAccount/index.js",
33964 "groupTitle": "Vtiger_Accounts"
33968 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33969 "title": "Gets account configurations",
33972 "title": "Example usage:",
33973 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33977 "name": "getConfigurations",
33978 "group": "Vtiger_Accounts",
33979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33980 "version": "0.0.0",
33981 "filename": "server/api/intVtigerAccount/index.js",
33982 "groupTitle": "Vtiger_Accounts"
33986 "url": "/api/integrations/vtiger/accounts/{id}/fields",
33987 "title": "Gets account fields",
33990 "title": "Example usage:",
33991 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33995 "name": "getFields",
33996 "group": "Vtiger_Accounts",
33997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33998 "version": "0.0.0",
33999 "filename": "server/api/intVtigerAccount/index.js",
34000 "groupTitle": "Vtiger_Accounts"
34004 "url": "/api/integrations/vtiger/accounts/{id}",
34005 "title": "Update an existing Vtiger Account",
34008 "title": "Example usage:",
34009 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
34013 "name": "updateVtiger_Accounts",
34014 "group": "Vtiger_Accounts",
34015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34016 "version": "0.0.0",
34017 "filename": "server/api/intVtigerAccount/index.js",
34018 "groupTitle": "Vtiger_Accounts"
34022 "url": "/api/integrations/vtiger/configurations",
34023 "title": "Creates a new Vtiger Configuration",
34026 "title": "Example usage:",
34027 "content": "curl https://{domain}/api/integrations/vtiger/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34031 "name": "CreateVtiger_Configurations",
34032 "group": "Vtiger_Configurations",
34047 "field": "description",
34053 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34054 "version": "0.0.0",
34055 "filename": "server/api/intVtigerConfiguration/index.js",
34056 "groupTitle": "Vtiger_Configurations"
34060 "url": "/api/integrations/vtiger/configurations/{id}",
34061 "title": "Deletes a Vtiger Configuration",
34064 "title": "Example usage:",
34065 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34069 "name": "DeleteVtiger_Configurations",
34070 "group": "Vtiger_Configurations",
34071 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34072 "version": "0.0.0",
34073 "filename": "server/api/intVtigerConfiguration/index.js",
34074 "groupTitle": "Vtiger_Configurations"
34078 "url": "/api/integrations/vtiger/configurations",
34079 "title": "Gets a list of Vtiger Configurations",
34082 "title": "Example usage:",
34083 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34087 "name": "GetVtiger_Configurations",
34088 "group": "Vtiger_Configurations",
34089 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/vtiger/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/vtiger/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/vtiger/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/vtiger/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/vtiger/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34090 "version": "0.0.0",
34091 "filename": "server/api/intVtigerConfiguration/index.js",
34092 "groupTitle": "Vtiger_Configurations"
34096 "url": "/api/integrations/vtiger/configurations/{id}",
34097 "title": "Gets a single Vtiger Configuration",
34100 "title": "Example usage:",
34101 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34105 "name": "ShowVtiger_Configurations",
34106 "group": "Vtiger_Configurations",
34107 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34108 "version": "0.0.0",
34109 "filename": "server/api/intVtigerConfiguration/index.js",
34110 "groupTitle": "Vtiger_Configurations"
34114 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34115 "title": "Gets configurations descriptions",
34118 "title": "Example usage:",
34119 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34123 "name": "getDescriptions",
34124 "group": "Vtiger_Configurations",
34125 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34126 "version": "0.0.0",
34127 "filename": "server/api/intVtigerConfiguration/index.js",
34128 "groupTitle": "Vtiger_Configurations"
34132 "url": "/api/integrations/vtiger/configurations/{id}/fields",
34133 "title": "Gets configurations fields",
34136 "title": "Example usage:",
34137 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34141 "name": "getFields",
34142 "group": "Vtiger_Configurations",
34143 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34144 "version": "0.0.0",
34145 "filename": "server/api/intVtigerConfiguration/index.js",
34146 "groupTitle": "Vtiger_Configurations"
34150 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34151 "title": "Gets configurations subjects",
34154 "title": "Example usage:",
34155 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34159 "name": "getSubjects",
34160 "group": "Vtiger_Configurations",
34161 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34162 "version": "0.0.0",
34163 "filename": "server/api/intVtigerConfiguration/index.js",
34164 "groupTitle": "Vtiger_Configurations"
34168 "url": "/api/integrations/vtiger/configurations/{id}",
34169 "title": "Update an existing Vtiger Configuration",
34172 "title": "Example usage:",
34173 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
34177 "name": "updateVtiger_Configurations",
34178 "group": "Vtiger_Configurations",
34179 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34180 "version": "0.0.0",
34181 "filename": "server/api/intVtigerConfiguration/index.js",
34182 "groupTitle": "Vtiger_Configurations"
34186 "url": "/api/integrations/vtiger/fields",
34187 "title": "Creates a new Vtiger Field",
34190 "title": "Example usage:",
34191 "content": "curl https://{domain}/api/integrations/vtiger/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34195 "name": "CreateVtiger_Fields",
34196 "group": "Vtiger_Fields",
34206 "\"customVariable\"",
34218 "field": "content",
34234 "\"customVariable\""
34237 "field": "keyType",
34244 "field": "keyContent",
34251 "field": "idField",
34258 "field": "nameField",
34265 "field": "customField",
34272 "field": "variableName",
34278 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34279 "version": "0.0.0",
34280 "filename": "server/api/intVtigerField/index.js",
34281 "groupTitle": "Vtiger_Fields"
34285 "url": "/api/integrations/vtiger/fields/{id}",
34286 "title": "Deletes a Vtiger Field",
34289 "title": "Example usage:",
34290 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34294 "name": "DeleteVtiger_Fields",
34295 "group": "Vtiger_Fields",
34296 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34297 "version": "0.0.0",
34298 "filename": "server/api/intVtigerField/index.js",
34299 "groupTitle": "Vtiger_Fields"
34303 "url": "/api/integrations/vtiger/fields",
34304 "title": "Gets a list of Vtiger Fields",
34307 "title": "Example usage:",
34308 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34312 "name": "GetVtiger_Fields",
34313 "group": "Vtiger_Fields",
34314 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/vtiger/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/vtiger/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/vtiger/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/vtiger/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/vtiger/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34315 "version": "0.0.0",
34316 "filename": "server/api/intVtigerField/index.js",
34317 "groupTitle": "Vtiger_Fields"
34321 "url": "/api/integrations/vtiger/fields/{id}",
34322 "title": "Gets a single Vtiger Field",
34325 "title": "Example usage:",
34326 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34330 "name": "ShowVtiger_Fields",
34331 "group": "Vtiger_Fields",
34332 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34333 "version": "0.0.0",
34334 "filename": "server/api/intVtigerField/index.js",
34335 "groupTitle": "Vtiger_Fields"
34339 "url": "/api/integrations/vtiger/fields/{id}",
34340 "title": "Update an existing Vtiger Field",
34343 "title": "Example usage:",
34344 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
34348 "name": "updateVtiger_Fields",
34349 "group": "Vtiger_Fields",
34350 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34351 "version": "0.0.0",
34352 "filename": "server/api/intVtigerField/index.js",
34353 "groupTitle": "Vtiger_Fields"
34357 "url": "/api/webbar/answer",
34358 "title": "answer webrtc call",
34361 "title": "Example usage:",
34362 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34366 "name": "Web_Bar_answer",
34375 "field": "sessionId",
34388 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34389 "version": "0.0.0",
34390 "filename": "server/api/webbar/index.js",
34391 "groupTitle": "WebBar"
34395 "url": "/api/webbar/calls",
34396 "title": "webrtc call list",
34399 "title": "Example usage:",
34400 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34404 "name": "Web_Bar_calls",
34419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34420 "version": "0.0.0",
34421 "filename": "server/api/webbar/index.js",
34422 "groupTitle": "WebBar"
34426 "url": "/api/webbar/hangup",
34427 "title": "hangup webrtc call",
34430 "title": "Example usage:",
34431 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34435 "name": "Web_Bar_hangup",
34444 "field": "sessionId",
34457 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34458 "version": "0.0.0",
34459 "filename": "server/api/webbar/index.js",
34460 "groupTitle": "WebBar"
34464 "url": "/api/webbar/unhold",
34465 "title": "unhold webrtc call",
34468 "title": "Example usage:",
34469 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34473 "name": "Web_Bar_hold",
34482 "field": "sessionId",
34495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34496 "version": "0.0.0",
34497 "filename": "server/api/webbar/index.js",
34498 "groupTitle": "WebBar"
34502 "url": "/api/webbar/hold",
34503 "title": "hold webrtc call",
34506 "title": "Example usage:",
34507 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34511 "name": "Web_Bar_hold",
34520 "field": "sessionId",
34533 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34534 "version": "0.0.0",
34535 "filename": "server/api/webbar/index.js",
34536 "groupTitle": "WebBar"
34540 "url": "/api/webbar/originate",
34541 "title": "Originate new webrtc call",
34544 "title": "Example usage:",
34545 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34549 "name": "Web_Bar_originate",
34558 "field": "callNumber",
34572 "field": "callerId",
34579 "field": "callbackUrl",
34585 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34586 "version": "0.0.0",
34587 "filename": "server/api/webbar/index.js",
34588 "groupTitle": "WebBar"
34592 "url": "/api/webbar/transfer",
34593 "title": "blind transfer webrtc call",
34596 "title": "Example usage:",
34597 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34601 "name": "Web_Bar_transfer",
34617 "field": "sessionId",
34624 "field": "transferNumber",
34630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34631 "version": "0.0.0",
34632 "filename": "server/api/webbar/index.js",
34633 "groupTitle": "WebBar"
34637 "url": "/api/whatsapp/accounts/{id}/users",
34638 "title": "Add agents to a whatsapp account",
34641 "title": "Example usage:",
34642 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34646 "name": "AddAgents",
34647 "group": "Whatsapp_Accounts",
34648 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34649 "version": "0.0.0",
34650 "filename": "server/api/whatsappAccount/index.js",
34651 "groupTitle": "Whatsapp_Accounts"
34655 "url": "/api/whatsapp/accounts",
34656 "title": "Creates a new Account",
34659 "title": "Example usage:",
34660 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34664 "name": "CreateAccounts",
34665 "group": "Whatsapp_Accounts",
34718 "field": "accountSid",
34725 "field": "authToken",
34732 "field": "notificationTemplate",
34739 "field": "notificationSound",
34746 "field": "notificationShake",
34753 "field": "waitForTheAssignedAgent",
34760 "field": "queueTransfer",
34767 "field": "queueTransferTimeout",
34774 "field": "agentTransfer",
34781 "field": "agentTransferTimeout",
34788 "field": "mandatoryDispositionPauseId",
34789 "description": "<p>Status to put when mandatory disposition is enabled</p>"
34795 "field": "mandatoryDisposition",
34796 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34802 "field": "description",
34808 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34809 "version": "0.0.0",
34810 "filename": "server/api/whatsappAccount/index.js",
34811 "groupTitle": "Whatsapp_Accounts"
34815 "url": "/api/whatsapp/accounts/{id}",
34816 "title": "Deletes a Account",
34819 "title": "Example usage:",
34820 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34824 "name": "DeleteAccounts",
34825 "group": "Whatsapp_Accounts",
34826 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34827 "version": "0.0.0",
34828 "filename": "server/api/whatsappAccount/index.js",
34829 "groupTitle": "Whatsapp_Accounts"
34833 "url": "/api/whatsapp/accounts/describe",
34834 "title": "Gets table info about Accounts",
34837 "title": "Example usage:",
34838 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34842 "name": "DescribeAccounts",
34843 "group": "Whatsapp_Accounts",
34844 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34845 "version": "0.0.0",
34846 "filename": "server/api/whatsappAccount/index.js",
34847 "groupTitle": "Whatsapp_Accounts"
34851 "url": "/api/whatsapp/accounts",
34852 "title": "Gets a list of Accounts",
34855 "title": "Example usage:",
34856 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34860 "name": "GetAccounts",
34861 "group": "Whatsapp_Accounts",
34862 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34863 "version": "0.0.0",
34864 "filename": "server/api/whatsappAccount/index.js",
34865 "groupTitle": "Whatsapp_Accounts"
34869 "url": "/api/whatsapp/accounts/{id}/users",
34870 "title": "Gets agents from whatsapp account",
34873 "title": "Example usage:",
34874 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34878 "name": "GetAgents",
34879 "group": "Whatsapp_Accounts",
34880 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34881 "version": "0.0.0",
34882 "filename": "server/api/whatsappAccount/index.js",
34883 "groupTitle": "Whatsapp_Accounts"
34887 "url": "/api/whatsapp/accounts/{id}/users",
34888 "title": "Removes agents from a whatsapp account",
34891 "title": "Example usage:",
34892 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34896 "name": "RemoveAgents",
34897 "group": "Whatsapp_Accounts",
34898 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34899 "version": "0.0.0",
34900 "filename": "server/api/whatsappAccount/index.js",
34901 "groupTitle": "Whatsapp_Accounts"
34905 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34906 "title": "Removes canned answers from account",
34909 "title": "Example usage:",
34910 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34914 "name": "RemoveAnswers",
34915 "group": "Whatsapp_Accounts",
34916 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34917 "version": "0.0.0",
34918 "filename": "server/api/whatsappAccount/index.js",
34919 "groupTitle": "Whatsapp_Accounts"
34923 "url": "/api/whatsapp/accounts/{id}/dispositions",
34924 "title": "Removes dispositions from account",
34927 "title": "Example usage:",
34928 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34932 "name": "RemoveDispositions",
34933 "group": "Whatsapp_Accounts",
34934 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34935 "version": "0.0.0",
34936 "filename": "server/api/whatsappAccount/index.js",
34937 "groupTitle": "Whatsapp_Accounts"
34941 "url": "/api/whatsapp/accounts/{id}",
34942 "title": "Gets a single Account",
34945 "title": "Example usage:",
34946 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34950 "name": "ShowAccounts",
34951 "group": "Whatsapp_Accounts",
34952 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34953 "version": "0.0.0",
34954 "filename": "server/api/whatsappAccount/index.js",
34955 "groupTitle": "Whatsapp_Accounts"
34959 "url": "/api/whatsapp/messages/{id}/accept",
34960 "title": "Accepts message",
34963 "title": "Example usage:",
34964 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34968 "name": "acceptMessage",
34969 "group": "Whatsapp_Accounts",
34970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34971 "version": "0.0.0",
34972 "filename": "server/api/whatsappMessage/index.js",
34973 "groupTitle": "Whatsapp_Accounts"
34977 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34978 "title": "Creates new canned answer",
34981 "title": "Example usage:",
34982 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34986 "name": "addAnswer",
34987 "group": "Whatsapp_Accounts",
35009 "field": "description",
35022 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35023 "version": "0.0.0",
35024 "filename": "server/api/whatsappAccount/index.js",
35025 "groupTitle": "Whatsapp_Accounts"
35029 "url": "/api/whatsapp/accounts/{id}/applications",
35030 "title": "Creates new applications",
35033 "title": "Example usage:",
35034 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35038 "name": "addApplications",
35039 "group": "Whatsapp_Accounts",
35047 "field": "priority",
35061 "field": "appdata",
35068 "field": "description",
35075 "field": "interval",
35081 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35082 "version": "0.0.0",
35083 "filename": "server/api/whatsappAccount/index.js",
35084 "groupTitle": "Whatsapp_Accounts"
35088 "url": "/api/whatsapp/accounts/{id}/dispositions",
35089 "title": "Creates new disposition",
35092 "title": "Example usage:",
35093 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35097 "name": "addDisposition",
35098 "group": "Whatsapp_Accounts",
35125 "field": "description",
35131 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35132 "version": "0.0.0",
35133 "filename": "server/api/whatsappAccount/index.js",
35134 "groupTitle": "Whatsapp_Accounts"
35138 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35139 "title": "Gets account canned answers",
35142 "title": "Example usage:",
35143 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35147 "name": "getAnswers",
35148 "group": "Whatsapp_Accounts",
35149 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35150 "version": "0.0.0",
35151 "filename": "server/api/whatsappAccount/index.js",
35152 "groupTitle": "Whatsapp_Accounts"
35156 "url": "/api/whatsapp/accounts/{id}/applications",
35157 "title": "Gets account applications",
35160 "title": "Example usage:",
35161 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35165 "name": "getApplications",
35166 "group": "Whatsapp_Accounts",
35167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35168 "version": "0.0.0",
35169 "filename": "server/api/whatsappAccount/index.js",
35170 "groupTitle": "Whatsapp_Accounts"
35174 "url": "/api/whatsapp/accounts/{id}/dispositions",
35175 "title": "Gets account dispositions",
35178 "title": "Example usage:",
35179 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35183 "name": "getDispositions",
35184 "group": "Whatsapp_Accounts",
35185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35186 "version": "0.0.0",
35187 "filename": "server/api/whatsappAccount/index.js",
35188 "groupTitle": "Whatsapp_Accounts"
35192 "url": "/api/whatsapp/accounts/{id}/notify",
35193 "title": "Notify new message",
35196 "title": "Example usage:",
35197 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35202 "group": "Whatsapp_Accounts",
35203 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new whatsapp message to be sent to the system.</p>",
35204 "version": "0.0.0",
35205 "filename": "server/api/whatsappAccount/index.js",
35206 "groupTitle": "Whatsapp_Accounts"
35210 "url": "/api/whatsapp/messages/{id}/reject",
35211 "title": "Rejects message",
35214 "title": "Example usage:",
35215 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35219 "name": "rejectMessage",
35220 "group": "Whatsapp_Accounts",
35221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35222 "version": "0.0.0",
35223 "filename": "server/api/whatsappMessage/index.js",
35224 "groupTitle": "Whatsapp_Accounts"
35228 "url": "/api/whatsapp/accounts/{id}/send",
35229 "title": "Send new whatsapp message",
35232 "title": "Example usage:",
35233 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/send -d '{from: '+39333123456', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35237 "name": "sendWhatsapp",
35238 "group": "Whatsapp_Accounts",
35239 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35240 "version": "0.0.0",
35241 "filename": "server/api/whatsappAccount/index.js",
35242 "groupTitle": "Whatsapp_Accounts"
35246 "url": "/api/whatsapp/messages/{id}/status",
35247 "title": "Receive message status",
35250 "title": "Example usage:",
35251 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35255 "name": "statusMessage",
35256 "group": "Whatsapp_Accounts",
35257 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35258 "version": "0.0.0",
35259 "filename": "server/api/whatsappMessage/index.js",
35260 "groupTitle": "Whatsapp_Accounts"
35264 "url": "/api/whatsapp/accounts/{id}",
35265 "title": "Update an existing Account",
35268 "title": "Example usage:",
35269 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35273 "name": "updateAccounts",
35274 "group": "Whatsapp_Accounts",
35275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35276 "version": "0.0.0",
35277 "filename": "server/api/whatsappAccount/index.js",
35278 "groupTitle": "Whatsapp_Accounts"
35282 "url": "/api/whatsapp/applications",
35283 "title": "Creates a new Application",
35286 "title": "Example usage:",
35287 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35291 "name": "CreateApplications",
35292 "group": "Whatsapp_Applications",
35300 "field": "priority",
35314 "field": "appdata",
35321 "field": "description",
35328 "field": "interval",
35334 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35335 "version": "0.0.0",
35336 "filename": "server/api/whatsappApplication/index.js",
35337 "groupTitle": "Whatsapp_Applications"
35341 "url": "/api/whatsapp/applications/{id}",
35342 "title": "Deletes a Application",
35345 "title": "Example usage:",
35346 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35350 "name": "DeleteApplications",
35351 "group": "Whatsapp_Applications",
35352 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35353 "version": "0.0.0",
35354 "filename": "server/api/whatsappApplication/index.js",
35355 "groupTitle": "Whatsapp_Applications"
35359 "url": "/api/whatsapp/applications",
35360 "title": "Gets a list of Applications",
35363 "title": "Example usage:",
35364 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35368 "name": "GetApplications",
35369 "group": "Whatsapp_Applications",
35370 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/applications?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
35371 "version": "0.0.0",
35372 "filename": "server/api/whatsappApplication/index.js",
35373 "groupTitle": "Whatsapp_Applications"
35377 "url": "/api/whatsapp/applications/{id}",
35378 "title": "Gets a single Application",
35381 "title": "Example usage:",
35382 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35386 "name": "ShowApplications",
35387 "group": "Whatsapp_Applications",
35388 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35389 "version": "0.0.0",
35390 "filename": "server/api/whatsappApplication/index.js",
35391 "groupTitle": "Whatsapp_Applications"
35395 "url": "/api/whatsapp/applications/{id}",
35396 "title": "Update an existing Application",
35399 "title": "Example usage:",
35400 "content": "curl https://{domain}/api/whatsapp/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35404 "name": "updateApplications",
35405 "group": "Whatsapp_Applications",
35406 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35407 "version": "0.0.0",
35408 "filename": "server/api/whatsappApplication/index.js",
35409 "groupTitle": "Whatsapp_Applications"
35413 "url": "/api/whatsapp/interactions/{id}/tags",
35414 "title": "Add tags to the interaction",
35417 "title": "Example usage:",
35418 "content": "curl https://{domain}/api/whatsapp/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35423 "group": "Whatsapp_Interactions",
35424 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35425 "version": "0.0.0",
35426 "filename": "server/api/whatsappInteraction/index.js",
35427 "groupTitle": "Whatsapp_Interactions"
35431 "url": "/api/whatsapp/interactions",
35432 "title": "Creates a new Interaction",
35435 "title": "Example usage:",
35436 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35440 "name": "CreateInteractions",
35441 "group": "Whatsapp_Interactions",
35456 "field": "closedAt",
35463 "field": "disposition",
35470 "field": "secondDisposition",
35477 "field": "thirdDisposition",
35498 "field": "read1stAt",
35509 "field": "firstMsgDirection",
35516 "field": "lastMsgAt",
35527 "field": "lastMsgDirection",
35534 "field": "autoreplyExecuted",
35540 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35541 "version": "0.0.0",
35542 "filename": "server/api/whatsappInteraction/index.js",
35543 "groupTitle": "Whatsapp_Interactions"
35547 "url": "/api/whatsapp/interactions/{id}",
35548 "title": "Deletes a Interaction",
35551 "title": "Example usage:",
35552 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35556 "name": "DeleteInteractions",
35557 "group": "Whatsapp_Interactions",
35558 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35559 "version": "0.0.0",
35560 "filename": "server/api/whatsappInteraction/index.js",
35561 "groupTitle": "Whatsapp_Interactions"
35565 "url": "/api/whatsapp/interactions/describe",
35566 "title": "Gets table info about Interactions",
35569 "title": "Example usage:",
35570 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35574 "name": "DescribeInteractions",
35575 "group": "Whatsapp_Interactions",
35576 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35577 "version": "0.0.0",
35578 "filename": "server/api/whatsappInteraction/index.js",
35579 "groupTitle": "Whatsapp_Interactions"
35583 "url": "/api/whatsapp/interactions",
35584 "title": "Gets a list of Interactions",
35587 "title": "Example usage:",
35588 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35592 "name": "GetInteractions",
35593 "group": "Whatsapp_Interactions",
35594 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
35595 "version": "0.0.0",
35596 "filename": "server/api/whatsappInteraction/index.js",
35597 "groupTitle": "Whatsapp_Interactions"
35601 "url": "/api/whatsapp/interactions/{id}/tags",
35602 "title": "Removes tags from interaction",
35605 "title": "Example usage:",
35606 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35610 "name": "RemoveTags",
35611 "group": "Whatsapp_Interactions",
35612 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35613 "version": "0.0.0",
35614 "filename": "server/api/whatsappInteraction/index.js",
35615 "groupTitle": "Whatsapp_Interactions"
35619 "url": "/api/whatsapp/interactions/{id}",
35620 "title": "Gets a single Interaction",
35623 "title": "Example usage:",
35624 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35628 "name": "ShowInteractions",
35629 "group": "Whatsapp_Interactions",
35630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35631 "version": "0.0.0",
35632 "filename": "server/api/whatsappInteraction/index.js",
35633 "groupTitle": "Whatsapp_Interactions"
35637 "url": "/api/whatsapp/interactions/{id}/messages",
35638 "title": "Creates new messages",
35641 "title": "Example usage:",
35642 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35646 "name": "addMessage",
35647 "group": "Whatsapp_Interactions",
35673 "field": "direction",
35680 "field": "messageId",
35708 "field": "providerName",
35715 "field": "providerResponse",
35721 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35722 "version": "0.0.0",
35723 "filename": "server/api/whatsappInteraction/index.js",
35724 "groupTitle": "Whatsapp_Interactions"
35728 "url": "/api/whatsapp/interactions/{id}/download",
35729 "title": "Gets interaction",
35732 "title": "Example usage:",
35733 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35737 "name": "download",
35738 "group": "Whatsapp_Interactions",
35739 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35740 "version": "0.0.0",
35741 "filename": "server/api/whatsappInteraction/index.js",
35742 "groupTitle": "Whatsapp_Interactions"
35746 "url": "/api/whatsapp/interactions/{id}/messages",
35747 "title": "Gets interaction messages",
35750 "title": "Example usage:",
35751 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35755 "name": "getMessages",
35756 "group": "Whatsapp_Interactions",
35757 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35758 "version": "0.0.0",
35759 "filename": "server/api/whatsappInteraction/index.js",
35760 "groupTitle": "Whatsapp_Interactions"
35764 "url": "/api/whatsapp/interactions/{id}",
35765 "title": "Update an existing Interaction",
35768 "title": "Example usage:",
35769 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35773 "name": "updateInteractions",
35774 "group": "Whatsapp_Interactions",
35775 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35776 "version": "0.0.0",
35777 "filename": "server/api/whatsappInteraction/index.js",
35778 "groupTitle": "Whatsapp_Interactions"
35782 "url": "/api/whatsapp/messages",
35783 "title": "Creates a new Message",
35786 "title": "Example usage:",
35787 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35791 "name": "CreateMessages",
35792 "group": "Whatsapp_Messages",
35818 "field": "direction",
35825 "field": "messageId",
35853 "field": "providerName",
35860 "field": "providerResponse",
35866 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35867 "version": "0.0.0",
35868 "filename": "server/api/whatsappMessage/index.js",
35869 "groupTitle": "Whatsapp_Messages"
35873 "url": "/api/whatsapp/messages/{id}",
35874 "title": "Deletes a Message",
35877 "title": "Example usage:",
35878 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35882 "name": "DeleteMessages",
35883 "group": "Whatsapp_Messages",
35884 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35885 "version": "0.0.0",
35886 "filename": "server/api/whatsappMessage/index.js",
35887 "groupTitle": "Whatsapp_Messages"
35891 "url": "/api/whatsapp/messages/describe",
35892 "title": "Gets table info about Messages",
35895 "title": "Example usage:",
35896 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35900 "name": "DescribeMessages",
35901 "group": "Whatsapp_Messages",
35902 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35903 "version": "0.0.0",
35904 "filename": "server/api/whatsappMessage/index.js",
35905 "groupTitle": "Whatsapp_Messages"
35909 "url": "/api/whatsapp/messages",
35910 "title": "Gets a list of Messages",
35913 "title": "Example usage:",
35914 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35918 "name": "GetMessages",
35919 "group": "Whatsapp_Messages",
35920 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
35921 "version": "0.0.0",
35922 "filename": "server/api/whatsappMessage/index.js",
35923 "groupTitle": "Whatsapp_Messages"
35927 "url": "/api/whatsapp/messages/{id}",
35928 "title": "Gets a single Message",
35931 "title": "Example usage:",
35932 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35936 "name": "ShowMessages",
35937 "group": "Whatsapp_Messages",
35938 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35939 "version": "0.0.0",
35940 "filename": "server/api/whatsappMessage/index.js",
35941 "groupTitle": "Whatsapp_Messages"
35945 "url": "/api/whatsapp/messages/{id}",
35946 "title": "Update an existing Message",
35949 "title": "Example usage:",
35950 "content": "curl https://{domain}/api/whatsapp/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35954 "name": "updateMessages",
35955 "group": "Whatsapp_Messages",
35956 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35957 "version": "0.0.0",
35958 "filename": "server/api/whatsappMessage/index.js",
35959 "groupTitle": "Whatsapp_Messages"
35963 "url": "/api/whatsapp/reports/queue",
35964 "title": "Creates a new Whatsapp Queue Report",
35967 "title": "Example usage:",
35968 "content": "curl https://{domain}/api/whatsapp/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35972 "name": "CreateWhatsapp_Queue_Reports",
35973 "group": "Whatsapp_Queue_Reports",
35981 "field": "uniqueid",
36002 "field": "leaveAt",
36009 "field": "acceptAt",
36029 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36030 "version": "0.0.0",
36031 "filename": "server/api/whatsappQueueReport/index.js",
36032 "groupTitle": "Whatsapp_Queue_Reports"
36036 "url": "/api/whatsapp/reports/queue/{id}",
36037 "title": "Deletes a Whatsapp Queue Report",
36040 "title": "Example usage:",
36041 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36045 "name": "DeleteWhatsapp_Queue_Reports",
36046 "group": "Whatsapp_Queue_Reports",
36047 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36048 "version": "0.0.0",
36049 "filename": "server/api/whatsappQueueReport/index.js",
36050 "groupTitle": "Whatsapp_Queue_Reports"
36054 "url": "/api/whatsapp/reports/queue/describe",
36055 "title": "Gets table info about Whatsapp Queue Reports",
36058 "title": "Example usage:",
36059 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36063 "name": "DescribeWhatsapp_Queue_Reports",
36064 "group": "Whatsapp_Queue_Reports",
36065 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36066 "version": "0.0.0",
36067 "filename": "server/api/whatsappQueueReport/index.js",
36068 "groupTitle": "Whatsapp_Queue_Reports"
36072 "url": "/api/whatsapp/reports/queue",
36073 "title": "Gets a list of Whatsapp Queue Reports",
36076 "title": "Example usage:",
36077 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36081 "name": "GetWhatsapp_Queue_Reports",
36082 "group": "Whatsapp_Queue_Reports",
36083 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36084 "version": "0.0.0",
36085 "filename": "server/api/whatsappQueueReport/index.js",
36086 "groupTitle": "Whatsapp_Queue_Reports"
36090 "url": "/api/whatsapp/reports/queue/{id}",
36091 "title": "Gets a single Whatsapp Queue Report",
36094 "title": "Example usage:",
36095 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36099 "name": "ShowWhatsapp_Queue_Reports",
36100 "group": "Whatsapp_Queue_Reports",
36101 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36102 "version": "0.0.0",
36103 "filename": "server/api/whatsappQueueReport/index.js",
36104 "groupTitle": "Whatsapp_Queue_Reports"
36108 "url": "/api/whatsapp/reports/queue/{id}",
36109 "title": "Update an existing Whatsapp Queue Report",
36112 "title": "Example usage:",
36113 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36117 "name": "updateWhatsapp_Queue_Reports",
36118 "group": "Whatsapp_Queue_Reports",
36119 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36120 "version": "0.0.0",
36121 "filename": "server/api/whatsappQueueReport/index.js",
36122 "groupTitle": "Whatsapp_Queue_Reports"
36126 "url": "/api/whatsapp/queues/{id}/users",
36127 "title": "Add agents to a queue",
36130 "title": "Example usage:",
36131 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36135 "name": "AddAgents",
36136 "group": "Whatsapp_Queues",
36137 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36138 "version": "0.0.0",
36139 "filename": "server/api/whatsappQueue/index.js",
36140 "groupTitle": "Whatsapp_Queues"
36144 "url": "/api/whatsapp/queues/{id}/teams",
36145 "title": "Add teams to a queue",
36148 "title": "Example usage:",
36149 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36153 "name": "AddTeams",
36154 "group": "Whatsapp_Queues",
36155 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36156 "version": "0.0.0",
36157 "filename": "server/api/whatsappQueue/index.js",
36158 "groupTitle": "Whatsapp_Queues"
36162 "url": "/api/whatsapp/queues",
36163 "title": "Creates a new Queue",
36166 "title": "Example usage:",
36167 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36171 "name": "CreateQueues",
36172 "group": "Whatsapp_Queues",
36187 "field": "timeout",
36199 "field": "strategy",
36206 "field": "description",
36212 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36213 "version": "0.0.0",
36214 "filename": "server/api/whatsappQueue/index.js",
36215 "groupTitle": "Whatsapp_Queues"
36219 "url": "/api/whatsapp/queues/{id}",
36220 "title": "Deletes a Queue",
36223 "title": "Example usage:",
36224 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36228 "name": "DeleteQueues",
36229 "group": "Whatsapp_Queues",
36230 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36231 "version": "0.0.0",
36232 "filename": "server/api/whatsappQueue/index.js",
36233 "groupTitle": "Whatsapp_Queues"
36237 "url": "/api/whatsapp/queues/describe",
36238 "title": "Gets table info about Queues",
36241 "title": "Example usage:",
36242 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36246 "name": "DescribeQueues",
36247 "group": "Whatsapp_Queues",
36248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36249 "version": "0.0.0",
36250 "filename": "server/api/whatsappQueue/index.js",
36251 "groupTitle": "Whatsapp_Queues"
36255 "url": "/api/whatsapp/queues/{id}/users",
36256 "title": "Gets queue agents",
36259 "title": "Example usage:",
36260 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36264 "name": "GetAgents",
36265 "group": "Whatsapp_Queues",
36266 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36267 "version": "0.0.0",
36268 "filename": "server/api/whatsappQueue/index.js",
36269 "groupTitle": "Whatsapp_Queues"
36273 "url": "/api/whatsapp/queues/{id}/members",
36274 "title": "GetMembers",
36277 "title": "Example usage:",
36278 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
36282 "name": "GetMembers",
36283 "group": "Whatsapp_Queues",
36284 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36285 "version": "0.0.0",
36286 "filename": "server/api/whatsappQueue/index.js",
36287 "groupTitle": "Whatsapp_Queues"
36291 "url": "/api/whatsapp/queues",
36292 "title": "Gets a list of Queues",
36295 "title": "Example usage:",
36296 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36300 "name": "GetQueues",
36301 "group": "Whatsapp_Queues",
36302 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36303 "version": "0.0.0",
36304 "filename": "server/api/whatsappQueue/index.js",
36305 "groupTitle": "Whatsapp_Queues"
36309 "url": "/api/whatsapp/queues/{id}/teams",
36310 "title": "Gets queues list",
36313 "title": "Example usage:",
36314 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36318 "name": "GetTeams",
36319 "group": "Whatsapp_Queues",
36320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36321 "version": "0.0.0",
36322 "filename": "server/api/whatsappQueue/index.js",
36323 "groupTitle": "Whatsapp_Queues"
36327 "url": "/api/whatsapp/queues/{id}/users",
36328 "title": "Removes agents from a queue",
36331 "title": "Example usage:",
36332 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36336 "name": "RemoveAgents",
36337 "group": "Whatsapp_Queues",
36338 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36339 "version": "0.0.0",
36340 "filename": "server/api/whatsappQueue/index.js",
36341 "groupTitle": "Whatsapp_Queues"
36345 "url": "/api/whatsapp/queues/{id}",
36346 "title": "Gets a single Queue",
36349 "title": "Example usage:",
36350 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36354 "name": "ShowQueues",
36355 "group": "Whatsapp_Queues",
36356 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36357 "version": "0.0.0",
36358 "filename": "server/api/whatsappQueue/index.js",
36359 "groupTitle": "Whatsapp_Queues"
36363 "url": "/api/whatsapp/queues/{id}",
36364 "title": "Update an existing Queue",
36367 "title": "Example usage:",
36368 "content": "curl https://{domain}/api/whatsapp/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36372 "name": "updateQueues",
36373 "group": "Whatsapp_Queues",
36374 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36375 "version": "0.0.0",
36376 "filename": "server/api/whatsappQueue/index.js",
36377 "groupTitle": "Whatsapp_Queues"
36381 "url": "/api/whatsapp/reports/transfer",
36382 "title": "Creates a new Whatsapp Transfer Report",
36385 "title": "Example usage:",
36386 "content": "curl https://{domain}/api/whatsapp/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36390 "name": "CreateWhatsapp_Transfer_Reports",
36391 "group": "Whatsapp_Transfer_Reports",
36399 "field": "uniqueid",
36418 "field": "transferredAt",
36424 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36425 "version": "0.0.0",
36426 "filename": "server/api/whatsappTransferReport/index.js",
36427 "groupTitle": "Whatsapp_Transfer_Reports"
36431 "url": "/api/whatsapp/reports/transfer/{id}",
36432 "title": "Deletes a Whatsapp Transfer Report",
36435 "title": "Example usage:",
36436 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36440 "name": "DeleteWhatsapp_Transfer_Reports",
36441 "group": "Whatsapp_Transfer_Reports",
36442 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36443 "version": "0.0.0",
36444 "filename": "server/api/whatsappTransferReport/index.js",
36445 "groupTitle": "Whatsapp_Transfer_Reports"
36449 "url": "/api/whatsapp/reports/transfer/describe",
36450 "title": "Gets table info about Whatsapp Transfer Reports",
36453 "title": "Example usage:",
36454 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36458 "name": "DescribeWhatsapp_Transfer_Reports",
36459 "group": "Whatsapp_Transfer_Reports",
36460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36461 "version": "0.0.0",
36462 "filename": "server/api/whatsappTransferReport/index.js",
36463 "groupTitle": "Whatsapp_Transfer_Reports"
36467 "url": "/api/whatsapp/reports/transfer",
36468 "title": "Gets a list of Whatsapp Transfer Reports",
36471 "title": "Example usage:",
36472 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36476 "name": "GetWhatsapp_Transfer_Reports",
36477 "group": "Whatsapp_Transfer_Reports",
36478 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/whatsapp/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/whatsapp/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/whatsapp/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36479 "version": "0.0.0",
36480 "filename": "server/api/whatsappTransferReport/index.js",
36481 "groupTitle": "Whatsapp_Transfer_Reports"
36485 "url": "/api/whatsapp/reports/transfer/{id}",
36486 "title": "Gets a single Whatsapp Transfer Report",
36489 "title": "Example usage:",
36490 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36494 "name": "ShowWhatsapp_Transfer_Reports",
36495 "group": "Whatsapp_Transfer_Reports",
36496 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36497 "version": "0.0.0",
36498 "filename": "server/api/whatsappTransferReport/index.js",
36499 "groupTitle": "Whatsapp_Transfer_Reports"
36503 "url": "/api/whatsapp/reports/transfer/{id}",
36504 "title": "Update an existing Whatsapp Transfer Report",
36507 "title": "Example usage:",
36508 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36512 "name": "updateWhatsapp_Transfer_Reports",
36513 "group": "Whatsapp_Transfer_Reports",
36514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36515 "version": "0.0.0",
36516 "filename": "server/api/whatsappTransferReport/index.js",
36517 "groupTitle": "Whatsapp_Transfer_Reports"
36521 "url": "/api/integrations/zendesk/accounts",
36522 "title": "Creates a new Zendesk Account",
36525 "title": "Example usage:",
36526 "content": "curl https://{domain}/api/integrations/zendesk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36530 "name": "CreateZendesk_Accounts",
36531 "group": "Zendesk_Accounts",
36546 "field": "description",
36553 "field": "username",
36560 "field": "password",
36574 "field": "remoteUri",
36585 "field": "authType",
36592 "field": "serverUrl",
36599 "\"integrationTab\"",
36609 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36610 "version": "0.0.0",
36611 "filename": "server/api/intZendeskAccount/index.js",
36612 "groupTitle": "Zendesk_Accounts"
36616 "url": "/api/integrations/zendesk/accounts/{id}",
36617 "title": "Deletes a Zendesk Account",
36620 "title": "Example usage:",
36621 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36625 "name": "DeleteZendesk_Accounts",
36626 "group": "Zendesk_Accounts",
36627 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36628 "version": "0.0.0",
36629 "filename": "server/api/intZendeskAccount/index.js",
36630 "groupTitle": "Zendesk_Accounts"
36634 "url": "/api/integrations/zendesk/accounts",
36635 "title": "Gets a list of Zendesk Accounts",
36638 "title": "Example usage:",
36639 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36643 "name": "GetZendesk_Accounts",
36644 "group": "Zendesk_Accounts",
36645 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zendesk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zendesk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zendesk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zendesk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zendesk/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36646 "version": "0.0.0",
36647 "filename": "server/api/intZendeskAccount/index.js",
36648 "groupTitle": "Zendesk_Accounts"
36652 "url": "/api/integrations/zendesk/accounts/{id}",
36653 "title": "Gets a single Zendesk Account",
36656 "title": "Example usage:",
36657 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36661 "name": "ShowZendesk_Accounts",
36662 "group": "Zendesk_Accounts",
36663 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36664 "version": "0.0.0",
36665 "filename": "server/api/intZendeskAccount/index.js",
36666 "groupTitle": "Zendesk_Accounts"
36670 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36671 "title": "Creates new configuration",
36674 "title": "Example usage:",
36675 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36679 "name": "addConfiguration",
36680 "group": "Zendesk_Accounts",
36681 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36682 "version": "0.0.0",
36683 "filename": "server/api/intZendeskAccount/index.js",
36684 "groupTitle": "Zendesk_Accounts"
36688 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36689 "title": "Gets account configurations",
36692 "title": "Example usage:",
36693 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36697 "name": "getConfigurations",
36698 "group": "Zendesk_Accounts",
36699 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36700 "version": "0.0.0",
36701 "filename": "server/api/intZendeskAccount/index.js",
36702 "groupTitle": "Zendesk_Accounts"
36706 "url": "/api/integrations/zendesk/accounts/{id}/fields",
36707 "title": "Gets account fields",
36710 "title": "Example usage:",
36711 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36715 "name": "getFields",
36716 "group": "Zendesk_Accounts",
36717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36718 "version": "0.0.0",
36719 "filename": "server/api/intZendeskAccount/index.js",
36720 "groupTitle": "Zendesk_Accounts"
36724 "url": "/api/integrations/zendesk/accounts/{id}",
36725 "title": "Update an existing Zendesk Account",
36728 "title": "Example usage:",
36729 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36733 "name": "updateZendesk_Accounts",
36734 "group": "Zendesk_Accounts",
36735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36736 "version": "0.0.0",
36737 "filename": "server/api/intZendeskAccount/index.js",
36738 "groupTitle": "Zendesk_Accounts"
36742 "url": "/api/integrations/zendesk/configurations",
36743 "title": "Creates a new Zendesk Configuration",
36746 "title": "Example usage:",
36747 "content": "curl https://{domain}/api/integrations/zendesk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36751 "name": "CreateZendesk_Configurations",
36752 "group": "Zendesk_Configurations",
36767 "field": "description",
36773 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36774 "version": "0.0.0",
36775 "filename": "server/api/intZendeskConfiguration/index.js",
36776 "groupTitle": "Zendesk_Configurations"
36780 "url": "/api/integrations/zendesk/configurations/{id}",
36781 "title": "Deletes a Zendesk Configuration",
36784 "title": "Example usage:",
36785 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36789 "name": "DeleteZendesk_Configurations",
36790 "group": "Zendesk_Configurations",
36791 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36792 "version": "0.0.0",
36793 "filename": "server/api/intZendeskConfiguration/index.js",
36794 "groupTitle": "Zendesk_Configurations"
36798 "url": "/api/integrations/zendesk/configurations",
36799 "title": "Gets a list of Zendesk Configurations",
36802 "title": "Example usage:",
36803 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36807 "name": "GetZendesk_Configurations",
36808 "group": "Zendesk_Configurations",
36809 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zendesk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zendesk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zendesk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zendesk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zendesk/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36810 "version": "0.0.0",
36811 "filename": "server/api/intZendeskConfiguration/index.js",
36812 "groupTitle": "Zendesk_Configurations"
36816 "url": "/api/integrations/zendesk/configurations/{id}",
36817 "title": "Gets a single Zendesk Configuration",
36820 "title": "Example usage:",
36821 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36825 "name": "ShowZendesk_Configurations",
36826 "group": "Zendesk_Configurations",
36827 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36828 "version": "0.0.0",
36829 "filename": "server/api/intZendeskConfiguration/index.js",
36830 "groupTitle": "Zendesk_Configurations"
36834 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36835 "title": "Gets configurations descriptions",
36838 "title": "Example usage:",
36839 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36843 "name": "getDescriptions",
36844 "group": "Zendesk_Configurations",
36845 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36846 "version": "0.0.0",
36847 "filename": "server/api/intZendeskConfiguration/index.js",
36848 "groupTitle": "Zendesk_Configurations"
36852 "url": "/api/integrations/zendesk/configurations/{id}/fields",
36853 "title": "Gets configurations fields",
36856 "title": "Example usage:",
36857 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36861 "name": "getFields",
36862 "group": "Zendesk_Configurations",
36863 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36864 "version": "0.0.0",
36865 "filename": "server/api/intZendeskConfiguration/index.js",
36866 "groupTitle": "Zendesk_Configurations"
36870 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36871 "title": "Gets configurations subjects",
36874 "title": "Example usage:",
36875 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36879 "name": "getSubjects",
36880 "group": "Zendesk_Configurations",
36881 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36882 "version": "0.0.0",
36883 "filename": "server/api/intZendeskConfiguration/index.js",
36884 "groupTitle": "Zendesk_Configurations"
36888 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36889 "title": "Gets configurations tags",
36892 "title": "Example usage:",
36893 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36898 "group": "Zendesk_Configurations",
36899 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36900 "version": "0.0.0",
36901 "filename": "server/api/intZendeskConfiguration/index.js",
36902 "groupTitle": "Zendesk_Configurations"
36906 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36907 "title": "Sets new tags",
36910 "title": "Example usage:",
36911 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36916 "group": "Zendesk_Configurations",
36917 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36918 "version": "0.0.0",
36919 "filename": "server/api/intZendeskConfiguration/index.js",
36920 "groupTitle": "Zendesk_Configurations"
36924 "url": "/api/integrations/zendesk/configurations/{id}",
36925 "title": "Update an existing Zendesk Configuration",
36928 "title": "Example usage:",
36929 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
36933 "name": "updateZendesk_Configurations",
36934 "group": "Zendesk_Configurations",
36935 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36936 "version": "0.0.0",
36937 "filename": "server/api/intZendeskConfiguration/index.js",
36938 "groupTitle": "Zendesk_Configurations"
36942 "url": "/api/integrations/zendesk/fields",
36943 "title": "Creates a new Zendesk Field",
36946 "title": "Example usage:",
36947 "content": "curl https://{domain}/api/integrations/zendesk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36951 "name": "CreateZendesk_Fields",
36952 "group": "Zendesk_Fields",
36962 "\"customVariable\"",
36974 "field": "content",
36990 "\"customVariable\""
36993 "field": "keyType",
37000 "field": "keyContent",
37007 "field": "idField",
37014 "field": "nameField",
37021 "field": "customField",
37028 "field": "variableName",
37034 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37035 "version": "0.0.0",
37036 "filename": "server/api/intZendeskField/index.js",
37037 "groupTitle": "Zendesk_Fields"
37041 "url": "/api/integrations/zendesk/fields/{id}",
37042 "title": "Deletes a Zendesk Field",
37045 "title": "Example usage:",
37046 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37050 "name": "DeleteZendesk_Fields",
37051 "group": "Zendesk_Fields",
37052 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37053 "version": "0.0.0",
37054 "filename": "server/api/intZendeskField/index.js",
37055 "groupTitle": "Zendesk_Fields"
37059 "url": "/api/integrations/zendesk/fields",
37060 "title": "Gets a list of Zendesk Fields",
37063 "title": "Example usage:",
37064 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37068 "name": "GetZendesk_Fields",
37069 "group": "Zendesk_Fields",
37070 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zendesk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zendesk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zendesk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zendesk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zendesk/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37071 "version": "0.0.0",
37072 "filename": "server/api/intZendeskField/index.js",
37073 "groupTitle": "Zendesk_Fields"
37077 "url": "/api/integrations/zendesk/fields/{id}",
37078 "title": "Gets a single Zendesk Field",
37081 "title": "Example usage:",
37082 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37086 "name": "ShowZendesk_Fields",
37087 "group": "Zendesk_Fields",
37088 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37089 "version": "0.0.0",
37090 "filename": "server/api/intZendeskField/index.js",
37091 "groupTitle": "Zendesk_Fields"
37095 "url": "/api/integrations/zendesk/fields/{id}",
37096 "title": "Update an existing Zendesk Field",
37099 "title": "Example usage:",
37100 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37104 "name": "updateZendesk_Fields",
37105 "group": "Zendesk_Fields",
37106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37107 "version": "0.0.0",
37108 "filename": "server/api/intZendeskField/index.js",
37109 "groupTitle": "Zendesk_Fields"
37113 "url": "/api/integrations/zoho/accounts",
37114 "title": "Creates a new Zoho Account",
37117 "title": "Example usage:",
37118 "content": "curl https://{domain}/api/integrations/zoho/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37122 "name": "CreateZoho_Accounts",
37123 "group": "Zoho_Accounts",
37138 "field": "description",
37159 "field": "clientId",
37166 "field": "clientSecret",
37173 "field": "serverUrl",
37187 "field": "refreshToken",
37193 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37194 "version": "0.0.0",
37195 "filename": "server/api/intZohoAccount/index.js",
37196 "groupTitle": "Zoho_Accounts"
37200 "url": "/api/integrations/zoho/accounts/{id}",
37201 "title": "Deletes a Zoho Account",
37204 "title": "Example usage:",
37205 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37209 "name": "DeleteZoho_Accounts",
37210 "group": "Zoho_Accounts",
37211 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37212 "version": "0.0.0",
37213 "filename": "server/api/intZohoAccount/index.js",
37214 "groupTitle": "Zoho_Accounts"
37218 "url": "/api/integrations/zoho/accounts",
37219 "title": "Gets a list of Zoho Accounts",
37222 "title": "Example usage:",
37223 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37227 "name": "GetZoho_Accounts",
37228 "group": "Zoho_Accounts",
37229 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zoho/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zoho/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zoho/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zoho/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zoho/accounts?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37230 "version": "0.0.0",
37231 "filename": "server/api/intZohoAccount/index.js",
37232 "groupTitle": "Zoho_Accounts"
37236 "url": "/api/integrations/zoho/accounts/{id}",
37237 "title": "Gets a single Zoho Account",
37240 "title": "Example usage:",
37241 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37245 "name": "ShowZoho_Accounts",
37246 "group": "Zoho_Accounts",
37247 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37248 "version": "0.0.0",
37249 "filename": "server/api/intZohoAccount/index.js",
37250 "groupTitle": "Zoho_Accounts"
37254 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37255 "title": "Creates new configuration",
37258 "title": "Example usage:",
37259 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
37263 "name": "addConfiguration",
37264 "group": "Zoho_Accounts",
37265 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37266 "version": "0.0.0",
37267 "filename": "server/api/intZohoAccount/index.js",
37268 "groupTitle": "Zoho_Accounts"
37272 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37273 "title": "Gets account configurations",
37276 "title": "Example usage:",
37277 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37281 "name": "getConfigurations",
37282 "group": "Zoho_Accounts",
37283 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37284 "version": "0.0.0",
37285 "filename": "server/api/intZohoAccount/index.js",
37286 "groupTitle": "Zoho_Accounts"
37290 "url": "/api/integrations/zoho/accounts/{id}/fields",
37291 "title": "Gets account fields",
37294 "title": "Example usage:",
37295 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37299 "name": "getFields",
37300 "group": "Zoho_Accounts",
37301 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37302 "version": "0.0.0",
37303 "filename": "server/api/intZohoAccount/index.js",
37304 "groupTitle": "Zoho_Accounts"
37308 "url": "/api/integrations/zoho/accounts/{id}",
37309 "title": "Update an existing Zoho Account",
37312 "title": "Example usage:",
37313 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37317 "name": "updateZoho_Accounts",
37318 "group": "Zoho_Accounts",
37319 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37320 "version": "0.0.0",
37321 "filename": "server/api/intZohoAccount/index.js",
37322 "groupTitle": "Zoho_Accounts"
37326 "url": "/api/integrations/zoho/configurations",
37327 "title": "Creates a new Zoho Configuration",
37330 "title": "Example usage:",
37331 "content": "curl https://{domain}/api/integrations/zoho/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37335 "name": "CreateZoho_Configurations",
37336 "group": "Zoho_Configurations",
37356 "field": "moduleCreate",
37363 "\"contact_lead\"",
37368 "field": "moduleSearch",
37375 "field": "description",
37381 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37382 "version": "0.0.0",
37383 "filename": "server/api/intZohoConfiguration/index.js",
37384 "groupTitle": "Zoho_Configurations"
37388 "url": "/api/integrations/zoho/configurations/{id}",
37389 "title": "Deletes a Zoho Configuration",
37392 "title": "Example usage:",
37393 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37397 "name": "DeleteZoho_Configurations",
37398 "group": "Zoho_Configurations",
37399 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37400 "version": "0.0.0",
37401 "filename": "server/api/intZohoConfiguration/index.js",
37402 "groupTitle": "Zoho_Configurations"
37406 "url": "/api/integrations/zoho/configurations",
37407 "title": "Gets a list of Zoho Configurations",
37410 "title": "Example usage:",
37411 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37415 "name": "GetZoho_Configurations",
37416 "group": "Zoho_Configurations",
37417 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zoho/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zoho/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zoho/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zoho/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zoho/configurations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37418 "version": "0.0.0",
37419 "filename": "server/api/intZohoConfiguration/index.js",
37420 "groupTitle": "Zoho_Configurations"
37424 "url": "/api/integrations/zoho/configurations/{id}",
37425 "title": "Gets a single Zoho Configuration",
37428 "title": "Example usage:",
37429 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37433 "name": "ShowZoho_Configurations",
37434 "group": "Zoho_Configurations",
37435 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37436 "version": "0.0.0",
37437 "filename": "server/api/intZohoConfiguration/index.js",
37438 "groupTitle": "Zoho_Configurations"
37442 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37443 "title": "Gets configurations descriptions",
37446 "title": "Example usage:",
37447 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37451 "name": "getDescriptions",
37452 "group": "Zoho_Configurations",
37453 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37454 "version": "0.0.0",
37455 "filename": "server/api/intZohoConfiguration/index.js",
37456 "groupTitle": "Zoho_Configurations"
37460 "url": "/api/integrations/zoho/configurations/{id}/fields",
37461 "title": "Gets configurations fields",
37464 "title": "Example usage:",
37465 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37469 "name": "getFields",
37470 "group": "Zoho_Configurations",
37471 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37472 "version": "0.0.0",
37473 "filename": "server/api/intZohoConfiguration/index.js",
37474 "groupTitle": "Zoho_Configurations"
37478 "url": "/api/integrations/zoho/configurations/{id}/subjects",
37479 "title": "Gets configurations subjects",
37482 "title": "Example usage:",
37483 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37487 "name": "getSubjects",
37488 "group": "Zoho_Configurations",
37489 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37490 "version": "0.0.0",
37491 "filename": "server/api/intZohoConfiguration/index.js",
37492 "groupTitle": "Zoho_Configurations"
37496 "url": "/api/integrations/zoho/configurations/{id}",
37497 "title": "Update an existing Zoho Configuration",
37500 "title": "Example usage:",
37501 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37505 "name": "updateZoho_Configurations",
37506 "group": "Zoho_Configurations",
37507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37508 "version": "0.0.0",
37509 "filename": "server/api/intZohoConfiguration/index.js",
37510 "groupTitle": "Zoho_Configurations"
37514 "url": "/api/integrations/zoho/fields",
37515 "title": "Creates a new Zoho Field",
37518 "title": "Example usage:",
37519 "content": "curl https://{domain}/api/integrations/zoho/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37523 "name": "CreateZoho_Fields",
37524 "group": "Zoho_Fields",
37534 "\"customVariable\"",
37546 "field": "content",
37562 "\"customVariable\""
37565 "field": "keyType",
37572 "field": "keyContent",
37579 "field": "idField",
37586 "field": "nameField",
37593 "field": "customField",
37600 "field": "variableName",
37606 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37607 "version": "0.0.0",
37608 "filename": "server/api/intZohoField/index.js",
37609 "groupTitle": "Zoho_Fields"
37613 "url": "/api/integrations/zoho/fields/{id}",
37614 "title": "Deletes a Zoho Field",
37617 "title": "Example usage:",
37618 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37622 "name": "DeleteZoho_Fields",
37623 "group": "Zoho_Fields",
37624 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37625 "version": "0.0.0",
37626 "filename": "server/api/intZohoField/index.js",
37627 "groupTitle": "Zoho_Fields"
37631 "url": "/api/integrations/zoho/fields",
37632 "title": "Gets a list of Zoho Fields",
37635 "title": "Example usage:",
37636 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37640 "name": "GetZoho_Fields",
37641 "group": "Zoho_Fields",
37642 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/zoho/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/zoho/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/zoho/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/zoho/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/zoho/fields?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37643 "version": "0.0.0",
37644 "filename": "server/api/intZohoField/index.js",
37645 "groupTitle": "Zoho_Fields"
37649 "url": "/api/integrations/zoho/fields/{id}",
37650 "title": "Gets a single Zoho Field",
37653 "title": "Example usage:",
37654 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37658 "name": "ShowZoho_Fields",
37659 "group": "Zoho_Fields",
37660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37661 "version": "0.0.0",
37662 "filename": "server/api/intZohoField/index.js",
37663 "groupTitle": "Zoho_Fields"
37667 "url": "/api/integrations/zoho/fields/{id}",
37668 "title": "Update an existing Zoho Field",
37671 "title": "Example usage:",
37672 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37676 "name": "updateZoho_Fields",
37677 "group": "Zoho_Fields",
37678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37679 "version": "0.0.0",
37680 "filename": "server/api/intZohoField/index.js",
37681 "groupTitle": "Zoho_Fields"
37686 "title": "Creates a new Cdr",
37689 "title": "Example usage:",
37690 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37694 "name": "CreateCdrs",
37703 "field": "calldate",
37731 "field": "dcontext",
37738 "field": "channel",
37745 "field": "dstchannel",
37752 "field": "lastapp",
37759 "field": "lastdata",
37766 "field": "duration",
37773 "field": "billsec",
37780 "field": "disposition",
37787 "field": "amaflags",
37794 "field": "accountcode",
37801 "field": "userfield",
37808 "field": "uniqueid",
37815 "field": "linkedid",
37822 "field": "sequence",
37829 "field": "peeraccount",
37849 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37850 "version": "0.0.0",
37851 "filename": "server/api/cdr/index.js",
37852 "groupTitle": "cdr"
37856 "url": "/api/cdr/{id}",
37857 "title": "Deletes a Cdr",
37860 "title": "Example usage:",
37861 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37865 "name": "DeleteCdrs",
37867 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37868 "version": "0.0.0",
37869 "filename": "server/api/cdr/index.js",
37870 "groupTitle": "cdr"
37874 "url": "/api/cdr/describe",
37875 "title": "Gets table info about Cdrs",
37878 "title": "Example usage:",
37879 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37883 "name": "DescribeCdrs",
37885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37886 "version": "0.0.0",
37887 "filename": "server/api/cdr/index.js",
37888 "groupTitle": "cdr"
37893 "title": "Gets a list of Cdrs",
37896 "title": "Example usage:",
37897 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37903 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cdr?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cdr?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cdr?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cdr?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cdr?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37904 "version": "0.0.0",
37905 "filename": "server/api/cdr/index.js",
37906 "groupTitle": "cdr"
37910 "url": "/api/cdr/{id}",
37911 "title": "Gets a single Cdr",
37914 "title": "Example usage:",
37915 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37919 "name": "ShowCdrs",
37921 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37922 "version": "0.0.0",
37923 "filename": "server/api/cdr/index.js",
37924 "groupTitle": "cdr"
37928 "url": "/api/cdr/{id}",
37929 "title": "Update an existing Cdr",
37932 "title": "Example usage:",
37933 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37937 "name": "updateCdrs",
37939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37940 "version": "0.0.0",
37941 "filename": "server/api/cdr/index.js",
37942 "groupTitle": "cdr"
37946 "url": "/api/voiceQueuesLog",
37947 "title": "Creates a new VoiceQueuesLog",
37950 "title": "Example usage:",
37951 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37955 "name": "CreateVoiceQueuesLogs",
37956 "group": "voiceQueuesLog",
37978 "field": "queuename",
38047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38048 "version": "0.0.0",
38049 "filename": "server/api/voiceQueuesLog/index.js",
38050 "groupTitle": "voiceQueuesLog"
38054 "url": "/api/voiceQueuesLog/{id}",
38055 "title": "Deletes a VoiceQueuesLog",
38058 "title": "Example usage:",
38059 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38063 "name": "DeleteVoiceQueuesLogs",
38064 "group": "voiceQueuesLog",
38065 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38066 "version": "0.0.0",
38067 "filename": "server/api/voiceQueuesLog/index.js",
38068 "groupTitle": "voiceQueuesLog"
38072 "url": "/api/voiceQueuesLog",
38073 "title": "Gets a list of VoiceQueuesLogs",
38076 "title": "Example usage:",
38077 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38081 "name": "GetVoiceQueuesLogs",
38082 "group": "voiceQueuesLog",
38083 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voiceQueuesLog?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/voiceQueuesLog?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/voiceQueuesLog?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/voiceQueuesLog?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/voiceQueuesLog?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
38084 "version": "0.0.0",
38085 "filename": "server/api/voiceQueuesLog/index.js",
38086 "groupTitle": "voiceQueuesLog"
38090 "url": "/api/voiceQueuesLog/{id}",
38091 "title": "Gets a single VoiceQueuesLog",
38094 "title": "Example usage:",
38095 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38099 "name": "ShowVoiceQueuesLogs",
38100 "group": "voiceQueuesLog",
38101 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38102 "version": "0.0.0",
38103 "filename": "server/api/voiceQueuesLog/index.js",
38104 "groupTitle": "voiceQueuesLog"
38108 "url": "/api/voiceQueuesLog/{id}",
38109 "title": "Update an existing VoiceQueuesLog",
38112 "title": "Example usage:",
38113 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38117 "name": "updateVoiceQueuesLogs",
38118 "group": "voiceQueuesLog",
38119 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38120 "version": "0.0.0",
38121 "filename": "server/api/voiceQueuesLog/index.js",
38122 "groupTitle": "voiceQueuesLog"