4 "url": "/api/cm/hopper/timezone",
5 "title": "Gets a single TZ data",
8 "title": "Example usage:",
9 "content": "curl https://{domain}/api/cm/hopper/timezone -d '{\"timezone\": [1]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
13 "name": "getTimezone",
15 "filename": "server/api/cmHopper/index.js",
16 "group": "/Users/andreabianco/Documents/Developments/motion-v2/server/api/cmHopper/index.js",
17 "groupTitle": "/Users/andreabianco/Documents/Developments/motion-v2/server/api/cmHopper/index.js"
21 "url": "/api/actions/{id}",
22 "title": "Deletes a Action",
25 "title": "Example usage:",
26 "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
30 "name": "DeleteActions",
32 "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>",
34 "filename": "server/api/action/index.js",
35 "groupTitle": "Actions"
39 "url": "/api/actions/{id}",
40 "title": "Update an existing Action",
43 "title": "Example usage:",
44 "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
48 "name": "updateActions",
50 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
52 "filename": "server/api/action/index.js",
53 "groupTitle": "Actions"
57 "url": "/api/analytics/custom_reports",
58 "title": "Creates a new Analytic Custom Report",
61 "title": "Example usage:",
62 "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",
66 "name": "CreateAnalytic_Custom_Reports",
67 "group": "Analytic_Custom_Reports",
82 "field": "description",
103 "field": "conditions",
116 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
118 "filename": "server/api/analyticCustomReport/index.js",
119 "groupTitle": "Analytic_Custom_Reports"
123 "url": "/api/analytics/custom_reports/{id}",
124 "title": "Deletes a Analytic Custom Report",
127 "title": "Example usage:",
128 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
132 "name": "DeleteAnalytic_Custom_Reports",
133 "group": "Analytic_Custom_Reports",
134 "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>",
136 "filename": "server/api/analyticCustomReport/index.js",
137 "groupTitle": "Analytic_Custom_Reports"
141 "url": "/api/analytics/custom_reports",
142 "title": "Gets a list of Analytic Custom Reports",
145 "title": "Example usage:",
146 "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
150 "name": "GetAnalytic_Custom_Reports",
151 "group": "Analytic_Custom_Reports",
152 "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>",
154 "filename": "server/api/analyticCustomReport/index.js",
155 "groupTitle": "Analytic_Custom_Reports"
159 "url": "/api/analytics/custom_reports/{id}",
160 "title": "Gets a single Analytic Custom Report",
163 "title": "Example usage:",
164 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
168 "name": "ShowAnalytic_Custom_Reports",
169 "group": "Analytic_Custom_Reports",
170 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
172 "filename": "server/api/analyticCustomReport/index.js",
173 "groupTitle": "Analytic_Custom_Reports"
177 "url": "/api/analytics/custom_reports/{id}/preview",
178 "title": "Report Preview",
181 "title": "Example usage:",
182 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
187 "group": "Analytic_Custom_Reports",
188 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
190 "filename": "server/api/analyticCustomReport/index.js",
191 "groupTitle": "Analytic_Custom_Reports"
195 "url": "/api/analytics/custom_reports/{id}/query",
196 "title": "Report Query SQL",
199 "title": "Example usage:",
200 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
205 "group": "Analytic_Custom_Reports",
206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
208 "filename": "server/api/analyticCustomReport/index.js",
209 "groupTitle": "Analytic_Custom_Reports"
213 "url": "/api/analytics/custom_reports/{id}/run",
214 "title": "Report Run",
217 "title": "Example usage:",
218 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
223 "group": "Analytic_Custom_Reports",
224 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
226 "filename": "server/api/analyticCustomReport/index.js",
227 "groupTitle": "Analytic_Custom_Reports"
231 "url": "/api/analytics/custom_reports/{id}",
232 "title": "Update an existing Analytic Custom Report",
235 "title": "Example usage:",
236 "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",
240 "name": "updateAnalytic_Custom_Reports",
241 "group": "Analytic_Custom_Reports",
242 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
244 "filename": "server/api/analyticCustomReport/index.js",
245 "groupTitle": "Analytic_Custom_Reports"
249 "url": "/api/analytics/default_reports",
250 "title": "Creates a new Analytic Default Report",
253 "title": "Example usage:",
254 "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",
258 "name": "CreateAnalytic_Default_Reports",
259 "group": "Analytic_Default_Reports",
274 "field": "description",
295 "field": "conditions",
308 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
310 "filename": "server/api/analyticDefaultReport/index.js",
311 "groupTitle": "Analytic_Default_Reports"
315 "url": "/api/analytics/default_reports/{id}",
316 "title": "Deletes a Analytic Default Report",
319 "title": "Example usage:",
320 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
324 "name": "DeleteAnalytic_Default_Reports",
325 "group": "Analytic_Default_Reports",
326 "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>",
328 "filename": "server/api/analyticDefaultReport/index.js",
329 "groupTitle": "Analytic_Default_Reports"
333 "url": "/api/analytics/default_reports",
334 "title": "Gets a list of Analytic Default Reports",
337 "title": "Example usage:",
338 "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
342 "name": "GetAnalytic_Default_Reports",
343 "group": "Analytic_Default_Reports",
344 "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>",
346 "filename": "server/api/analyticDefaultReport/index.js",
347 "groupTitle": "Analytic_Default_Reports"
351 "url": "/api/analytics/default_reports/{id}",
352 "title": "Gets a single Analytic Default Report",
355 "title": "Example usage:",
356 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
360 "name": "ShowAnalytic_Default_Reports",
361 "group": "Analytic_Default_Reports",
362 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
364 "filename": "server/api/analyticDefaultReport/index.js",
365 "groupTitle": "Analytic_Default_Reports"
369 "url": "/api/analytics/default_reports/{id}/preview",
370 "title": "Report Preview",
373 "title": "Example usage:",
374 "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
379 "group": "Analytic_Default_Reports",
380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
382 "filename": "server/api/analyticDefaultReport/index.js",
383 "groupTitle": "Analytic_Default_Reports"
387 "url": "/api/analytics/default_reports/{id}/query",
388 "title": "Report Query SQL",
391 "title": "Example usage:",
392 "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
397 "group": "Analytic_Default_Reports",
398 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
400 "filename": "server/api/analyticDefaultReport/index.js",
401 "groupTitle": "Analytic_Default_Reports"
405 "url": "/api/analytics/default_reports/{id}/run",
406 "title": "Report Run",
409 "title": "Example usage:",
410 "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
415 "group": "Analytic_Default_Reports",
416 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
418 "filename": "server/api/analyticDefaultReport/index.js",
419 "groupTitle": "Analytic_Default_Reports"
423 "url": "/api/analytics/default_reports/{id}",
424 "title": "Update an existing Analytic Default Report",
427 "title": "Example usage:",
428 "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",
432 "name": "updateAnalytic_Default_Reports",
433 "group": "Analytic_Default_Reports",
434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
436 "filename": "server/api/analyticDefaultReport/index.js",
437 "groupTitle": "Analytic_Default_Reports"
441 "url": "/api/analytics/extracted_reports",
442 "title": "Creates a new Analytic Extracted Report",
445 "title": "Example usage:",
446 "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",
450 "name": "CreateAnalytic_Extacted_Reports",
451 "group": "Analytic_Extracted_Reports",
492 "field": "startDate",
531 "field": "reportType",
537 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
539 "filename": "server/api/analyticExtractedReport/index.js",
540 "groupTitle": "Analytic_Extracted_Reports"
544 "url": "/api/analytics/extracted_reports/{id}",
545 "title": "Deletes a Analytic Extracted Report",
548 "title": "Example usage:",
549 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
553 "name": "DeleteAnalytic_Extacted_Reports",
554 "group": "Analytic_Extracted_Reports",
555 "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>",
557 "filename": "server/api/analyticExtractedReport/index.js",
558 "groupTitle": "Analytic_Extracted_Reports"
562 "url": "/api/analytics/extracted_reports",
563 "title": "Gets a list of Analytic Extacted Reports",
566 "title": "Example usage:",
567 "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
571 "name": "GetAnalytic_Extacted_Reports",
572 "group": "Analytic_Extracted_Reports",
573 "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>",
575 "filename": "server/api/analyticExtractedReport/index.js",
576 "groupTitle": "Analytic_Extracted_Reports"
580 "url": "/api/analytics/extracted_reports/{id}",
581 "title": "Gets a single Analytic Extracted Report",
584 "title": "Example usage:",
585 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
589 "name": "ShowAnalytic_Extacted_Reports",
590 "group": "Analytic_Extracted_Reports",
591 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
593 "filename": "server/api/analyticExtractedReport/index.js",
594 "groupTitle": "Analytic_Extracted_Reports"
598 "url": "/api/analytics/extracted_reports/{id}/download",
599 "title": "Download Extracted Report",
602 "title": "Example usage:",
603 "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
608 "group": "Analytic_Extracted_Reports",
609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
611 "filename": "server/api/analyticExtractedReport/index.js",
612 "groupTitle": "Analytic_Extracted_Reports"
616 "url": "/api/analytics/extracted_reports/{id}",
617 "title": "Update an existing Analytic Extracted Report",
620 "title": "Example usage:",
621 "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",
625 "name": "updateAnalytic_Extacted_Reports",
626 "group": "Analytic_Extracted_Reports",
627 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
629 "filename": "server/api/analyticExtractedReport/index.js",
630 "groupTitle": "Analytic_Extracted_Reports"
634 "url": "/api/analytics/field_reports/create_many",
635 "title": "Creates many Analytic Field Reports",
638 "title": "Example usage:",
639 "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",
643 "name": "BulkCreateAnalytic_Field_Reports",
644 "group": "Analytic_Field_Reports",
700 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
702 "filename": "server/api/analyticFieldReport/index.js",
703 "groupTitle": "Analytic_Field_Reports"
707 "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
708 "title": "Deletes many Analytic Field Reports",
711 "title": "Example usage:",
712 "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
716 "name": "BulkDeleteAnalytic_Field_Reports",
717 "group": "Analytic_Field_Reports",
718 "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>",
720 "filename": "server/api/analyticFieldReport/index.js",
721 "groupTitle": "Analytic_Field_Reports"
725 "url": "/api/analytics/field_reports",
726 "title": "Creates a new Analytic Field Report",
729 "title": "Example usage:",
730 "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",
734 "name": "CreateAnalytic_Field_Reports",
735 "group": "Analytic_Field_Reports",
791 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
793 "filename": "server/api/analyticFieldReport/index.js",
794 "groupTitle": "Analytic_Field_Reports"
798 "url": "/api/analytics/field_reports/{id}",
799 "title": "Deletes a Analytic Field Report",
802 "title": "Example usage:",
803 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
807 "name": "DeleteAnalytic_Field_Reports",
808 "group": "Analytic_Field_Reports",
809 "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>",
811 "filename": "server/api/analyticFieldReport/index.js",
812 "groupTitle": "Analytic_Field_Reports"
816 "url": "/api/analytics/field_reports",
817 "title": "Gets a list of Analytic Field Reports",
820 "title": "Example usage:",
821 "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
825 "name": "GetAnalytic_Field_Reports",
826 "group": "Analytic_Field_Reports",
827 "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>",
829 "filename": "server/api/analyticFieldReport/index.js",
830 "groupTitle": "Analytic_Field_Reports"
834 "url": "/api/analytics/field_reports/{id}",
835 "title": "Gets a single Analytic Field Report",
838 "title": "Example usage:",
839 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
843 "name": "ShowAnalytic_Field_Reports",
844 "group": "Analytic_Field_Reports",
845 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
847 "filename": "server/api/analyticFieldReport/index.js",
848 "groupTitle": "Analytic_Field_Reports"
852 "url": "/api/analytics/field_reports/{id}/create_many",
853 "title": "Rewrite fields set",
856 "title": "Example usage:",
857 "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
862 "group": "Analytic_Field_Reports",
863 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
865 "filename": "server/api/analyticFieldReport/index.js",
866 "groupTitle": "Analytic_Field_Reports"
870 "url": "/api/analytics/field_reports/{id}",
871 "title": "Update an existing Analytic Field Report",
874 "title": "Example usage:",
875 "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",
879 "name": "updateAnalytic_Field_Reports",
880 "group": "Analytic_Field_Reports",
881 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
883 "filename": "server/api/analyticFieldReport/index.js",
884 "groupTitle": "Analytic_Field_Reports"
888 "url": "/api/analytics/metrics",
889 "title": "Creates a new Analytic Metrics",
892 "title": "Example usage:",
893 "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
897 "name": "CreateAnalytic_Metric",
898 "group": "Analytic_Metrics",
927 "field": "description",
933 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
935 "filename": "server/api/analyticMetric/index.js",
936 "groupTitle": "Analytic_Metrics"
940 "url": "/api/analytics/metrics/{id}",
941 "title": "Deletes a Analytic Metrics",
944 "title": "Example usage:",
945 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
949 "name": "DeleteAnalytic_Metric",
950 "group": "Analytic_Metrics",
951 "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>",
953 "filename": "server/api/analyticMetric/index.js",
954 "groupTitle": "Analytic_Metrics"
958 "url": "/api/analytics/metrics",
959 "title": "Gets a list of Analytic Metric",
962 "title": "Example usage:",
963 "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
967 "name": "GetAnalytic_Metric",
968 "group": "Analytic_Metrics",
969 "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>",
971 "filename": "server/api/analyticMetric/index.js",
972 "groupTitle": "Analytic_Metrics"
976 "url": "/api/analytics/metrics/{id}",
977 "title": "Gets a single Analytic Metrics",
980 "title": "Example usage:",
981 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
985 "name": "ShowAnalytic_Metric",
986 "group": "Analytic_Metrics",
987 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
989 "filename": "server/api/analyticMetric/index.js",
990 "groupTitle": "Analytic_Metrics"
994 "url": "/api/analytics/metrics/{id}",
995 "title": "Update an existing Analytic Metrics",
998 "title": "Example usage:",
999 "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",
1003 "name": "updateAnalytic_Metric",
1004 "group": "Analytic_Metrics",
1005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1007 "filename": "server/api/analyticMetric/index.js",
1008 "groupTitle": "Analytic_Metrics"
1012 "url": "/api/analytics/tree_reports",
1013 "title": "Creates a new Analytic Tree Report",
1016 "title": "Example usage:",
1017 "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",
1021 "name": "CreateAnalytic_Tree_Reports",
1022 "group": "Analytic_Tree_Reports",
1036 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1038 "filename": "server/api/analyticTreeReport/index.js",
1039 "groupTitle": "Analytic_Tree_Reports"
1043 "url": "/api/analytics/tree_reports/{id}",
1044 "title": "Deletes a Analytic Tree Report",
1047 "title": "Example usage:",
1048 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1052 "name": "DeleteAnalytic_Tree_Reports",
1053 "group": "Analytic_Tree_Reports",
1054 "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>",
1056 "filename": "server/api/analyticTreeReport/index.js",
1057 "groupTitle": "Analytic_Tree_Reports"
1061 "url": "/api/analytics/tree_reports",
1062 "title": "Gets a list of Analytic Tree Reports",
1065 "title": "Example usage:",
1066 "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1070 "name": "GetAnalytic_Tree_Reports",
1071 "group": "Analytic_Tree_Reports",
1072 "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>",
1074 "filename": "server/api/analyticTreeReport/index.js",
1075 "groupTitle": "Analytic_Tree_Reports"
1079 "url": "/api/analytics/tree_reports/{id}",
1080 "title": "Gets a single Analytic Tree Report",
1083 "title": "Example usage:",
1084 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1088 "name": "ShowAnalytic_Tree_Reports",
1089 "group": "Analytic_Tree_Reports",
1090 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1092 "filename": "server/api/analyticTreeReport/index.js",
1093 "groupTitle": "Analytic_Tree_Reports"
1097 "url": "/api/analytics/tree_reports/{id}",
1098 "title": "Update an existing Analytic Tree Report",
1101 "title": "Example usage:",
1102 "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",
1106 "name": "updateAnalytic_Tree_Reports",
1107 "group": "Analytic_Tree_Reports",
1108 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1110 "filename": "server/api/analyticTreeReport/index.js",
1111 "groupTitle": "Analytic_Tree_Reports"
1115 "url": "/api/attachments/clone",
1116 "title": "Clone an existing Attachment",
1119 "title": "Example usage:",
1120 "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1124 "name": "CloneAttachments",
1125 "group": "Attachments",
1126 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1128 "filename": "server/api/attachment/index.js",
1129 "groupTitle": "Attachments"
1133 "url": "/api/attachments/{id}",
1134 "title": "Deletes a Attachment",
1137 "title": "Example usage:",
1138 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1142 "name": "DeleteAttachments",
1143 "group": "Attachments",
1144 "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>",
1146 "filename": "server/api/attachment/index.js",
1147 "groupTitle": "Attachments"
1151 "url": "/api/attachments",
1152 "title": "Gets a list of Attachments",
1155 "title": "Example usage:",
1156 "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1160 "name": "GetAttachments",
1161 "group": "Attachments",
1162 "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>",
1164 "filename": "server/api/attachment/index.js",
1165 "groupTitle": "Attachments"
1169 "url": "/api/attachments/{id}",
1170 "title": "Gets a single Attachment",
1173 "title": "Example usage:",
1174 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1178 "name": "ShowAttachments",
1179 "group": "Attachments",
1180 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1182 "filename": "server/api/attachment/index.js",
1183 "groupTitle": "Attachments"
1187 "url": "/api/attachments",
1188 "title": "Add attachment",
1191 "title": "Example usage:",
1192 "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1197 "group": "Attachments",
1198 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1200 "filename": "server/api/attachment/index.js",
1201 "groupTitle": "Attachments"
1205 "url": "/api/attachments/:id/download",
1206 "title": "Download attachment",
1209 "title": "Example usage:",
1210 "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1215 "group": "Attachments",
1216 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1218 "filename": "server/api/attachment/index.js",
1219 "groupTitle": "Attachments"
1223 "url": "/api/chat/interactions/{id}/attachment_download",
1224 "title": "Download attachment",
1227 "title": "Example usage:",
1228 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1233 "group": "Attachments",
1234 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1236 "filename": "server/api/chatInteraction/index.js",
1237 "groupTitle": "Attachments"
1241 "url": "/api/attachments/{id}",
1242 "title": "Update an existing Attachment",
1245 "title": "Example usage:",
1246 "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1250 "name": "updateAttachments",
1251 "group": "Attachments",
1252 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1254 "filename": "server/api/attachment/index.js",
1255 "groupTitle": "Attachments"
1259 "url": "/api/auth/local/forgot",
1260 "title": "Creates a new password reset token",
1263 "title": "Example usage:",
1264 "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1268 "name": "Local_Forgot_Password",
1269 "group": "Authentication",
1283 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1285 "filename": "server/api/authLocal/index.js",
1286 "groupTitle": "Authentication"
1290 "url": "/api/auth/local/reset/:token",
1291 "title": "Reset user password",
1294 "title": "Example usage:",
1295 "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1299 "name": "Local_Reset_Password",
1300 "group": "Authentication",
1308 "field": "password",
1314 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1316 "filename": "server/api/authLocal/index.js",
1317 "groupTitle": "Authentication"
1321 "url": "/api/auth/local",
1322 "title": "Creates a new User token",
1325 "title": "Example usage:",
1326 "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1330 "name": "Local_login",
1331 "group": "Authentication",
1346 "field": "password",
1352 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1354 "filename": "server/api/authLocal/index.js",
1355 "groupTitle": "Authentication"
1359 "url": "/api/auth/google",
1360 "title": "Creates a new User token",
1363 "title": "Example usage:",
1364 "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1368 "name": "Local_login",
1369 "group": "Authentication",
1384 "field": "password",
1390 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1392 "filename": "server/api/authGoogle/index.js",
1393 "groupTitle": "Authentication"
1397 "url": "/api/auth/activedirectory",
1398 "title": "Creates a new User token",
1401 "title": "Example usage:",
1402 "content": "curl https://{domain}/api/auth/activedirectory -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1406 "name": "Local_login",
1407 "group": "Authentication",
1422 "field": "password",
1428 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1430 "filename": "server/api/authActiveDirectory/index.js",
1431 "groupTitle": "Authentication"
1435 "url": "/api/automations",
1436 "title": "Creates a new Automation",
1439 "title": "Example usage:",
1440 "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1444 "name": "CreateAutomations",
1445 "group": "Automations",
1467 "field": "description",
1487 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1489 "filename": "server/api/automation/index.js",
1490 "groupTitle": "Automations"
1494 "url": "/api/automations/{id}",
1495 "title": "Deletes a Automation",
1498 "title": "Example usage:",
1499 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1503 "name": "DeleteAutomations",
1504 "group": "Automations",
1505 "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>",
1507 "filename": "server/api/automation/index.js",
1508 "groupTitle": "Automations"
1512 "url": "/api/automations",
1513 "title": "Gets a list of Automations",
1516 "title": "Example usage:",
1517 "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1521 "name": "GetAutomations",
1522 "group": "Automations",
1523 "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>",
1525 "filename": "server/api/automation/index.js",
1526 "groupTitle": "Automations"
1530 "url": "/api/automations/{id}",
1531 "title": "Gets a single Automation",
1534 "title": "Example usage:",
1535 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1539 "name": "ShowAutomations",
1540 "group": "Automations",
1541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1543 "filename": "server/api/automation/index.js",
1544 "groupTitle": "Automations"
1548 "url": "/api/automations/{id}/actions",
1549 "title": "Creates new actions",
1552 "title": "Example usage:",
1553 "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",
1557 "name": "addActions",
1558 "group": "Automations",
1574 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1581 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1588 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1595 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1628 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1630 "filename": "server/api/automation/index.js",
1631 "groupTitle": "Automations"
1635 "url": "/api/automations/{id}/conditions",
1636 "title": "Creates new conditions",
1639 "title": "Example usage:",
1640 "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",
1644 "name": "addConditions",
1645 "group": "Automations",
1667 "field": "operator",
1680 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1682 "filename": "server/api/automation/index.js",
1683 "groupTitle": "Automations"
1687 "url": "/api/automations/{id}/actions",
1688 "title": "Gets Automation Actions",
1691 "title": "Example usage:",
1692 "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1696 "name": "getActions",
1697 "group": "Automations",
1698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1700 "filename": "server/api/automation/index.js",
1701 "groupTitle": "Automations"
1705 "url": "/api/automations/{id}/conditions",
1706 "title": "Gets Automation Conditions",
1709 "title": "Example usage:",
1710 "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1714 "name": "getConditions",
1715 "group": "Automations",
1716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1718 "filename": "server/api/automation/index.js",
1719 "groupTitle": "Automations"
1723 "url": "/api/automations/{id}",
1724 "title": "Update an existing Automation",
1727 "title": "Example usage:",
1728 "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1732 "name": "updateAutomations",
1733 "group": "Automations",
1734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1736 "filename": "server/api/automation/index.js",
1737 "groupTitle": "Automations"
1741 "url": "/api/canned_answers",
1742 "title": "Create a new canned answer",
1745 "title": "Example usage:",
1746 "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1751 "group": "Canned_Answers",
1752 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1754 "filename": "server/api/cannedAnswer/index.js",
1755 "groupTitle": "Canned_Answers"
1759 "url": "/api/canned_answers/{id}",
1760 "title": "Deletes a Canned Answer",
1763 "title": "Example usage:",
1764 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1768 "name": "DeleteCanned_Answers",
1769 "group": "Canned_Answers",
1770 "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>",
1772 "filename": "server/api/cannedAnswer/index.js",
1773 "groupTitle": "Canned_Answers"
1777 "url": "/api/canned_answers",
1778 "title": "Gets a list of Canned Answers",
1781 "title": "Example usage:",
1782 "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1786 "name": "GetCanned_Answers",
1787 "group": "Canned_Answers",
1788 "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>",
1790 "filename": "server/api/cannedAnswer/index.js",
1791 "groupTitle": "Canned_Answers"
1795 "url": "/api/canned_answers/{id}",
1796 "title": "Gets a single Canned Answer",
1799 "title": "Example usage:",
1800 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1804 "name": "ShowCanned_Answers",
1805 "group": "Canned_Answers",
1806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1808 "filename": "server/api/cannedAnswer/index.js",
1809 "groupTitle": "Canned_Answers"
1813 "url": "/api/canned_answers/{id}",
1814 "title": "Update an existing Canned Answer",
1817 "title": "Example usage:",
1818 "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",
1822 "name": "updateCanned_Answers",
1823 "group": "Canned_Answers",
1824 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1826 "filename": "server/api/cannedAnswer/index.js",
1827 "groupTitle": "Canned_Answers"
1831 "url": "/chat/internal/users",
1832 "title": "Gets Users Last Messages",
1835 "title": "Example usage:",
1836 "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
1840 "name": "getLastUsersMessages",
1841 "group": "ChatInternalMessage",
1842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1844 "filename": "server/api/chatInternalMessage/index.js",
1845 "groupTitle": "ChatInternalMessage"
1849 "url": "/api/chat/applications/{id}",
1850 "title": "Deletes a Application",
1853 "title": "Example usage:",
1854 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1858 "name": "DeleteApplications",
1859 "group": "Chat_Applications",
1860 "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>",
1862 "filename": "server/api/chatApplication/index.js",
1863 "groupTitle": "Chat_Applications"
1867 "url": "/api/chat/applications/{id}",
1868 "title": "Gets a single Application",
1871 "title": "Example usage:",
1872 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1876 "name": "ShowApplications",
1877 "group": "Chat_Applications",
1878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1880 "filename": "server/api/chatApplication/index.js",
1881 "groupTitle": "Chat_Applications"
1885 "url": "/api/chat/applications/{id}",
1886 "title": "Update an existing Application",
1889 "title": "Example usage:",
1890 "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",
1894 "name": "updateApplications",
1895 "group": "Chat_Applications",
1896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1898 "filename": "server/api/chatApplication/index.js",
1899 "groupTitle": "Chat_Applications"
1903 "url": "/api/chat/groups",
1904 "title": "Creates a new Group",
1907 "title": "Example usage:",
1908 "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1912 "name": "CreateGroups",
1913 "group": "Chat_Groups",
1928 "field": "description",
1941 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1943 "filename": "server/api/chatGroup/index.js",
1944 "groupTitle": "Chat_Groups"
1948 "url": "/api/chat/groups/{id}",
1949 "title": "Deletes a Group",
1952 "title": "Example usage:",
1953 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1957 "name": "DeleteGroups",
1958 "group": "Chat_Groups",
1959 "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>",
1961 "filename": "server/api/chatGroup/index.js",
1962 "groupTitle": "Chat_Groups"
1966 "url": "/api/chat/groups/describe",
1967 "title": "Gets table info about Groups",
1970 "title": "Example usage:",
1971 "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1975 "name": "DescribeGroups",
1976 "group": "Chat_Groups",
1977 "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>",
1979 "filename": "server/api/chatGroup/index.js",
1980 "groupTitle": "Chat_Groups"
1984 "url": "/api/chat/groups",
1985 "title": "Gets a list of Groups",
1988 "title": "Example usage:",
1989 "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1993 "name": "GetGroups",
1994 "group": "Chat_Groups",
1995 "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>",
1997 "filename": "server/api/chatGroup/index.js",
1998 "groupTitle": "Chat_Groups"
2002 "url": "/api/chat/groups/{id}/members",
2003 "title": "Removes members from a group",
2006 "title": "Example usage:",
2007 "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2011 "name": "RemoveMembers",
2012 "group": "Chat_Groups",
2013 "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>",
2015 "filename": "server/api/chatGroup/index.js",
2016 "groupTitle": "Chat_Groups"
2020 "url": "/api/chat/groups/{id}",
2021 "title": "Gets a single Group",
2024 "title": "Example usage:",
2025 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
2029 "name": "ShowGroups",
2030 "group": "Chat_Groups",
2031 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2033 "filename": "server/api/chatGroup/index.js",
2034 "groupTitle": "Chat_Groups"
2038 "url": "/api/chat/groups/{id}/members",
2039 "title": "Add members to chat group",
2042 "title": "Example usage:",
2043 "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",
2047 "name": "addMembers",
2048 "group": "Chat_Groups",
2049 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2051 "filename": "server/api/chatGroup/index.js",
2052 "groupTitle": "Chat_Groups"
2056 "url": "/api/chat/groups/{id}/messages",
2057 "title": "Creates a new group message",
2060 "title": "Example usage:",
2061 "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2065 "name": "addMessage",
2066 "group": "Chat_Groups",
2067 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2069 "filename": "server/api/chatGroup/index.js",
2070 "groupTitle": "Chat_Groups"
2074 "url": "/api/chat/groups/{id}/members",
2075 "title": "Gets Members",
2078 "title": "Example usage:",
2079 "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2083 "name": "getMembers",
2084 "group": "Chat_Groups",
2085 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2087 "filename": "server/api/chatGroup/index.js",
2088 "groupTitle": "Chat_Groups"
2092 "url": "/api/chat/groups/{id}/messages",
2093 "title": "Gets Messages",
2096 "title": "Example usage:",
2097 "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2101 "name": "getMessages",
2102 "group": "Chat_Groups",
2103 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2105 "filename": "server/api/chatGroup/index.js",
2106 "groupTitle": "Chat_Groups"
2110 "url": "/api/chat/groups/{id}/unread",
2111 "title": "Get unread chat group messages",
2114 "title": "Example usage:",
2115 "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2120 "group": "Chat_Groups",
2121 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2123 "filename": "server/api/chatGroup/index.js",
2124 "groupTitle": "Chat_Groups"
2128 "url": "/api/chat/groups/{id}",
2129 "title": "Update an existing Group",
2132 "title": "Example usage:",
2133 "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",
2137 "name": "updateGroups",
2138 "group": "Chat_Groups",
2139 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2141 "filename": "server/api/chatGroup/index.js",
2142 "groupTitle": "Chat_Groups"
2146 "url": "/api/chat/interactions/{id}/tags",
2147 "title": "Add tags to the interaction",
2150 "title": "Example usage:",
2151 "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",
2156 "group": "Chat_Interactions",
2157 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2159 "filename": "server/api/chatInteraction/index.js",
2160 "groupTitle": "Chat_Interactions"
2164 "url": "/api/chat/interactions",
2165 "title": "Creates a new Interaction",
2168 "title": "Example usage:",
2169 "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2173 "name": "CreateInteractions",
2174 "group": "Chat_Interactions",
2189 "field": "ratingValue",
2200 "field": "ratingType",
2207 "field": "ratingMessage",
2214 "field": "pathTranscript",
2221 "field": "mailTranscript",
2228 "field": "closedAt",
2235 "field": "disposition",
2242 "field": "secondDisposition",
2249 "field": "thirdDisposition",
2263 "field": "browserName",
2270 "field": "browserVersion",
2284 "field": "osVersion",
2291 "field": "deviceModel",
2298 "field": "deviceVendor",
2305 "field": "deviceType",
2319 "field": "customerIp",
2326 "field": "formData",
2333 "field": "read1stAt",
2340 "field": "lastMsgAt",
2351 "field": "lastMsgDirection",
2358 "field": "closeReason",
2365 "field": "customerPort",
2372 "field": "vidaooSessionId",
2379 "field": "autoreplyExecuted",
2385 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2387 "filename": "server/api/chatInteraction/index.js",
2388 "groupTitle": "Chat_Interactions"
2392 "url": "/api/chat/interactions/{id}",
2393 "title": "Deletes a Interaction",
2396 "title": "Example usage:",
2397 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2401 "name": "DeleteInteractions",
2402 "group": "Chat_Interactions",
2403 "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>",
2405 "filename": "server/api/chatInteraction/index.js",
2406 "groupTitle": "Chat_Interactions"
2410 "url": "/api/chat/interactions/describe",
2411 "title": "Gets table info about Interactions",
2414 "title": "Example usage:",
2415 "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2419 "name": "DescribeInteractions",
2420 "group": "Chat_Interactions",
2421 "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>",
2423 "filename": "server/api/chatInteraction/index.js",
2424 "groupTitle": "Chat_Interactions"
2428 "url": "/api/chat/interactions",
2429 "title": "Gets a list of Interactions",
2432 "title": "Example usage:",
2433 "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2437 "name": "GetInteractions",
2438 "group": "Chat_Interactions",
2439 "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>",
2441 "filename": "server/api/chatInteraction/index.js",
2442 "groupTitle": "Chat_Interactions"
2446 "url": "/api/chat/interactions/{id}/tags",
2447 "title": "Removes tags from interaction",
2450 "title": "Example usage:",
2451 "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2455 "name": "RemoveTags",
2456 "group": "Chat_Interactions",
2457 "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>",
2459 "filename": "server/api/chatInteraction/index.js",
2460 "groupTitle": "Chat_Interactions"
2464 "url": "/api/chat/interactions/{id}",
2465 "title": "Gets a single Interaction",
2468 "title": "Example usage:",
2469 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2473 "name": "ShowInteractions",
2474 "group": "Chat_Interactions",
2475 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2477 "filename": "server/api/chatInteraction/index.js",
2478 "groupTitle": "Chat_Interactions"
2482 "url": "/api/chat/interactions/{id}/abandon",
2483 "title": "Abandon interaction",
2486 "title": "Example usage:",
2487 "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2492 "group": "Chat_Interactions",
2493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2495 "filename": "server/api/chatInteraction/index.js",
2496 "groupTitle": "Chat_Interactions"
2500 "url": "/api/chat/interactions/{id}/messages",
2501 "title": "Creates new messages",
2504 "title": "Example usage:",
2505 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2509 "name": "addMessage",
2510 "group": "Chat_Interactions",
2543 "field": "direction",
2557 "field": "providerName",
2564 "field": "providerResponse",
2570 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2572 "filename": "server/api/chatInteraction/index.js",
2573 "groupTitle": "Chat_Interactions"
2577 "url": "/api/chat/interactions/{id}/close",
2578 "title": "Close Interaction",
2581 "title": "Example usage:",
2582 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2586 "name": "addMessage",
2587 "group": "Chat_Interactions",
2588 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2590 "filename": "server/api/chatInteraction/index.js",
2591 "groupTitle": "Chat_Interactions"
2595 "url": "/api/chat/interactions/{id}/attachment_upload",
2596 "title": "Add attachment",
2599 "title": "Example usage:",
2600 "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",
2604 "name": "attachmentUpload",
2605 "group": "Chat_Interactions",
2606 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2608 "filename": "server/api/chatInteraction/index.js",
2609 "groupTitle": "Chat_Interactions"
2613 "url": "/api/chat/interactions/{id}/vidaoo",
2614 "title": "Create Vidaoo Session",
2617 "title": "Example usage:",
2618 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2622 "name": "createVidaooSession",
2623 "group": "Chat_Interactions",
2624 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2626 "filename": "server/api/chatInteraction/index.js",
2627 "groupTitle": "Chat_Interactions"
2631 "url": "/api/chat/interactions/{id}/custom_update",
2632 "title": "Update interaction",
2635 "title": "Example usage:",
2636 "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",
2640 "name": "customUpdate",
2641 "group": "Chat_Interactions",
2642 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2644 "filename": "server/api/chatInteraction/index.js",
2645 "groupTitle": "Chat_Interactions"
2649 "url": "/api/chat/interactions/{id}/download",
2650 "title": "Gets interaction",
2653 "title": "Example usage:",
2654 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2659 "group": "Chat_Interactions",
2660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2662 "filename": "server/api/chatInteraction/index.js",
2663 "groupTitle": "Chat_Interactions"
2667 "url": "/api/chat/interactions/{id}/messages",
2668 "title": "Gets interaction messages",
2671 "title": "Example usage:",
2672 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2676 "name": "getMessages",
2677 "group": "Chat_Interactions",
2678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2680 "filename": "server/api/chatInteraction/index.js",
2681 "groupTitle": "Chat_Interactions"
2685 "url": "/api/chat/interactions/{id}/my_messages",
2686 "title": "Gets interaction messages",
2689 "title": "Example usage:",
2690 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2694 "name": "getMyMessages",
2695 "group": "Chat_Interactions",
2696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2698 "filename": "server/api/chatInteraction/index.js",
2699 "groupTitle": "Chat_Interactions"
2703 "url": "/api/chat/interactions/{id}",
2704 "title": "Update an existing Interaction",
2707 "title": "Example usage:",
2708 "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",
2712 "name": "updateInteractions",
2713 "group": "Chat_Interactions",
2714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2716 "filename": "server/api/chatInteraction/index.js",
2717 "groupTitle": "Chat_Interactions"
2721 "url": "/api/chat/internal/messages",
2722 "title": "Creates a new Message",
2725 "title": "Example usage:",
2726 "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",
2730 "name": "CreateMessages",
2731 "group": "Chat_Internal_Messages",
2753 "field": "ChatInternalMessageId",
2759 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2761 "filename": "server/api/chatInternalMessage/index.js",
2762 "groupTitle": "Chat_Internal_Messages"
2766 "url": "/api/chat/internal/messages/{id}",
2767 "title": "Deletes a Message",
2770 "title": "Example usage:",
2771 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2775 "name": "DeleteMessages",
2776 "group": "Chat_Internal_Messages",
2777 "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>",
2779 "filename": "server/api/chatInternalMessage/index.js",
2780 "groupTitle": "Chat_Internal_Messages"
2784 "url": "/api/chat/internal/messages/describe",
2785 "title": "Gets table info about Messages",
2788 "title": "Example usage:",
2789 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2793 "name": "DescribeMessages",
2794 "group": "Chat_Internal_Messages",
2795 "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>",
2797 "filename": "server/api/chatInternalMessage/index.js",
2798 "groupTitle": "Chat_Internal_Messages"
2802 "url": "/api/chat/internal/messages",
2803 "title": "Gets a list of Messages",
2806 "title": "Example usage:",
2807 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2811 "name": "GetMessages",
2812 "group": "Chat_Internal_Messages",
2813 "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>",
2815 "filename": "server/api/chatInternalMessage/index.js",
2816 "groupTitle": "Chat_Internal_Messages"
2820 "url": "/api/chat/internal/messages/{id}",
2821 "title": "Gets a single Message",
2824 "title": "Example usage:",
2825 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2829 "name": "ShowMessages",
2830 "group": "Chat_Internal_Messages",
2831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2833 "filename": "server/api/chatInternalMessage/index.js",
2834 "groupTitle": "Chat_Internal_Messages"
2838 "url": "/api/chat/internal/messages/{id}",
2839 "title": "Update an existing Message",
2842 "title": "Example usage:",
2843 "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",
2847 "name": "updateMessages",
2848 "group": "Chat_Internal_Messages",
2849 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2851 "filename": "server/api/chatInternalMessage/index.js",
2852 "groupTitle": "Chat_Internal_Messages"
2856 "url": "/api/chat/messages",
2857 "title": "Creates a new Message",
2860 "title": "Example usage:",
2861 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2865 "name": "CreateMessages",
2866 "group": "Chat_Messages",
2899 "field": "direction",
2913 "field": "providerName",
2920 "field": "providerResponse",
2926 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2928 "filename": "server/api/chatMessage/index.js",
2929 "groupTitle": "Chat_Messages"
2933 "url": "/api/chat/messages/{id}",
2934 "title": "Deletes a Message",
2937 "title": "Example usage:",
2938 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2942 "name": "DeleteMessages",
2943 "group": "Chat_Messages",
2944 "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>",
2946 "filename": "server/api/chatMessage/index.js",
2947 "groupTitle": "Chat_Messages"
2951 "url": "/api/chat/messages/describe",
2952 "title": "Gets table info about Messages",
2955 "title": "Example usage:",
2956 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2960 "name": "DescribeMessages",
2961 "group": "Chat_Messages",
2962 "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>",
2964 "filename": "server/api/chatMessage/index.js",
2965 "groupTitle": "Chat_Messages"
2969 "url": "/api/chat/messages",
2970 "title": "Gets a list of Messages",
2973 "title": "Example usage:",
2974 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2978 "name": "GetMessages",
2979 "group": "Chat_Messages",
2980 "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>",
2982 "filename": "server/api/chatMessage/index.js",
2983 "groupTitle": "Chat_Messages"
2987 "url": "/api/chat/messages/{id}",
2988 "title": "Gets a single Message",
2991 "title": "Example usage:",
2992 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2996 "name": "ShowMessages",
2997 "group": "Chat_Messages",
2998 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3000 "filename": "server/api/chatMessage/index.js",
3001 "groupTitle": "Chat_Messages"
3005 "url": "/api/chat/messages/{id}",
3006 "title": "Update an existing Message",
3009 "title": "Example usage:",
3010 "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",
3014 "name": "updateMessages",
3015 "group": "Chat_Messages",
3016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3018 "filename": "server/api/chatMessage/index.js",
3019 "groupTitle": "Chat_Messages"
3023 "url": "/api/chat/offline_messages",
3024 "title": "Creates a new OfflineMessage",
3027 "title": "Example usage:",
3028 "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",
3032 "name": "CreateOfflineMessages",
3033 "group": "Chat_Offline_Messages",
3047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3049 "filename": "server/api/chatOfflineMessage/index.js",
3050 "groupTitle": "Chat_Offline_Messages"
3054 "url": "/api/chat/offline_messages/{id}",
3055 "title": "Deletes a OfflineMessage",
3058 "title": "Example usage:",
3059 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3063 "name": "DeleteOfflineMessages",
3064 "group": "Chat_Offline_Messages",
3065 "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>",
3067 "filename": "server/api/chatOfflineMessage/index.js",
3068 "groupTitle": "Chat_Offline_Messages"
3072 "url": "/api/chat/offline_messages/describe",
3073 "title": "Gets table info about OfflineMessages",
3076 "title": "Example usage:",
3077 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3081 "name": "DescribeOfflineMessages",
3082 "group": "Chat_Offline_Messages",
3083 "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>",
3085 "filename": "server/api/chatOfflineMessage/index.js",
3086 "groupTitle": "Chat_Offline_Messages"
3090 "url": "/api/chat/offline_messages",
3091 "title": "Gets a list of OfflineMessages",
3094 "title": "Example usage:",
3095 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3099 "name": "GetOfflineMessages",
3100 "group": "Chat_Offline_Messages",
3101 "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>",
3103 "filename": "server/api/chatOfflineMessage/index.js",
3104 "groupTitle": "Chat_Offline_Messages"
3108 "url": "/api/chat/offline_messages/{id}",
3109 "title": "Gets a single OfflineMessage",
3112 "title": "Example usage:",
3113 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3117 "name": "ShowOfflineMessages",
3118 "group": "Chat_Offline_Messages",
3119 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3121 "filename": "server/api/chatOfflineMessage/index.js",
3122 "groupTitle": "Chat_Offline_Messages"
3126 "url": "/api/chat/offline_messages/{id}",
3127 "title": "Update an existing OfflineMessage",
3130 "title": "Example usage:",
3131 "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",
3135 "name": "updateOfflineMessages",
3136 "group": "Chat_Offline_Messages",
3137 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3139 "filename": "server/api/chatOfflineMessage/index.js",
3140 "groupTitle": "Chat_Offline_Messages"
3144 "url": "/api/chat/proactive_actions",
3145 "title": "Creates a new Proactive Action",
3148 "title": "Example usage:",
3149 "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",
3153 "name": "CreateProactive_Actions",
3154 "group": "Chat_Proactive_Actions",
3180 "field": "selector",
3193 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3195 "filename": "server/api/chatProactiveAction/index.js",
3196 "groupTitle": "Chat_Proactive_Actions"
3200 "url": "/api/chat/proactive_actions/{id}",
3201 "title": "Deletes a Proactive Action",
3204 "title": "Example usage:",
3205 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3209 "name": "DeleteProactive_Actions",
3210 "group": "Chat_Proactive_Actions",
3211 "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>",
3213 "filename": "server/api/chatProactiveAction/index.js",
3214 "groupTitle": "Chat_Proactive_Actions"
3218 "url": "/api/chat/proactive_actions/{id}",
3219 "title": "Gets a single Proactive Action",
3222 "title": "Example usage:",
3223 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3227 "name": "ShowProactive_Actions",
3228 "group": "Chat_Proactive_Actions",
3229 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3231 "filename": "server/api/chatProactiveAction/index.js",
3232 "groupTitle": "Chat_Proactive_Actions"
3236 "url": "/api/chat/proactive_actions/{id}",
3237 "title": "Update an existing Proactive Action",
3240 "title": "Example usage:",
3241 "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",
3245 "name": "updateProactive_Actions",
3246 "group": "Chat_Proactive_Actions",
3247 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3249 "filename": "server/api/chatProactiveAction/index.js",
3250 "groupTitle": "Chat_Proactive_Actions"
3254 "url": "/api/chat/reports/queue",
3255 "title": "Creates a new Chat Queue Report",
3258 "title": "Example usage:",
3259 "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",
3263 "name": "CreateChat_Queue_Reports",
3264 "group": "Chat_Queue_Reports",
3272 "field": "uniqueid",
3300 "field": "acceptAt",
3320 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3322 "filename": "server/api/chatQueueReport/index.js",
3323 "groupTitle": "Chat_Queue_Reports"
3327 "url": "/api/chat/reports/queue/{id}",
3328 "title": "Deletes a Chat Queue Report",
3331 "title": "Example usage:",
3332 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3336 "name": "DeleteChat_Queue_Reports",
3337 "group": "Chat_Queue_Reports",
3338 "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>",
3340 "filename": "server/api/chatQueueReport/index.js",
3341 "groupTitle": "Chat_Queue_Reports"
3345 "url": "/api/chat/reports/queue/describe",
3346 "title": "Gets table info about Chat Queue Reports",
3349 "title": "Example usage:",
3350 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3354 "name": "DescribeChat_Queue_Reports",
3355 "group": "Chat_Queue_Reports",
3356 "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>",
3358 "filename": "server/api/chatQueueReport/index.js",
3359 "groupTitle": "Chat_Queue_Reports"
3363 "url": "/api/chat/reports/queue",
3364 "title": "Gets a list of Chat Queue Reports",
3367 "title": "Example usage:",
3368 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3372 "name": "GetChat_Queue_Reports",
3373 "group": "Chat_Queue_Reports",
3374 "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>",
3376 "filename": "server/api/chatQueueReport/index.js",
3377 "groupTitle": "Chat_Queue_Reports"
3381 "url": "/api/chat/reports/queue/{id}",
3382 "title": "Gets a single Chat Queue Report",
3385 "title": "Example usage:",
3386 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3390 "name": "ShowChat_Queue_Reports",
3391 "group": "Chat_Queue_Reports",
3392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3394 "filename": "server/api/chatQueueReport/index.js",
3395 "groupTitle": "Chat_Queue_Reports"
3399 "url": "/api/chat/reports/queue/{id}",
3400 "title": "Update an existing Chat Queue Report",
3403 "title": "Example usage:",
3404 "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",
3408 "name": "updateChat_Queue_Reports",
3409 "group": "Chat_Queue_Reports",
3410 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3412 "filename": "server/api/chatQueueReport/index.js",
3413 "groupTitle": "Chat_Queue_Reports"
3417 "url": "/api/chat/queues/{id}/users",
3418 "title": "Add agents to a queue",
3421 "title": "Example usage:",
3422 "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",
3426 "name": "AddAgents",
3427 "group": "Chat_Queues",
3428 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3430 "filename": "server/api/chatQueue/index.js",
3431 "groupTitle": "Chat_Queues"
3435 "url": "/api/chat/queues/{id}/teams",
3436 "title": "Add teams to a queue",
3439 "title": "Example usage:",
3440 "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",
3445 "group": "Chat_Queues",
3446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3448 "filename": "server/api/chatQueue/index.js",
3449 "groupTitle": "Chat_Queues"
3453 "url": "/api/chat/queues",
3454 "title": "Creates a new Queue",
3457 "title": "Example usage:",
3458 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3462 "name": "CreateQueues",
3463 "group": "Chat_Queues",
3478 "field": "description",
3497 "field": "strategy",
3503 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3505 "filename": "server/api/chatQueue/index.js",
3506 "groupTitle": "Chat_Queues"
3510 "url": "/api/chat/queues/{id}",
3511 "title": "Deletes a Queue",
3514 "title": "Example usage:",
3515 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3519 "name": "DeleteQueues",
3520 "group": "Chat_Queues",
3521 "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>",
3523 "filename": "server/api/chatQueue/index.js",
3524 "groupTitle": "Chat_Queues"
3528 "url": "/api/chat/queues/describe",
3529 "title": "Gets table info about Queues",
3532 "title": "Example usage:",
3533 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3537 "name": "DescribeQueues",
3538 "group": "Chat_Queues",
3539 "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>",
3541 "filename": "server/api/chatQueue/index.js",
3542 "groupTitle": "Chat_Queues"
3546 "url": "/api/chat/queues/{id}/users",
3547 "title": "Gets queue agents",
3550 "title": "Example usage:",
3551 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3555 "name": "GetAgents",
3556 "group": "Chat_Queues",
3557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3559 "filename": "server/api/chatQueue/index.js",
3560 "groupTitle": "Chat_Queues"
3564 "url": "/api/chat/queues/{id}/members",
3565 "title": "GetMembers",
3568 "title": "Example usage:",
3569 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3573 "name": "GetMembers",
3574 "group": "Chat_Queues",
3575 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3577 "filename": "server/api/chatQueue/index.js",
3578 "groupTitle": "Chat_Queues"
3582 "url": "/api/chat/queues",
3583 "title": "Gets a list of Queues",
3586 "title": "Example usage:",
3587 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3591 "name": "GetQueues",
3592 "group": "Chat_Queues",
3593 "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>",
3595 "filename": "server/api/chatQueue/index.js",
3596 "groupTitle": "Chat_Queues"
3600 "url": "/api/chat/queues/{id}/teams",
3601 "title": "Gets queues list",
3604 "title": "Example usage:",
3605 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3610 "group": "Chat_Queues",
3611 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3613 "filename": "server/api/chatQueue/index.js",
3614 "groupTitle": "Chat_Queues"
3618 "url": "/api/chat/queues/{id}/users",
3619 "title": "Removes agents from a queue",
3622 "title": "Example usage:",
3623 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3627 "name": "RemoveAgents",
3628 "group": "Chat_Queues",
3629 "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>",
3631 "filename": "server/api/chatQueue/index.js",
3632 "groupTitle": "Chat_Queues"
3636 "url": "/api/chat/queues/{id}",
3637 "title": "Gets a single Queue",
3640 "title": "Example usage:",
3641 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3645 "name": "ShowQueues",
3646 "group": "Chat_Queues",
3647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3649 "filename": "server/api/chatQueue/index.js",
3650 "groupTitle": "Chat_Queues"
3654 "url": "/api/chat/queues/{id}",
3655 "title": "Update an existing Queue",
3658 "title": "Example usage:",
3659 "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",
3663 "name": "updateQueues",
3664 "group": "Chat_Queues",
3665 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3667 "filename": "server/api/chatQueue/index.js",
3668 "groupTitle": "Chat_Queues"
3672 "url": "/api/chat/reports/transfer",
3673 "title": "Creates a new Chat Transfer Report",
3676 "title": "Example usage:",
3677 "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",
3681 "name": "CreateChat_Transfer_Reports",
3682 "group": "Chat_Transfer_Reports",
3690 "field": "uniqueid",
3709 "field": "transferredAt",
3715 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3717 "filename": "server/api/chatTransferReport/index.js",
3718 "groupTitle": "Chat_Transfer_Reports"
3722 "url": "/api/chat/reports/transfer/{id}",
3723 "title": "Deletes a Chat Transfer Report",
3726 "title": "Example usage:",
3727 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3731 "name": "DeleteChat_Transfer_Reports",
3732 "group": "Chat_Transfer_Reports",
3733 "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>",
3735 "filename": "server/api/chatTransferReport/index.js",
3736 "groupTitle": "Chat_Transfer_Reports"
3740 "url": "/api/chat/reports/transfer/describe",
3741 "title": "Gets table info about Chat Transfer Reports",
3744 "title": "Example usage:",
3745 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3749 "name": "DescribeChat_Transfer_Reports",
3750 "group": "Chat_Transfer_Reports",
3751 "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>",
3753 "filename": "server/api/chatTransferReport/index.js",
3754 "groupTitle": "Chat_Transfer_Reports"
3758 "url": "/api/chat/reports/transfer",
3759 "title": "Gets a list of Chat Transfer Reports",
3762 "title": "Example usage:",
3763 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3767 "name": "GetChat_Transfer_Reports",
3768 "group": "Chat_Transfer_Reports",
3769 "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>",
3771 "filename": "server/api/chatTransferReport/index.js",
3772 "groupTitle": "Chat_Transfer_Reports"
3776 "url": "/api/chat/reports/transfer/{id}",
3777 "title": "Gets a single Chat Transfer Report",
3780 "title": "Example usage:",
3781 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3785 "name": "ShowChat_Transfer_Reports",
3786 "group": "Chat_Transfer_Reports",
3787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3789 "filename": "server/api/chatTransferReport/index.js",
3790 "groupTitle": "Chat_Transfer_Reports"
3794 "url": "/api/chat/reports/transfer/{id}",
3795 "title": "Update an existing Chat Transfer Report",
3798 "title": "Example usage:",
3799 "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",
3803 "name": "updateChat_Transfer_Reports",
3804 "group": "Chat_Transfer_Reports",
3805 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3807 "filename": "server/api/chatTransferReport/index.js",
3808 "groupTitle": "Chat_Transfer_Reports"
3812 "url": "/api/chat/websites/{id}/users",
3813 "title": "Add agents to a website",
3816 "title": "Example usage:",
3817 "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",
3821 "name": "AddAgents",
3822 "group": "Chat_Websites",
3823 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3825 "filename": "server/api/chatWebsite/index.js",
3826 "groupTitle": "Chat_Websites"
3830 "url": "/api/chat/websites",
3831 "title": "Creates a new Website",
3834 "title": "Example usage:",
3835 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3839 "name": "CreateWebsites",
3840 "group": "Chat_Websites",
3862 "field": "description",
3876 "field": "mapKeyOffline",
3890 "field": "agentAlias",
3897 "field": "customerAlias",
3911 "field": "color_button",
3918 "field": "textColor",
3925 "field": "fontSize",
3939 "field": "animation",
3950 "field": "header_shape",
3957 "field": "header_online",
3964 "field": "start_chat_button",
3971 "field": "offline_chat_button",
3978 "field": "header_offline",
3985 "field": "download_transcript",
3999 "field": "whiteLabel",
4006 "field": "defaultWhiteLabel",
4020 "field": "closingQuestion",
4027 "field": "formSubmitSuccessMessage",
4034 "field": "formSubmitFailureMessage",
4041 "field": "noteTitle",
4048 "field": "placeholderMessage",
4055 "field": "closingMessage",
4062 "field": "closingMessageButton",
4069 "field": "skipMessageButton",
4076 "field": "conditionAgreement",
4083 "field": "enableRating",
4090 "field": "enableFeedback",
4097 "field": "enableSendButton",
4104 "field": "feedbackTitle",
4115 "field": "ratingType",
4122 "field": "ratingStarsNumber",
4129 "field": "onlineForm",
4136 "field": "offlineForm",
4150 "field": "autoclose",
4157 "field": "enableCustomerWriting",
4164 "field": "forwardTranscript",
4171 "field": "forwardTranscriptMessage",
4178 "field": "forwardOffline",
4185 "field": "forwardOfflineAddress",
4192 "field": "waitingTitle",
4199 "field": "waitingMessage",
4206 "field": "offlineMessageSubject",
4213 "field": "offlineMessageBody",
4220 "field": "enableUnmanagedNote",
4227 "field": "unmanagedMessage",
4234 "field": "skipUnmanaged",
4241 "field": "sendUnmanaged",
4248 "field": "enableCustomerAttachment",
4255 "field": "enableCustomerCheckmarks",
4262 "field": "agentAvatar",
4269 "field": "showAgentAvatar",
4276 "field": "timezone",
4283 "field": "notificationTemplate",
4290 "field": "notificationSound",
4297 "field": "notificationShake",
4304 "field": "hideWhenOffline",
4311 "field": "agentIdentifier",
4318 "field": "waitForTheAssignedAgent",
4325 "field": "alignment",
4332 "field": "verticalAlignment",
4339 "field": "labelText",
4346 "field": "messagesAlignment",
4353 "field": "defaultTitle",
4360 "field": "customerAvatar",
4367 "field": "showCustomerAvatar",
4374 "field": "messageFontSize",
4381 "field": "backgroundColor",
4388 "field": "queueTransfer",
4395 "field": "queueTransferTimeout",
4402 "field": "agentTransfer",
4409 "field": "agentTransferTimeout",
4416 "field": "systemAlias",
4423 "field": "systemAvatar",
4430 "field": "mandatoryDispositionPauseId",
4431 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4437 "field": "mandatoryDisposition",
4438 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4444 "field": "vidaooEscalation",
4451 "field": "vidaooApiKey",
4458 "field": "vidaooTopic",
4465 "field": "vidaooNote",
4472 "field": "vidaooMetadata",
4479 "field": "openNewInteraction",
4486 "field": "subjectOffline",
4492 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4494 "filename": "server/api/chatWebsite/index.js",
4495 "groupTitle": "Chat_Websites"
4499 "url": "/api/chat/websites/{id}",
4500 "title": "Deletes a Website",
4503 "title": "Example usage:",
4504 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4508 "name": "DeleteWebsites",
4509 "group": "Chat_Websites",
4510 "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>",
4512 "filename": "server/api/chatWebsite/index.js",
4513 "groupTitle": "Chat_Websites"
4517 "url": "/api/chat/websites/describe",
4518 "title": "Gets table info about Websites",
4521 "title": "Example usage:",
4522 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4526 "name": "DescribeWebsites",
4527 "group": "Chat_Websites",
4528 "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>",
4530 "filename": "server/api/chatWebsite/index.js",
4531 "groupTitle": "Chat_Websites"
4535 "url": "/api/chat/websites/{id}/users",
4536 "title": "Gets agents from website",
4539 "title": "Example usage:",
4540 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4544 "name": "GetAgents",
4545 "group": "Chat_Websites",
4546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4548 "filename": "server/api/chatWebsite/index.js",
4549 "groupTitle": "Chat_Websites"
4553 "url": "/api/chat/websites",
4554 "title": "Gets a list of Websites",
4557 "title": "Example usage:",
4558 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4562 "name": "GetWebsites",
4563 "group": "Chat_Websites",
4564 "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>",
4566 "filename": "server/api/chatWebsite/index.js",
4567 "groupTitle": "Chat_Websites"
4571 "url": "/api/chat/websites/{id}/users",
4572 "title": "Removes agents from a website",
4575 "title": "Example usage:",
4576 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4580 "name": "RemoveAgents",
4581 "group": "Chat_Websites",
4582 "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>",
4584 "filename": "server/api/chatWebsite/index.js",
4585 "groupTitle": "Chat_Websites"
4589 "url": "/api/chat/websites/{id}/canned_answers",
4590 "title": "Removes canned answers from account",
4593 "title": "Example usage:",
4594 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4598 "name": "RemoveAnswers",
4599 "group": "Chat_Websites",
4600 "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>",
4602 "filename": "server/api/chatWebsite/index.js",
4603 "groupTitle": "Chat_Websites"
4607 "url": "/api/chat/websites/{id}/dispositions",
4608 "title": "Removes canned answers from account",
4611 "title": "Example usage:",
4612 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4616 "name": "RemoveDispositions",
4617 "group": "Chat_Websites",
4618 "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>",
4620 "filename": "server/api/chatWebsite/index.js",
4621 "groupTitle": "Chat_Websites"
4625 "url": "/api/chat/websites/{id}",
4626 "title": "Gets a single Website",
4629 "title": "Example usage:",
4630 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4634 "name": "ShowWebsites",
4635 "group": "Chat_Websites",
4636 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4638 "filename": "server/api/chatWebsite/index.js",
4639 "groupTitle": "Chat_Websites"
4643 "url": "/api/chat/messages/{id}/accept",
4644 "title": "Accepts message",
4647 "title": "Example usage:",
4648 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4652 "name": "acceptMessage",
4653 "group": "Chat_Websites",
4654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4656 "filename": "server/api/chatMessage/index.js",
4657 "groupTitle": "Chat_Websites"
4661 "url": "/api/chat/websites/{id}/canned_answers",
4662 "title": "Creates new canned answer",
4665 "title": "Example usage:",
4666 "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",
4670 "name": "addAnswer",
4671 "group": "Chat_Websites",
4693 "field": "description",
4706 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4708 "filename": "server/api/chatWebsite/index.js",
4709 "groupTitle": "Chat_Websites"
4713 "url": "/api/chat/websites/{id}/applications",
4714 "title": "Creates new applications",
4717 "title": "Example usage:",
4718 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4722 "name": "addApplications",
4723 "group": "Chat_Websites",
4731 "field": "priority",
4752 "field": "description",
4759 "field": "interval",
4765 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4767 "filename": "server/api/chatWebsite/index.js",
4768 "groupTitle": "Chat_Websites"
4772 "url": "/api/chat/websites/{id}/avatar",
4773 "title": "Add avatar",
4776 "title": "Example usage:",
4777 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4781 "name": "addAvatar",
4782 "group": "Chat_Websites",
4783 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4785 "filename": "server/api/chatWebsite/index.js",
4786 "groupTitle": "Chat_Websites"
4790 "url": "/api/chat/websites/{id}/customer_avatar",
4791 "title": "Add customer avatar",
4794 "title": "Example usage:",
4795 "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",
4799 "name": "addCustomerAvatar",
4800 "group": "Chat_Websites",
4801 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4803 "filename": "server/api/chatWebsite/index.js",
4804 "groupTitle": "Chat_Websites"
4808 "url": "/api/chat/websites/{id}/dispositions",
4809 "title": "Creates new disposition",
4812 "title": "Example usage:",
4813 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4817 "name": "addDisposition",
4818 "group": "Chat_Websites",
4845 "field": "description",
4851 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4853 "filename": "server/api/chatWebsite/index.js",
4854 "groupTitle": "Chat_Websites"
4858 "url": "/api/chat/accounts/{id}/interactions",
4859 "title": "Creates new interactions",
4862 "title": "Example usage:",
4863 "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",
4867 "name": "addInteraction",
4868 "group": "Chat_Websites",
4883 "field": "ratingValue",
4894 "field": "ratingType",
4901 "field": "ratingMessage",
4908 "field": "pathTranscript",
4915 "field": "mailTranscript",
4922 "field": "closedAt",
4929 "field": "disposition",
4936 "field": "secondDisposition",
4943 "field": "thirdDisposition",
4957 "field": "browserName",
4964 "field": "browserVersion",
4978 "field": "osVersion",
4985 "field": "deviceModel",
4992 "field": "deviceVendor",
4999 "field": "deviceType",
5013 "field": "customerIp",
5020 "field": "formData",
5027 "field": "read1stAt",
5034 "field": "lastMsgAt",
5045 "field": "lastMsgDirection",
5052 "field": "closeReason",
5059 "field": "customerPort",
5066 "field": "vidaooSessionId",
5073 "field": "autoreplyExecuted",
5079 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5081 "filename": "server/api/chatWebsite/index.js",
5082 "groupTitle": "Chat_Websites"
5086 "url": "/api/chat/websites/{id}/logo",
5087 "title": "Add logo",
5090 "title": "Example usage:",
5091 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5096 "group": "Chat_Websites",
5097 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5099 "filename": "server/api/chatWebsite/index.js",
5100 "groupTitle": "Chat_Websites"
5104 "url": "/api/chat/websites/{id}/proactive_actions",
5105 "title": "Creates new Proactive Actions",
5108 "title": "Example usage:",
5109 "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",
5113 "name": "addProactiveActions",
5114 "group": "Chat_Websites",
5140 "field": "selector",
5153 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5155 "filename": "server/api/chatWebsite/index.js",
5156 "groupTitle": "Chat_Websites"
5160 "url": "/api/chat/websites/{id}/system_avatar",
5161 "title": "Add system avatar",
5164 "title": "Example usage:",
5165 "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",
5169 "name": "addSystemAvatar",
5170 "group": "Chat_Websites",
5171 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5173 "filename": "server/api/chatWebsite/index.js",
5174 "groupTitle": "Chat_Websites"
5178 "url": "/api/chat/websites/{id}/canned_answers",
5179 "title": "Gets account canned answers",
5182 "title": "Example usage:",
5183 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5187 "name": "getAnswers",
5188 "group": "Chat_Websites",
5189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5191 "filename": "server/api/chatWebsite/index.js",
5192 "groupTitle": "Chat_Websites"
5196 "url": "/api/chat/websites/{id}/applications",
5197 "title": "Gets Website Applications",
5200 "title": "Example usage:",
5201 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5205 "name": "getApplications",
5206 "group": "Chat_Websites",
5207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5209 "filename": "server/api/chatWebsite/index.js",
5210 "groupTitle": "Chat_Websites"
5214 "url": "/api/chat/websites/{id}/avatar",
5215 "title": "Get avatar",
5218 "title": "Example usage:",
5219 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5223 "name": "getAvatar",
5224 "group": "Chat_Websites",
5225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5227 "filename": "server/api/chatWebsite/index.js",
5228 "groupTitle": "Chat_Websites"
5232 "url": "/api/chat/websites/{id}/customer_avatar",
5233 "title": "Get Customer Avatar",
5236 "title": "Example usage:",
5237 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5241 "name": "getCustomerAvatar",
5242 "group": "Chat_Websites",
5243 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5245 "filename": "server/api/chatWebsite/index.js",
5246 "groupTitle": "Chat_Websites"
5250 "url": "/api/chat/websites/{id}/dispositions",
5251 "title": "Gets account dispositions",
5254 "title": "Example usage:",
5255 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5259 "name": "getDispositions",
5260 "group": "Chat_Websites",
5261 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5263 "filename": "server/api/chatWebsite/index.js",
5264 "groupTitle": "Chat_Websites"
5268 "url": "/api/chat/websites/{id}/fields",
5269 "title": "Gets Website Fields",
5272 "title": "Example usage:",
5273 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5277 "name": "getFields",
5278 "group": "Chat_Websites",
5279 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5281 "filename": "server/api/chatWebsite/index.js",
5282 "groupTitle": "Chat_Websites"
5286 "url": "/api/chat/websites/{id}/interactions",
5287 "title": "Gets Website Interactions",
5290 "title": "Example usage:",
5291 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5295 "name": "getInteraction",
5296 "group": "Chat_Websites",
5297 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5299 "filename": "server/api/chatWebsite/index.js",
5300 "groupTitle": "Chat_Websites"
5304 "url": "/api/chat/websites/{id}/logo",
5305 "title": "Get logo",
5308 "title": "Example usage:",
5309 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5314 "group": "Chat_Websites",
5315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5317 "filename": "server/api/chatWebsite/index.js",
5318 "groupTitle": "Chat_Websites"
5322 "url": "/api/chat/websites/{id}/offline_messages",
5323 "title": "Gets Website Offline Messages",
5326 "title": "Example usage:",
5327 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5331 "name": "getOfflineMessages",
5332 "group": "Chat_Websites",
5333 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5335 "filename": "server/api/chatWebsite/index.js",
5336 "groupTitle": "Chat_Websites"
5340 "url": "/api/chat/websites/{id}/proactive_actions",
5341 "title": "Gets Website Proactive Actions",
5344 "title": "Example usage:",
5345 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5349 "name": "getProactiveActions",
5350 "group": "Chat_Websites",
5351 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5353 "filename": "server/api/chatWebsite/index.js",
5354 "groupTitle": "Chat_Websites"
5358 "url": "/api/chat/websites/{id}/snippet",
5359 "title": "Gets Website Snippet",
5362 "title": "Example usage:",
5363 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5367 "name": "getSnippet",
5368 "group": "Chat_Websites",
5369 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5371 "filename": "server/api/chatWebsite/index.js",
5372 "groupTitle": "Chat_Websites"
5376 "url": "/api/chat/websites/{id}/system_avatar",
5377 "title": "Get System Avatar",
5380 "title": "Example usage:",
5381 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5385 "name": "getSystemAvatar",
5386 "group": "Chat_Websites",
5387 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5389 "filename": "server/api/chatWebsite/index.js",
5390 "groupTitle": "Chat_Websites"
5394 "url": "/api/chat/websites/{id}/notify",
5395 "title": "Notify new message",
5398 "title": "Example usage:",
5399 "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",
5404 "group": "Chat_Websites",
5405 "description": "<p>Motion 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>",
5407 "filename": "server/api/chatWebsite/index.js",
5408 "groupTitle": "Chat_Websites"
5412 "url": "/api/chat/websites/{id}/offline",
5413 "title": "Offline message",
5416 "title": "Example usage:",
5417 "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",
5422 "group": "Chat_Websites",
5423 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5425 "filename": "server/api/chatWebsite/index.js",
5426 "groupTitle": "Chat_Websites"
5430 "url": "/api/chat/messages/{id}/reject",
5431 "title": "Rejects message",
5434 "title": "Example usage:",
5435 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5439 "name": "rejectMessage",
5440 "group": "Chat_Websites",
5441 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5443 "filename": "server/api/chatMessage/index.js",
5444 "groupTitle": "Chat_Websites"
5448 "url": "/api/chat/websites/{id}",
5449 "title": "Update an existing Website",
5452 "title": "Example usage:",
5453 "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",
5457 "name": "updateWebsites",
5458 "group": "Chat_Websites",
5459 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5461 "filename": "server/api/chatWebsite/index.js",
5462 "groupTitle": "Chat_Websites"
5466 "url": "/api/cloudProviders",
5467 "title": "Creates a new CloudProvider",
5470 "title": "Example usage:",
5471 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5475 "name": "CreateCloudProviders",
5476 "group": "CloudProviders",
5515 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5517 "filename": "server/api/cloudProvider/index.js",
5518 "groupTitle": "CloudProviders"
5522 "url": "/api/cloudProviders/{id}",
5523 "title": "Deletes a CloudProvider",
5526 "title": "Example usage:",
5527 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5531 "name": "DeleteCloudProviders",
5532 "group": "CloudProviders",
5533 "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>",
5535 "filename": "server/api/cloudProvider/index.js",
5536 "groupTitle": "CloudProviders"
5540 "url": "/api/cloudProviders",
5541 "title": "Gets a list of CloudProviders",
5544 "title": "Example usage:",
5545 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5549 "name": "GetCloudProviders",
5550 "group": "CloudProviders",
5551 "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>",
5553 "filename": "server/api/cloudProvider/index.js",
5554 "groupTitle": "CloudProviders"
5558 "url": "/api/cloudProviders/oauth2/microsoft/authorize/{id}",
5559 "title": "Generates the Microsoft Identity platform authorization url",
5562 "title": "Example usage:",
5563 "content": "curl https://{domain}/api/cloudProviders/oauth2/microsoft/authorize/{id} -v -u {name}:{password}",
5567 "name": "Oauth2MicrosoftAuthorize",
5568 "group": "CloudProviders",
5569 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5571 "filename": "server/api/cloudProvider/index.js",
5572 "groupTitle": "CloudProviders"
5576 "url": "/api/cloudProviders/oauth2/microsoft/callback",
5577 "title": "Receives an authorization code from Microsoft Identity platform",
5578 "name": "Oauth2MicrosoftCallback",
5579 "group": "CloudProviders",
5580 "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>",
5582 "filename": "server/api/cloudProvider/index.js",
5583 "groupTitle": "CloudProviders"
5587 "url": "/api/cloudProviders/{id}",
5588 "title": "Gets a single CloudProvider",
5591 "title": "Example usage:",
5592 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5596 "name": "ShowCloudProviders",
5597 "group": "CloudProviders",
5598 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5600 "filename": "server/api/cloudProvider/index.js",
5601 "groupTitle": "CloudProviders"
5605 "url": "/api/cloudProviders/{id}",
5606 "title": "Update an existing CloudProvider",
5609 "title": "Example usage:",
5610 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5614 "name": "updateCloudProviders",
5615 "group": "CloudProviders",
5616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5618 "filename": "server/api/cloudProvider/index.js",
5619 "groupTitle": "CloudProviders"
5623 "url": "/api/cm_contact_has_items",
5624 "title": "Creates a new CmContactHasItem",
5627 "title": "Example usage:",
5628 "content": "curl https://{domain}/api/cm_contact_has_items -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5632 "name": "CreateCmContactHasItems",
5633 "group": "CmContactHasItems",
5641 "field": "CmContactId",
5655 "field": "ItemTypeId",
5662 "field": "ItemClass",
5676 "field": "description",
5682 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5684 "filename": "server/api/cmContactHasItem/index.js",
5685 "groupTitle": "CmContactHasItems"
5689 "url": "/api/cm_contact_has_items/{id}",
5690 "title": "Deletes a CmContactHasItem",
5693 "title": "Example usage:",
5694 "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password} -X DELETE",
5698 "name": "DeleteCmContactHasItems",
5699 "group": "CmContactHasItems",
5700 "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>",
5702 "filename": "server/api/cmContactHasItem/index.js",
5703 "groupTitle": "CmContactHasItems"
5707 "url": "/api/cm_contact_has_items",
5708 "title": "Gets a list of CmContactHasItems",
5711 "title": "Example usage:",
5712 "content": "curl https://{domain}/api/cm_contact_has_items -v -u {name}:{password}",
5716 "name": "GetCmContactHasItems",
5717 "group": "CmContactHasItems",
5718 "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_contact_has_items?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_contact_has_items?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_contact_has_items?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_contact_has_items?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_contact_has_items?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>",
5720 "filename": "server/api/cmContactHasItem/index.js",
5721 "groupTitle": "CmContactHasItems"
5725 "url": "/api/cm_contact_has_items/{id}",
5726 "title": "Gets a single CmContactHasItem",
5729 "title": "Example usage:",
5730 "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password}",
5734 "name": "ShowCmContactHasItems",
5735 "group": "CmContactHasItems",
5736 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5738 "filename": "server/api/cmContactHasItem/index.js",
5739 "groupTitle": "CmContactHasItems"
5743 "url": "/api/cm_contact_has_items/{id}",
5744 "title": "Update an existing CmContactHasItem",
5747 "title": "Example usage:",
5748 "content": "curl https://{domain}/api/cm_contact_has_items/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5752 "name": "updateCmContactHasItems",
5753 "group": "CmContactHasItems",
5754 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5756 "filename": "server/api/cmContactHasItem/index.js",
5757 "groupTitle": "CmContactHasItems"
5761 "url": "/api/cm_hopper_additional_phones",
5762 "title": "Creates a new CmHopperAdditionalPhone",
5765 "title": "Example usage:",
5766 "content": "curl https://{domain}/api/cm_hopper_additional_phones -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5770 "name": "CreateCmHopperAdditionalPhones",
5771 "group": "CmHopperAdditionalPhones",
5779 "field": "CmHopperId",
5800 "field": "scheduledat",
5807 "field": "countbusyretry",
5814 "field": "countcongestionretry",
5821 "field": "countnoanswerretry",
5828 "field": "countnosuchnumberretry",
5835 "field": "countdropretry",
5842 "field": "countabandonedretry",
5849 "field": "countmachineretry",
5856 "field": "countagentrejectretry",
5862 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5864 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5865 "groupTitle": "CmHopperAdditionalPhones"
5869 "url": "/api/cm_hopper_additional_phones/{id}",
5870 "title": "Deletes a CmHopperAdditionalPhone",
5873 "title": "Example usage:",
5874 "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password} -X DELETE",
5878 "name": "DeleteCmHopperAdditionalPhones",
5879 "group": "CmHopperAdditionalPhones",
5880 "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>",
5882 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5883 "groupTitle": "CmHopperAdditionalPhones"
5887 "url": "/api/cm_hopper_additional_phones",
5888 "title": "Gets a list of CmHopperAdditionalPhones",
5891 "title": "Example usage:",
5892 "content": "curl https://{domain}/api/cm_hopper_additional_phones -v -u {name}:{password}",
5896 "name": "GetCmHopperAdditionalPhones",
5897 "group": "CmHopperAdditionalPhones",
5898 "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_additional_phones?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_additional_phones?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_additional_phones?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_additional_phones?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_additional_phones?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>",
5900 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5901 "groupTitle": "CmHopperAdditionalPhones"
5905 "url": "/api/cm_hopper_additional_phones/{id}",
5906 "title": "Gets a single CmHopperAdditionalPhone",
5909 "title": "Example usage:",
5910 "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password}",
5914 "name": "ShowCmHopperAdditionalPhones",
5915 "group": "CmHopperAdditionalPhones",
5916 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5918 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5919 "groupTitle": "CmHopperAdditionalPhones"
5923 "url": "/api/cm_hopper_additional_phones/{id}",
5924 "title": "Update an existing CmHopperAdditionalPhone",
5927 "title": "Example usage:",
5928 "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5932 "name": "updateCmHopperAdditionalPhones",
5933 "group": "CmHopperAdditionalPhones",
5934 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5936 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5937 "groupTitle": "CmHopperAdditionalPhones"
5941 "url": "/api/cm/companies",
5942 "title": "Creates a new Company",
5945 "title": "Example usage:",
5946 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5950 "name": "CreateCompanies",
5951 "group": "Cm_Companies",
5973 "field": "companyId",
6015 "field": "postalCode",
6043 "field": "emailDomain",
6057 "field": "sPostalCode",
6071 "field": "sCountry",
6078 "field": "description",
6084 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6086 "filename": "server/api/cmCompany/index.js",
6087 "groupTitle": "Cm_Companies"
6091 "url": "/api/cm/companies/{id}",
6092 "title": "Deletes a Company",
6095 "title": "Example usage:",
6096 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
6100 "name": "DeleteCompanies",
6101 "group": "Cm_Companies",
6102 "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>",
6104 "filename": "server/api/cmCompany/index.js",
6105 "groupTitle": "Cm_Companies"
6109 "url": "/api/cm/companies/describe",
6110 "title": "Gets table info about Companies",
6113 "title": "Example usage:",
6114 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
6118 "name": "DescribeCompanies",
6119 "group": "Cm_Companies",
6120 "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>",
6122 "filename": "server/api/cmCompany/index.js",
6123 "groupTitle": "Cm_Companies"
6127 "url": "/api/cm/companies",
6128 "title": "Gets a list of Companies",
6131 "title": "Example usage:",
6132 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
6136 "name": "GetCompanies",
6137 "group": "Cm_Companies",
6138 "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>",
6140 "filename": "server/api/cmCompany/index.js",
6141 "groupTitle": "Cm_Companies"
6145 "url": "/api/cm/companies/{id}",
6146 "title": "Gets a single Company",
6149 "title": "Example usage:",
6150 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
6154 "name": "ShowCompanies",
6155 "group": "Cm_Companies",
6156 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6158 "filename": "server/api/cmCompany/index.js",
6159 "groupTitle": "Cm_Companies"
6163 "url": "/api/cm/companies/{id}/contacts",
6164 "title": "Creates new contacts",
6167 "title": "Example usage:",
6168 "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",
6172 "name": "addContacts",
6173 "group": "Cm_Companies",
6181 "field": "firstName",
6188 "field": "lastName",
6202 "field": "postalCode",
6223 "field": "dateOfBirth",
6230 "field": "description",
6272 "field": "facebook",
6328 "field": "telegram",
6342 "field": "priority",
6349 "field": "scheduledat",
6355 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6357 "filename": "server/api/cmCompany/index.js",
6358 "groupTitle": "Cm_Companies"
6362 "url": "/api/cm/companies/{id}/contacts",
6363 "title": "Gets List Contacts",
6366 "title": "Example usage:",
6367 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6371 "name": "getContacts",
6372 "group": "Cm_Companies",
6373 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6375 "filename": "server/api/cmCompany/index.js",
6376 "groupTitle": "Cm_Companies"
6380 "url": "/api/cm/companies/{id}",
6381 "title": "Update an existing Company",
6384 "title": "Example usage:",
6385 "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",
6389 "name": "updateCompanies",
6390 "group": "Cm_Companies",
6391 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6393 "filename": "server/api/cmCompany/index.js",
6394 "groupTitle": "Cm_Companies"
6398 "url": "/api/cm/contacts/{id}",
6399 "title": "Deletes a Contact",
6402 "title": "Example usage:",
6403 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6407 "name": "DeleteContacts",
6408 "group": "Cm_Contacts",
6409 "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>",
6411 "filename": "server/api/cmContact/index.js",
6412 "groupTitle": "Cm_Contacts"
6416 "url": "/api/cm/contacts/describe",
6417 "title": "Gets table info about Contacts",
6420 "title": "Example usage:",
6421 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6425 "name": "DescribeContacts",
6426 "group": "Cm_Contacts",
6427 "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>",
6429 "filename": "server/api/cmContact/index.js",
6430 "groupTitle": "Cm_Contacts"
6434 "url": "/api/cm/contacts",
6435 "title": "Gets a list of Contacts",
6438 "title": "Example usage:",
6439 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6443 "name": "GetContacts",
6444 "group": "Cm_Contacts",
6445 "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>",
6447 "filename": "server/api/cmContact/index.js",
6448 "groupTitle": "Cm_Contacts"
6452 "url": "/api/cm/contacts/{id}/finals",
6453 "title": "Gets contact hopper finals",
6456 "title": "Example usage:",
6457 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6461 "name": "GetHopperFinals",
6462 "group": "Cm_Contacts",
6463 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6465 "filename": "server/api/cmContact/index.js",
6466 "groupTitle": "Cm_Contacts"
6470 "url": "/api/cm/contacts/{id}/hopper_histories",
6471 "title": "Gets contact hopper histories",
6474 "title": "Example usage:",
6475 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6479 "name": "GetHopperHistories",
6480 "group": "Cm_Contacts",
6481 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6483 "filename": "server/api/cmContact/index.js",
6484 "groupTitle": "Cm_Contacts"
6488 "url": "/api/cm/contacts/{id}/hoppers",
6489 "title": "Gets contact hoppers",
6492 "title": "Example usage:",
6493 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6497 "name": "GetHoppers",
6498 "group": "Cm_Contacts",
6499 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6501 "filename": "server/api/cmContact/index.js",
6502 "groupTitle": "Cm_Contacts"
6506 "url": "/api/cm/contacts/create_many",
6507 "title": "Create Contacts",
6510 "title": "Example usage:",
6511 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6515 "name": "bulkCreate",
6516 "group": "Cm_Contacts",
6517 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6519 "filename": "server/api/cmContact/index.js",
6520 "groupTitle": "Cm_Contacts"
6524 "url": "/api/cm/contacts",
6525 "title": "Create Contact",
6528 "title": "Example usage:",
6529 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6534 "group": "Cm_Contacts",
6535 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6537 "filename": "server/api/cmContact/index.js",
6538 "groupTitle": "Cm_Contacts"
6542 "url": "/api/cm/contacts/{id}/duplicatePhones",
6543 "title": "Sets new contact additional phones",
6546 "title": "Example usage:",
6547 "content": "curl https://{domain}/api/cm/contacts/{id}/duplicateAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6551 "name": "duplicateAdditionalPhones",
6552 "group": "Cm_Contacts",
6553 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6555 "filename": "server/api/cmContact/index.js",
6556 "groupTitle": "Cm_Contacts"
6560 "url": "/api/cm/contacts/{id}/phones",
6561 "title": "Gets contact phones",
6564 "title": "Example usage:",
6565 "content": "curl https://{domain}/api/cm/contacts/{id}/phones -v -u {name}:{password} -X GET",
6569 "name": "getAdditionalPhones",
6570 "group": "Cm_Contacts",
6571 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6573 "filename": "server/api/cmContact/index.js",
6574 "groupTitle": "Cm_Contacts"
6578 "url": "/api/cm/contacts/{id}/journey",
6579 "title": "Gets customer journey",
6582 "title": "Example usage:",
6583 "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
6587 "name": "getJourney",
6588 "group": "Cm_Contacts",
6589 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6591 "filename": "server/api/cmContact/index.js",
6592 "groupTitle": "Cm_Contacts"
6596 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6597 "title": "Gets contact hopper blacks",
6600 "title": "Example usage:",
6601 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6605 "name": "getJscriptySessions",
6606 "group": "Cm_Contacts",
6607 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6609 "filename": "server/api/cmContact/index.js",
6610 "groupTitle": "Cm_Contacts"
6614 "url": "/api/cm/contacts/{id}/tags",
6615 "title": "Gets configurations tags",
6618 "title": "Example usage:",
6619 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6624 "group": "Cm_Contacts",
6625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6627 "filename": "server/api/cmContact/index.js",
6628 "groupTitle": "Cm_Contacts"
6632 "url": "/api/cm/contacts/merge",
6633 "title": "Merge Contact",
6636 "title": "Example usage:",
6637 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6642 "group": "Cm_Contacts",
6643 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6645 "filename": "server/api/cmContact/index.js",
6646 "groupTitle": "Cm_Contacts"
6650 "url": "/api/cm/contacts/{id}/rescheduleAdditionalPhones",
6651 "title": "Sets new contact additional phones",
6654 "title": "Example usage:",
6655 "content": "curl https://{domain}/api/cm/contacts/{id}/rescheduleAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6659 "name": "rescheduleAdditionalPhones",
6660 "group": "Cm_Contacts",
6661 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6663 "filename": "server/api/cmContact/index.js",
6664 "groupTitle": "Cm_Contacts"
6668 "url": "/api/cm/contacts/{id}/phones",
6669 "title": "Sets new contact phones",
6672 "title": "Example usage:",
6673 "content": "curl https://{domain}/api/cm/contacts/{id}/phones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6677 "name": "setAdditionalPhones",
6678 "group": "Cm_Contacts",
6679 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6681 "filename": "server/api/cmContact/index.js",
6682 "groupTitle": "Cm_Contacts"
6686 "url": "/api/cm/contacts/{id}/tags",
6687 "title": "Sets new tags",
6690 "title": "Example usage:",
6691 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6696 "group": "Cm_Contacts",
6697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6699 "filename": "server/api/cmContact/index.js",
6700 "groupTitle": "Cm_Contacts"
6704 "url": "/api/cm/contacts/{id}",
6705 "title": "Gets a single Contact",
6708 "title": "Example usage:",
6709 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6714 "group": "Cm_Contacts",
6715 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6717 "filename": "server/api/cmContact/index.js",
6718 "groupTitle": "Cm_Contacts"
6722 "url": "/api/cm/contacts/{id}",
6723 "title": "Update a single Contact",
6726 "title": "Example usage:",
6727 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6732 "group": "Cm_Contacts",
6733 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6735 "filename": "server/api/cmContact/index.js",
6736 "groupTitle": "Cm_Contacts"
6740 "url": "/api/cm/custom_fields/{id}",
6741 "title": "Deletes a Custom Field",
6744 "title": "Example usage:",
6745 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6749 "name": "DeleteCustom_Fields",
6750 "group": "Cm_Custom_Fields",
6751 "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>",
6753 "filename": "server/api/cmCustomField/index.js",
6754 "groupTitle": "Cm_Custom_Fields"
6758 "url": "/api/cm/custom_fields",
6759 "title": "Gets a list of Custom Fields",
6762 "title": "Example usage:",
6763 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6767 "name": "GetCustom_Fields",
6768 "group": "Cm_Custom_Fields",
6769 "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>",
6771 "filename": "server/api/cmCustomField/index.js",
6772 "groupTitle": "Cm_Custom_Fields"
6776 "url": "/api/cm/custom_fields/{id}",
6777 "title": "Gets a single Custom Field",
6780 "title": "Example usage:",
6781 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6785 "name": "ShowCustom_Fields",
6786 "group": "Cm_Custom_Fields",
6787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6789 "filename": "server/api/cmCustomField/index.js",
6790 "groupTitle": "Cm_Custom_Fields"
6794 "url": "/api/cm/custom_fields/{id}",
6795 "title": "Update an existing Custom Field",
6798 "title": "Example usage:",
6799 "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",
6803 "name": "updateCustom_Fields",
6804 "group": "Cm_Custom_Fields",
6805 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6807 "filename": "server/api/cmCustomField/index.js",
6808 "groupTitle": "Cm_Custom_Fields"
6812 "url": "/api/cm/hopper",
6813 "title": "Creates a new Hopper",
6816 "title": "Example usage:",
6817 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6821 "name": "CreateHopper",
6822 "group": "Cm_Hopper",
6844 "field": "scheduledat",
6851 "field": "countbusyretry",
6858 "field": "countcongestionretry",
6865 "field": "countnoanswerretry",
6872 "field": "callback",
6879 "field": "callbackuniqueid",
6886 "field": "callbackat",
6893 "field": "priority",
6900 "field": "recallme",
6907 "field": "ContactId",
6928 "field": "VoiceQueueId",
6935 "field": "CampaignId",
6942 "field": "countnosuchnumberretry",
6949 "field": "countdropretry",
6956 "field": "countabandonedretry",
6963 "field": "countmachineretry",
6970 "field": "countagentrejectretry",
6984 "field": "dialTimezone",
6990 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6992 "filename": "server/api/cmHopper/index.js",
6993 "groupTitle": "Cm_Hopper"
6997 "url": "/api/cm/hopper/describe",
6998 "title": "Gets table info about Hopper",
7001 "title": "Example usage:",
7002 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
7006 "name": "DescribeHopper",
7007 "group": "Cm_Hopper",
7008 "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>",
7010 "filename": "server/api/cmHopper/index.js",
7011 "groupTitle": "Cm_Hopper"
7015 "url": "/api/cm/hopper",
7016 "title": "Gets a list of Hopper",
7019 "title": "Example usage:",
7020 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
7024 "name": "GetHopper",
7025 "group": "Cm_Hopper",
7026 "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>",
7028 "filename": "server/api/cmHopper/index.js",
7029 "groupTitle": "Cm_Hopper"
7033 "url": "/api/cm/hopper/{id}",
7034 "title": "Gets a single Hopper",
7037 "title": "Example usage:",
7038 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
7042 "name": "ShowHopper",
7043 "group": "Cm_Hopper",
7044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7046 "filename": "server/api/cmHopper/index.js",
7047 "groupTitle": "Cm_Hopper"
7051 "url": "/api/cm/hopper_black/{id}",
7052 "title": "Deletes a Hopper Black",
7055 "title": "Example usage:",
7056 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
7060 "name": "DeleteHopper_Black",
7061 "group": "Cm_Hopper_Black",
7062 "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>",
7064 "filename": "server/api/cmHopperBlack/index.js",
7065 "groupTitle": "Cm_Hopper_Black"
7069 "url": "/api/cm/hopper_black/describe",
7070 "title": "Gets table info about Hopper Black",
7073 "title": "Example usage:",
7074 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
7078 "name": "DescribeHopper_Black",
7079 "group": "Cm_Hopper_Black",
7080 "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>",
7082 "filename": "server/api/cmHopperBlack/index.js",
7083 "groupTitle": "Cm_Hopper_Black"
7087 "url": "/api/cm/hopper_black",
7088 "title": "Gets a list of Hopper Black",
7091 "title": "Example usage:",
7092 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
7096 "name": "GetHopper_Black",
7097 "group": "Cm_Hopper_Black",
7098 "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>",
7100 "filename": "server/api/cmHopperBlack/index.js",
7101 "groupTitle": "Cm_Hopper_Black"
7105 "url": "/api/cm/hopper_black/{id}",
7106 "title": "Gets a single Hopper Black",
7109 "title": "Example usage:",
7110 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
7114 "name": "ShowHopper_Black",
7115 "group": "Cm_Hopper_Black",
7116 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7118 "filename": "server/api/cmHopperBlack/index.js",
7119 "groupTitle": "Cm_Hopper_Black"
7123 "url": "/api/cm/hopper_black/{id}",
7124 "title": "Update an existing Hopper Black",
7127 "title": "Example usage:",
7128 "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",
7132 "name": "updateHopper_Black",
7133 "group": "Cm_Hopper_Black",
7134 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7136 "filename": "server/api/cmHopperBlack/index.js",
7137 "groupTitle": "Cm_Hopper_Black"
7141 "url": "/api/cm/hopper_final/checkContactHopper",
7142 "title": "Check if contact is in hopper",
7145 "title": "Example usage:",
7146 "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",
7150 "name": "/checkContactHopper",
7151 "group": "Cm_Hopper_Final",
7152 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7154 "filename": "server/api/cmHopperFinal/index.js",
7155 "groupTitle": "Cm_Hopper_Final"
7159 "url": "/api/cm/hopper_final/describe",
7160 "title": "Gets table info about HopperFinal",
7163 "title": "Example usage:",
7164 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
7168 "name": "DescribeHopperFinal",
7169 "group": "Cm_Hopper_Final",
7170 "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>",
7172 "filename": "server/api/cmHopperFinal/index.js",
7173 "groupTitle": "Cm_Hopper_Final"
7177 "url": "/api/cm/hopper_final",
7178 "title": "Gets a list of HopperFinal",
7181 "title": "Example usage:",
7182 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
7186 "name": "GetHopperFinal",
7187 "group": "Cm_Hopper_Final",
7188 "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>",
7190 "filename": "server/api/cmHopperFinal/index.js",
7191 "groupTitle": "Cm_Hopper_Final"
7195 "url": "/api/cm/hopper_final/{id}",
7196 "title": "Gets a single HopperFinal",
7199 "title": "Example usage:",
7200 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
7204 "name": "ShowHopperFinal",
7205 "group": "Cm_Hopper_Final",
7206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7208 "filename": "server/api/cmHopperFinal/index.js",
7209 "groupTitle": "Cm_Hopper_Final"
7213 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
7214 "title": "Return number contacts for attributes",
7217 "title": "Example usage:",
7218 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7222 "name": "countContactsIvrCampaignHopperFinal",
7223 "group": "Cm_Hopper_Final",
7224 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7226 "filename": "server/api/cmHopperFinal/index.js",
7227 "groupTitle": "Cm_Hopper_Final"
7231 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
7232 "title": "Return number contacts for attributes",
7235 "title": "Example usage:",
7236 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7240 "name": "countContactsQueueCampaignHopperFinal",
7241 "group": "Cm_Hopper_Final",
7242 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7244 "filename": "server/api/cmHopperFinal/index.js",
7245 "groupTitle": "Cm_Hopper_Final"
7249 "url": "/api/cm/hopper_final/campaign/{id}",
7250 "title": "Move contacts in hopper",
7253 "title": "Example usage:",
7254 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7258 "name": "moveContactsIvrCampaignHopperFinal",
7259 "group": "Cm_Hopper_Final",
7260 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7262 "filename": "server/api/cmHopperFinal/index.js",
7263 "groupTitle": "Cm_Hopper_Final"
7267 "url": "/api/cm/hopper_final/voice/queue/{id}",
7268 "title": "Move contacts in hopper",
7271 "title": "Example usage:",
7272 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
7276 "name": "moveContactsQueueCampaignHopperFinal",
7277 "group": "Cm_Hopper_Final",
7278 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7280 "filename": "server/api/cmHopperFinal/index.js",
7281 "groupTitle": "Cm_Hopper_Final"
7285 "url": "/api/cm/hopper_final/{id}",
7286 "title": "Update a single hopper final",
7289 "title": "Example usage:",
7290 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7295 "group": "Cm_Hopper_Final",
7296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7298 "filename": "server/api/cmHopperFinal/index.js",
7299 "groupTitle": "Cm_Hopper_Final"
7303 "url": "/api/cm/hopper_history",
7304 "title": "Creates a new HopperHistory",
7307 "title": "Example usage:",
7308 "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",
7312 "name": "CreateHopperHistory",
7313 "group": "Cm_Hopper_History",
7328 "field": "statedesc",
7335 "field": "scheduledat",
7342 "field": "countbusyretry",
7349 "field": "countcongestionretry",
7356 "field": "countnoanswerretry",
7363 "field": "countglobal",
7370 "field": "uniqueid",
7377 "field": "originatecalleridnum",
7384 "field": "originatecalleridname",
7391 "field": "calleridnum",
7398 "field": "calleridname",
7405 "field": "starttime",
7412 "field": "responsetime",
7419 "field": "answertime",
7426 "field": "droptime",
7440 "field": "ringtime",
7447 "field": "holdtime",
7454 "field": "talktime",
7461 "field": "followuptime",
7468 "field": "dropreason",
7475 "field": "campaign",
7482 "field": "campaigntype",
7489 "field": "membername",
7517 "field": "callback",
7524 "field": "callbackuniqueid",
7531 "field": "callbackat",
7538 "field": "recallme",
7545 "field": "editedat",
7559 "field": "countnosuchnumberretry",
7566 "field": "countdropretry",
7573 "field": "countabandonedretry",
7580 "field": "countmachineretry",
7587 "field": "countagentrejectretry",
7593 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7595 "filename": "server/api/cmHopperHistory/index.js",
7596 "groupTitle": "Cm_Hopper_History"
7600 "url": "/api/cm/hopper_history/describe",
7601 "title": "Gets table info about HopperHistory",
7604 "title": "Example usage:",
7605 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7609 "name": "DescribeHopperHistory",
7610 "group": "Cm_Hopper_History",
7611 "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>",
7613 "filename": "server/api/cmHopperHistory/index.js",
7614 "groupTitle": "Cm_Hopper_History"
7618 "url": "/api/cm/hopper_history",
7619 "title": "Gets a list of HopperHistory",
7622 "title": "Example usage:",
7623 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7627 "name": "GetHopperHistory",
7628 "group": "Cm_Hopper_History",
7629 "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>",
7631 "filename": "server/api/cmHopperHistory/index.js",
7632 "groupTitle": "Cm_Hopper_History"
7636 "url": "/api/cm/hopper_history/{id}",
7637 "title": "Gets a single HopperHistory",
7640 "title": "Example usage:",
7641 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7645 "name": "ShowHopperHistory",
7646 "group": "Cm_Hopper_History",
7647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7649 "filename": "server/api/cmHopperHistory/index.js",
7650 "groupTitle": "Cm_Hopper_History"
7654 "url": "/api/cm/hopper_history/{id}",
7655 "title": "Update a single hopper history",
7658 "title": "Example usage:",
7659 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7664 "group": "Cm_Hopper_History",
7665 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7667 "filename": "server/api/cmHopperHistory/index.js",
7668 "groupTitle": "Cm_Hopper_History"
7672 "url": "/api/cm/hopper/{id}",
7673 "title": "Delete Hopper",
7676 "title": "Example usage:",
7677 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7682 "group": "Cm_Hopper",
7683 "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>",
7685 "filename": "server/api/cmHopper/index.js",
7686 "groupTitle": "Cm_Hopper"
7690 "url": "/api/cm/hopper/opencontacts",
7691 "title": "Gets Open Contacts",
7694 "title": "Example usage:",
7695 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7699 "name": "getOpenContacts",
7700 "group": "Cm_Hopper",
7701 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7703 "filename": "server/api/cmHopper/index.js",
7704 "groupTitle": "Cm_Hopper"
7708 "url": "/api/cm/hopper/preview",
7709 "title": "Gets Preview Dialer Contacts",
7712 "title": "Example usage:",
7713 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7717 "name": "getPreview",
7718 "group": "Cm_Hopper",
7719 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7721 "filename": "server/api/cmHopper/index.js",
7722 "groupTitle": "Cm_Hopper"
7726 "url": "/api/cm/hopper/{id}/previewrecall",
7727 "title": "Gets Preview Dialer Contacts for Recall",
7730 "title": "Example usage:",
7731 "content": "curl https://{domain}/api/cm/hopper/{id}/previewrecall \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7735 "name": "getPreviewRecall",
7736 "group": "Cm_Hopper",
7737 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7739 "filename": "server/api/cmHopper/index.js",
7740 "groupTitle": "Cm_Hopper"
7744 "url": "/api/cm/hopper/timezones",
7745 "title": "Gets TZs list",
7748 "title": "Example usage:",
7749 "content": "curl https://{domain}/api/cm/hopper/timezones -v -u {name}:{password} -X GET",
7753 "name": "getTimezones",
7754 "group": "Cm_Hopper",
7755 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7757 "filename": "server/api/cmHopper/index.js",
7758 "groupTitle": "Cm_Hopper"
7762 "url": "/api/cm/hopper/{id}",
7763 "title": "Update an existing Hopper",
7766 "title": "Example usage:",
7767 "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",
7771 "name": "updateHopper",
7772 "group": "Cm_Hopper",
7773 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7775 "filename": "server/api/cmHopper/index.js",
7776 "groupTitle": "Cm_Hopper"
7780 "url": "/api/cm/lists",
7781 "title": "Creates a new List",
7784 "title": "Example usage:",
7785 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7789 "name": "CreateLists",
7790 "group": "Cm_Lists",
7805 "field": "description",
7812 "field": "dialPrefix",
7818 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7820 "filename": "server/api/cmList/index.js",
7821 "groupTitle": "Cm_Lists"
7825 "url": "/api/cm/lists/{id}",
7826 "title": "Deletes a List",
7829 "title": "Example usage:",
7830 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7834 "name": "DeleteLists",
7835 "group": "Cm_Lists",
7836 "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>",
7838 "filename": "server/api/cmList/index.js",
7839 "groupTitle": "Cm_Lists"
7843 "url": "/api/cm/lists/describe",
7844 "title": "Gets table info about Lists",
7847 "title": "Example usage:",
7848 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7852 "name": "DescribeLists",
7853 "group": "Cm_Lists",
7854 "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>",
7856 "filename": "server/api/cmList/index.js",
7857 "groupTitle": "Cm_Lists"
7861 "url": "/api/cm/lists/{id}/users",
7862 "title": "Gets agents from list",
7865 "title": "Example usage:",
7866 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7870 "name": "GetAgents",
7871 "group": "Cm_Lists",
7872 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7874 "filename": "server/api/cmList/index.js",
7875 "groupTitle": "Cm_Lists"
7879 "url": "/api/cm/lists",
7880 "title": "Gets a list of Lists",
7883 "title": "Example usage:",
7884 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7889 "group": "Cm_Lists",
7890 "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>",
7892 "filename": "server/api/cmList/index.js",
7893 "groupTitle": "Cm_Lists"
7897 "url": "/api/cm/lists/{id}/users",
7898 "title": "Removes agents from a list",
7901 "title": "Example usage:",
7902 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7906 "name": "RemoveAgents",
7907 "group": "Cm_Lists",
7908 "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>",
7910 "filename": "server/api/cmList/index.js",
7911 "groupTitle": "Cm_Lists"
7915 "url": "/api/cm/lists/{id}/dispositions",
7916 "title": "Removes dispositions from account",
7919 "title": "Example usage:",
7920 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7924 "name": "RemoveDispositions",
7925 "group": "Cm_Lists",
7926 "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>",
7928 "filename": "server/api/cmList/index.js",
7929 "groupTitle": "Cm_Lists"
7933 "url": "/api/cm/lists/{id}",
7934 "title": "Gets a single List",
7937 "title": "Example usage:",
7938 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7942 "name": "ShowLists",
7943 "group": "Cm_Lists",
7944 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7946 "filename": "server/api/cmList/index.js",
7947 "groupTitle": "Cm_Lists"
7951 "url": "/api/cm/lists/{id}/users",
7952 "title": "Adds agents to a list",
7955 "title": "Example usage:",
7956 "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",
7960 "name": "addAgents",
7961 "group": "Cm_Lists",
7962 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7964 "filename": "server/api/cmList/index.js",
7965 "groupTitle": "Cm_Lists"
7969 "url": "/api/cm/lists/{id}/contacts",
7970 "title": "Creates new contacts",
7973 "title": "Example usage:",
7974 "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",
7978 "name": "addContacts",
7979 "group": "Cm_Lists",
7987 "field": "firstName",
7994 "field": "lastName",
8008 "field": "postalCode",
8029 "field": "dateOfBirth",
8036 "field": "description",
8078 "field": "facebook",
8134 "field": "telegram",
8148 "field": "priority",
8155 "field": "scheduledat",
8161 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8163 "filename": "server/api/cmList/index.js",
8164 "groupTitle": "Cm_Lists"
8168 "url": "/api/cm/lists/{id}/fields",
8169 "title": "Creates a new custom field",
8172 "title": "Example usage:",
8173 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8177 "name": "addCustomField",
8178 "group": "Cm_Lists",
8179 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8181 "filename": "server/api/cmList/index.js",
8182 "groupTitle": "Cm_Lists"
8186 "url": "/api/cm/lists/{id}/dispositions",
8187 "title": "Creates new disposition",
8190 "title": "Example usage:",
8191 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8195 "name": "addDisposition",
8196 "group": "Cm_Lists",
8223 "field": "description",
8229 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8231 "filename": "server/api/cmList/index.js",
8232 "groupTitle": "Cm_Lists"
8236 "url": "/api/cm/lists/{id}/contacts",
8237 "title": "Gets List Contacts",
8240 "title": "Example usage:",
8241 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
8245 "name": "getContacts",
8246 "group": "Cm_Lists",
8247 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8249 "filename": "server/api/cmList/index.js",
8250 "groupTitle": "Cm_Lists"
8254 "url": "/api/cm/lists/{id}/fields",
8255 "title": "Gets Custom Fields",
8258 "title": "Example usage:",
8259 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
8263 "name": "getCustomFields",
8264 "group": "Cm_Lists",
8265 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8267 "filename": "server/api/cmList/index.js",
8268 "groupTitle": "Cm_Lists"
8272 "url": "/api/cm/lists/{id}/dispositions",
8273 "title": "Gets list dispositions",
8276 "title": "Example usage:",
8277 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
8281 "name": "getDispositions",
8282 "group": "Cm_Lists",
8283 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8285 "filename": "server/api/cmList/index.js",
8286 "groupTitle": "Cm_Lists"
8290 "url": "/api/cm/lists/global_fields",
8291 "title": "Gets GLOBAL Custom Fields",
8294 "title": "Example usage:",
8295 "content": "curl https://{domain}/api/cm/lists/global_fields -v -u {name}:{password} -X GET",
8299 "name": "getGlobalCustomFields",
8300 "group": "Cm_Lists",
8301 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8303 "filename": "server/api/cmList/index.js",
8304 "groupTitle": "Cm_Lists"
8308 "url": "/api/cm/lists/{id}/contacts/csv",
8309 "title": "Gets CSV List Contacts",
8312 "title": "Example usage:",
8313 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
8318 "group": "Cm_Lists",
8319 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8321 "filename": "server/api/cmList/index.js",
8322 "groupTitle": "Cm_Lists"
8326 "url": "/api/cm/lists/{id}",
8327 "title": "Update an existing List",
8330 "title": "Example usage:",
8331 "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",
8335 "name": "updateLists",
8336 "group": "Cm_Lists",
8337 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8339 "filename": "server/api/cmList/index.js",
8340 "groupTitle": "Cm_Lists"
8344 "url": "/api/cm/contacts/upload/:id",
8345 "title": "Import new contacts by csv",
8348 "title": "Example usage:",
8349 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
8354 "group": "Cm_contacts",
8355 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8357 "filename": "server/api/cmContact/index.js",
8358 "groupTitle": "Cm_contacts"
8362 "url": "/api/cm/contacts/uploadUpdates/:id",
8363 "title": "Import existing contacts by csv",
8366 "title": "Example usage:",
8367 "content": "curl https://{domain}/api/cm/contacts/uploadUpdates/:id -v -u {name}:{password} -X POST",
8371 "name": "importUpdates",
8372 "group": "Cm_contacts",
8373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8375 "filename": "server/api/cmContact/index.js",
8376 "groupTitle": "Cm_contacts"
8380 "url": "/api/cm/contacts/upload",
8381 "title": "Upload csv",
8384 "title": "Example usage:",
8385 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8390 "group": "Cm_contacts",
8391 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8393 "filename": "server/api/cmContact/index.js",
8394 "groupTitle": "Cm_contacts"
8398 "url": "/api/cm/contacts/csv",
8399 "title": "Create new contacts by csv",
8402 "title": "Example usage:",
8403 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8407 "name": "uploadCsv",
8408 "group": "Cm_contacts",
8409 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8411 "filename": "server/api/cmContact/index.js",
8412 "groupTitle": "Cm_contacts"
8416 "url": "/api/conditions/{id}",
8417 "title": "Deletes a Condition",
8420 "title": "Example usage:",
8421 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
8425 "name": "DeleteConditions",
8426 "group": "Conditions",
8427 "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>",
8429 "filename": "server/api/condition/index.js",
8430 "groupTitle": "Conditions"
8434 "url": "/api/conditions/{id}",
8435 "title": "Update an existing Condition",
8438 "title": "Example usage:",
8439 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8443 "name": "updateConditions",
8444 "group": "Conditions",
8445 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8447 "filename": "server/api/condition/index.js",
8448 "groupTitle": "Conditions"
8452 "url": "/api/contact_item_types",
8453 "title": "Creates a new ContactItemType",
8456 "title": "Example usage:",
8457 "content": "curl https://{domain}/api/contact_item_types -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8461 "name": "CreateContactItemTypes",
8462 "group": "ContactItemType",
8484 "field": "rgbBackgroundColor",
8490 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8492 "filename": "server/api/contactItemType/index.js",
8493 "groupTitle": "ContactItemType"
8497 "url": "/api/contact_item_types/{id}",
8498 "title": "Deletes a ContactItemType",
8501 "title": "Example usage:",
8502 "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password} -X DELETE",
8506 "name": "DeleteContactItemTypes",
8507 "group": "ContactItemType",
8508 "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>",
8510 "filename": "server/api/contactItemType/index.js",
8511 "groupTitle": "ContactItemType"
8515 "url": "/api/contact_item_types",
8516 "title": "Gets a list of ContactItemTypes",
8519 "title": "Example usage:",
8520 "content": "curl https://{domain}/api/contact_item_types -v -u {name}:{password}",
8524 "name": "GetContactItemTypes",
8525 "group": "ContactItemType",
8526 "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/contact_item_types?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/contact_item_types?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/contact_item_types?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/contact_item_types?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/contact_item_types?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>",
8528 "filename": "server/api/contactItemType/index.js",
8529 "groupTitle": "ContactItemType"
8533 "url": "/api/contact_item_types/{id}",
8534 "title": "Gets a single ContactItemType",
8537 "title": "Example usage:",
8538 "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password}",
8542 "name": "ShowContactItemTypes",
8543 "group": "ContactItemType",
8544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8546 "filename": "server/api/contactItemType/index.js",
8547 "groupTitle": "ContactItemType"
8551 "url": "/api/contact_item_types/{id}",
8552 "title": "Update an existing ContactItemType",
8555 "title": "Example usage:",
8556 "content": "curl https://{domain}/api/contact_item_types/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8560 "name": "updateContactItemTypes",
8561 "group": "ContactItemType",
8562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8564 "filename": "server/api/contactItemType/index.js",
8565 "groupTitle": "ContactItemType"
8569 "url": "/api/cm/custom_field",
8570 "title": "Create a new custom field",
8573 "title": "Example usage:",
8574 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8578 "name": "CreateCustomField",
8579 "group": "Custom_Fields",
8580 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8582 "filename": "server/api/cmCustomField/index.js",
8583 "groupTitle": "Custom_Fields"
8587 "url": "/api/dashboards/items",
8588 "title": "Create dasboard item",
8591 "title": "Example usage:",
8592 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8597 "group": "Dashboard_Items",
8598 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8600 "filename": "server/api/dashboardItem/index.js",
8601 "groupTitle": "Dashboard_Items"
8605 "url": "/api/dashboards/items/{id}",
8606 "title": "Deletes a Dashboard Item",
8609 "title": "Example usage:",
8610 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8614 "name": "DeleteDashboard_Items",
8615 "group": "Dashboard_Items",
8616 "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>",
8618 "filename": "server/api/dashboardItem/index.js",
8619 "groupTitle": "Dashboard_Items"
8623 "url": "/api/dashboards/items/{id}",
8624 "title": "Gets a single Dashboard Item",
8627 "title": "Example usage:",
8628 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8632 "name": "ShowDashboard_Items",
8633 "group": "Dashboard_Items",
8634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8636 "filename": "server/api/dashboardItem/index.js",
8637 "groupTitle": "Dashboard_Items"
8641 "url": "/api/dashboards/items/{id}",
8642 "title": "Update an existing item",
8645 "title": "Example usage:",
8646 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8651 "group": "Dashboard_Items",
8652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8654 "filename": "server/api/dashboardItem/index.js",
8655 "groupTitle": "Dashboard_Items"
8659 "url": "/api/dashboards/clone",
8660 "title": "Clone an existing Dashboard",
8663 "title": "Example usage:",
8664 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8668 "name": "CloneDashboards",
8669 "group": "Dashboards",
8670 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8672 "filename": "server/api/dashboard/index.js",
8673 "groupTitle": "Dashboards"
8677 "url": "/api/dashboards",
8678 "title": "Creates a new Dashboard",
8681 "title": "Example usage:",
8682 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8686 "name": "CreateDashboards",
8687 "group": "Dashboards",
8702 "field": "description",
8708 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8710 "filename": "server/api/dashboard/index.js",
8711 "groupTitle": "Dashboards"
8715 "url": "/api/dashboards/{id}",
8716 "title": "Deletes a Dashboard",
8719 "title": "Example usage:",
8720 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8724 "name": "DeleteDashboards",
8725 "group": "Dashboards",
8726 "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>",
8728 "filename": "server/api/dashboard/index.js",
8729 "groupTitle": "Dashboards"
8733 "url": "/api/dashboards",
8734 "title": "Gets a list of Dashboards",
8737 "title": "Example usage:",
8738 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8742 "name": "GetDashboards",
8743 "group": "Dashboards",
8744 "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>",
8746 "filename": "server/api/dashboard/index.js",
8747 "groupTitle": "Dashboards"
8751 "url": "/api/dashboards/{id}",
8752 "title": "Gets a single Dashboard",
8755 "title": "Example usage:",
8756 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8760 "name": "ShowDashboards",
8761 "group": "Dashboards",
8762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8764 "filename": "server/api/dashboard/index.js",
8765 "groupTitle": "Dashboards"
8769 "url": "/api/dashboards/{id}/items",
8770 "title": "Creates new item",
8773 "title": "Example usage:",
8774 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8779 "group": "Dashboards",
8780 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8782 "filename": "server/api/dashboard/index.js",
8783 "groupTitle": "Dashboards"
8787 "url": "/api/dashboards/{id}/items",
8788 "title": "Gets items",
8791 "title": "Example usage:",
8792 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8797 "group": "Dashboards",
8798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8800 "filename": "server/api/dashboard/index.js",
8801 "groupTitle": "Dashboards"
8805 "url": "/api/dashboards/{id}",
8806 "title": "Update an existing Dashboard",
8809 "title": "Example usage:",
8810 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8814 "name": "updateDashboards",
8815 "group": "Dashboards",
8816 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8818 "filename": "server/api/dashboard/index.js",
8819 "groupTitle": "Dashboards"
8823 "url": "/api/integrations/desk/accounts",
8824 "title": "Creates a new Desk Account",
8827 "title": "Example usage:",
8828 "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",
8832 "name": "CreateDesk_Accounts",
8833 "group": "Desk_Accounts",
8848 "field": "description",
8855 "field": "username",
8862 "field": "remoteUri",
8872 "field": "authType",
8879 "field": "password",
8886 "field": "consumerKey",
8893 "field": "consumerSecret",
8907 "field": "tokenSecret",
8914 "field": "serverUrl",
8921 "\"integrationTab\"",
8931 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8933 "filename": "server/api/intDeskAccount/index.js",
8934 "groupTitle": "Desk_Accounts"
8938 "url": "/api/integrations/desk/accounts/{id}",
8939 "title": "Deletes a Desk Account",
8942 "title": "Example usage:",
8943 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8947 "name": "DeleteDesk_Accounts",
8948 "group": "Desk_Accounts",
8949 "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>",
8951 "filename": "server/api/intDeskAccount/index.js",
8952 "groupTitle": "Desk_Accounts"
8956 "url": "/api/integrations/desk/accounts",
8957 "title": "Gets a list of Desk Accounts",
8960 "title": "Example usage:",
8961 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8965 "name": "GetDesk_Accounts",
8966 "group": "Desk_Accounts",
8967 "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>",
8969 "filename": "server/api/intDeskAccount/index.js",
8970 "groupTitle": "Desk_Accounts"
8974 "url": "/api/integrations/desk/accounts/{id}",
8975 "title": "Gets a single Desk Account",
8978 "title": "Example usage:",
8979 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8983 "name": "ShowDesk_Accounts",
8984 "group": "Desk_Accounts",
8985 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8987 "filename": "server/api/intDeskAccount/index.js",
8988 "groupTitle": "Desk_Accounts"
8992 "url": "/api/integrations/desk/accounts/{id}/configurations",
8993 "title": "Creates new configuration",
8996 "title": "Example usage:",
8997 "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",
9001 "name": "addConfiguration",
9002 "group": "Desk_Accounts",
9003 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9005 "filename": "server/api/intDeskAccount/index.js",
9006 "groupTitle": "Desk_Accounts"
9010 "url": "/api/integrations/desk/accounts/{id}/configurations",
9011 "title": "Gets account configurations",
9014 "title": "Example usage:",
9015 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9019 "name": "getConfigurations",
9020 "group": "Desk_Accounts",
9021 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9023 "filename": "server/api/intDeskAccount/index.js",
9024 "groupTitle": "Desk_Accounts"
9028 "url": "/api/integrations/desk/accounts/{id}/fields",
9029 "title": "Gets account fields",
9032 "title": "Example usage:",
9033 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
9037 "name": "getFields",
9038 "group": "Desk_Accounts",
9039 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9041 "filename": "server/api/intDeskAccount/index.js",
9042 "groupTitle": "Desk_Accounts"
9046 "url": "/api/integrations/desk/accounts/{id}",
9047 "title": "Update an existing Desk Account",
9050 "title": "Example usage:",
9051 "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",
9055 "name": "updateDesk_Accounts",
9056 "group": "Desk_Accounts",
9057 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9059 "filename": "server/api/intDeskAccount/index.js",
9060 "groupTitle": "Desk_Accounts"
9064 "url": "/api/integrations/desk/configurations",
9065 "title": "Creates a new Desk Configuration",
9068 "title": "Example usage:",
9069 "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",
9073 "name": "CreateDesk_Configurations",
9074 "group": "Desk_Configurations",
9089 "field": "description",
9095 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9097 "filename": "server/api/intDeskConfiguration/index.js",
9098 "groupTitle": "Desk_Configurations"
9102 "url": "/api/integrations/desk/configurations/{id}",
9103 "title": "Deletes a Desk Configuration",
9106 "title": "Example usage:",
9107 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
9111 "name": "DeleteDesk_Configurations",
9112 "group": "Desk_Configurations",
9113 "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>",
9115 "filename": "server/api/intDeskConfiguration/index.js",
9116 "groupTitle": "Desk_Configurations"
9120 "url": "/api/integrations/desk/configurations",
9121 "title": "Gets a list of Desk Configurations",
9124 "title": "Example usage:",
9125 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
9129 "name": "GetDesk_Configurations",
9130 "group": "Desk_Configurations",
9131 "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>",
9133 "filename": "server/api/intDeskConfiguration/index.js",
9134 "groupTitle": "Desk_Configurations"
9138 "url": "/api/integrations/desk/configurations/{id}",
9139 "title": "Gets a single Desk Configuration",
9142 "title": "Example usage:",
9143 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
9147 "name": "ShowDesk_Configurations",
9148 "group": "Desk_Configurations",
9149 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9151 "filename": "server/api/intDeskConfiguration/index.js",
9152 "groupTitle": "Desk_Configurations"
9156 "url": "/api/integrations/desk/configurations/{id}/descriptions",
9157 "title": "Gets configurations descriptions",
9160 "title": "Example usage:",
9161 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9165 "name": "getDescriptions",
9166 "group": "Desk_Configurations",
9167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9169 "filename": "server/api/intDeskConfiguration/index.js",
9170 "groupTitle": "Desk_Configurations"
9174 "url": "/api/integrations/desk/configurations/{id}/fields",
9175 "title": "Gets configurations fields",
9178 "title": "Example usage:",
9179 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
9183 "name": "getFields",
9184 "group": "Desk_Configurations",
9185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9187 "filename": "server/api/intDeskConfiguration/index.js",
9188 "groupTitle": "Desk_Configurations"
9192 "url": "/api/integrations/desk/configurations/{id}/subjects",
9193 "title": "Gets configurations subjects",
9196 "title": "Example usage:",
9197 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9201 "name": "getSubjects",
9202 "group": "Desk_Configurations",
9203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9205 "filename": "server/api/intDeskConfiguration/index.js",
9206 "groupTitle": "Desk_Configurations"
9210 "url": "/api/integrations/desk/configurations/{id}/tags",
9211 "title": "Gets configurations tags",
9214 "title": "Example usage:",
9215 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
9220 "group": "Desk_Configurations",
9221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9223 "filename": "server/api/intDeskConfiguration/index.js",
9224 "groupTitle": "Desk_Configurations"
9228 "url": "/api/integrations/desk/configurations/{id}/tags",
9229 "title": "Sets new tags",
9232 "title": "Example usage:",
9233 "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",
9238 "group": "Desk_Configurations",
9239 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9241 "filename": "server/api/intDeskConfiguration/index.js",
9242 "groupTitle": "Desk_Configurations"
9246 "url": "/api/integrations/desk/configurations/{id}",
9247 "title": "Update an existing Desk Configuration",
9250 "title": "Example usage:",
9251 "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",
9255 "name": "updateDesk_Configurations",
9256 "group": "Desk_Configurations",
9257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9259 "filename": "server/api/intDeskConfiguration/index.js",
9260 "groupTitle": "Desk_Configurations"
9264 "url": "/api/integrations/desk/fields",
9265 "title": "Creates a new Desk Field",
9268 "title": "Example usage:",
9269 "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",
9273 "name": "CreateDesk_Fields",
9274 "group": "Desk_Fields",
9284 "\"customVariable\"",
9312 "\"customVariable\""
9322 "field": "keyContent",
9336 "field": "nameField",
9343 "field": "customField",
9350 "field": "variableName",
9356 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9358 "filename": "server/api/intDeskField/index.js",
9359 "groupTitle": "Desk_Fields"
9363 "url": "/api/integrations/desk/fields/{id}",
9364 "title": "Deletes a Desk Field",
9367 "title": "Example usage:",
9368 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
9372 "name": "DeleteDesk_Fields",
9373 "group": "Desk_Fields",
9374 "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>",
9376 "filename": "server/api/intDeskField/index.js",
9377 "groupTitle": "Desk_Fields"
9381 "url": "/api/integrations/desk/fields",
9382 "title": "Gets a list of Desk Fields",
9385 "title": "Example usage:",
9386 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
9390 "name": "GetDesk_Fields",
9391 "group": "Desk_Fields",
9392 "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>",
9394 "filename": "server/api/intDeskField/index.js",
9395 "groupTitle": "Desk_Fields"
9399 "url": "/api/integrations/desk/fields/{id}",
9400 "title": "Gets a single Desk Field",
9403 "title": "Example usage:",
9404 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
9408 "name": "ShowDesk_Fields",
9409 "group": "Desk_Fields",
9410 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9412 "filename": "server/api/intDeskField/index.js",
9413 "groupTitle": "Desk_Fields"
9417 "url": "/api/integrations/desk/fields/{id}",
9418 "title": "Update an existing Desk Field",
9421 "title": "Example usage:",
9422 "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",
9426 "name": "updateDesk_Fields",
9427 "group": "Desk_Fields",
9428 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9430 "filename": "server/api/intDeskField/index.js",
9431 "groupTitle": "Desk_Fields"
9435 "url": "/api/dispositions",
9436 "title": "Creates a new Disposition",
9439 "title": "Example usage:",
9440 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9444 "name": "CreateDispositions",
9445 "group": "Dispositions",
9472 "field": "description",
9478 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9480 "filename": "server/api/disposition/index.js",
9481 "groupTitle": "Dispositions"
9485 "url": "/api/dispositions/{id}",
9486 "title": "Deletes a Disposition",
9489 "title": "Example usage:",
9490 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
9494 "name": "DeleteDispositions",
9495 "group": "Dispositions",
9496 "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>",
9498 "filename": "server/api/disposition/index.js",
9499 "groupTitle": "Dispositions"
9503 "url": "/api/dispositions",
9504 "title": "Gets a list of Dispositions",
9507 "title": "Example usage:",
9508 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
9512 "name": "GetDispositions",
9513 "group": "Dispositions",
9514 "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>",
9516 "filename": "server/api/disposition/index.js",
9517 "groupTitle": "Dispositions"
9521 "url": "/api/dispositions/{id}",
9522 "title": "Gets a single Disposition",
9525 "title": "Example usage:",
9526 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
9530 "name": "ShowDispositions",
9531 "group": "Dispositions",
9532 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9534 "filename": "server/api/disposition/index.js",
9535 "groupTitle": "Dispositions"
9539 "url": "/api/dispositions/{id}",
9540 "title": "Update an existing Disposition",
9543 "title": "Example usage:",
9544 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9548 "name": "updateDispositions",
9549 "group": "Dispositions",
9550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9552 "filename": "server/api/disposition/index.js",
9553 "groupTitle": "Dispositions"
9557 "url": "/api/integrations/dynamics365/accounts",
9558 "title": "Creates a new Dynamics365 Account",
9561 "title": "Example usage:",
9562 "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",
9566 "name": "CreateDynamics365_Accounts",
9567 "group": "Dynamics365_Accounts",
9582 "field": "username",
9589 "field": "password",
9596 "field": "remoteUri",
9603 "field": "tenantId",
9610 "field": "clientId",
9617 "field": "clientSecret",
9624 "field": "serverUrl",
9631 "field": "description",
9637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9639 "filename": "server/api/intDynamics365Account/index.js",
9640 "groupTitle": "Dynamics365_Accounts"
9644 "url": "/api/integrations/dynamics365/accounts/{id}",
9645 "title": "Deletes a Dynamics365 Account",
9648 "title": "Example usage:",
9649 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9653 "name": "DeleteDynamics365_Accounts",
9654 "group": "Dynamics365_Accounts",
9655 "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>",
9657 "filename": "server/api/intDynamics365Account/index.js",
9658 "groupTitle": "Dynamics365_Accounts"
9662 "url": "/api/integrations/dynamics365/accounts",
9663 "title": "Gets a list of Dynamics365 Accounts",
9666 "title": "Example usage:",
9667 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9671 "name": "GetDynamics365_Accounts",
9672 "group": "Dynamics365_Accounts",
9673 "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>",
9675 "filename": "server/api/intDynamics365Account/index.js",
9676 "groupTitle": "Dynamics365_Accounts"
9680 "url": "/api/integrations/dynamics365/accounts/{id}",
9681 "title": "Gets a single Dynamics365 Account",
9684 "title": "Example usage:",
9685 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9689 "name": "ShowDynamics365_Accounts",
9690 "group": "Dynamics365_Accounts",
9691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9693 "filename": "server/api/intDynamics365Account/index.js",
9694 "groupTitle": "Dynamics365_Accounts"
9698 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9699 "title": "Creates new configuration",
9702 "title": "Example usage:",
9703 "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",
9707 "name": "addConfiguration",
9708 "group": "Dynamics365_Accounts",
9709 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9711 "filename": "server/api/intDynamics365Account/index.js",
9712 "groupTitle": "Dynamics365_Accounts"
9716 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9717 "title": "Gets account configurations",
9720 "title": "Example usage:",
9721 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9725 "name": "getConfigurations",
9726 "group": "Dynamics365_Accounts",
9727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9729 "filename": "server/api/intDynamics365Account/index.js",
9730 "groupTitle": "Dynamics365_Accounts"
9734 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9735 "title": "Gets account fields",
9738 "title": "Example usage:",
9739 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9743 "name": "getFields",
9744 "group": "Dynamics365_Accounts",
9745 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9747 "filename": "server/api/intDynamics365Account/index.js",
9748 "groupTitle": "Dynamics365_Accounts"
9752 "url": "/api/integrations/dynamics365/accounts/{id}",
9753 "title": "Update an existing Dynamics365 Account",
9756 "title": "Example usage:",
9757 "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",
9761 "name": "updateDynamics365_Accounts",
9762 "group": "Dynamics365_Accounts",
9763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9765 "filename": "server/api/intDynamics365Account/index.js",
9766 "groupTitle": "Dynamics365_Accounts"
9770 "url": "/api/integrations/dynamics365/configurations",
9771 "title": "Creates a new Dynamics365 Configuration",
9774 "title": "Example usage:",
9775 "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",
9779 "name": "CreateDynamics365_Configurations",
9780 "group": "Dynamics365_Configurations",
9795 "field": "description",
9806 "field": "ticketType",
9812 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9814 "filename": "server/api/intDynamics365Configuration/index.js",
9815 "groupTitle": "Dynamics365_Configurations"
9819 "url": "/api/integrations/dynamics365/configurations/{id}",
9820 "title": "Deletes a Dynamics365 Configuration",
9823 "title": "Example usage:",
9824 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9828 "name": "DeleteDynamics365_Configurations",
9829 "group": "Dynamics365_Configurations",
9830 "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>",
9832 "filename": "server/api/intDynamics365Configuration/index.js",
9833 "groupTitle": "Dynamics365_Configurations"
9837 "url": "/api/integrations/dynamics365/configurations",
9838 "title": "Gets a list of Dynamics365 Configurations",
9841 "title": "Example usage:",
9842 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9846 "name": "GetDynamics365_Configurations",
9847 "group": "Dynamics365_Configurations",
9848 "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>",
9850 "filename": "server/api/intDynamics365Configuration/index.js",
9851 "groupTitle": "Dynamics365_Configurations"
9855 "url": "/api/integrations/dynamics365/configurations/{id}",
9856 "title": "Gets a single Dynamics365 Configuration",
9859 "title": "Example usage:",
9860 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9864 "name": "ShowDynamics365_Configurations",
9865 "group": "Dynamics365_Configurations",
9866 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9868 "filename": "server/api/intDynamics365Configuration/index.js",
9869 "groupTitle": "Dynamics365_Configurations"
9873 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9874 "title": "Gets configurations descriptions",
9877 "title": "Example usage:",
9878 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9882 "name": "getDescriptions",
9883 "group": "Dynamics365_Configurations",
9884 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9886 "filename": "server/api/intDynamics365Configuration/index.js",
9887 "groupTitle": "Dynamics365_Configurations"
9891 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9892 "title": "Gets configurations fields",
9895 "title": "Example usage:",
9896 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9900 "name": "getFields",
9901 "group": "Dynamics365_Configurations",
9902 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9904 "filename": "server/api/intDynamics365Configuration/index.js",
9905 "groupTitle": "Dynamics365_Configurations"
9909 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9910 "title": "Gets configurations subjects",
9913 "title": "Example usage:",
9914 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9918 "name": "getSubjects",
9919 "group": "Dynamics365_Configurations",
9920 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9922 "filename": "server/api/intDynamics365Configuration/index.js",
9923 "groupTitle": "Dynamics365_Configurations"
9927 "url": "/api/integrations/dynamics365/configurations/{id}",
9928 "title": "Update an existing Dynamics365 Configuration",
9931 "title": "Example usage:",
9932 "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",
9936 "name": "updateDynamics365_Configurations",
9937 "group": "Dynamics365_Configurations",
9938 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9940 "filename": "server/api/intDynamics365Configuration/index.js",
9941 "groupTitle": "Dynamics365_Configurations"
9945 "url": "/api/integrations/dynamics365/fields",
9946 "title": "Creates a new Dynamics365 Field",
9949 "title": "Example usage:",
9950 "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",
9954 "name": "CreateDynamics365_Fields",
9955 "group": "Dynamics365_Fields",
9965 "\"customVariable\"",
9993 "\"customVariable\""
10003 "field": "keyContent",
10010 "field": "idField",
10017 "field": "nameField",
10024 "field": "customField",
10031 "field": "variableName",
10037 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10038 "version": "0.0.0",
10039 "filename": "server/api/intDynamics365Field/index.js",
10040 "groupTitle": "Dynamics365_Fields"
10044 "url": "/api/integrations/dynamics365/fields/{id}",
10045 "title": "Deletes a Dynamics365 Field",
10048 "title": "Example usage:",
10049 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
10053 "name": "DeleteDynamics365_Fields",
10054 "group": "Dynamics365_Fields",
10055 "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>",
10056 "version": "0.0.0",
10057 "filename": "server/api/intDynamics365Field/index.js",
10058 "groupTitle": "Dynamics365_Fields"
10062 "url": "/api/integrations/dynamics365/fields",
10063 "title": "Gets a list of Dynamics365 Fields",
10066 "title": "Example usage:",
10067 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
10071 "name": "GetDynamics365_Fields",
10072 "group": "Dynamics365_Fields",
10073 "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>",
10074 "version": "0.0.0",
10075 "filename": "server/api/intDynamics365Field/index.js",
10076 "groupTitle": "Dynamics365_Fields"
10080 "url": "/api/integrations/dynamics365/fields/{id}",
10081 "title": "Gets a single Dynamics365 Field",
10084 "title": "Example usage:",
10085 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
10089 "name": "ShowDynamics365_Fields",
10090 "group": "Dynamics365_Fields",
10091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10092 "version": "0.0.0",
10093 "filename": "server/api/intDynamics365Field/index.js",
10094 "groupTitle": "Dynamics365_Fields"
10098 "url": "/api/integrations/dynamics365/fields/{id}",
10099 "title": "Update an existing Dynamics365 Field",
10102 "title": "Example usage:",
10103 "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",
10107 "name": "updateDynamics365_Fields",
10108 "group": "Dynamics365_Fields",
10109 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10110 "version": "0.0.0",
10111 "filename": "server/api/intDynamics365Field/index.js",
10112 "groupTitle": "Dynamics365_Fields"
10116 "url": "/api/fax/accounts/{id}/users",
10117 "title": "Add agents to a fax account",
10120 "title": "Example usage:",
10121 "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",
10125 "name": "AddAgents",
10126 "group": "Fax_Accounts",
10127 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10128 "version": "0.0.0",
10129 "filename": "server/api/faxAccount/index.js",
10130 "groupTitle": "Fax_Accounts"
10134 "url": "/api/fax/accounts",
10135 "title": "Creates a new Account",
10138 "title": "Example usage:",
10139 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10143 "name": "CreateAccounts",
10144 "group": "Fax_Accounts",
10159 "field": "description",
10177 "field": "headerinfo",
10184 "field": "localstationid",
10199 "field": "minrate",
10214 "field": "maxrate",
10228 "field": "gateway",
10235 "field": "faxdetect",
10242 "field": "t38timeout",
10269 "field": "notificationTemplate",
10276 "field": "notificationSound",
10283 "field": "notificationShake",
10290 "field": "waitForTheAssignedAgent",
10297 "field": "queueTransfer",
10304 "field": "queueTransferTimeout",
10311 "field": "agentTransfer",
10318 "field": "agentTransferTimeout",
10325 "field": "mandatoryDispositionPauseId",
10326 "description": "<p>Status to put when mandatory disposition is enabled</p>"
10332 "field": "mandatoryDisposition",
10333 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
10338 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10339 "version": "0.0.0",
10340 "filename": "server/api/faxAccount/index.js",
10341 "groupTitle": "Fax_Accounts"
10345 "url": "/api/fax/accounts/{id}",
10346 "title": "Deletes a Account",
10349 "title": "Example usage:",
10350 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
10354 "name": "DeleteAccounts",
10355 "group": "Fax_Accounts",
10356 "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>",
10357 "version": "0.0.0",
10358 "filename": "server/api/faxAccount/index.js",
10359 "groupTitle": "Fax_Accounts"
10363 "url": "/api/fax/accounts/describe",
10364 "title": "Gets table info about Accounts",
10367 "title": "Example usage:",
10368 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
10372 "name": "DescribeAccounts",
10373 "group": "Fax_Accounts",
10374 "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>",
10375 "version": "0.0.0",
10376 "filename": "server/api/faxAccount/index.js",
10377 "groupTitle": "Fax_Accounts"
10381 "url": "/api/fax/accounts",
10382 "title": "Gets a list of Accounts",
10385 "title": "Example usage:",
10386 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
10390 "name": "GetAccounts",
10391 "group": "Fax_Accounts",
10392 "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>",
10393 "version": "0.0.0",
10394 "filename": "server/api/faxAccount/index.js",
10395 "groupTitle": "Fax_Accounts"
10399 "url": "/api/fax/accounts/{id}/users",
10400 "title": "Gets agents from fax account",
10403 "title": "Example usage:",
10404 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
10408 "name": "GetAgents",
10409 "group": "Fax_Accounts",
10410 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10411 "version": "0.0.0",
10412 "filename": "server/api/faxAccount/index.js",
10413 "groupTitle": "Fax_Accounts"
10417 "url": "/api/fax/accounts/{id}/users",
10418 "title": "Removes agents from a fax account",
10421 "title": "Example usage:",
10422 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10426 "name": "RemoveAgents",
10427 "group": "Fax_Accounts",
10428 "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>",
10429 "version": "0.0.0",
10430 "filename": "server/api/faxAccount/index.js",
10431 "groupTitle": "Fax_Accounts"
10435 "url": "/api/fax/accounts/{id}/canned_answers",
10436 "title": "Removes canned answers from account",
10439 "title": "Example usage:",
10440 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10444 "name": "RemoveAnswers",
10445 "group": "Fax_Accounts",
10446 "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>",
10447 "version": "0.0.0",
10448 "filename": "server/api/faxAccount/index.js",
10449 "groupTitle": "Fax_Accounts"
10453 "url": "/api/fax/accounts/{id}/dispositions",
10454 "title": "Removes dispositions from account",
10457 "title": "Example usage:",
10458 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10462 "name": "RemoveDispositions",
10463 "group": "Fax_Accounts",
10464 "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>",
10465 "version": "0.0.0",
10466 "filename": "server/api/faxAccount/index.js",
10467 "groupTitle": "Fax_Accounts"
10471 "url": "/api/fax/accounts/{id}",
10472 "title": "Gets a single Account",
10475 "title": "Example usage:",
10476 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
10480 "name": "ShowAccounts",
10481 "group": "Fax_Accounts",
10482 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10483 "version": "0.0.0",
10484 "filename": "server/api/faxAccount/index.js",
10485 "groupTitle": "Fax_Accounts"
10489 "url": "/api/fax/accounts/{id}/canned_answers",
10490 "title": "Creates new canned answer",
10493 "title": "Example usage:",
10494 "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",
10498 "name": "addAnswer",
10499 "group": "Fax_Accounts",
10521 "field": "description",
10534 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10535 "version": "0.0.0",
10536 "filename": "server/api/faxAccount/index.js",
10537 "groupTitle": "Fax_Accounts"
10541 "url": "/api/fax/accounts/addaccountapplications",
10542 "title": "Creates new account and applications",
10545 "title": "Example usage:",
10546 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10550 "name": "addApplications",
10551 "group": "Fax_Accounts",
10559 "field": "priority",
10573 "field": "appdata",
10580 "field": "description",
10587 "field": "interval",
10593 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10594 "version": "0.0.0",
10595 "filename": "server/api/faxAccount/index.js",
10596 "groupTitle": "Fax_Accounts"
10600 "url": "/api/fax/accounts/{id}/applications",
10601 "title": "Creates new applications",
10604 "title": "Example usage:",
10605 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10609 "name": "addApplications",
10610 "group": "Fax_Accounts",
10618 "field": "priority",
10632 "field": "appdata",
10639 "field": "description",
10646 "field": "interval",
10652 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10653 "version": "0.0.0",
10654 "filename": "server/api/faxAccount/index.js",
10655 "groupTitle": "Fax_Accounts"
10659 "url": "/api/fax/accounts/{id}/dispositions",
10660 "title": "Creates new disposition",
10663 "title": "Example usage:",
10664 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10668 "name": "addDisposition",
10669 "group": "Fax_Accounts",
10696 "field": "description",
10702 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10703 "version": "0.0.0",
10704 "filename": "server/api/faxAccount/index.js",
10705 "groupTitle": "Fax_Accounts"
10709 "url": "/api/fax/accounts/{id}/interactions",
10710 "title": "Creates new interactions",
10713 "title": "Example usage:",
10714 "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",
10718 "name": "addInteraction",
10719 "group": "Fax_Accounts",
10734 "field": "closedAt",
10741 "field": "disposition",
10748 "field": "secondDisposition",
10755 "field": "thirdDisposition",
10769 "field": "read1stAt",
10787 "field": "firstMsgDirection",
10794 "field": "lastMsgAt",
10805 "field": "lastMsgDirection",
10811 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10812 "version": "0.0.0",
10813 "filename": "server/api/faxAccount/index.js",
10814 "groupTitle": "Fax_Accounts"
10818 "url": "/api/fax/accounts/{id}/canned_answers",
10819 "title": "Gets account canned answers",
10822 "title": "Example usage:",
10823 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10827 "name": "getAnswers",
10828 "group": "Fax_Accounts",
10829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10830 "version": "0.0.0",
10831 "filename": "server/api/faxAccount/index.js",
10832 "groupTitle": "Fax_Accounts"
10836 "url": "/api/fax/accounts/{id}/applications",
10837 "title": "Gets account pplications",
10840 "title": "Example usage:",
10841 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10845 "name": "getApplications",
10846 "group": "Fax_Accounts",
10847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10848 "version": "0.0.0",
10849 "filename": "server/api/faxAccount/index.js",
10850 "groupTitle": "Fax_Accounts"
10854 "url": "/api/fax/accounts/{id}/dispositions",
10855 "title": "Gets account dispositions",
10858 "title": "Example usage:",
10859 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10863 "name": "getDispositions",
10864 "group": "Fax_Accounts",
10865 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10866 "version": "0.0.0",
10867 "filename": "server/api/faxAccount/index.js",
10868 "groupTitle": "Fax_Accounts"
10872 "url": "/api/fax/accounts/{id}/interactions",
10873 "title": "Gets account interactions",
10876 "title": "Example usage:",
10877 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10881 "name": "getInteraction",
10882 "group": "Fax_Accounts",
10883 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10884 "version": "0.0.0",
10885 "filename": "server/api/faxAccount/index.js",
10886 "groupTitle": "Fax_Accounts"
10890 "url": "/api/fax/accounts/{id}/messages",
10891 "title": "Gets account messages",
10894 "title": "Example usage:",
10895 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10899 "name": "getMessages",
10900 "group": "Fax_Accounts",
10901 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10902 "version": "0.0.0",
10903 "filename": "server/api/faxAccount/index.js",
10904 "groupTitle": "Fax_Accounts"
10908 "url": "/api/fax/accounts/{id}/send",
10909 "title": "Send new fax",
10912 "title": "Example usage:",
10913 "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",
10918 "group": "Fax_Accounts",
10919 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10920 "version": "0.0.0",
10921 "filename": "server/api/faxAccount/index.js",
10922 "groupTitle": "Fax_Accounts"
10926 "url": "/api/fax/accounts/{id}",
10927 "title": "Update an existing Account",
10930 "title": "Example usage:",
10931 "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",
10935 "name": "updateAccounts",
10936 "group": "Fax_Accounts",
10937 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10938 "version": "0.0.0",
10939 "filename": "server/api/faxAccount/index.js",
10940 "groupTitle": "Fax_Accounts"
10944 "url": "/api/fax/accounts/updateaccountapplications",
10945 "title": "Update account and applications",
10948 "title": "Example usage:",
10949 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10953 "name": "updateApplications",
10954 "group": "Fax_Accounts",
10962 "field": "priority",
10976 "field": "appdata",
10983 "field": "description",
10990 "field": "interval",
10996 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10997 "version": "0.0.0",
10998 "filename": "server/api/faxAccount/index.js",
10999 "groupTitle": "Fax_Accounts"
11003 "url": "/api/fax/applications",
11004 "title": "Creates a new Application",
11007 "title": "Example usage:",
11008 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11012 "name": "CreateApplications",
11013 "group": "Fax_Applications",
11021 "field": "priority",
11035 "field": "appdata",
11042 "field": "description",
11049 "field": "interval",
11055 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11056 "version": "0.0.0",
11057 "filename": "server/api/faxApplication/index.js",
11058 "groupTitle": "Fax_Applications"
11062 "url": "/api/fax/applications/{id}",
11063 "title": "Deletes a Application",
11066 "title": "Example usage:",
11067 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
11071 "name": "DeleteApplications",
11072 "group": "Fax_Applications",
11073 "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>",
11074 "version": "0.0.0",
11075 "filename": "server/api/faxApplication/index.js",
11076 "groupTitle": "Fax_Applications"
11080 "url": "/api/fax/applications",
11081 "title": "Gets a list of Applications",
11084 "title": "Example usage:",
11085 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
11089 "name": "GetApplications",
11090 "group": "Fax_Applications",
11091 "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>",
11092 "version": "0.0.0",
11093 "filename": "server/api/faxApplication/index.js",
11094 "groupTitle": "Fax_Applications"
11098 "url": "/api/fax/applications/{id}",
11099 "title": "Gets a single Application",
11102 "title": "Example usage:",
11103 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
11107 "name": "ShowApplications",
11108 "group": "Fax_Applications",
11109 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11110 "version": "0.0.0",
11111 "filename": "server/api/faxApplication/index.js",
11112 "groupTitle": "Fax_Applications"
11116 "url": "/api/fax/applications/{id}",
11117 "title": "Update an existing Application",
11120 "title": "Example usage:",
11121 "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",
11125 "name": "updateApplications",
11126 "group": "Fax_Applications",
11127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11128 "version": "0.0.0",
11129 "filename": "server/api/faxApplication/index.js",
11130 "groupTitle": "Fax_Applications"
11134 "url": "/api/fax/interactions/{id}/tags",
11135 "title": "Add tags to the interaction",
11138 "title": "Example usage:",
11139 "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",
11144 "group": "Fax_Interactions",
11145 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11146 "version": "0.0.0",
11147 "filename": "server/api/faxInteraction/index.js",
11148 "groupTitle": "Fax_Interactions"
11152 "url": "/api/fax/interactions",
11153 "title": "Creates a new Interaction",
11156 "title": "Example usage:",
11157 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11161 "name": "CreateInteractions",
11162 "group": "Fax_Interactions",
11177 "field": "closedAt",
11184 "field": "disposition",
11191 "field": "secondDisposition",
11198 "field": "thirdDisposition",
11212 "field": "read1stAt",
11230 "field": "firstMsgDirection",
11237 "field": "lastMsgAt",
11248 "field": "lastMsgDirection",
11254 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11255 "version": "0.0.0",
11256 "filename": "server/api/faxInteraction/index.js",
11257 "groupTitle": "Fax_Interactions"
11261 "url": "/api/fax/interactions/{id}",
11262 "title": "Deletes a Interaction",
11265 "title": "Example usage:",
11266 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
11270 "name": "DeleteInteractions",
11271 "group": "Fax_Interactions",
11272 "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>",
11273 "version": "0.0.0",
11274 "filename": "server/api/faxInteraction/index.js",
11275 "groupTitle": "Fax_Interactions"
11279 "url": "/api/fax/interactions/describe",
11280 "title": "Gets table info about Interactions",
11283 "title": "Example usage:",
11284 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
11288 "name": "DescribeInteractions",
11289 "group": "Fax_Interactions",
11290 "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>",
11291 "version": "0.0.0",
11292 "filename": "server/api/faxInteraction/index.js",
11293 "groupTitle": "Fax_Interactions"
11297 "url": "/api/fax/interactions",
11298 "title": "Gets a list of Interactions",
11301 "title": "Example usage:",
11302 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
11306 "name": "GetInteractions",
11307 "group": "Fax_Interactions",
11308 "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>",
11309 "version": "0.0.0",
11310 "filename": "server/api/faxInteraction/index.js",
11311 "groupTitle": "Fax_Interactions"
11315 "url": "/api/fax/interactions/{id}/tags",
11316 "title": "Removes tags from interaction",
11319 "title": "Example usage:",
11320 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11324 "name": "RemoveTags",
11325 "group": "Fax_Interactions",
11326 "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>",
11327 "version": "0.0.0",
11328 "filename": "server/api/faxInteraction/index.js",
11329 "groupTitle": "Fax_Interactions"
11333 "url": "/api/fax/interactions/{id}",
11334 "title": "Gets a single Interaction",
11337 "title": "Example usage:",
11338 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
11342 "name": "ShowInteractions",
11343 "group": "Fax_Interactions",
11344 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11345 "version": "0.0.0",
11346 "filename": "server/api/faxInteraction/index.js",
11347 "groupTitle": "Fax_Interactions"
11351 "url": "/api/fax/interactions/{id}/messages",
11352 "title": "Creates new messages",
11355 "title": "Example usage:",
11356 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11360 "name": "addMessage",
11361 "group": "Fax_Interactions",
11387 "field": "direction",
11394 "field": "failMessage",
11407 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11408 "version": "0.0.0",
11409 "filename": "server/api/faxInteraction/index.js",
11410 "groupTitle": "Fax_Interactions"
11414 "url": "/api/fax/interactions/{id}/download",
11415 "title": "Get interactions",
11418 "title": "Example usage:",
11419 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
11423 "name": "download",
11424 "group": "Fax_Interactions",
11425 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11426 "version": "0.0.0",
11427 "filename": "server/api/faxInteraction/index.js",
11428 "groupTitle": "Fax_Interactions"
11432 "url": "/api/fax/interactions/{id}/messages",
11433 "title": "Gets interaction messages",
11436 "title": "Example usage:",
11437 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
11441 "name": "getMessages",
11442 "group": "Fax_Interactions",
11443 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11444 "version": "0.0.0",
11445 "filename": "server/api/faxInteraction/index.js",
11446 "groupTitle": "Fax_Interactions"
11450 "url": "/api/fax/interactions/{id}",
11451 "title": "Update an existing Interaction",
11454 "title": "Example usage:",
11455 "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",
11459 "name": "updateInteractions",
11460 "group": "Fax_Interactions",
11461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11462 "version": "0.0.0",
11463 "filename": "server/api/faxInteraction/index.js",
11464 "groupTitle": "Fax_Interactions"
11468 "url": "/api/fax/messages/{id}/download",
11469 "title": "Get message",
11472 "title": "Example usage:",
11473 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
11477 "name": "download",
11478 "group": "Fax_Message",
11479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11480 "version": "0.0.0",
11481 "filename": "server/api/faxMessage/index.js",
11482 "groupTitle": "Fax_Message"
11486 "url": "/api/fax/messages/{id}",
11487 "title": "Deletes a Message",
11490 "title": "Example usage:",
11491 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
11495 "name": "DeleteMessages",
11496 "group": "Fax_Messages",
11497 "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>",
11498 "version": "0.0.0",
11499 "filename": "server/api/faxMessage/index.js",
11500 "groupTitle": "Fax_Messages"
11504 "url": "/api/fax/messages/describe",
11505 "title": "Gets table info about Messages",
11508 "title": "Example usage:",
11509 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
11513 "name": "DescribeMessages",
11514 "group": "Fax_Messages",
11515 "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>",
11516 "version": "0.0.0",
11517 "filename": "server/api/faxMessage/index.js",
11518 "groupTitle": "Fax_Messages"
11522 "url": "/api/fax/messages",
11523 "title": "Gets a list of Messages",
11526 "title": "Example usage:",
11527 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
11531 "name": "GetMessages",
11532 "group": "Fax_Messages",
11533 "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>",
11534 "version": "0.0.0",
11535 "filename": "server/api/faxMessage/index.js",
11536 "groupTitle": "Fax_Messages"
11540 "url": "/api/fax/messages/{id}",
11541 "title": "Gets a single Message",
11544 "title": "Example usage:",
11545 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
11549 "name": "ShowMessages",
11550 "group": "Fax_Messages",
11551 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11552 "version": "0.0.0",
11553 "filename": "server/api/faxMessage/index.js",
11554 "groupTitle": "Fax_Messages"
11558 "url": "/api/fax/messages/{id}/accept",
11559 "title": "Accepts message",
11562 "title": "Example usage:",
11563 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11567 "name": "acceptMessage",
11568 "group": "Fax_Messages",
11569 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11570 "version": "0.0.0",
11571 "filename": "server/api/faxMessage/index.js",
11572 "groupTitle": "Fax_Messages"
11576 "url": "/api/fax/messages",
11577 "title": "Create message and send Fax",
11580 "title": "Example usage:",
11581 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11585 "name": "rejectMessage",
11586 "group": "Fax_Messages",
11587 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11588 "version": "0.0.0",
11589 "filename": "server/api/faxMessage/index.js",
11590 "groupTitle": "Fax_Messages"
11594 "url": "/api/fax/messages/{id}/reject",
11595 "title": "Rejects message",
11598 "title": "Example usage:",
11599 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11603 "name": "rejectMessage",
11604 "group": "Fax_Messages",
11605 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11606 "version": "0.0.0",
11607 "filename": "server/api/faxMessage/index.js",
11608 "groupTitle": "Fax_Messages"
11612 "url": "/api/fax/messages/{id}",
11613 "title": "Update an existing Message",
11616 "title": "Example usage:",
11617 "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",
11621 "name": "updateMessages",
11622 "group": "Fax_Messages",
11623 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11624 "version": "0.0.0",
11625 "filename": "server/api/faxMessage/index.js",
11626 "groupTitle": "Fax_Messages"
11630 "url": "/api/fax/reports/queue",
11631 "title": "Creates a new Fax Queue Report",
11634 "title": "Example usage:",
11635 "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",
11639 "name": "CreateFax_Queue_Reports",
11640 "group": "Fax_Queue_Reports",
11648 "field": "uniqueid",
11669 "field": "leaveAt",
11676 "field": "acceptAt",
11696 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11697 "version": "0.0.0",
11698 "filename": "server/api/faxQueueReport/index.js",
11699 "groupTitle": "Fax_Queue_Reports"
11703 "url": "/api/fax/reports/queue/{id}",
11704 "title": "Deletes a Fax Queue Report",
11707 "title": "Example usage:",
11708 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11712 "name": "DeleteFax_Queue_Reports",
11713 "group": "Fax_Queue_Reports",
11714 "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>",
11715 "version": "0.0.0",
11716 "filename": "server/api/faxQueueReport/index.js",
11717 "groupTitle": "Fax_Queue_Reports"
11721 "url": "/api/fax/reports/queue/describe",
11722 "title": "Gets table info about Fax Queue Reports",
11725 "title": "Example usage:",
11726 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11730 "name": "DescribeFax_Queue_Reports",
11731 "group": "Fax_Queue_Reports",
11732 "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>",
11733 "version": "0.0.0",
11734 "filename": "server/api/faxQueueReport/index.js",
11735 "groupTitle": "Fax_Queue_Reports"
11739 "url": "/api/fax/reports/queue",
11740 "title": "Gets a list of Fax Queue Reports",
11743 "title": "Example usage:",
11744 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11748 "name": "GetFax_Queue_Reports",
11749 "group": "Fax_Queue_Reports",
11750 "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>",
11751 "version": "0.0.0",
11752 "filename": "server/api/faxQueueReport/index.js",
11753 "groupTitle": "Fax_Queue_Reports"
11757 "url": "/api/fax/reports/queue/{id}",
11758 "title": "Gets a single Fax Queue Report",
11761 "title": "Example usage:",
11762 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11766 "name": "ShowFax_Queue_Reports",
11767 "group": "Fax_Queue_Reports",
11768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11769 "version": "0.0.0",
11770 "filename": "server/api/faxQueueReport/index.js",
11771 "groupTitle": "Fax_Queue_Reports"
11775 "url": "/api/fax/reports/queue/{id}",
11776 "title": "Update an existing Fax Queue Report",
11779 "title": "Example usage:",
11780 "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",
11784 "name": "updateFax_Queue_Reports",
11785 "group": "Fax_Queue_Reports",
11786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11787 "version": "0.0.0",
11788 "filename": "server/api/faxQueueReport/index.js",
11789 "groupTitle": "Fax_Queue_Reports"
11793 "url": "/api/fax/queues/{id}/users",
11794 "title": "Add agents to a queue",
11797 "title": "Example usage:",
11798 "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",
11802 "name": "AddAgents",
11803 "group": "Fax_Queues",
11804 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11805 "version": "0.0.0",
11806 "filename": "server/api/faxQueue/index.js",
11807 "groupTitle": "Fax_Queues"
11811 "url": "/api/fax/queues/{id}/teams",
11812 "title": "Add teams to a queue",
11815 "title": "Example usage:",
11816 "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",
11820 "name": "AddTeams",
11821 "group": "Fax_Queues",
11822 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11823 "version": "0.0.0",
11824 "filename": "server/api/faxQueue/index.js",
11825 "groupTitle": "Fax_Queues"
11829 "url": "/api/fax/queues",
11830 "title": "Creates a new Queue",
11833 "title": "Example usage:",
11834 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11838 "name": "CreateQueues",
11839 "group": "Fax_Queues",
11854 "field": "description",
11861 "field": "timeout",
11873 "field": "strategy",
11880 "field": "lastAgent",
11886 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11887 "version": "0.0.0",
11888 "filename": "server/api/faxQueue/index.js",
11889 "groupTitle": "Fax_Queues"
11893 "url": "/api/fax/queues/{id}",
11894 "title": "Deletes a Queue",
11897 "title": "Example usage:",
11898 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11902 "name": "DeleteQueues",
11903 "group": "Fax_Queues",
11904 "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>",
11905 "version": "0.0.0",
11906 "filename": "server/api/faxQueue/index.js",
11907 "groupTitle": "Fax_Queues"
11911 "url": "/api/fax/queues/describe",
11912 "title": "Gets table info about Queues",
11915 "title": "Example usage:",
11916 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11920 "name": "DescribeQueues",
11921 "group": "Fax_Queues",
11922 "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>",
11923 "version": "0.0.0",
11924 "filename": "server/api/faxQueue/index.js",
11925 "groupTitle": "Fax_Queues"
11929 "url": "/api/fax/queues/{id}/users",
11930 "title": "Gets queue agents",
11933 "title": "Example usage:",
11934 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11938 "name": "GetAgents",
11939 "group": "Fax_Queues",
11940 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11941 "version": "0.0.0",
11942 "filename": "server/api/faxQueue/index.js",
11943 "groupTitle": "Fax_Queues"
11947 "url": "/api/fax/queues/{id}/members",
11948 "title": "GetMembers",
11951 "title": "Example usage:",
11952 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11956 "name": "GetMembers",
11957 "group": "Fax_Queues",
11958 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11959 "version": "0.0.0",
11960 "filename": "server/api/faxQueue/index.js",
11961 "groupTitle": "Fax_Queues"
11965 "url": "/api/fax/queues",
11966 "title": "Gets a list of Queues",
11969 "title": "Example usage:",
11970 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11974 "name": "GetQueues",
11975 "group": "Fax_Queues",
11976 "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>",
11977 "version": "0.0.0",
11978 "filename": "server/api/faxQueue/index.js",
11979 "groupTitle": "Fax_Queues"
11983 "url": "/api/fax/queues/{id}/teams",
11984 "title": "Gets queues list",
11987 "title": "Example usage:",
11988 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11992 "name": "GetTeams",
11993 "group": "Fax_Queues",
11994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11995 "version": "0.0.0",
11996 "filename": "server/api/faxQueue/index.js",
11997 "groupTitle": "Fax_Queues"
12001 "url": "/api/fax/queues/{id}/users",
12002 "title": "Removes agents from a queue",
12005 "title": "Example usage:",
12006 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12010 "name": "RemoveAgents",
12011 "group": "Fax_Queues",
12012 "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>",
12013 "version": "0.0.0",
12014 "filename": "server/api/faxQueue/index.js",
12015 "groupTitle": "Fax_Queues"
12019 "url": "/api/fax/queues/{id}",
12020 "title": "Gets a single Queue",
12023 "title": "Example usage:",
12024 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
12028 "name": "ShowQueues",
12029 "group": "Fax_Queues",
12030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12031 "version": "0.0.0",
12032 "filename": "server/api/faxQueue/index.js",
12033 "groupTitle": "Fax_Queues"
12037 "url": "/api/fax/queues/{id}",
12038 "title": "Update an existing Queue",
12041 "title": "Example usage:",
12042 "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",
12046 "name": "updateQueues",
12047 "group": "Fax_Queues",
12048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12049 "version": "0.0.0",
12050 "filename": "server/api/faxQueue/index.js",
12051 "groupTitle": "Fax_Queues"
12055 "url": "/api/fax/reports/transfer",
12056 "title": "Creates a new Fax Transfer Report",
12059 "title": "Example usage:",
12060 "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",
12064 "name": "CreateFax_Transfer_Reports",
12065 "group": "Fax_Transfer_Reports",
12073 "field": "uniqueid",
12092 "field": "transferredAt",
12098 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12099 "version": "0.0.0",
12100 "filename": "server/api/faxTransferReport/index.js",
12101 "groupTitle": "Fax_Transfer_Reports"
12105 "url": "/api/fax/reports/transfer/{id}",
12106 "title": "Deletes a Fax Transfer Report",
12109 "title": "Example usage:",
12110 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
12114 "name": "DeleteFax_Transfer_Reports",
12115 "group": "Fax_Transfer_Reports",
12116 "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>",
12117 "version": "0.0.0",
12118 "filename": "server/api/faxTransferReport/index.js",
12119 "groupTitle": "Fax_Transfer_Reports"
12123 "url": "/api/fax/reports/transfer/describe",
12124 "title": "Gets table info about Fax Transfer Reports",
12127 "title": "Example usage:",
12128 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
12132 "name": "DescribeFax_Transfer_Reports",
12133 "group": "Fax_Transfer_Reports",
12134 "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>",
12135 "version": "0.0.0",
12136 "filename": "server/api/faxTransferReport/index.js",
12137 "groupTitle": "Fax_Transfer_Reports"
12141 "url": "/api/fax/reports/transfer",
12142 "title": "Gets a list of Fax Transfer Reports",
12145 "title": "Example usage:",
12146 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
12150 "name": "GetFax_Transfer_Reports",
12151 "group": "Fax_Transfer_Reports",
12152 "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>",
12153 "version": "0.0.0",
12154 "filename": "server/api/faxTransferReport/index.js",
12155 "groupTitle": "Fax_Transfer_Reports"
12159 "url": "/api/fax/reports/transfer/{id}",
12160 "title": "Gets a single Fax Transfer Report",
12163 "title": "Example usage:",
12164 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
12168 "name": "ShowFax_Transfer_Reports",
12169 "group": "Fax_Transfer_Reports",
12170 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12171 "version": "0.0.0",
12172 "filename": "server/api/faxTransferReport/index.js",
12173 "groupTitle": "Fax_Transfer_Reports"
12177 "url": "/api/fax/reports/transfer/{id}",
12178 "title": "Update an existing Fax Transfer Report",
12181 "title": "Example usage:",
12182 "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",
12186 "name": "updateFax_Transfer_Reports",
12187 "group": "Fax_Transfer_Reports",
12188 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12189 "version": "0.0.0",
12190 "filename": "server/api/faxTransferReport/index.js",
12191 "groupTitle": "Fax_Transfer_Reports"
12195 "url": "/api/integrations/freshdesk/accounts",
12196 "title": "Creates a new Freshdesk Account",
12199 "title": "Example usage:",
12200 "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",
12204 "name": "CreateFreshdesk_Accounts",
12205 "group": "Freshdesk_Accounts",
12220 "field": "description",
12227 "field": "username",
12241 "field": "remoteUri",
12248 "field": "serverUrl",
12254 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12255 "version": "0.0.0",
12256 "filename": "server/api/intFreshdeskAccount/index.js",
12257 "groupTitle": "Freshdesk_Accounts"
12261 "url": "/api/integrations/freshdesk/accounts/{id}",
12262 "title": "Deletes a Freshdesk Account",
12265 "title": "Example usage:",
12266 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
12270 "name": "DeleteFreshdesk_Accounts",
12271 "group": "Freshdesk_Accounts",
12272 "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>",
12273 "version": "0.0.0",
12274 "filename": "server/api/intFreshdeskAccount/index.js",
12275 "groupTitle": "Freshdesk_Accounts"
12279 "url": "/api/integrations/freshdesk/accounts",
12280 "title": "Gets a list of Freshdesk Accounts",
12283 "title": "Example usage:",
12284 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
12288 "name": "GetFreshdesk_Accounts",
12289 "group": "Freshdesk_Accounts",
12290 "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>",
12291 "version": "0.0.0",
12292 "filename": "server/api/intFreshdeskAccount/index.js",
12293 "groupTitle": "Freshdesk_Accounts"
12297 "url": "/api/integrations/freshdesk/accounts/{id}",
12298 "title": "Gets a single Freshdesk Account",
12301 "title": "Example usage:",
12302 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
12306 "name": "ShowFreshdesk_Accounts",
12307 "group": "Freshdesk_Accounts",
12308 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12309 "version": "0.0.0",
12310 "filename": "server/api/intFreshdeskAccount/index.js",
12311 "groupTitle": "Freshdesk_Accounts"
12315 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12316 "title": "Creates new configuration",
12319 "title": "Example usage:",
12320 "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",
12324 "name": "addConfiguration",
12325 "group": "Freshdesk_Accounts",
12326 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12327 "version": "0.0.0",
12328 "filename": "server/api/intFreshdeskAccount/index.js",
12329 "groupTitle": "Freshdesk_Accounts"
12333 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12334 "title": "Gets account configurations",
12337 "title": "Example usage:",
12338 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12342 "name": "getConfigurations",
12343 "group": "Freshdesk_Accounts",
12344 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12345 "version": "0.0.0",
12346 "filename": "server/api/intFreshdeskAccount/index.js",
12347 "groupTitle": "Freshdesk_Accounts"
12351 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
12352 "title": "Gets account fields",
12355 "title": "Example usage:",
12356 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
12360 "name": "getFields",
12361 "group": "Freshdesk_Accounts",
12362 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12363 "version": "0.0.0",
12364 "filename": "server/api/intFreshdeskAccount/index.js",
12365 "groupTitle": "Freshdesk_Accounts"
12369 "url": "/api/integrations/freshdesk/accounts/{id}",
12370 "title": "Update an existing Freshdesk Account",
12373 "title": "Example usage:",
12374 "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",
12378 "name": "updateFreshdesk_Accounts",
12379 "group": "Freshdesk_Accounts",
12380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12381 "version": "0.0.0",
12382 "filename": "server/api/intFreshdeskAccount/index.js",
12383 "groupTitle": "Freshdesk_Accounts"
12387 "url": "/api/integrations/freshdesk/configurations",
12388 "title": "Creates a new Freshdesk Configuration",
12391 "title": "Example usage:",
12392 "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",
12396 "name": "CreateFreshdesk_Configurations",
12397 "group": "Freshdesk_Configurations",
12412 "field": "description",
12418 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12419 "version": "0.0.0",
12420 "filename": "server/api/intFreshdeskConfiguration/index.js",
12421 "groupTitle": "Freshdesk_Configurations"
12425 "url": "/api/integrations/freshdesk/configurations/{id}",
12426 "title": "Deletes a Freshdesk Configuration",
12429 "title": "Example usage:",
12430 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
12434 "name": "DeleteFreshdesk_Configurations",
12435 "group": "Freshdesk_Configurations",
12436 "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>",
12437 "version": "0.0.0",
12438 "filename": "server/api/intFreshdeskConfiguration/index.js",
12439 "groupTitle": "Freshdesk_Configurations"
12443 "url": "/api/integrations/freshdesk/configurations",
12444 "title": "Gets a list of Freshdesk Configurations",
12447 "title": "Example usage:",
12448 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
12452 "name": "GetFreshdesk_Configurations",
12453 "group": "Freshdesk_Configurations",
12454 "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>",
12455 "version": "0.0.0",
12456 "filename": "server/api/intFreshdeskConfiguration/index.js",
12457 "groupTitle": "Freshdesk_Configurations"
12461 "url": "/api/integrations/freshdesk/configurations/{id}",
12462 "title": "Gets a single Freshdesk Configuration",
12465 "title": "Example usage:",
12466 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
12470 "name": "ShowFreshdesk_Configurations",
12471 "group": "Freshdesk_Configurations",
12472 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12473 "version": "0.0.0",
12474 "filename": "server/api/intFreshdeskConfiguration/index.js",
12475 "groupTitle": "Freshdesk_Configurations"
12479 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
12480 "title": "Gets configurations descriptions",
12483 "title": "Example usage:",
12484 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12488 "name": "getDescriptions",
12489 "group": "Freshdesk_Configurations",
12490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12491 "version": "0.0.0",
12492 "filename": "server/api/intFreshdeskConfiguration/index.js",
12493 "groupTitle": "Freshdesk_Configurations"
12497 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
12498 "title": "Gets configurations fields",
12501 "title": "Example usage:",
12502 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
12506 "name": "getFields",
12507 "group": "Freshdesk_Configurations",
12508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12509 "version": "0.0.0",
12510 "filename": "server/api/intFreshdeskConfiguration/index.js",
12511 "groupTitle": "Freshdesk_Configurations"
12515 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
12516 "title": "Gets configurations subjects",
12519 "title": "Example usage:",
12520 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12524 "name": "getSubjects",
12525 "group": "Freshdesk_Configurations",
12526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12527 "version": "0.0.0",
12528 "filename": "server/api/intFreshdeskConfiguration/index.js",
12529 "groupTitle": "Freshdesk_Configurations"
12533 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12534 "title": "Gets configurations tags",
12537 "title": "Example usage:",
12538 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
12543 "group": "Freshdesk_Configurations",
12544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12545 "version": "0.0.0",
12546 "filename": "server/api/intFreshdeskConfiguration/index.js",
12547 "groupTitle": "Freshdesk_Configurations"
12551 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12552 "title": "Sets new tags",
12555 "title": "Example usage:",
12556 "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",
12561 "group": "Freshdesk_Configurations",
12562 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12563 "version": "0.0.0",
12564 "filename": "server/api/intFreshdeskConfiguration/index.js",
12565 "groupTitle": "Freshdesk_Configurations"
12569 "url": "/api/integrations/freshdesk/configurations/{id}",
12570 "title": "Update an existing Freshdesk Configuration",
12573 "title": "Example usage:",
12574 "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",
12578 "name": "updateFreshdesk_Configurations",
12579 "group": "Freshdesk_Configurations",
12580 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12581 "version": "0.0.0",
12582 "filename": "server/api/intFreshdeskConfiguration/index.js",
12583 "groupTitle": "Freshdesk_Configurations"
12587 "url": "/api/integrations/freshdesk/fields",
12588 "title": "Creates a new Freshdesk Field",
12591 "title": "Example usage:",
12592 "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",
12596 "name": "CreateFreshdesk_Fields",
12597 "group": "Freshdesk_Fields",
12607 "\"customVariable\"",
12619 "field": "content",
12635 "\"customVariable\""
12638 "field": "keyType",
12645 "field": "keyContent",
12652 "field": "idField",
12659 "field": "nameField",
12666 "field": "customField",
12673 "field": "variableName",
12679 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12680 "version": "0.0.0",
12681 "filename": "server/api/intFreshdeskField/index.js",
12682 "groupTitle": "Freshdesk_Fields"
12686 "url": "/api/integrations/freshdesk/fields/{id}",
12687 "title": "Deletes a Freshdesk Field",
12690 "title": "Example usage:",
12691 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12695 "name": "DeleteFreshdesk_Fields",
12696 "group": "Freshdesk_Fields",
12697 "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>",
12698 "version": "0.0.0",
12699 "filename": "server/api/intFreshdeskField/index.js",
12700 "groupTitle": "Freshdesk_Fields"
12704 "url": "/api/integrations/freshdesk/fields",
12705 "title": "Gets a list of Freshdesk Fields",
12708 "title": "Example usage:",
12709 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12713 "name": "GetFreshdesk_Fields",
12714 "group": "Freshdesk_Fields",
12715 "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>",
12716 "version": "0.0.0",
12717 "filename": "server/api/intFreshdeskField/index.js",
12718 "groupTitle": "Freshdesk_Fields"
12722 "url": "/api/integrations/freshdesk/fields/{id}",
12723 "title": "Gets a single Freshdesk Field",
12726 "title": "Example usage:",
12727 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12731 "name": "ShowFreshdesk_Fields",
12732 "group": "Freshdesk_Fields",
12733 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12734 "version": "0.0.0",
12735 "filename": "server/api/intFreshdeskField/index.js",
12736 "groupTitle": "Freshdesk_Fields"
12740 "url": "/api/integrations/freshdesk/fields/{id}",
12741 "title": "Update an existing Freshdesk Field",
12744 "title": "Example usage:",
12745 "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",
12749 "name": "updateFreshdesk_Fields",
12750 "group": "Freshdesk_Fields",
12751 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12752 "version": "0.0.0",
12753 "filename": "server/api/intFreshdeskField/index.js",
12754 "groupTitle": "Freshdesk_Fields"
12758 "url": "/api/integrations/freshsales/accounts",
12759 "title": "Creates a new Freshsales Account",
12762 "title": "Example usage:",
12763 "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",
12767 "name": "CreateFreshsales_Accounts",
12768 "group": "Freshsales_Accounts",
12783 "field": "description",
12790 "field": "username",
12804 "field": "remoteUri",
12811 "field": "serverUrl",
12817 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12818 "version": "0.0.0",
12819 "filename": "server/api/intFreshsalesAccount/index.js",
12820 "groupTitle": "Freshsales_Accounts"
12824 "url": "/api/integrations/freshsales/accounts/{id}",
12825 "title": "Deletes a Freshsales Account",
12828 "title": "Example usage:",
12829 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12833 "name": "DeleteFreshsales_Accounts",
12834 "group": "Freshsales_Accounts",
12835 "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>",
12836 "version": "0.0.0",
12837 "filename": "server/api/intFreshsalesAccount/index.js",
12838 "groupTitle": "Freshsales_Accounts"
12842 "url": "/api/integrations/freshsales/accounts",
12843 "title": "Gets a list of Freshsales Accounts",
12846 "title": "Example usage:",
12847 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12851 "name": "GetFreshsales_Accounts",
12852 "group": "Freshsales_Accounts",
12853 "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>",
12854 "version": "0.0.0",
12855 "filename": "server/api/intFreshsalesAccount/index.js",
12856 "groupTitle": "Freshsales_Accounts"
12860 "url": "/api/integrations/freshsales/accounts/{id}",
12861 "title": "Gets a single Freshsales Account",
12864 "title": "Example usage:",
12865 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12869 "name": "ShowFreshsales_Accounts",
12870 "group": "Freshsales_Accounts",
12871 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12872 "version": "0.0.0",
12873 "filename": "server/api/intFreshsalesAccount/index.js",
12874 "groupTitle": "Freshsales_Accounts"
12878 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12879 "title": "Creates new configuration",
12882 "title": "Example usage:",
12883 "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",
12887 "name": "addConfiguration",
12888 "group": "Freshsales_Accounts",
12889 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12890 "version": "0.0.0",
12891 "filename": "server/api/intFreshsalesAccount/index.js",
12892 "groupTitle": "Freshsales_Accounts"
12896 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12897 "title": "Gets account configurations",
12900 "title": "Example usage:",
12901 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12905 "name": "getConfigurations",
12906 "group": "Freshsales_Accounts",
12907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12908 "version": "0.0.0",
12909 "filename": "server/api/intFreshsalesAccount/index.js",
12910 "groupTitle": "Freshsales_Accounts"
12914 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12915 "title": "Gets account fields",
12918 "title": "Example usage:",
12919 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12923 "name": "getFields",
12924 "group": "Freshsales_Accounts",
12925 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12926 "version": "0.0.0",
12927 "filename": "server/api/intFreshsalesAccount/index.js",
12928 "groupTitle": "Freshsales_Accounts"
12932 "url": "/api/integrations/freshsales/accounts/{id}",
12933 "title": "Update an existing Freshsales Account",
12936 "title": "Example usage:",
12937 "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",
12941 "name": "updateFreshsales_Accounts",
12942 "group": "Freshsales_Accounts",
12943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12944 "version": "0.0.0",
12945 "filename": "server/api/intFreshsalesAccount/index.js",
12946 "groupTitle": "Freshsales_Accounts"
12950 "url": "/api/integrations/freshsales/configurations",
12951 "title": "Creates a new Freshsales Configuration",
12954 "title": "Example usage:",
12955 "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",
12959 "name": "CreateFreshsales_Configurations",
12960 "group": "Freshsales_Configurations",
12975 "field": "description",
12981 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12982 "version": "0.0.0",
12983 "filename": "server/api/intFreshsalesConfiguration/index.js",
12984 "groupTitle": "Freshsales_Configurations"
12988 "url": "/api/integrations/freshsales/configurations/{id}",
12989 "title": "Deletes a Freshsales Configuration",
12992 "title": "Example usage:",
12993 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12997 "name": "DeleteFreshsales_Configurations",
12998 "group": "Freshsales_Configurations",
12999 "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>",
13000 "version": "0.0.0",
13001 "filename": "server/api/intFreshsalesConfiguration/index.js",
13002 "groupTitle": "Freshsales_Configurations"
13006 "url": "/api/integrations/freshsales/configurations",
13007 "title": "Gets a list of Freshsales Configurations",
13010 "title": "Example usage:",
13011 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
13015 "name": "GetFreshsales_Configurations",
13016 "group": "Freshsales_Configurations",
13017 "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>",
13018 "version": "0.0.0",
13019 "filename": "server/api/intFreshsalesConfiguration/index.js",
13020 "groupTitle": "Freshsales_Configurations"
13024 "url": "/api/integrations/freshsales/configurations/{id}",
13025 "title": "Gets a single Freshsales Configuration",
13028 "title": "Example usage:",
13029 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
13033 "name": "ShowFreshsales_Configurations",
13034 "group": "Freshsales_Configurations",
13035 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13036 "version": "0.0.0",
13037 "filename": "server/api/intFreshsalesConfiguration/index.js",
13038 "groupTitle": "Freshsales_Configurations"
13042 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
13043 "title": "Gets configurations descriptions",
13046 "title": "Example usage:",
13047 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
13051 "name": "getDescriptions",
13052 "group": "Freshsales_Configurations",
13053 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13054 "version": "0.0.0",
13055 "filename": "server/api/intFreshsalesConfiguration/index.js",
13056 "groupTitle": "Freshsales_Configurations"
13060 "url": "/api/integrations/freshsales/configurations/{id}/fields",
13061 "title": "Gets configurations fields",
13064 "title": "Example usage:",
13065 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
13069 "name": "getFields",
13070 "group": "Freshsales_Configurations",
13071 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13072 "version": "0.0.0",
13073 "filename": "server/api/intFreshsalesConfiguration/index.js",
13074 "groupTitle": "Freshsales_Configurations"
13078 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
13079 "title": "Gets configurations subjects",
13082 "title": "Example usage:",
13083 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
13087 "name": "getSubjects",
13088 "group": "Freshsales_Configurations",
13089 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13090 "version": "0.0.0",
13091 "filename": "server/api/intFreshsalesConfiguration/index.js",
13092 "groupTitle": "Freshsales_Configurations"
13096 "url": "/api/integrations/freshsales/configurations/{id}",
13097 "title": "Update an existing Freshsales Configuration",
13100 "title": "Example usage:",
13101 "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",
13105 "name": "updateFreshsales_Configurations",
13106 "group": "Freshsales_Configurations",
13107 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13108 "version": "0.0.0",
13109 "filename": "server/api/intFreshsalesConfiguration/index.js",
13110 "groupTitle": "Freshsales_Configurations"
13114 "url": "/api/integrations/freshsales/fields",
13115 "title": "Creates a new Freshsales Field",
13118 "title": "Example usage:",
13119 "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",
13123 "name": "CreateFreshsales_Fields",
13124 "group": "Freshsales_Fields",
13134 "\"customVariable\"",
13146 "field": "content",
13162 "\"customVariable\""
13165 "field": "keyType",
13172 "field": "keyContent",
13179 "field": "idField",
13186 "field": "nameField",
13193 "field": "customField",
13200 "field": "variableName",
13206 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13207 "version": "0.0.0",
13208 "filename": "server/api/intFreshsalesField/index.js",
13209 "groupTitle": "Freshsales_Fields"
13213 "url": "/api/integrations/freshsales/fields/{id}",
13214 "title": "Deletes a Freshsales Field",
13217 "title": "Example usage:",
13218 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
13222 "name": "DeleteFreshsales_Fields",
13223 "group": "Freshsales_Fields",
13224 "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>",
13225 "version": "0.0.0",
13226 "filename": "server/api/intFreshsalesField/index.js",
13227 "groupTitle": "Freshsales_Fields"
13231 "url": "/api/integrations/freshsales/fields",
13232 "title": "Gets a list of Freshsales Fields",
13235 "title": "Example usage:",
13236 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
13240 "name": "GetFreshsales_Fields",
13241 "group": "Freshsales_Fields",
13242 "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>",
13243 "version": "0.0.0",
13244 "filename": "server/api/intFreshsalesField/index.js",
13245 "groupTitle": "Freshsales_Fields"
13249 "url": "/api/integrations/freshsales/fields/{id}",
13250 "title": "Gets a single Freshsales Field",
13253 "title": "Example usage:",
13254 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
13258 "name": "ShowFreshsales_Fields",
13259 "group": "Freshsales_Fields",
13260 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13261 "version": "0.0.0",
13262 "filename": "server/api/intFreshsalesField/index.js",
13263 "groupTitle": "Freshsales_Fields"
13267 "url": "/api/integrations/freshsales/fields/{id}",
13268 "title": "Update an existing Freshsales Field",
13271 "title": "Example usage:",
13272 "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",
13276 "name": "updateFreshsales_Fields",
13277 "group": "Freshsales_Fields",
13278 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13279 "version": "0.0.0",
13280 "filename": "server/api/intFreshsalesField/index.js",
13281 "groupTitle": "Freshsales_Fields"
13285 "url": "/api/campaigns/{id}/blacklists",
13286 "title": "Add blacklists to an IVR campaign",
13289 "title": "Example usage:",
13290 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13294 "name": "AddBlackLists",
13295 "group": "IVR_Campaigns",
13296 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13297 "version": "0.0.0",
13298 "filename": "server/api/campaign/index.js",
13299 "groupTitle": "IVR_Campaigns"
13303 "url": "/api/campaigns/{id}/lists",
13304 "title": "Add lists to an IVR campaign",
13307 "title": "Example usage:",
13308 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13312 "name": "AddLists",
13313 "group": "IVR_Campaigns",
13314 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13315 "version": "0.0.0",
13316 "filename": "server/api/campaign/index.js",
13317 "groupTitle": "IVR_Campaigns"
13321 "url": "/api/campaigns/clone",
13322 "title": "Clone an existing IVR Campaign",
13325 "title": "Example usage:",
13326 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13330 "name": "CloneIVR_Campaigns",
13331 "group": "IVR_Campaigns",
13332 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13333 "version": "0.0.0",
13334 "filename": "server/api/campaign/index.js",
13335 "groupTitle": "IVR_Campaigns"
13339 "url": "/api/campaigns",
13340 "title": "Creates a new IVR Campaign",
13343 "title": "Example usage:",
13344 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13348 "name": "CreateIVR_Campaigns",
13349 "group": "IVR_Campaigns",
13374 "field": "description",
13382 "description": "<p>Active/Disactive Campaign</p>"
13388 "field": "limitCalls",
13389 "description": "<p>Max 200 calls.</p>"
13395 "field": "dialOriginateCallerIdName",
13402 "field": "dialOriginateCallerIdNumber",
13409 "field": "dialOriginateTimeout",
13410 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
13416 "field": "dialCongestionMaxRetry",
13417 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
13423 "field": "dialCongestionRetryFrequency",
13424 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
13430 "field": "dialBusyMaxRetry",
13431 "description": "<p>#Busy Retry (min:1, max:999)</p>"
13437 "field": "dialBusyRetryFrequency",
13438 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
13444 "field": "dialNoAnswerMaxRetry",
13445 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
13451 "field": "dialNoAnswerRetryFrequency",
13452 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
13458 "field": "dialGlobalMaxRetry",
13459 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
13465 "field": "dialTimezone",
13472 "field": "dialGlobalInterval",
13484 "field": "dialCheckDuplicateType",
13491 "field": "dialAMDActive",
13492 "description": "<p>Active/Disactive AMD</p>"
13498 "field": "dialAMDInitialSilence",
13499 "description": "<p>#AMD Initial Silence</p>"
13505 "field": "dialAMDGreeting",
13506 "description": "<p>#AMD Greeting</p>"
13512 "field": "dialAMDAfterGreetingSilence",
13513 "description": "<p>#AMD After Greeting Silence</p>"
13519 "field": "dialAMDTotalAnalysisTime",
13520 "description": "<p>#AMD Total Analysis Time</p>"
13526 "field": "dialAMDMinWordLength",
13527 "description": "<p>#AMD Min Word Length</p>"
13533 "field": "dialAMDBetweenWordsSilence",
13534 "description": "<p>#AMD Between Words Silence</p>"
13540 "field": "dialAMDMaximumNumberOfWords",
13541 "description": "<p>#AMD Maximum Number Of Words</p>"
13547 "field": "dialAMDSilenceThreshold",
13548 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
13554 "field": "dialAMDMaximumWordLength",
13555 "description": "<p>#AMD Maximum Word Length</p>"
13565 "field": "dialOrderByScheduledAt",
13572 "field": "dialPrefix",
13579 "field": "dialRandomLastDigitCallerIdNumber",
13580 "description": "<p>Random Last Digit (min:1, max:15)</p>"
13586 "field": "dialCutDigit",
13587 "description": "<p>Cut Digit (min:1, max:15)</p>"
13593 "field": "dialNoSuchNumberMaxRetry",
13594 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13600 "field": "dialNoSuchNumberRetryFrequency",
13601 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13607 "field": "dialDropMaxRetry",
13608 "description": "<p>#Drop Retry (min:1, max:999)</p>"
13614 "field": "dialDropRetryFrequency",
13615 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13621 "field": "dialAbandonedMaxRetry",
13622 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13628 "field": "dialAbandonedRetryFrequency",
13629 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13635 "field": "dialMachineMaxRetry",
13636 "description": "<p>#Machine Retry (min:1, max:999)</p>"
13642 "field": "dialMachineRetryFrequency",
13643 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13649 "field": "dialAgentRejectMaxRetry",
13650 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13656 "field": "dialAgentRejectRetryFrequency",
13657 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13662 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13663 "version": "0.0.0",
13664 "filename": "server/api/campaign/index.js",
13665 "groupTitle": "IVR_Campaigns"
13669 "url": "/api/campaigns/{id}",
13670 "title": "Deletes a IVR Campaign",
13673 "title": "Example usage:",
13674 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13678 "name": "DeleteIVR_Campaigns",
13679 "group": "IVR_Campaigns",
13680 "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>",
13681 "version": "0.0.0",
13682 "filename": "server/api/campaign/index.js",
13683 "groupTitle": "IVR_Campaigns"
13687 "url": "/api/campaigns/{id}/blacklists",
13688 "title": "Get IVR campaign blacklists",
13691 "title": "Example usage:",
13692 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13696 "name": "GetBlackLists",
13697 "group": "IVR_Campaigns",
13698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13699 "version": "0.0.0",
13700 "filename": "server/api/campaign/index.js",
13701 "groupTitle": "IVR_Campaigns"
13705 "url": "/api/campaigns/{id}/finals",
13706 "title": "Gets IVR campaign hopper finals",
13709 "title": "Example usage:",
13710 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
13714 "name": "GetHopperFinals",
13715 "group": "IVR_Campaigns",
13716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13717 "version": "0.0.0",
13718 "filename": "server/api/campaign/index.js",
13719 "groupTitle": "IVR_Campaigns"
13723 "url": "/api/campaigns/{id}/hopper_histories",
13724 "title": "Gets IVR campaign hopper histories",
13727 "title": "Example usage:",
13728 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13732 "name": "GetHopperHistories",
13733 "group": "IVR_Campaigns",
13734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13735 "version": "0.0.0",
13736 "filename": "server/api/campaign/index.js",
13737 "groupTitle": "IVR_Campaigns"
13741 "url": "/api/campaigns/{id}/hoppers",
13742 "title": "Gets IVR campaign hoppers",
13745 "title": "Example usage:",
13746 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13750 "name": "GetHoppers",
13751 "group": "IVR_Campaigns",
13752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13753 "version": "0.0.0",
13754 "filename": "server/api/campaign/index.js",
13755 "groupTitle": "IVR_Campaigns"
13759 "url": "/api/campaigns",
13760 "title": "Gets a list of IVR Campaigns",
13763 "title": "Example usage:",
13764 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13768 "name": "GetIVR_Campaigns",
13769 "group": "IVR_Campaigns",
13770 "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>",
13771 "version": "0.0.0",
13772 "filename": "server/api/campaign/index.js",
13773 "groupTitle": "IVR_Campaigns"
13777 "url": "/api/campaigns/{id}/lists",
13778 "title": "Get IVR campaign lists",
13781 "title": "Example usage:",
13782 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13786 "name": "GetLists",
13787 "group": "IVR_Campaigns",
13788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13789 "version": "0.0.0",
13790 "filename": "server/api/campaign/index.js",
13791 "groupTitle": "IVR_Campaigns"
13795 "url": "/api/campaigns/{id}/blacklists",
13796 "title": "Remove blacklists from an IVR Campaign",
13799 "title": "Example usage:",
13800 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13804 "name": "RemoveBlackLists",
13805 "group": "IVR_Campaigns",
13806 "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>",
13807 "version": "0.0.0",
13808 "filename": "server/api/campaign/index.js",
13809 "groupTitle": "IVR_Campaigns"
13813 "url": "/api/campaigns/{id}/lists",
13814 "title": "Remove lists from an IVR Campaign",
13817 "title": "Example usage:",
13818 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13822 "name": "RemoveLists",
13823 "group": "IVR_Campaigns",
13824 "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>",
13825 "version": "0.0.0",
13826 "filename": "server/api/campaign/index.js",
13827 "groupTitle": "IVR_Campaigns"
13831 "url": "/api/campaigns/{id}",
13832 "title": "Gets a single IVR Campaign",
13835 "title": "Example usage:",
13836 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13840 "name": "ShowIVR_Campaigns",
13841 "group": "IVR_Campaigns",
13842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13843 "version": "0.0.0",
13844 "filename": "server/api/campaign/index.js",
13845 "groupTitle": "IVR_Campaigns"
13849 "url": "/api/campaigns/{id}/blacks",
13850 "title": "Gets IVR campaign hopper blacks",
13853 "title": "Example usage:",
13854 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13858 "name": "getHopperBlacks",
13859 "group": "IVR_Campaigns",
13860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13861 "version": "0.0.0",
13862 "filename": "server/api/campaign/index.js",
13863 "groupTitle": "IVR_Campaigns"
13867 "url": "/api/campaigns/{id}",
13868 "title": "Update an existing IVR Campaign",
13871 "title": "Example usage:",
13872 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13876 "name": "updateIVR_Campaigns",
13877 "group": "IVR_Campaigns",
13878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13879 "version": "0.0.0",
13880 "filename": "server/api/campaign/index.js",
13881 "groupTitle": "IVR_Campaigns"
13885 "url": "/api/integrations/reports",
13886 "title": "Creates a new Integration Report",
13889 "title": "Example usage:",
13890 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13894 "name": "CreateIntegration_Reports",
13895 "group": "Integration_Reports",
13903 "field": "integration",
13910 "field": "eventChannel",
13917 "field": "exitStatus",
13924 "field": "ticketId",
13931 "field": "integrationId",
13938 "field": "contacts",
13945 "field": "uniqueid",
13952 "field": "calleridnum",
13959 "field": "calleridname",
13973 "field": "interface",
13980 "field": "membername",
13987 "field": "agentcalledAt",
13994 "field": "agentconnectAt",
14001 "field": "holdtime",
14008 "field": "agentcomplete",
14015 "field": "agentcompleteAt",
14022 "field": "talktime",
14029 "field": "agentacw",
14036 "field": "acwtime",
14050 "field": "agentringnoanswer",
14057 "field": "agentringnoanswerAt",
14064 "field": "agentdump",
14071 "field": "agentdumpAt",
14078 "field": "lastevent",
14085 "field": "channel",
14092 "field": "channelstate",
14099 "field": "channelstatedesc",
14106 "field": "connectedlinenum",
14113 "field": "connectedlinename",
14120 "field": "language",
14127 "field": "accountcode",
14134 "field": "context",
14148 "field": "priority",
14155 "field": "destchannel",
14162 "field": "destchannelstate",
14169 "field": "destchannelstatedesc",
14176 "field": "destcalleridnum",
14183 "field": "destcalleridname",
14190 "field": "destconnectedlinenum",
14197 "field": "destconnectedlinename",
14204 "field": "destlanguage",
14211 "field": "destaccountcode",
14218 "field": "destcontext",
14225 "field": "destexten",
14232 "field": "destpriority",
14239 "field": "destuniqueid",
14246 "field": "messageId",
14253 "field": "inReplyTo",
14260 "field": "subject",
14288 "field": "attachment",
14336 "field": "appdata",
14343 "field": "projectId",
14349 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14350 "version": "0.0.0",
14351 "filename": "server/api/integrationReport/index.js",
14352 "groupTitle": "Integration_Reports"
14356 "url": "/api/integrations/reports/{id}",
14357 "title": "Deletes a Integration Report",
14360 "title": "Example usage:",
14361 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
14365 "name": "DeleteIntegration_Reports",
14366 "group": "Integration_Reports",
14367 "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>",
14368 "version": "0.0.0",
14369 "filename": "server/api/integrationReport/index.js",
14370 "groupTitle": "Integration_Reports"
14374 "url": "/api/integrations/reports/describe",
14375 "title": "Gets table info about Integration Reports",
14378 "title": "Example usage:",
14379 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
14383 "name": "DescribeIntegration_Reports",
14384 "group": "Integration_Reports",
14385 "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>",
14386 "version": "0.0.0",
14387 "filename": "server/api/integrationReport/index.js",
14388 "groupTitle": "Integration_Reports"
14392 "url": "/api/integrations/reports",
14393 "title": "Gets a list of Integration Reports",
14396 "title": "Example usage:",
14397 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
14401 "name": "GetIntegration_Reports",
14402 "group": "Integration_Reports",
14403 "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>",
14404 "version": "0.0.0",
14405 "filename": "server/api/integrationReport/index.js",
14406 "groupTitle": "Integration_Reports"
14410 "url": "/api/integrations/reports/{id}",
14411 "title": "Gets a single Integration Report",
14414 "title": "Example usage:",
14415 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
14419 "name": "ShowIntegration_Reports",
14420 "group": "Integration_Reports",
14421 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14422 "version": "0.0.0",
14423 "filename": "server/api/integrationReport/index.js",
14424 "groupTitle": "Integration_Reports"
14428 "url": "/api/integrations/reports/{id}",
14429 "title": "Update an existing Integration Report",
14432 "title": "Example usage:",
14433 "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",
14437 "name": "updateIntegration_Reports",
14438 "group": "Integration_Reports",
14439 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14440 "version": "0.0.0",
14441 "filename": "server/api/integrationReport/index.js",
14442 "groupTitle": "Integration_Reports"
14446 "url": "/api/intervals",
14447 "title": "Creates a new Interval",
14450 "title": "Example usage:",
14451 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14455 "name": "CreateIntervals",
14456 "group": "Intervals",
14471 "field": "description",
14478 "field": "interval",
14484 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14485 "version": "0.0.0",
14486 "filename": "server/api/interval/index.js",
14487 "groupTitle": "Intervals"
14491 "url": "/api/intervals/{id}",
14492 "title": "Deletes a Interval",
14495 "title": "Example usage:",
14496 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
14500 "name": "DeleteIntervals",
14501 "group": "Intervals",
14502 "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>",
14503 "version": "0.0.0",
14504 "filename": "server/api/interval/index.js",
14505 "groupTitle": "Intervals"
14509 "url": "/api/intervals",
14510 "title": "Gets a list of Intervals",
14513 "title": "Example usage:",
14514 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
14518 "name": "GetIntervals",
14519 "group": "Intervals",
14520 "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>",
14521 "version": "0.0.0",
14522 "filename": "server/api/interval/index.js",
14523 "groupTitle": "Intervals"
14527 "url": "/api/intervals/{id}",
14528 "title": "Gets a single Interval",
14531 "title": "Example usage:",
14532 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
14536 "name": "ShowIntervals",
14537 "group": "Intervals",
14538 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14539 "version": "0.0.0",
14540 "filename": "server/api/interval/index.js",
14541 "groupTitle": "Intervals"
14545 "url": "/api/intervals/{id}/sub_intervals",
14546 "title": "Creates a new sub interval",
14549 "title": "Example usage:",
14550 "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",
14554 "name": "addInterval",
14555 "group": "Intervals",
14556 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14557 "version": "0.0.0",
14558 "filename": "server/api/interval/index.js",
14559 "groupTitle": "Intervals"
14563 "url": "/api/intervals/{id}/sub_intervals/create_many",
14564 "title": "Create new sub intervals set",
14567 "title": "Example usage:",
14568 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14572 "name": "addIntervals",
14573 "group": "Intervals",
14574 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14575 "version": "0.0.0",
14576 "filename": "server/api/interval/index.js",
14577 "groupTitle": "Intervals"
14581 "url": "/api/intervals/{id}/sub_intervals",
14582 "title": "Get sub intervals set",
14585 "title": "Example usage:",
14586 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
14590 "name": "getIntervals",
14591 "group": "Intervals",
14592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14593 "version": "0.0.0",
14594 "filename": "server/api/interval/index.js",
14595 "groupTitle": "Intervals"
14599 "url": "/api/intervals/{id}",
14600 "title": "Update an existing Interval",
14603 "title": "Example usage:",
14604 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14608 "name": "updateIntervals",
14609 "group": "Intervals",
14610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14611 "version": "0.0.0",
14612 "filename": "server/api/interval/index.js",
14613 "groupTitle": "Intervals"
14617 "url": "/api/jira",
14618 "title": "Creates a new issue",
14621 "title": "Example usage:",
14622 "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}",
14626 "name": "Creates_Issue",
14638 "field": "issuetype",
14645 "field": "summary",
14652 "field": "description",
14658 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14659 "version": "0.0.0",
14660 "filename": "server/api/jira/index.js",
14661 "groupTitle": "Issue"
14665 "url": "/api/jscripty/answers/reports",
14666 "title": "Creates a new Report",
14669 "title": "Example usage:",
14670 "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",
14674 "name": "CreateReports",
14675 "group": "JscriptyAnswerReport",
14683 "field": "question",
14697 "field": "membername",
14704 "field": "projectname",
14718 "field": "uniqueid",
14725 "field": "calleridname",
14732 "field": "calleridnum",
14739 "field": "questionId",
14745 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14746 "version": "0.0.0",
14747 "filename": "server/api/jscriptyAnswerReport/index.js",
14748 "groupTitle": "JscriptyAnswerReport"
14752 "url": "/api/jscripty/answers/reports/{id}",
14753 "title": "Deletes a Report",
14756 "title": "Example usage:",
14757 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14761 "name": "DeleteReports",
14762 "group": "JscriptyAnswerReport",
14763 "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>",
14764 "version": "0.0.0",
14765 "filename": "server/api/jscriptyAnswerReport/index.js",
14766 "groupTitle": "JscriptyAnswerReport"
14770 "url": "/api/jscripty/answers/reports/describe",
14771 "title": "Gets table info about Reports",
14774 "title": "Example usage:",
14775 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14779 "name": "DescribeReports",
14780 "group": "JscriptyAnswerReport",
14781 "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>",
14782 "version": "0.0.0",
14783 "filename": "server/api/jscriptyAnswerReport/index.js",
14784 "groupTitle": "JscriptyAnswerReport"
14788 "url": "/api/jscripty/answers/reports",
14789 "title": "Gets a list of Reports",
14792 "title": "Example usage:",
14793 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14797 "name": "GetReports",
14798 "group": "JscriptyAnswerReport",
14799 "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>",
14800 "version": "0.0.0",
14801 "filename": "server/api/jscriptyAnswerReport/index.js",
14802 "groupTitle": "JscriptyAnswerReport"
14806 "url": "/api/jscripty/answers/reports/{id}",
14807 "title": "Gets a single Report",
14810 "title": "Example usage:",
14811 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14815 "name": "ShowReports",
14816 "group": "JscriptyAnswerReport",
14817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14818 "version": "0.0.0",
14819 "filename": "server/api/jscriptyAnswerReport/index.js",
14820 "groupTitle": "JscriptyAnswerReport"
14824 "url": "/api/jscripty/answers/reports/{id}",
14825 "title": "Update an existing Report",
14828 "title": "Example usage:",
14829 "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",
14833 "name": "updateReports",
14834 "group": "JscriptyAnswerReport",
14835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14836 "version": "0.0.0",
14837 "filename": "server/api/jscriptyAnswerReport/index.js",
14838 "groupTitle": "JscriptyAnswerReport"
14842 "url": "/api/jscripty/questions/reports",
14843 "title": "Creates a new Report",
14846 "title": "Example usage:",
14847 "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",
14851 "name": "CreateReports",
14852 "group": "JscriptyQuestionReport",
14860 "field": "question",
14874 "field": "membername",
14881 "field": "projectname",
14895 "field": "uniqueid",
14902 "field": "calleridname",
14909 "field": "calleridnum",
14916 "field": "questionId",
14922 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14923 "version": "0.0.0",
14924 "filename": "server/api/jscriptyQuestionReport/index.js",
14925 "groupTitle": "JscriptyQuestionReport"
14929 "url": "/api/jscripty/questions/reports/{id}",
14930 "title": "Deletes a Report",
14933 "title": "Example usage:",
14934 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14938 "name": "DeleteReports",
14939 "group": "JscriptyQuestionReport",
14940 "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>",
14941 "version": "0.0.0",
14942 "filename": "server/api/jscriptyQuestionReport/index.js",
14943 "groupTitle": "JscriptyQuestionReport"
14947 "url": "/api/jscripty/questions/reports/describe",
14948 "title": "Gets table info about Reports",
14951 "title": "Example usage:",
14952 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14956 "name": "DescribeReports",
14957 "group": "JscriptyQuestionReport",
14958 "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>",
14959 "version": "0.0.0",
14960 "filename": "server/api/jscriptyQuestionReport/index.js",
14961 "groupTitle": "JscriptyQuestionReport"
14965 "url": "/api/jscripty/questions/reports",
14966 "title": "Gets a list of Reports",
14969 "title": "Example usage:",
14970 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14974 "name": "GetReports",
14975 "group": "JscriptyQuestionReport",
14976 "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>",
14977 "version": "0.0.0",
14978 "filename": "server/api/jscriptyQuestionReport/index.js",
14979 "groupTitle": "JscriptyQuestionReport"
14983 "url": "/api/jscripty/questions/reports/{id}",
14984 "title": "Gets a single Report",
14987 "title": "Example usage:",
14988 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14992 "name": "ShowReports",
14993 "group": "JscriptyQuestionReport",
14994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14995 "version": "0.0.0",
14996 "filename": "server/api/jscriptyQuestionReport/index.js",
14997 "groupTitle": "JscriptyQuestionReport"
15001 "url": "/api/jscripty/questions/reports/{id}",
15002 "title": "Update an existing Report",
15005 "title": "Example usage:",
15006 "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",
15010 "name": "updateReports",
15011 "group": "JscriptyQuestionReport",
15012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15013 "version": "0.0.0",
15014 "filename": "server/api/jscriptyQuestionReport/index.js",
15015 "groupTitle": "JscriptyQuestionReport"
15019 "url": "/api/jscripty/sessions/reports",
15020 "title": "Creates a new Report",
15023 "title": "Example usage:",
15024 "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",
15028 "name": "CreateReports",
15029 "group": "JscriptySessionReport",
15037 "field": "starttime",
15044 "field": "endtime",
15051 "field": "membername",
15058 "field": "projectname",
15072 "field": "uniqueid",
15079 "field": "calleridname",
15086 "field": "calleridnum",
15093 "field": "completed",
15099 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15100 "version": "0.0.0",
15101 "filename": "server/api/jscriptySessionReport/index.js",
15102 "groupTitle": "JscriptySessionReport"
15106 "url": "/api/jscripty/sessions/reports/{id}",
15107 "title": "Deletes a Report",
15110 "title": "Example usage:",
15111 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
15115 "name": "DeleteReports",
15116 "group": "JscriptySessionReport",
15117 "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>",
15118 "version": "0.0.0",
15119 "filename": "server/api/jscriptySessionReport/index.js",
15120 "groupTitle": "JscriptySessionReport"
15124 "url": "/api/jscripty/sessions/reports/describe",
15125 "title": "Gets table info about Reports",
15128 "title": "Example usage:",
15129 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
15133 "name": "DescribeReports",
15134 "group": "JscriptySessionReport",
15135 "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>",
15136 "version": "0.0.0",
15137 "filename": "server/api/jscriptySessionReport/index.js",
15138 "groupTitle": "JscriptySessionReport"
15142 "url": "/api/jscripty/sessions/reports",
15143 "title": "Gets a list of Reports",
15146 "title": "Example usage:",
15147 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
15151 "name": "GetReports",
15152 "group": "JscriptySessionReport",
15153 "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>",
15154 "version": "0.0.0",
15155 "filename": "server/api/jscriptySessionReport/index.js",
15156 "groupTitle": "JscriptySessionReport"
15160 "url": "/api/jscripty/sessions/reports/{id}",
15161 "title": "Gets a single Report",
15164 "title": "Example usage:",
15165 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
15169 "name": "ShowReports",
15170 "group": "JscriptySessionReport",
15171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15172 "version": "0.0.0",
15173 "filename": "server/api/jscriptySessionReport/index.js",
15174 "groupTitle": "JscriptySessionReport"
15178 "url": "/api/jscripty/sessions/reports/{id}/questions",
15179 "title": "Gets Jscripty Session questions",
15182 "title": "Example usage:",
15183 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
15187 "name": "getQuestions",
15188 "group": "JscriptySessionReport",
15189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15190 "version": "0.0.0",
15191 "filename": "server/api/jscriptySessionReport/index.js",
15192 "groupTitle": "JscriptySessionReport"
15196 "url": "/api/jscripty/sessions/reports/{id}",
15197 "title": "Update an existing Report",
15200 "title": "Example usage:",
15201 "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",
15205 "name": "updateReports",
15206 "group": "JscriptySessionReport",
15207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15208 "version": "0.0.0",
15209 "filename": "server/api/jscriptySessionReport/index.js",
15210 "groupTitle": "JscriptySessionReport"
15214 "url": "/api/jscripty/projects/clone",
15215 "title": "Clone an existing Project",
15218 "title": "Example usage:",
15219 "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",
15223 "name": "CloneProjects",
15224 "group": "Jscripty_Projects",
15225 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15226 "version": "0.0.0",
15227 "filename": "server/api/jscriptyProject/index.js",
15228 "groupTitle": "Jscripty_Projects"
15232 "url": "/api/jscripty/projects",
15233 "title": "Creates a new Project",
15236 "title": "Example usage:",
15237 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15241 "name": "CreateProjects",
15242 "group": "Jscripty_Projects",
15257 "field": "description",
15264 "field": "formData",
15271 "field": "enableUncompleteSave",
15278 "field": "sendUnpauseOnSubmit",
15284 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15285 "version": "0.0.0",
15286 "filename": "server/api/jscriptyProject/index.js",
15287 "groupTitle": "Jscripty_Projects"
15291 "url": "/api/jscripty/projects/{id}",
15292 "title": "Deletes a Project",
15295 "title": "Example usage:",
15296 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
15300 "name": "DeleteProjects",
15301 "group": "Jscripty_Projects",
15302 "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>",
15303 "version": "0.0.0",
15304 "filename": "server/api/jscriptyProject/index.js",
15305 "groupTitle": "Jscripty_Projects"
15309 "url": "/api/jscripty/projects",
15310 "title": "Gets a list of Projects",
15313 "title": "Example usage:",
15314 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
15318 "name": "GetProjects",
15319 "group": "Jscripty_Projects",
15320 "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>",
15321 "version": "0.0.0",
15322 "filename": "server/api/jscriptyProject/index.js",
15323 "groupTitle": "Jscripty_Projects"
15327 "url": "/api/jscripty/projects/{id}",
15328 "title": "Gets a single Project",
15331 "title": "Example usage:",
15332 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
15336 "name": "ShowProjects",
15337 "group": "Jscripty_Projects",
15338 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15339 "version": "0.0.0",
15340 "filename": "server/api/jscriptyProject/index.js",
15341 "groupTitle": "Jscripty_Projects"
15345 "url": "/api/jscripty/projects/{id}/answers",
15346 "title": "Gets jscripty project answers",
15349 "title": "Example usage:",
15350 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
15354 "name": "getAnswers",
15355 "group": "Jscripty_Projects",
15356 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15357 "version": "0.0.0",
15358 "filename": "server/api/jscriptyProject/index.js",
15359 "groupTitle": "Jscripty_Projects"
15363 "url": "/api/jscripty/projects/{id}/sessions",
15364 "title": "Gets jscripty project sessions",
15367 "title": "Example usage:",
15368 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
15372 "name": "getSessions",
15373 "group": "Jscripty_Projects",
15374 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15375 "version": "0.0.0",
15376 "filename": "server/api/jscriptyProject/index.js",
15377 "groupTitle": "Jscripty_Projects"
15381 "url": "/api/jscripty/projects/{id}/summary",
15382 "title": "Gets jscripty project summary",
15385 "title": "Example usage:",
15386 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
15390 "name": "getSummary",
15391 "group": "Jscripty_Projects",
15392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15393 "version": "0.0.0",
15394 "filename": "server/api/jscriptyProject/index.js",
15395 "groupTitle": "Jscripty_Projects"
15399 "url": "/api/jscripty/projects/{id}",
15400 "title": "Update an existing Project",
15403 "title": "Example usage:",
15404 "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",
15408 "name": "updateProjects",
15409 "group": "Jscripty_Projects",
15410 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15411 "version": "0.0.0",
15412 "filename": "server/api/jscriptyProject/index.js",
15413 "groupTitle": "Jscripty_Projects"
15417 "url": "/api/license",
15418 "title": "Gets License Info",
15421 "title": "Example usage:",
15422 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
15427 "group": "License",
15428 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15429 "version": "0.0.0",
15430 "filename": "server/api/license/index.js",
15431 "groupTitle": "License"
15435 "url": "/api/license/{id}",
15436 "title": "Update License Info",
15439 "title": "Example usage:",
15440 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
15445 "group": "License",
15446 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15447 "version": "0.0.0",
15448 "filename": "server/api/license/index.js",
15449 "groupTitle": "License"
15453 "url": "/api/mail/accounts/{id}/users",
15454 "title": "Add agents to a mail account",
15457 "title": "Example usage:",
15458 "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",
15462 "name": "AddAgents",
15463 "group": "Mail_Accounts",
15464 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15465 "version": "0.0.0",
15466 "filename": "server/api/mailAccount/index.js",
15467 "groupTitle": "Mail_Accounts"
15471 "url": "/api/mail/accounts/{id}/in_servers",
15472 "title": "Creates a new IMAP server",
15475 "title": "Example usage:",
15476 "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",
15481 "group": "Mail_Accounts",
15489 "field": "description",
15503 "field": "authentication",
15517 "field": "password",
15538 "field": "mailbox",
15545 "field": "connTimeout",
15552 "field": "authTimeout",
15559 "field": "service",
15565 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15566 "version": "0.0.0",
15567 "filename": "server/api/mailAccount/index.js",
15568 "groupTitle": "Mail_Accounts"
15572 "url": "/api/mail/accounts/{id}/out_servers",
15573 "title": "Creates a new SMTP server",
15576 "title": "Example usage:",
15577 "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",
15582 "group": "Mail_Accounts",
15590 "field": "description",
15632 "field": "service",
15639 "field": "authentication",
15645 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15646 "version": "0.0.0",
15647 "filename": "server/api/mailAccount/index.js",
15648 "groupTitle": "Mail_Accounts"
15652 "url": "/api/mail/accounts/{id}",
15653 "title": "Deletes a mail account",
15656 "title": "Example usage:",
15657 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15661 "name": "DeleteMailAccounts",
15662 "group": "Mail_Accounts",
15663 "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>",
15664 "version": "0.0.0",
15665 "filename": "server/api/mailAccount/index.js",
15666 "groupTitle": "Mail_Accounts"
15670 "url": "/api/mail/accounts/describe",
15671 "title": "Gets table info about Accounts",
15674 "title": "Example usage:",
15675 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15679 "name": "DescribeAccounts",
15680 "group": "Mail_Accounts",
15681 "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>",
15682 "version": "0.0.0",
15683 "filename": "server/api/mailAccount/index.js",
15684 "groupTitle": "Mail_Accounts"
15688 "url": "/api/mail/accounts",
15689 "title": "Gets a list of Accounts",
15692 "title": "Example usage:",
15693 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15697 "name": "GetAccounts",
15698 "group": "Mail_Accounts",
15699 "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>",
15700 "version": "0.0.0",
15701 "filename": "server/api/mailAccount/index.js",
15702 "groupTitle": "Mail_Accounts"
15706 "url": "/api/mail/accounts/{id}/users",
15707 "title": "Gets agents from mail account",
15710 "title": "Example usage:",
15711 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15715 "name": "GetAgents",
15716 "group": "Mail_Accounts",
15717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15718 "version": "0.0.0",
15719 "filename": "server/api/mailAccount/index.js",
15720 "groupTitle": "Mail_Accounts"
15724 "url": "/api/mail/accounts/{id}/in_servers",
15725 "title": "Gets account IMAP server",
15728 "title": "Example usage:",
15729 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15734 "group": "Mail_Accounts",
15735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15736 "version": "0.0.0",
15737 "filename": "server/api/mailAccount/index.js",
15738 "groupTitle": "Mail_Accounts"
15742 "url": "/api/mail/accounts/{id}/out_servers",
15743 "title": "Gets account SMTP server",
15746 "title": "Example usage:",
15747 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15752 "group": "Mail_Accounts",
15753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15754 "version": "0.0.0",
15755 "filename": "server/api/mailAccount/index.js",
15756 "groupTitle": "Mail_Accounts"
15760 "url": "/api/mail/accounts/{id}/users",
15761 "title": "Removes agents from a mail account",
15764 "title": "Example usage:",
15765 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15769 "name": "RemoveAgents",
15770 "group": "Mail_Accounts",
15771 "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>",
15772 "version": "0.0.0",
15773 "filename": "server/api/mailAccount/index.js",
15774 "groupTitle": "Mail_Accounts"
15778 "url": "/api/mail/accounts/{id}/canned_answers",
15779 "title": "Removes canned answers from account",
15782 "title": "Example usage:",
15783 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15787 "name": "RemoveAnswers",
15788 "group": "Mail_Accounts",
15789 "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>",
15790 "version": "0.0.0",
15791 "filename": "server/api/mailAccount/index.js",
15792 "groupTitle": "Mail_Accounts"
15796 "url": "/api/mail/accounts/{id}/dispositions",
15797 "title": "Removes dispositions from account",
15800 "title": "Example usage:",
15801 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15805 "name": "RemoveDispositions",
15806 "group": "Mail_Accounts",
15807 "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>",
15808 "version": "0.0.0",
15809 "filename": "server/api/mailAccount/index.js",
15810 "groupTitle": "Mail_Accounts"
15814 "url": "/api/mail/accounts/{id}/in_servers",
15815 "title": "Removes IMAP server from an account",
15818 "title": "Example usage:",
15819 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15823 "name": "RemoveImmap",
15824 "group": "Mail_Accounts",
15825 "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>",
15826 "version": "0.0.0",
15827 "filename": "server/api/mailAccount/index.js",
15828 "groupTitle": "Mail_Accounts"
15832 "url": "/api/mail/accounts/{id}/out_servers",
15833 "title": "Removes SMTP server from an account",
15836 "title": "Example usage:",
15837 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15841 "name": "RemoveSmtp",
15842 "group": "Mail_Accounts",
15843 "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>",
15844 "version": "0.0.0",
15845 "filename": "server/api/mailAccount/index.js",
15846 "groupTitle": "Mail_Accounts"
15850 "url": "/api/mail/accounts/{id}",
15851 "title": "Gets a single Account",
15854 "title": "Example usage:",
15855 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15859 "name": "ShowAccounts",
15860 "group": "Mail_Accounts",
15861 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15862 "version": "0.0.0",
15863 "filename": "server/api/mailAccount/index.js",
15864 "groupTitle": "Mail_Accounts"
15868 "url": "/api/mail/accounts/{id}/canned_answers",
15869 "title": "Creates new canned answer",
15872 "title": "Example usage:",
15873 "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",
15877 "name": "addAnswer",
15878 "group": "Mail_Accounts",
15900 "field": "description",
15913 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15914 "version": "0.0.0",
15915 "filename": "server/api/mailAccount/index.js",
15916 "groupTitle": "Mail_Accounts"
15920 "url": "/api/mail/accounts/{id}/applications",
15921 "title": "Creates new applications",
15924 "title": "Example usage:",
15925 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15929 "name": "addApplications",
15930 "group": "Mail_Accounts",
15938 "field": "priority",
15952 "field": "appdata",
15959 "field": "description",
15966 "field": "interval",
15972 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15973 "version": "0.0.0",
15974 "filename": "server/api/mailAccount/index.js",
15975 "groupTitle": "Mail_Accounts"
15979 "url": "/api/mail/accounts/{id}/dispositions",
15980 "title": "Creates new disposition",
15983 "title": "Example usage:",
15984 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15988 "name": "addDisposition",
15989 "group": "Mail_Accounts",
16016 "field": "description",
16022 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16023 "version": "0.0.0",
16024 "filename": "server/api/mailAccount/index.js",
16025 "groupTitle": "Mail_Accounts"
16029 "url": "/api/mail/accounts/{id}/interactions",
16030 "title": "Creates new interactions",
16033 "title": "Example usage:",
16034 "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",
16038 "name": "addInteraction",
16039 "group": "Mail_Accounts",
16054 "field": "closedAt",
16061 "field": "disposition",
16068 "field": "secondDisposition",
16075 "field": "thirdDisposition",
16089 "field": "inReplyTo",
16110 "field": "subject",
16124 "field": "read1stAt",
16131 "field": "substatus",
16138 "field": "substatusAt",
16149 "field": "firstMsgDirection",
16156 "field": "lastMsgAt",
16167 "field": "lastMsgDirection",
16174 "field": "autoreplyExecuted",
16180 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16181 "version": "0.0.0",
16182 "filename": "server/api/mailAccount/index.js",
16183 "groupTitle": "Mail_Accounts"
16187 "url": "/api/mail/accounts",
16188 "title": "Create a mail account",
16191 "title": "Example usage:",
16192 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16197 "group": "Mail_Accounts",
16198 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16199 "version": "0.0.0",
16200 "filename": "server/api/mailAccount/index.js",
16201 "groupTitle": "Mail_Accounts"
16205 "url": "/api/mail/accounts/{id}/canned_answers",
16206 "title": "Gets account canned answers",
16209 "title": "Example usage:",
16210 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
16214 "name": "getAnswers",
16215 "group": "Mail_Accounts",
16216 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16217 "version": "0.0.0",
16218 "filename": "server/api/mailAccount/index.js",
16219 "groupTitle": "Mail_Accounts"
16223 "url": "/api/mail/accounts/{id}/applications",
16224 "title": "Gets account applications",
16227 "title": "Example usage:",
16228 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
16232 "name": "getApplications",
16233 "group": "Mail_Accounts",
16234 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16235 "version": "0.0.0",
16236 "filename": "server/api/mailAccount/index.js",
16237 "groupTitle": "Mail_Accounts"
16241 "url": "/api/mail/accounts/{id}/dispositions",
16242 "title": "Gets account dispositions",
16245 "title": "Example usage:",
16246 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
16250 "name": "getDispositions",
16251 "group": "Mail_Accounts",
16252 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16253 "version": "0.0.0",
16254 "filename": "server/api/mailAccount/index.js",
16255 "groupTitle": "Mail_Accounts"
16259 "url": "/api/mail/accounts/{id}/interactions",
16260 "title": "Gets account interactions",
16263 "title": "Example usage:",
16264 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
16268 "name": "getInteraction",
16269 "group": "Mail_Accounts",
16270 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16271 "version": "0.0.0",
16272 "filename": "server/api/mailAccount/index.js",
16273 "groupTitle": "Mail_Accounts"
16277 "url": "/api/mail/accounts/{id}/messages",
16278 "title": "Gets account messages",
16281 "title": "Example usage:",
16282 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
16286 "name": "getMessages",
16287 "group": "Mail_Accounts",
16288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16289 "version": "0.0.0",
16290 "filename": "server/api/mailAccount/index.js",
16291 "groupTitle": "Mail_Accounts"
16295 "url": "/api/mail/accounts/{id}/send",
16296 "title": "Send new mail",
16299 "title": "Example usage:",
16300 "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",
16304 "name": "sendMail",
16305 "group": "Mail_Accounts",
16306 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16307 "version": "0.0.0",
16308 "filename": "server/api/mailAccount/index.js",
16309 "groupTitle": "Mail_Accounts"
16313 "url": "/api/mail/accounts/{id}",
16314 "title": "Update an existing Account",
16317 "title": "Example usage:",
16318 "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",
16322 "name": "updateAccounts",
16323 "group": "Mail_Accounts",
16324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16325 "version": "0.0.0",
16326 "filename": "server/api/mailAccount/index.js",
16327 "groupTitle": "Mail_Accounts"
16331 "url": "/api/mail/accounts/{id}/verify",
16332 "title": "Verify mail account",
16335 "title": "Example usage:",
16336 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
16340 "name": "verifySmtp",
16341 "group": "Mail_Accounts",
16342 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16343 "version": "0.0.0",
16344 "filename": "server/api/mailAccount/index.js",
16345 "groupTitle": "Mail_Accounts"
16349 "url": "/api/mail/applications/{id}",
16350 "title": "Deletes a Application",
16353 "title": "Example usage:",
16354 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
16358 "name": "DeleteApplications",
16359 "group": "Mail_Applications",
16360 "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>",
16361 "version": "0.0.0",
16362 "filename": "server/api/mailApplication/index.js",
16363 "groupTitle": "Mail_Applications"
16367 "url": "/api/mail/applications/{id}",
16368 "title": "Gets a single Application",
16371 "title": "Example usage:",
16372 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
16376 "name": "ShowApplications",
16377 "group": "Mail_Applications",
16378 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16379 "version": "0.0.0",
16380 "filename": "server/api/mailApplication/index.js",
16381 "groupTitle": "Mail_Applications"
16385 "url": "/api/mail/applications/{id}",
16386 "title": "Update an existing Application",
16389 "title": "Example usage:",
16390 "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",
16394 "name": "updateApplications",
16395 "group": "Mail_Applications",
16396 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16397 "version": "0.0.0",
16398 "filename": "server/api/mailApplication/index.js",
16399 "groupTitle": "Mail_Applications"
16403 "url": "/api/mail/interactions/{id}/tags",
16404 "title": "Add tags to the interaction",
16407 "title": "Example usage:",
16408 "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",
16413 "group": "Mail_Interactions",
16414 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16415 "version": "0.0.0",
16416 "filename": "server/api/mailInteraction/index.js",
16417 "groupTitle": "Mail_Interactions"
16421 "url": "/api/mail/interactions",
16422 "title": "Creates a new Interaction",
16425 "title": "Example usage:",
16426 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16430 "name": "CreateInteractions",
16431 "group": "Mail_Interactions",
16446 "field": "closedAt",
16453 "field": "disposition",
16460 "field": "secondDisposition",
16467 "field": "thirdDisposition",
16481 "field": "inReplyTo",
16502 "field": "subject",
16516 "field": "read1stAt",
16523 "field": "substatus",
16530 "field": "substatusAt",
16541 "field": "firstMsgDirection",
16548 "field": "lastMsgAt",
16559 "field": "lastMsgDirection",
16566 "field": "autoreplyExecuted",
16572 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16573 "version": "0.0.0",
16574 "filename": "server/api/mailInteraction/index.js",
16575 "groupTitle": "Mail_Interactions"
16579 "url": "/api/mail/interactions/{id}",
16580 "title": "Deletes a Interaction",
16583 "title": "Example usage:",
16584 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
16588 "name": "DeleteInteractions",
16589 "group": "Mail_Interactions",
16590 "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>",
16591 "version": "0.0.0",
16592 "filename": "server/api/mailInteraction/index.js",
16593 "groupTitle": "Mail_Interactions"
16597 "url": "/api/mail/interactions/describe",
16598 "title": "Gets table info about Interactions",
16601 "title": "Example usage:",
16602 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16606 "name": "DescribeInteractions",
16607 "group": "Mail_Interactions",
16608 "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>",
16609 "version": "0.0.0",
16610 "filename": "server/api/mailInteraction/index.js",
16611 "groupTitle": "Mail_Interactions"
16615 "url": "/api/mail/interactions",
16616 "title": "Gets a list of Interactions",
16619 "title": "Example usage:",
16620 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16624 "name": "GetInteractions",
16625 "group": "Mail_Interactions",
16626 "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>",
16627 "version": "0.0.0",
16628 "filename": "server/api/mailInteraction/index.js",
16629 "groupTitle": "Mail_Interactions"
16633 "url": "/api/mail/interactions/{id}/tags",
16634 "title": "Removes tags from interaction",
16637 "title": "Example usage:",
16638 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16642 "name": "RemoveTags",
16643 "group": "Mail_Interactions",
16644 "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>",
16645 "version": "0.0.0",
16646 "filename": "server/api/mailInteraction/index.js",
16647 "groupTitle": "Mail_Interactions"
16651 "url": "/api/mail/interactions/{id}",
16652 "title": "Gets a single Interaction",
16655 "title": "Example usage:",
16656 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16660 "name": "ShowInteractions",
16661 "group": "Mail_Interactions",
16662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16663 "version": "0.0.0",
16664 "filename": "server/api/mailInteraction/index.js",
16665 "groupTitle": "Mail_Interactions"
16669 "url": "/api/mail/interactions/{id}/messages",
16670 "title": "Creates new message",
16673 "title": "Example usage:",
16674 "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",
16678 "name": "addMessage",
16679 "group": "Mail_Interactions",
16694 "field": "plainBody",
16712 "field": "direction",
16719 "field": "messageId",
16754 "field": "subject",
16789 "field": "originTo",
16796 "field": "originCc",
16807 "field": "originChannel",
16813 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16814 "version": "0.0.0",
16815 "filename": "server/api/mailInteraction/index.js",
16816 "groupTitle": "Mail_Interactions"
16820 "url": "/api/mail/interactions/{id}/download",
16821 "title": "Gets interaction",
16824 "title": "Example usage:",
16825 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16829 "name": "download",
16830 "group": "Mail_Interactions",
16831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16832 "version": "0.0.0",
16833 "filename": "server/api/mailInteraction/index.js",
16834 "groupTitle": "Mail_Interactions"
16838 "url": "/api/mail/interactions/{id}/messages",
16839 "title": "Gets interaction messages",
16842 "title": "Example usage:",
16843 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16847 "name": "getMessages",
16848 "group": "Mail_Interactions",
16849 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16850 "version": "0.0.0",
16851 "filename": "server/api/mailInteraction/index.js",
16852 "groupTitle": "Mail_Interactions"
16856 "url": "/api/mail/interactions/{id}",
16857 "title": "Update an existing Interaction",
16860 "title": "Example usage:",
16861 "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",
16865 "name": "updateInteractions",
16866 "group": "Mail_Interactions",
16867 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16868 "version": "0.0.0",
16869 "filename": "server/api/mailInteraction/index.js",
16870 "groupTitle": "Mail_Interactions"
16874 "url": "/api/mail/messages/{id}",
16875 "title": "Deletes a Message",
16878 "title": "Example usage:",
16879 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16883 "name": "DeleteMessages",
16884 "group": "Mail_Messages",
16885 "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>",
16886 "version": "0.0.0",
16887 "filename": "server/api/mailMessage/index.js",
16888 "groupTitle": "Mail_Messages"
16892 "url": "/api/mail/messages/describe",
16893 "title": "Gets table info about Messages",
16896 "title": "Example usage:",
16897 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16901 "name": "DescribeMessages",
16902 "group": "Mail_Messages",
16903 "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>",
16904 "version": "0.0.0",
16905 "filename": "server/api/mailMessage/index.js",
16906 "groupTitle": "Mail_Messages"
16910 "url": "/api/mail/messages",
16911 "title": "Gets a list of Messages",
16914 "title": "Example usage:",
16915 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16919 "name": "GetMessages",
16920 "group": "Mail_Messages",
16921 "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>",
16922 "version": "0.0.0",
16923 "filename": "server/api/mailMessage/index.js",
16924 "groupTitle": "Mail_Messages"
16928 "url": "/api/mail/messages/{id}",
16929 "title": "Gets a single Message",
16932 "title": "Example usage:",
16933 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16937 "name": "ShowMessages",
16938 "group": "Mail_Messages",
16939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16940 "version": "0.0.0",
16941 "filename": "server/api/mailMessage/index.js",
16942 "groupTitle": "Mail_Messages"
16946 "url": "/api/mail/messages/{id}/accept",
16947 "title": "Accepts message",
16950 "title": "Example usage:",
16951 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16955 "name": "acceptMessage",
16956 "group": "Mail_Messages",
16957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16958 "version": "0.0.0",
16959 "filename": "server/api/mailMessage/index.js",
16960 "groupTitle": "Mail_Messages"
16964 "url": "/api/mail/messages",
16965 "title": "Create a message",
16968 "title": "Example usage:",
16969 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16973 "name": "createMessage",
16974 "group": "Mail_Messages",
16975 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16976 "version": "0.0.0",
16977 "filename": "server/api/mailMessage/index.js",
16978 "groupTitle": "Mail_Messages"
16982 "url": "/api/mail/messages/{id}/download",
16983 "title": "Gets message",
16986 "title": "Example usage:",
16987 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16991 "name": "download",
16992 "group": "Mail_Messages",
16993 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16994 "version": "0.0.0",
16995 "filename": "server/api/mailMessage/index.js",
16996 "groupTitle": "Mail_Messages"
17000 "url": "/api/mail/messages/{id}/reject",
17001 "title": "Rejects message",
17004 "title": "Example usage:",
17005 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17009 "name": "rejectMessage",
17010 "group": "Mail_Messages",
17011 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17012 "version": "0.0.0",
17013 "filename": "server/api/mailMessage/index.js",
17014 "groupTitle": "Mail_Messages"
17018 "url": "/api/mail/messages/{id}",
17019 "title": "Update an existing Message",
17022 "title": "Example usage:",
17023 "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",
17027 "name": "updateMessages",
17028 "group": "Mail_Messages",
17029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17030 "version": "0.0.0",
17031 "filename": "server/api/mailMessage/index.js",
17032 "groupTitle": "Mail_Messages"
17036 "url": "/api/mail/reports/queue",
17037 "title": "Creates a new Mail Queue Report",
17040 "title": "Example usage:",
17041 "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",
17045 "name": "CreateMail_Queue_Reports",
17046 "group": "Mail_Queue_Reports",
17054 "field": "uniqueid",
17075 "field": "leaveAt",
17082 "field": "acceptAt",
17102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17103 "version": "0.0.0",
17104 "filename": "server/api/mailQueueReport/index.js",
17105 "groupTitle": "Mail_Queue_Reports"
17109 "url": "/api/mail/reports/queue/{id}",
17110 "title": "Deletes a Mail Queue Report",
17113 "title": "Example usage:",
17114 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
17118 "name": "DeleteMail_Queue_Reports",
17119 "group": "Mail_Queue_Reports",
17120 "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>",
17121 "version": "0.0.0",
17122 "filename": "server/api/mailQueueReport/index.js",
17123 "groupTitle": "Mail_Queue_Reports"
17127 "url": "/api/mail/reports/queue/describe",
17128 "title": "Gets table info about Mail Queue Reports",
17131 "title": "Example usage:",
17132 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
17136 "name": "DescribeMail_Queue_Reports",
17137 "group": "Mail_Queue_Reports",
17138 "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>",
17139 "version": "0.0.0",
17140 "filename": "server/api/mailQueueReport/index.js",
17141 "groupTitle": "Mail_Queue_Reports"
17145 "url": "/api/mail/reports/queue",
17146 "title": "Gets a list of Mail Queue Reports",
17149 "title": "Example usage:",
17150 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
17154 "name": "GetMail_Queue_Reports",
17155 "group": "Mail_Queue_Reports",
17156 "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>",
17157 "version": "0.0.0",
17158 "filename": "server/api/mailQueueReport/index.js",
17159 "groupTitle": "Mail_Queue_Reports"
17163 "url": "/api/mail/reports/queue/{id}",
17164 "title": "Gets a single Mail Queue Report",
17167 "title": "Example usage:",
17168 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
17172 "name": "ShowMail_Queue_Reports",
17173 "group": "Mail_Queue_Reports",
17174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17175 "version": "0.0.0",
17176 "filename": "server/api/mailQueueReport/index.js",
17177 "groupTitle": "Mail_Queue_Reports"
17181 "url": "/api/mail/reports/queue/{id}",
17182 "title": "Update an existing Mail Queue Report",
17185 "title": "Example usage:",
17186 "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",
17190 "name": "updateMail_Queue_Reports",
17191 "group": "Mail_Queue_Reports",
17192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17193 "version": "0.0.0",
17194 "filename": "server/api/mailQueueReport/index.js",
17195 "groupTitle": "Mail_Queue_Reports"
17199 "url": "/api/mail/queues/{id}/users",
17200 "title": "Add agents to a queue",
17203 "title": "Example usage:",
17204 "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",
17208 "name": "AddAgents",
17209 "group": "Mail_Queues",
17210 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17211 "version": "0.0.0",
17212 "filename": "server/api/mailQueue/index.js",
17213 "groupTitle": "Mail_Queues"
17217 "url": "/api/mail/queues/{id}/teams",
17218 "title": "Add teams to a queue",
17221 "title": "Example usage:",
17222 "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",
17226 "name": "AddTeams",
17227 "group": "Mail_Queues",
17228 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17229 "version": "0.0.0",
17230 "filename": "server/api/mailQueue/index.js",
17231 "groupTitle": "Mail_Queues"
17235 "url": "/api/mail/queues",
17236 "title": "Creates a new Queue",
17239 "title": "Example usage:",
17240 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17244 "name": "CreateQueues",
17245 "group": "Mail_Queues",
17260 "field": "description",
17267 "field": "timeout",
17279 "field": "strategy",
17285 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17286 "version": "0.0.0",
17287 "filename": "server/api/mailQueue/index.js",
17288 "groupTitle": "Mail_Queues"
17292 "url": "/api/mail/queues/{id}",
17293 "title": "Deletes a Queue",
17296 "title": "Example usage:",
17297 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
17301 "name": "DeleteQueues",
17302 "group": "Mail_Queues",
17303 "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>",
17304 "version": "0.0.0",
17305 "filename": "server/api/mailQueue/index.js",
17306 "groupTitle": "Mail_Queues"
17310 "url": "/api/mail/queues/describe",
17311 "title": "Gets table info about Queues",
17314 "title": "Example usage:",
17315 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
17319 "name": "DescribeQueues",
17320 "group": "Mail_Queues",
17321 "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>",
17322 "version": "0.0.0",
17323 "filename": "server/api/mailQueue/index.js",
17324 "groupTitle": "Mail_Queues"
17328 "url": "/api/mail/queues/{id}/users",
17329 "title": "Gets queue agents",
17332 "title": "Example usage:",
17333 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
17337 "name": "GetAgents",
17338 "group": "Mail_Queues",
17339 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17340 "version": "0.0.0",
17341 "filename": "server/api/mailQueue/index.js",
17342 "groupTitle": "Mail_Queues"
17346 "url": "/api/mail/queues/{id}/members",
17347 "title": "GetMembers",
17350 "title": "Example usage:",
17351 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
17355 "name": "GetMembers",
17356 "group": "Mail_Queues",
17357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17358 "version": "0.0.0",
17359 "filename": "server/api/mailQueue/index.js",
17360 "groupTitle": "Mail_Queues"
17364 "url": "/api/mail/queues",
17365 "title": "Gets a list of Queues",
17368 "title": "Example usage:",
17369 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
17373 "name": "GetQueues",
17374 "group": "Mail_Queues",
17375 "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>",
17376 "version": "0.0.0",
17377 "filename": "server/api/mailQueue/index.js",
17378 "groupTitle": "Mail_Queues"
17382 "url": "/api/mail/queues/{id}/teams",
17383 "title": "Gets queues list",
17386 "title": "Example usage:",
17387 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
17391 "name": "GetTeams",
17392 "group": "Mail_Queues",
17393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17394 "version": "0.0.0",
17395 "filename": "server/api/mailQueue/index.js",
17396 "groupTitle": "Mail_Queues"
17400 "url": "/api/mail/queues/{id}/users",
17401 "title": "Removes agents from a queue",
17404 "title": "Example usage:",
17405 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17409 "name": "RemoveAgents",
17410 "group": "Mail_Queues",
17411 "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>",
17412 "version": "0.0.0",
17413 "filename": "server/api/mailQueue/index.js",
17414 "groupTitle": "Mail_Queues"
17418 "url": "/api/mail/queues/{id}",
17419 "title": "Gets a single Queue",
17422 "title": "Example usage:",
17423 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
17427 "name": "ShowQueues",
17428 "group": "Mail_Queues",
17429 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17430 "version": "0.0.0",
17431 "filename": "server/api/mailQueue/index.js",
17432 "groupTitle": "Mail_Queues"
17436 "url": "/api/mail/queues/{id}",
17437 "title": "Update an existing Queue",
17440 "title": "Example usage:",
17441 "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",
17445 "name": "updateQueues",
17446 "group": "Mail_Queues",
17447 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17448 "version": "0.0.0",
17449 "filename": "server/api/mailQueue/index.js",
17450 "groupTitle": "Mail_Queues"
17454 "url": "/api/mail/out_servers",
17455 "title": "Creates a new SMTP",
17458 "title": "Example usage:",
17459 "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",
17463 "name": "CreateSMTPs",
17464 "group": "Mail_SMTP",
17472 "field": "description",
17514 "field": "service",
17521 "field": "authentication",
17527 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17528 "version": "0.0.0",
17529 "filename": "server/api/mailServerOut/index.js",
17530 "groupTitle": "Mail_SMTP"
17534 "url": "/api/mail/out_servers/{id}",
17535 "title": "Deletes a SMTP",
17538 "title": "Example usage:",
17539 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
17543 "name": "DeleteSMTPs",
17544 "group": "Mail_SMTP",
17545 "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>",
17546 "version": "0.0.0",
17547 "filename": "server/api/mailServerOut/index.js",
17548 "groupTitle": "Mail_SMTP"
17552 "url": "/api/mail/out_servers",
17553 "title": "Gets a list of SMTPs",
17556 "title": "Example usage:",
17557 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
17561 "name": "GetSMTPs",
17562 "group": "Mail_SMTP",
17563 "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>",
17564 "version": "0.0.0",
17565 "filename": "server/api/mailServerOut/index.js",
17566 "groupTitle": "Mail_SMTP"
17570 "url": "/api/mail/out_servers/{id}",
17571 "title": "Gets a single SMTP",
17574 "title": "Example usage:",
17575 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
17579 "name": "ShowSMTPs",
17580 "group": "Mail_SMTP",
17581 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17582 "version": "0.0.0",
17583 "filename": "server/api/mailServerOut/index.js",
17584 "groupTitle": "Mail_SMTP"
17588 "url": "/api/mail/out_servers/{id}",
17589 "title": "Update an existing SMTP",
17592 "title": "Example usage:",
17593 "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",
17597 "name": "updateSMTPs",
17598 "group": "Mail_SMTP",
17599 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17600 "version": "0.0.0",
17601 "filename": "server/api/mailServerOut/index.js",
17602 "groupTitle": "Mail_SMTP"
17606 "url": "/api/mail/substatuses",
17607 "title": "Creates a new Queue",
17610 "title": "Example usage:",
17611 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17615 "name": "CreateSubstatuses",
17616 "group": "Mail_Substatuses",
17631 "field": "description",
17637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17638 "version": "0.0.0",
17639 "filename": "server/api/mailSubstatus/index.js",
17640 "groupTitle": "Mail_Substatuses"
17644 "url": "/api/mail/substatuses/{id}",
17645 "title": "Deletes a Queue",
17648 "title": "Example usage:",
17649 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17653 "name": "DeleteSubstatuses",
17654 "group": "Mail_Substatuses",
17655 "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>",
17656 "version": "0.0.0",
17657 "filename": "server/api/mailSubstatus/index.js",
17658 "groupTitle": "Mail_Substatuses"
17662 "url": "/api/mail/substatuses/describe",
17663 "title": "Gets table info about Substatuses",
17666 "title": "Example usage:",
17667 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17671 "name": "DescribeSubstatuses",
17672 "group": "Mail_Substatuses",
17673 "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>",
17674 "version": "0.0.0",
17675 "filename": "server/api/mailSubstatus/index.js",
17676 "groupTitle": "Mail_Substatuses"
17680 "url": "/api/mail/substatuses",
17681 "title": "Gets a list of Substatuses",
17684 "title": "Example usage:",
17685 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17689 "name": "GetSubstatuses",
17690 "group": "Mail_Substatuses",
17691 "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>",
17692 "version": "0.0.0",
17693 "filename": "server/api/mailSubstatus/index.js",
17694 "groupTitle": "Mail_Substatuses"
17698 "url": "/api/mail/substatuses/{id}",
17699 "title": "Gets a single Queue",
17702 "title": "Example usage:",
17703 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17707 "name": "ShowSubstatuses",
17708 "group": "Mail_Substatuses",
17709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17710 "version": "0.0.0",
17711 "filename": "server/api/mailSubstatus/index.js",
17712 "groupTitle": "Mail_Substatuses"
17716 "url": "/api/mail/substatuses/{id}",
17717 "title": "Update an existing Queue",
17720 "title": "Example usage:",
17721 "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",
17725 "name": "updateSubstatuses",
17726 "group": "Mail_Substatuses",
17727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17728 "version": "0.0.0",
17729 "filename": "server/api/mailSubstatus/index.js",
17730 "groupTitle": "Mail_Substatuses"
17734 "url": "/api/mail/reports/transfer",
17735 "title": "Creates a new Mail Transfer Report",
17738 "title": "Example usage:",
17739 "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",
17743 "name": "CreateMail_Transfer_Reports",
17744 "group": "Mail_Transfer_Reports",
17752 "field": "uniqueid",
17771 "field": "transferredAt",
17777 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17778 "version": "0.0.0",
17779 "filename": "server/api/mailTransferReport/index.js",
17780 "groupTitle": "Mail_Transfer_Reports"
17784 "url": "/api/mail/reports/transfer/{id}",
17785 "title": "Deletes a Mail Transfer Report",
17788 "title": "Example usage:",
17789 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17793 "name": "DeleteMail_Transfer_Reports",
17794 "group": "Mail_Transfer_Reports",
17795 "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>",
17796 "version": "0.0.0",
17797 "filename": "server/api/mailTransferReport/index.js",
17798 "groupTitle": "Mail_Transfer_Reports"
17802 "url": "/api/mail/reports/transfer/describe",
17803 "title": "Gets table info about Mail Transfer Reports",
17806 "title": "Example usage:",
17807 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17811 "name": "DescribeMail_Transfer_Reports",
17812 "group": "Mail_Transfer_Reports",
17813 "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>",
17814 "version": "0.0.0",
17815 "filename": "server/api/mailTransferReport/index.js",
17816 "groupTitle": "Mail_Transfer_Reports"
17820 "url": "/api/mail/reports/transfer",
17821 "title": "Gets a list of Mail Transfer Reports",
17824 "title": "Example usage:",
17825 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17829 "name": "GetMail_Transfer_Reports",
17830 "group": "Mail_Transfer_Reports",
17831 "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>",
17832 "version": "0.0.0",
17833 "filename": "server/api/mailTransferReport/index.js",
17834 "groupTitle": "Mail_Transfer_Reports"
17838 "url": "/api/mail/reports/transfer/{id}",
17839 "title": "Gets a single Mail Transfer Report",
17842 "title": "Example usage:",
17843 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17847 "name": "ShowMail_Transfer_Reports",
17848 "group": "Mail_Transfer_Reports",
17849 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17850 "version": "0.0.0",
17851 "filename": "server/api/mailTransferReport/index.js",
17852 "groupTitle": "Mail_Transfer_Reports"
17856 "url": "/api/mail/reports/transfer/{id}",
17857 "title": "Update an existing Mail Transfer Report",
17860 "title": "Example usage:",
17861 "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",
17865 "name": "updateMail_Transfer_Reports",
17866 "group": "Mail_Transfer_Reports",
17867 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17868 "version": "0.0.0",
17869 "filename": "server/api/mailTransferReport/index.js",
17870 "groupTitle": "Mail_Transfer_Reports"
17874 "url": "/api/members/reports/describe",
17875 "title": "Gets table info about Member Reports",
17878 "title": "Example usage:",
17879 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17883 "name": "DescribeMember_Reports",
17884 "group": "Member_Reports",
17885 "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>",
17886 "version": "0.0.0",
17887 "filename": "server/api/memberReport/index.js",
17888 "groupTitle": "Member_Reports"
17892 "url": "/api/members/reports",
17893 "title": "Gets a list of Member Reports",
17896 "title": "Example usage:",
17897 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17901 "name": "GetMember_Reports",
17902 "group": "Member_Reports",
17903 "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>",
17904 "version": "0.0.0",
17905 "filename": "server/api/memberReport/index.js",
17906 "groupTitle": "Member_Reports"
17910 "url": "/api/members/reports/{id}",
17911 "title": "Gets a single Member Report",
17914 "title": "Example usage:",
17915 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17919 "name": "ShowMember_Reports",
17920 "group": "Member_Reports",
17921 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17922 "version": "0.0.0",
17923 "filename": "server/api/memberReport/index.js",
17924 "groupTitle": "Member_Reports"
17928 "url": "/api/migrations",
17929 "title": "Gets a list of Migrations",
17932 "title": "Example usage:",
17933 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17937 "name": "GetMigrations",
17938 "group": "Migrations",
17939 "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>",
17940 "version": "0.0.0",
17941 "filename": "server/api/migration/index.js",
17942 "groupTitle": "Migrations"
17946 "url": "/api/voice/networks",
17947 "title": "Create a new network",
17950 "title": "Example usage:",
17951 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17956 "group": "Networks",
17957 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17958 "version": "0.0.0",
17959 "filename": "server/api/network/index.js",
17960 "groupTitle": "Networks"
17964 "url": "/api/voice/networks/{id}",
17965 "title": "Deletes a network",
17968 "title": "Example usage:",
17969 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17974 "group": "Networks",
17975 "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>",
17976 "version": "0.0.0",
17977 "filename": "server/api/network/index.js",
17978 "groupTitle": "Networks"
17982 "url": "/api/networks",
17983 "title": "Gets a list of Networks",
17986 "title": "Example usage:",
17987 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17991 "name": "GetNetworks",
17992 "group": "Networks",
17993 "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>",
17994 "version": "0.0.0",
17995 "filename": "server/api/network/index.js",
17996 "groupTitle": "Networks"
18000 "url": "/api/networks/{id}",
18001 "title": "Gets a single Network",
18004 "title": "Example usage:",
18005 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
18009 "name": "ShowNetworks",
18010 "group": "Networks",
18011 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18012 "version": "0.0.0",
18013 "filename": "server/api/network/index.js",
18014 "groupTitle": "Networks"
18018 "url": "/api/voice/networks/{id}",
18019 "title": "Update an existing network",
18022 "title": "Example usage:",
18023 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
18028 "group": "Networks",
18029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18030 "version": "0.0.0",
18031 "filename": "server/api/network/index.js",
18032 "groupTitle": "Networks"
18036 "url": "/api/openchannel/accounts/{id}/users",
18037 "title": "Add agents to a openchannel account",
18040 "title": "Example usage:",
18041 "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",
18045 "name": "AddAgents",
18046 "group": "Openchannel_Accounts",
18047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18048 "version": "0.0.0",
18049 "filename": "server/api/openchannelAccount/index.js",
18050 "groupTitle": "Openchannel_Accounts"
18054 "url": "/api/openchannel/accounts",
18055 "title": "Creates a new Account",
18058 "title": "Example usage:",
18059 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18063 "name": "CreateAccounts",
18064 "group": "Openchannel_Accounts",
18079 "field": "description",
18093 "field": "replyUri",
18107 "field": "notificationTemplate",
18114 "field": "notificationSound",
18121 "field": "notificationShake",
18128 "field": "waitForTheAssignedAgent",
18142 "field": "queueTransfer",
18149 "field": "queueTransferTimeout",
18156 "field": "agentTransfer",
18163 "field": "agentTransferTimeout",
18170 "field": "mandatoryDispositionPauseId",
18171 "description": "<p>Status to put when mandatory disposition is enabled</p>"
18177 "field": "mandatoryDisposition",
18178 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
18183 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18184 "version": "0.0.0",
18185 "filename": "server/api/openchannelAccount/index.js",
18186 "groupTitle": "Openchannel_Accounts"
18190 "url": "/api/openchannel/accounts/{id}",
18191 "title": "Deletes a Account",
18194 "title": "Example usage:",
18195 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
18199 "name": "DeleteAccounts",
18200 "group": "Openchannel_Accounts",
18201 "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>",
18202 "version": "0.0.0",
18203 "filename": "server/api/openchannelAccount/index.js",
18204 "groupTitle": "Openchannel_Accounts"
18208 "url": "/api/openchannel/accounts/describe",
18209 "title": "Gets table info about Accounts",
18212 "title": "Example usage:",
18213 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
18217 "name": "DescribeAccounts",
18218 "group": "Openchannel_Accounts",
18219 "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>",
18220 "version": "0.0.0",
18221 "filename": "server/api/openchannelAccount/index.js",
18222 "groupTitle": "Openchannel_Accounts"
18226 "url": "/api/openchannel/accounts",
18227 "title": "Gets a list of Accounts",
18230 "title": "Example usage:",
18231 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
18235 "name": "GetAccounts",
18236 "group": "Openchannel_Accounts",
18237 "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>",
18238 "version": "0.0.0",
18239 "filename": "server/api/openchannelAccount/index.js",
18240 "groupTitle": "Openchannel_Accounts"
18244 "url": "/api/openchannel/accounts/{id}/users",
18245 "title": "Gets agents from openchannel account",
18248 "title": "Example usage:",
18249 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
18253 "name": "GetAgents",
18254 "group": "Openchannel_Accounts",
18255 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18256 "version": "0.0.0",
18257 "filename": "server/api/openchannelAccount/index.js",
18258 "groupTitle": "Openchannel_Accounts"
18262 "url": "/api/openchannel/accounts/{id}/users",
18263 "title": "Removes agents from a openchannel account",
18266 "title": "Example usage:",
18267 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18271 "name": "RemoveAgents",
18272 "group": "Openchannel_Accounts",
18273 "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>",
18274 "version": "0.0.0",
18275 "filename": "server/api/openchannelAccount/index.js",
18276 "groupTitle": "Openchannel_Accounts"
18280 "url": "/api/openchannel/accounts/{id}/canned_answers",
18281 "title": "Removes canned answers from account",
18284 "title": "Example usage:",
18285 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18289 "name": "RemoveAnswers",
18290 "group": "Openchannel_Accounts",
18291 "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>",
18292 "version": "0.0.0",
18293 "filename": "server/api/openchannelAccount/index.js",
18294 "groupTitle": "Openchannel_Accounts"
18298 "url": "/api/openchannel/accounts/{id}/dispositions",
18299 "title": "Removes dispositions from account",
18302 "title": "Example usage:",
18303 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18307 "name": "RemoveDispositions",
18308 "group": "Openchannel_Accounts",
18309 "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>",
18310 "version": "0.0.0",
18311 "filename": "server/api/openchannelAccount/index.js",
18312 "groupTitle": "Openchannel_Accounts"
18316 "url": "/api/openchannel/accounts/{id}",
18317 "title": "Gets a single Account",
18320 "title": "Example usage:",
18321 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
18325 "name": "ShowAccounts",
18326 "group": "Openchannel_Accounts",
18327 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18328 "version": "0.0.0",
18329 "filename": "server/api/openchannelAccount/index.js",
18330 "groupTitle": "Openchannel_Accounts"
18334 "url": "/api/openchannel/accounts/{id}/canned_answers",
18335 "title": "Creates new canned answer",
18338 "title": "Example usage:",
18339 "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",
18343 "name": "addAnswer",
18344 "group": "Openchannel_Accounts",
18366 "field": "description",
18379 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18380 "version": "0.0.0",
18381 "filename": "server/api/openchannelAccount/index.js",
18382 "groupTitle": "Openchannel_Accounts"
18386 "url": "/api/openchannel/accounts/{id}/applications",
18387 "title": "Creates new applications",
18390 "title": "Example usage:",
18391 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18395 "name": "addApplications",
18396 "group": "Openchannel_Accounts",
18404 "field": "priority",
18418 "field": "appdata",
18425 "field": "description",
18432 "field": "interval",
18438 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18439 "version": "0.0.0",
18440 "filename": "server/api/openchannelAccount/index.js",
18441 "groupTitle": "Openchannel_Accounts"
18445 "url": "/api/openchannel/accounts/{id}/dispositions",
18446 "title": "Creates new disposition",
18449 "title": "Example usage:",
18450 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18454 "name": "addDisposition",
18455 "group": "Openchannel_Accounts",
18482 "field": "description",
18488 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18489 "version": "0.0.0",
18490 "filename": "server/api/openchannelAccount/index.js",
18491 "groupTitle": "Openchannel_Accounts"
18495 "url": "/api/openchannel/accounts/{id}/canned_answers",
18496 "title": "Gets account canned answers",
18499 "title": "Example usage:",
18500 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
18504 "name": "getAnswers",
18505 "group": "Openchannel_Accounts",
18506 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18507 "version": "0.0.0",
18508 "filename": "server/api/openchannelAccount/index.js",
18509 "groupTitle": "Openchannel_Accounts"
18513 "url": "/api/openchannel/accounts/{id}/applications",
18514 "title": "Gets account applications",
18517 "title": "Example usage:",
18518 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
18522 "name": "getApplications",
18523 "group": "Openchannel_Accounts",
18524 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18525 "version": "0.0.0",
18526 "filename": "server/api/openchannelAccount/index.js",
18527 "groupTitle": "Openchannel_Accounts"
18531 "url": "/api/openchannel/accounts/{id}/dispositions",
18532 "title": "Gets account dispositions",
18535 "title": "Example usage:",
18536 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
18540 "name": "getDispositions",
18541 "group": "Openchannel_Accounts",
18542 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18543 "version": "0.0.0",
18544 "filename": "server/api/openchannelAccount/index.js",
18545 "groupTitle": "Openchannel_Accounts"
18549 "url": "/api/openchannel/accounts/{id}/interactions",
18550 "title": "Gets Openchannel Account Interactions",
18553 "title": "Example usage:",
18554 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
18558 "name": "getInteractions",
18559 "group": "Openchannel_Accounts",
18560 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18561 "version": "0.0.0",
18562 "filename": "server/api/openchannelAccount/index.js",
18563 "groupTitle": "Openchannel_Accounts"
18567 "url": "/api/openchannel/accounts/{id}/notify",
18568 "title": "Notify new message",
18571 "title": "Example usage:",
18572 "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",
18577 "group": "Openchannel_Accounts",
18578 "description": "<p>Motion 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>",
18579 "version": "0.0.0",
18580 "filename": "server/api/openchannelAccount/index.js",
18581 "groupTitle": "Openchannel_Accounts"
18585 "url": "/api/openchannel/accounts/{id}/send",
18586 "title": "Send new openchannel message",
18589 "title": "Example usage:",
18590 "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",
18594 "name": "sendOpenchannel",
18595 "group": "Openchannel_Accounts",
18596 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18597 "version": "0.0.0",
18598 "filename": "server/api/openchannelAccount/index.js",
18599 "groupTitle": "Openchannel_Accounts"
18603 "url": "/api/openchannel/accounts/{id}",
18604 "title": "Update an existing Account",
18607 "title": "Example usage:",
18608 "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",
18612 "name": "updateAccounts",
18613 "group": "Openchannel_Accounts",
18614 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18615 "version": "0.0.0",
18616 "filename": "server/api/openchannelAccount/index.js",
18617 "groupTitle": "Openchannel_Accounts"
18621 "url": "/api/openchannel/applications",
18622 "title": "Creates a new Application",
18625 "title": "Example usage:",
18626 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18630 "name": "CreateApplications",
18631 "group": "Openchannel_Applications",
18639 "field": "priority",
18653 "field": "appdata",
18660 "field": "description",
18667 "field": "interval",
18673 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18674 "version": "0.0.0",
18675 "filename": "server/api/openchannelApplication/index.js",
18676 "groupTitle": "Openchannel_Applications"
18680 "url": "/api/openchannel/applications/{id}",
18681 "title": "Deletes a Application",
18684 "title": "Example usage:",
18685 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18689 "name": "DeleteApplications",
18690 "group": "Openchannel_Applications",
18691 "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>",
18692 "version": "0.0.0",
18693 "filename": "server/api/openchannelApplication/index.js",
18694 "groupTitle": "Openchannel_Applications"
18698 "url": "/api/openchannel/applications",
18699 "title": "Gets a list of Applications",
18702 "title": "Example usage:",
18703 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18707 "name": "GetApplications",
18708 "group": "Openchannel_Applications",
18709 "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>",
18710 "version": "0.0.0",
18711 "filename": "server/api/openchannelApplication/index.js",
18712 "groupTitle": "Openchannel_Applications"
18716 "url": "/api/openchannel/applications/{id}",
18717 "title": "Gets a single Application",
18720 "title": "Example usage:",
18721 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18725 "name": "ShowApplications",
18726 "group": "Openchannel_Applications",
18727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18728 "version": "0.0.0",
18729 "filename": "server/api/openchannelApplication/index.js",
18730 "groupTitle": "Openchannel_Applications"
18734 "url": "/api/openchannel/applications/{id}",
18735 "title": "Update an existing Application",
18738 "title": "Example usage:",
18739 "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",
18743 "name": "updateApplications",
18744 "group": "Openchannel_Applications",
18745 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18746 "version": "0.0.0",
18747 "filename": "server/api/openchannelApplication/index.js",
18748 "groupTitle": "Openchannel_Applications"
18752 "url": "/api/openchannel/interactions/{id}/tags",
18753 "title": "Add tags to the interaction",
18756 "title": "Example usage:",
18757 "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",
18762 "group": "Openchannel_Interactions",
18763 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18764 "version": "0.0.0",
18765 "filename": "server/api/openchannelInteraction/index.js",
18766 "groupTitle": "Openchannel_Interactions"
18770 "url": "/api/openchannel/interactions",
18771 "title": "Creates a new Interaction",
18774 "title": "Example usage:",
18775 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18779 "name": "CreateInteractions",
18780 "group": "Openchannel_Interactions",
18795 "field": "closedAt",
18802 "field": "disposition",
18809 "field": "secondDisposition",
18816 "field": "thirdDisposition",
18830 "field": "read1stAt",
18837 "field": "threadId",
18844 "field": "externalUrl",
18851 "field": "lastMsgAt",
18862 "field": "lastMsgDirection",
18876 "field": "autoreplyExecuted",
18882 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18883 "version": "0.0.0",
18884 "filename": "server/api/openchannelInteraction/index.js",
18885 "groupTitle": "Openchannel_Interactions"
18889 "url": "/api/openchannel/interactions/{id}",
18890 "title": "Deletes a Interaction",
18893 "title": "Example usage:",
18894 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18898 "name": "DeleteInteractions",
18899 "group": "Openchannel_Interactions",
18900 "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>",
18901 "version": "0.0.0",
18902 "filename": "server/api/openchannelInteraction/index.js",
18903 "groupTitle": "Openchannel_Interactions"
18907 "url": "/api/openchannel/interactions/describe",
18908 "title": "Gets table info about Interactions",
18911 "title": "Example usage:",
18912 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18916 "name": "DescribeInteractions",
18917 "group": "Openchannel_Interactions",
18918 "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>",
18919 "version": "0.0.0",
18920 "filename": "server/api/openchannelInteraction/index.js",
18921 "groupTitle": "Openchannel_Interactions"
18925 "url": "/api/openchannel/interactions",
18926 "title": "Gets a list of Interactions",
18929 "title": "Example usage:",
18930 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18934 "name": "GetInteractions",
18935 "group": "Openchannel_Interactions",
18936 "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>",
18937 "version": "0.0.0",
18938 "filename": "server/api/openchannelInteraction/index.js",
18939 "groupTitle": "Openchannel_Interactions"
18943 "url": "/api/openchannel/interactions/{id}/tags",
18944 "title": "Removes tags from interaction",
18947 "title": "Example usage:",
18948 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18952 "name": "RemoveTags",
18953 "group": "Openchannel_Interactions",
18954 "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>",
18955 "version": "0.0.0",
18956 "filename": "server/api/openchannelInteraction/index.js",
18957 "groupTitle": "Openchannel_Interactions"
18961 "url": "/api/openchannel/interactions/{id}",
18962 "title": "Gets a single Interaction",
18965 "title": "Example usage:",
18966 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18970 "name": "ShowInteractions",
18971 "group": "Openchannel_Interactions",
18972 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18973 "version": "0.0.0",
18974 "filename": "server/api/openchannelInteraction/index.js",
18975 "groupTitle": "Openchannel_Interactions"
18979 "url": "/api/openchannel/interactions/{id}/messages",
18980 "title": "Creates new messages",
18983 "title": "Example usage:",
18984 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18988 "name": "addMessage",
18989 "group": "Openchannel_Interactions",
19022 "field": "direction",
19036 "field": "providerName",
19043 "field": "providerResponse",
19049 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19050 "version": "0.0.0",
19051 "filename": "server/api/openchannelInteraction/index.js",
19052 "groupTitle": "Openchannel_Interactions"
19056 "url": "/api/openchannel/interactions/{id}/download",
19057 "title": "Gets interaction",
19060 "title": "Example usage:",
19061 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
19065 "name": "download",
19066 "group": "Openchannel_Interactions",
19067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19068 "version": "0.0.0",
19069 "filename": "server/api/openchannelInteraction/index.js",
19070 "groupTitle": "Openchannel_Interactions"
19074 "url": "/api/openchannel/interactions/{id}/messages",
19075 "title": "Gets interaction messages",
19078 "title": "Example usage:",
19079 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
19083 "name": "getMessages",
19084 "group": "Openchannel_Interactions",
19085 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19086 "version": "0.0.0",
19087 "filename": "server/api/openchannelInteraction/index.js",
19088 "groupTitle": "Openchannel_Interactions"
19092 "url": "/api/openchannel/interactions/{id}",
19093 "title": "Update an existing Interaction",
19096 "title": "Example usage:",
19097 "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",
19101 "name": "updateInteractions",
19102 "group": "Openchannel_Interactions",
19103 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19104 "version": "0.0.0",
19105 "filename": "server/api/openchannelInteraction/index.js",
19106 "groupTitle": "Openchannel_Interactions"
19110 "url": "/api/openchannel/messages",
19111 "title": "Creates a new Message",
19114 "title": "Example usage:",
19115 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19119 "name": "CreateMessages",
19120 "group": "Openchannel_Messages",
19153 "field": "direction",
19167 "field": "providerName",
19174 "field": "providerResponse",
19180 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19181 "version": "0.0.0",
19182 "filename": "server/api/openchannelMessage/index.js",
19183 "groupTitle": "Openchannel_Messages"
19187 "url": "/api/openchannel/messages/{id}",
19188 "title": "Deletes a Message",
19191 "title": "Example usage:",
19192 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
19196 "name": "DeleteMessages",
19197 "group": "Openchannel_Messages",
19198 "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>",
19199 "version": "0.0.0",
19200 "filename": "server/api/openchannelMessage/index.js",
19201 "groupTitle": "Openchannel_Messages"
19205 "url": "/api/openchannel/messages/describe",
19206 "title": "Gets table info about Messages",
19209 "title": "Example usage:",
19210 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
19214 "name": "DescribeMessages",
19215 "group": "Openchannel_Messages",
19216 "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>",
19217 "version": "0.0.0",
19218 "filename": "server/api/openchannelMessage/index.js",
19219 "groupTitle": "Openchannel_Messages"
19223 "url": "/api/openchannel/messages",
19224 "title": "Gets a list of Messages",
19227 "title": "Example usage:",
19228 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
19232 "name": "GetMessages",
19233 "group": "Openchannel_Messages",
19234 "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>",
19235 "version": "0.0.0",
19236 "filename": "server/api/openchannelMessage/index.js",
19237 "groupTitle": "Openchannel_Messages"
19241 "url": "/api/openchannel/messages/{id}",
19242 "title": "Gets a single Message",
19245 "title": "Example usage:",
19246 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
19250 "name": "ShowMessages",
19251 "group": "Openchannel_Messages",
19252 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19253 "version": "0.0.0",
19254 "filename": "server/api/openchannelMessage/index.js",
19255 "groupTitle": "Openchannel_Messages"
19259 "url": "/api/openchannel/messages/{id}/accept",
19260 "title": "Accepts message",
19263 "title": "Example usage:",
19264 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19268 "name": "acceptMessage",
19269 "group": "Openchannel_Messages",
19270 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19271 "version": "0.0.0",
19272 "filename": "server/api/openchannelMessage/index.js",
19273 "groupTitle": "Openchannel_Messages"
19277 "url": "/api/openchannel/messages/{id}/reject",
19278 "title": "Rejects message",
19281 "title": "Example usage:",
19282 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19286 "name": "rejectMessage",
19287 "group": "Openchannel_Messages",
19288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19289 "version": "0.0.0",
19290 "filename": "server/api/openchannelMessage/index.js",
19291 "groupTitle": "Openchannel_Messages"
19295 "url": "/api/openchannel/messages/{id}",
19296 "title": "Update an existing Message",
19299 "title": "Example usage:",
19300 "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",
19304 "name": "updateMessages",
19305 "group": "Openchannel_Messages",
19306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19307 "version": "0.0.0",
19308 "filename": "server/api/openchannelMessage/index.js",
19309 "groupTitle": "Openchannel_Messages"
19313 "url": "/api/openchannel/reports/queue",
19314 "title": "Creates a new Openchannel Queue Report",
19317 "title": "Example usage:",
19318 "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",
19322 "name": "CreateOpenchannel_Queue_Reports",
19323 "group": "Openchannel_Queue_Reports",
19331 "field": "uniqueid",
19352 "field": "leaveAt",
19359 "field": "acceptAt",
19379 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19380 "version": "0.0.0",
19381 "filename": "server/api/openchannelQueueReport/index.js",
19382 "groupTitle": "Openchannel_Queue_Reports"
19386 "url": "/api/openchannel/reports/queue/{id}",
19387 "title": "Deletes a Openchannel Queue Report",
19390 "title": "Example usage:",
19391 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
19395 "name": "DeleteOpenchannel_Queue_Reports",
19396 "group": "Openchannel_Queue_Reports",
19397 "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>",
19398 "version": "0.0.0",
19399 "filename": "server/api/openchannelQueueReport/index.js",
19400 "groupTitle": "Openchannel_Queue_Reports"
19404 "url": "/api/openchannel/reports/queue/describe",
19405 "title": "Gets table info about Openchannel Queue Reports",
19408 "title": "Example usage:",
19409 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
19413 "name": "DescribeOpenchannel_Queue_Reports",
19414 "group": "Openchannel_Queue_Reports",
19415 "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>",
19416 "version": "0.0.0",
19417 "filename": "server/api/openchannelQueueReport/index.js",
19418 "groupTitle": "Openchannel_Queue_Reports"
19422 "url": "/api/openchannel/reports/queue",
19423 "title": "Gets a list of Openchannel Queue Reports",
19426 "title": "Example usage:",
19427 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
19431 "name": "GetOpenchannel_Queue_Reports",
19432 "group": "Openchannel_Queue_Reports",
19433 "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>",
19434 "version": "0.0.0",
19435 "filename": "server/api/openchannelQueueReport/index.js",
19436 "groupTitle": "Openchannel_Queue_Reports"
19440 "url": "/api/openchannel/reports/queue/{id}",
19441 "title": "Gets a single Openchannel Queue Report",
19444 "title": "Example usage:",
19445 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
19449 "name": "ShowOpenchannel_Queue_Reports",
19450 "group": "Openchannel_Queue_Reports",
19451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19452 "version": "0.0.0",
19453 "filename": "server/api/openchannelQueueReport/index.js",
19454 "groupTitle": "Openchannel_Queue_Reports"
19458 "url": "/api/openchannel/reports/queue/{id}",
19459 "title": "Update an existing Openchannel Queue Report",
19462 "title": "Example usage:",
19463 "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",
19467 "name": "updateOpenchannel_Queue_Reports",
19468 "group": "Openchannel_Queue_Reports",
19469 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19470 "version": "0.0.0",
19471 "filename": "server/api/openchannelQueueReport/index.js",
19472 "groupTitle": "Openchannel_Queue_Reports"
19476 "url": "/api/openchannel/queues/{id}/users",
19477 "title": "Add agents to a queue",
19480 "title": "Example usage:",
19481 "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",
19485 "name": "AddAgents",
19486 "group": "Openchannel_Queues",
19487 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19488 "version": "0.0.0",
19489 "filename": "server/api/openchannelQueue/index.js",
19490 "groupTitle": "Openchannel_Queues"
19494 "url": "/api/openchannel/queues/{id}/teams",
19495 "title": "Add teams to a queue",
19498 "title": "Example usage:",
19499 "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",
19503 "name": "AddTeams",
19504 "group": "Openchannel_Queues",
19505 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19506 "version": "0.0.0",
19507 "filename": "server/api/openchannelQueue/index.js",
19508 "groupTitle": "Openchannel_Queues"
19512 "url": "/api/openchannel/queues",
19513 "title": "Creates a new Queue",
19516 "title": "Example usage:",
19517 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19521 "name": "CreateQueues",
19522 "group": "Openchannel_Queues",
19537 "field": "description",
19544 "field": "timeout",
19556 "field": "strategy",
19562 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19563 "version": "0.0.0",
19564 "filename": "server/api/openchannelQueue/index.js",
19565 "groupTitle": "Openchannel_Queues"
19569 "url": "/api/openchannel/queues/{id}",
19570 "title": "Deletes a Queue",
19573 "title": "Example usage:",
19574 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
19578 "name": "DeleteQueues",
19579 "group": "Openchannel_Queues",
19580 "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>",
19581 "version": "0.0.0",
19582 "filename": "server/api/openchannelQueue/index.js",
19583 "groupTitle": "Openchannel_Queues"
19587 "url": "/api/openchannel/queues/describe",
19588 "title": "Gets table info about Queues",
19591 "title": "Example usage:",
19592 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19596 "name": "DescribeQueues",
19597 "group": "Openchannel_Queues",
19598 "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>",
19599 "version": "0.0.0",
19600 "filename": "server/api/openchannelQueue/index.js",
19601 "groupTitle": "Openchannel_Queues"
19605 "url": "/api/openchannel/queues/{id}/users",
19606 "title": "Gets queue agents",
19609 "title": "Example usage:",
19610 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19614 "name": "GetAgents",
19615 "group": "Openchannel_Queues",
19616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19617 "version": "0.0.0",
19618 "filename": "server/api/openchannelQueue/index.js",
19619 "groupTitle": "Openchannel_Queues"
19623 "url": "/api/openchannel/queues/{id}/members",
19624 "title": "GetMembers",
19627 "title": "Example usage:",
19628 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
19632 "name": "GetMembers",
19633 "group": "Openchannel_Queues",
19634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19635 "version": "0.0.0",
19636 "filename": "server/api/openchannelQueue/index.js",
19637 "groupTitle": "Openchannel_Queues"
19641 "url": "/api/openchannel/queues",
19642 "title": "Gets a list of Queues",
19645 "title": "Example usage:",
19646 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19650 "name": "GetQueues",
19651 "group": "Openchannel_Queues",
19652 "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>",
19653 "version": "0.0.0",
19654 "filename": "server/api/openchannelQueue/index.js",
19655 "groupTitle": "Openchannel_Queues"
19659 "url": "/api/openchannel/queues/{id}/teams",
19660 "title": "Gets queues list",
19663 "title": "Example usage:",
19664 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19668 "name": "GetTeams",
19669 "group": "Openchannel_Queues",
19670 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19671 "version": "0.0.0",
19672 "filename": "server/api/openchannelQueue/index.js",
19673 "groupTitle": "Openchannel_Queues"
19677 "url": "/api/openchannel/queues/{id}/users",
19678 "title": "Removes agents from a queue",
19681 "title": "Example usage:",
19682 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19686 "name": "RemoveAgents",
19687 "group": "Openchannel_Queues",
19688 "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>",
19689 "version": "0.0.0",
19690 "filename": "server/api/openchannelQueue/index.js",
19691 "groupTitle": "Openchannel_Queues"
19695 "url": "/api/openchannel/queues/{id}",
19696 "title": "Gets a single Queue",
19699 "title": "Example usage:",
19700 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19704 "name": "ShowQueues",
19705 "group": "Openchannel_Queues",
19706 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19707 "version": "0.0.0",
19708 "filename": "server/api/openchannelQueue/index.js",
19709 "groupTitle": "Openchannel_Queues"
19713 "url": "/api/openchannel/queues/{id}",
19714 "title": "Update an existing Queue",
19717 "title": "Example usage:",
19718 "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",
19722 "name": "updateQueues",
19723 "group": "Openchannel_Queues",
19724 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19725 "version": "0.0.0",
19726 "filename": "server/api/openchannelQueue/index.js",
19727 "groupTitle": "Openchannel_Queues"
19731 "url": "/api/openchannel/reports/transfer",
19732 "title": "Creates a new Openchannel Transfer Report",
19735 "title": "Example usage:",
19736 "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",
19740 "name": "CreateOpenchannel_Transfer_Reports",
19741 "group": "Openchannel_Transfer_Reports",
19749 "field": "uniqueid",
19768 "field": "transferredAt",
19774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19775 "version": "0.0.0",
19776 "filename": "server/api/openchannelTransferReport/index.js",
19777 "groupTitle": "Openchannel_Transfer_Reports"
19781 "url": "/api/openchannel/reports/transfer/{id}",
19782 "title": "Deletes a Openchannel Transfer Report",
19785 "title": "Example usage:",
19786 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19790 "name": "DeleteOpenchannel_Transfer_Reports",
19791 "group": "Openchannel_Transfer_Reports",
19792 "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>",
19793 "version": "0.0.0",
19794 "filename": "server/api/openchannelTransferReport/index.js",
19795 "groupTitle": "Openchannel_Transfer_Reports"
19799 "url": "/api/openchannel/reports/transfer/describe",
19800 "title": "Gets table info about Openchannel Transfer Reports",
19803 "title": "Example usage:",
19804 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19808 "name": "DescribeOpenchannel_Transfer_Reports",
19809 "group": "Openchannel_Transfer_Reports",
19810 "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>",
19811 "version": "0.0.0",
19812 "filename": "server/api/openchannelTransferReport/index.js",
19813 "groupTitle": "Openchannel_Transfer_Reports"
19817 "url": "/api/openchannel/reports/transfer",
19818 "title": "Gets a list of Openchannel Transfer Reports",
19821 "title": "Example usage:",
19822 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19826 "name": "GetOpenchannel_Transfer_Reports",
19827 "group": "Openchannel_Transfer_Reports",
19828 "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>",
19829 "version": "0.0.0",
19830 "filename": "server/api/openchannelTransferReport/index.js",
19831 "groupTitle": "Openchannel_Transfer_Reports"
19835 "url": "/api/openchannel/reports/transfer/{id}",
19836 "title": "Gets a single Openchannel Transfer Report",
19839 "title": "Example usage:",
19840 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19844 "name": "ShowOpenchannel_Transfer_Reports",
19845 "group": "Openchannel_Transfer_Reports",
19846 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19847 "version": "0.0.0",
19848 "filename": "server/api/openchannelTransferReport/index.js",
19849 "groupTitle": "Openchannel_Transfer_Reports"
19853 "url": "/api/openchannel/reports/transfer/{id}",
19854 "title": "Update an existing Openchannel Transfer Report",
19857 "title": "Example usage:",
19858 "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",
19862 "name": "updateOpenchannel_Transfer_Reports",
19863 "group": "Openchannel_Transfer_Reports",
19864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19865 "version": "0.0.0",
19866 "filename": "server/api/openchannelTransferReport/index.js",
19867 "groupTitle": "Openchannel_Transfer_Reports"
19871 "url": "/api/pauses",
19872 "title": "Creates a new Pause",
19875 "title": "Example usage:",
19876 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19880 "name": "CreatePauses",
19896 "field": "description",
19902 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19903 "version": "0.0.0",
19904 "filename": "server/api/pause/index.js",
19905 "groupTitle": "Pauses"
19909 "url": "/api/pauses/{id}",
19910 "title": "Deletes a Pause",
19913 "title": "Example usage:",
19914 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19918 "name": "DeletePauses",
19920 "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>",
19921 "version": "0.0.0",
19922 "filename": "server/api/pause/index.js",
19923 "groupTitle": "Pauses"
19927 "url": "/api/pauses",
19928 "title": "Gets a list of Pauses",
19931 "title": "Example usage:",
19932 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19936 "name": "GetPauses",
19938 "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>",
19939 "version": "0.0.0",
19940 "filename": "server/api/pause/index.js",
19941 "groupTitle": "Pauses"
19945 "url": "/api/pauses/{id}",
19946 "title": "Gets a single Pause",
19949 "title": "Example usage:",
19950 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19954 "name": "ShowPauses",
19956 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19957 "version": "0.0.0",
19958 "filename": "server/api/pause/index.js",
19959 "groupTitle": "Pauses"
19963 "url": "/api/pauses/{id}",
19964 "title": "Update an existing Pause",
19967 "title": "Example usage:",
19968 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19972 "name": "updatePauses",
19974 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19975 "version": "0.0.0",
19976 "filename": "server/api/pause/index.js",
19977 "groupTitle": "Pauses"
19981 "url": "/api/plugins",
19982 "title": "Gets a list of Plugins",
19985 "title": "Example usage:",
19986 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19990 "name": "GetPlugins",
19991 "group": "Plugins",
19992 "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>",
19993 "version": "0.0.0",
19994 "filename": "server/api/plugin/index.js",
19995 "groupTitle": "Plugins"
19999 "url": "/api/plugins/{id}",
20000 "title": "Gets a single Plugin",
20003 "title": "Example usage:",
20004 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
20008 "name": "ShowPlugins",
20009 "group": "Plugins",
20010 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20011 "version": "0.0.0",
20012 "filename": "server/api/plugin/index.js",
20013 "groupTitle": "Plugins"
20017 "url": "/api/plugins/{id}",
20018 "title": "Delete a plugin",
20021 "title": "Example usage:",
20022 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
20026 "name": "destroyPlugin",
20027 "group": "Plugins",
20028 "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>",
20029 "version": "0.0.0",
20030 "filename": "server/api/plugin/index.js",
20031 "groupTitle": "Plugins"
20035 "url": "/api/plugins/{id}/download",
20036 "title": "Download plugin source code",
20039 "title": "Example usage:",
20040 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
20044 "name": "download",
20045 "group": "Plugins",
20046 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20047 "version": "0.0.0",
20048 "filename": "server/api/plugin/index.js",
20049 "groupTitle": "Plugins"
20053 "url": "/api/plugins/{id}",
20054 "title": "Update an existing plugin",
20057 "title": "Example usage:",
20058 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
20062 "name": "updatePlugin",
20063 "group": "Plugins",
20064 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20065 "version": "0.0.0",
20066 "filename": "server/api/plugin/index.js",
20067 "groupTitle": "Plugins"
20071 "url": "/api/plugins",
20072 "title": "Upload new plugin",
20075 "title": "Example usage:",
20076 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
20080 "name": "uploadPlugin",
20081 "group": "Plugins",
20082 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20083 "version": "0.0.0",
20084 "filename": "server/api/plugin/index.js",
20085 "groupTitle": "Plugins"
20089 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
20090 "title": "Redirect a plugin request to the specified path",
20093 "title": "Example usage:",
20094 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
20098 "name": "webhookPlugin",
20099 "group": "Plugins",
20100 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20101 "version": "0.0.0",
20102 "filename": "server/api/plugin/index.js",
20103 "groupTitle": "Plugins"
20107 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
20108 "title": "Redirect a plugin request to the specified path",
20111 "title": "Example usage:",
20112 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
20116 "name": "webhookPlugin",
20117 "group": "Plugins",
20118 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20119 "version": "0.0.0",
20120 "filename": "server/api/plugin/index.js",
20121 "groupTitle": "Plugins"
20125 "url": "/api/pm2/{id}",
20126 "title": "Deletes an existing process",
20129 "title": "Example usage:",
20130 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
20134 "name": "DeletePm2Process",
20136 "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>",
20137 "version": "0.0.0",
20138 "filename": "server/api/pm2/index.js",
20139 "groupTitle": "Pm2"
20143 "url": "/api/pm2/{id}",
20144 "title": "Gets a single pm2 process",
20147 "title": "Example usage:",
20148 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
20152 "name": "GetPm2Process",
20154 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20155 "version": "0.0.0",
20156 "filename": "server/api/pm2/index.js",
20157 "groupTitle": "Pm2"
20162 "title": "Gets pm2 processes",
20165 "title": "Example usage:",
20166 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
20170 "name": "GetPm2Processes",
20172 "description": "<p>Motion returns the pm2 processes list.</p>",
20173 "version": "0.0.0",
20174 "filename": "server/api/pm2/index.js",
20175 "groupTitle": "Pm2"
20180 "title": "Start a single pm2 process",
20183 "title": "Example usage:",
20184 "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",
20188 "name": "StartPm2Process",
20210 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20211 "version": "0.0.0",
20212 "filename": "server/api/pm2/index.js",
20213 "groupTitle": "Pm2"
20217 "url": "/api/pm2/{id}",
20218 "title": "Update an existing process",
20221 "title": "Example usage:",
20222 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20226 "name": "UpdatePm2Process",
20228 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20229 "version": "0.0.0",
20230 "filename": "server/api/pm2/index.js",
20231 "groupTitle": "Pm2"
20235 "url": "/api/rpc/campaigns/",
20236 "title": "Gets a list of campaigns",
20239 "title": "Example usage:",
20240 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
20244 "name": "Campaigns",
20245 "group": "RPC_Realtime",
20246 "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>",
20247 "version": "0.0.0",
20248 "filename": "server/api/rpc/index.js",
20249 "groupTitle": "RPC_Realtime"
20253 "url": "/api/rpc/fax/accounts",
20254 "title": "Gets a list of FaxAccounts",
20257 "title": "Example usage:",
20258 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
20262 "name": "FaxAccounts",
20263 "group": "RPC_Realtime",
20264 "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>",
20265 "version": "0.0.0",
20266 "filename": "server/api/rpc/index.js",
20267 "groupTitle": "RPC_Realtime"
20271 "url": "/api/rpc/agents/:id/capacity",
20272 "title": "Sets agent capacity",
20275 "title": "Example usage:",
20276 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
20280 "name": "RTAgentCapacity",
20281 "group": "RPC_Realtime",
20282 "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>",
20283 "version": "0.0.0",
20284 "filename": "server/api/rpc/index.js",
20285 "groupTitle": "RPC_Realtime"
20289 "url": "/api/rpc/agents",
20290 "title": "Gets a list of RTAgents",
20293 "title": "Example usage:",
20294 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
20298 "name": "RTAgents",
20299 "group": "RPC_Realtime",
20300 "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>",
20301 "version": "0.0.0",
20302 "filename": "server/api/rpc/index.js",
20303 "groupTitle": "RPC_Realtime"
20307 "url": "/api/rpc/chat/queues",
20308 "title": "Gets a list of RTChatQueues",
20311 "title": "Example usage:",
20312 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
20316 "name": "RTChatQueues",
20317 "group": "RPC_Realtime",
20318 "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>",
20319 "version": "0.0.0",
20320 "filename": "server/api/rpc/index.js",
20321 "groupTitle": "RPC_Realtime"
20325 "url": "/api/rpc/fax/queues",
20326 "title": "Gets a list of RTFaxQueues",
20329 "title": "Example usage:",
20330 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
20334 "name": "RTFaxQueues",
20335 "group": "RPC_Realtime",
20336 "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>",
20337 "version": "0.0.0",
20338 "filename": "server/api/rpc/index.js",
20339 "groupTitle": "RPC_Realtime"
20343 "url": "/api/rpc/mail/accounts",
20344 "title": "Gets a list of RTMailAccounts",
20347 "title": "Example usage:",
20348 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
20352 "name": "RTMailAccounts",
20353 "group": "RPC_Realtime",
20354 "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>",
20355 "version": "0.0.0",
20356 "filename": "server/api/rpc/index.js",
20357 "groupTitle": "RPC_Realtime"
20361 "url": "/api/rpc/mail/queues",
20362 "title": "Gets a list of RTMailQueues",
20365 "title": "Example usage:",
20366 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
20370 "name": "RTMailQueues",
20371 "group": "RPC_Realtime",
20372 "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>",
20373 "version": "0.0.0",
20374 "filename": "server/api/rpc/index.js",
20375 "groupTitle": "RPC_Realtime"
20379 "url": "/api/rpc/openchannel/queues",
20380 "title": "Gets a list of RTOpenchannelQueues",
20383 "title": "Example usage:",
20384 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
20388 "name": "RTOpenchannelQueues",
20389 "group": "RPC_Realtime",
20390 "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>",
20391 "version": "0.0.0",
20392 "filename": "server/api/rpc/index.js",
20393 "groupTitle": "RPC_Realtime"
20397 "url": "/api/rpc/outbound/channels",
20398 "title": "Gets a list of RTOutboundChannels",
20401 "title": "Example usage:",
20402 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
20406 "name": "RTOutboundChannels",
20407 "group": "RPC_Realtime",
20408 "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>",
20409 "version": "0.0.0",
20410 "filename": "server/api/rpc/index.js",
20411 "groupTitle": "RPC_Realtime"
20415 "url": "/api/rpc/sms/queues",
20416 "title": "Gets a list of RTSmsQueues",
20419 "title": "Example usage:",
20420 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
20424 "name": "RTSmsQueues",
20425 "group": "RPC_Realtime",
20426 "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>",
20427 "version": "0.0.0",
20428 "filename": "server/api/rpc/index.js",
20429 "groupTitle": "RPC_Realtime"
20433 "url": "/api/rpc/telephones",
20434 "title": "Gets a list of RTTelephones",
20437 "title": "Example usage:",
20438 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
20442 "name": "RTTelephones",
20443 "group": "RPC_Realtime",
20444 "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>",
20445 "version": "0.0.0",
20446 "filename": "server/api/rpc/index.js",
20447 "groupTitle": "RPC_Realtime"
20451 "url": "/api/rpc/trunks",
20452 "title": "Gets a list of RTTrunks",
20455 "title": "Example usage:",
20456 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
20460 "name": "RTTrunks",
20461 "group": "RPC_Realtime",
20462 "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>",
20463 "version": "0.0.0",
20464 "filename": "server/api/rpc/index.js",
20465 "groupTitle": "RPC_Realtime"
20469 "url": "/api/rpc/voice/channels",
20470 "title": "Gets a list of RTVoiceChannelMixMonitor",
20473 "title": "Example usage:",
20474 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
20478 "name": "RTVoiceChannelMixMonitor",
20479 "group": "RPC_Realtime",
20480 "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>",
20481 "version": "0.0.0",
20482 "filename": "server/api/rpc/index.js",
20483 "groupTitle": "RPC_Realtime"
20487 "url": "/api/rpc/voice/channels",
20488 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
20491 "title": "Example usage:",
20492 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
20496 "name": "RTVoiceChannelStopMixMonitor",
20497 "group": "RPC_Realtime",
20498 "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>",
20499 "version": "0.0.0",
20500 "filename": "server/api/rpc/index.js",
20501 "groupTitle": "RPC_Realtime"
20505 "url": "/api/rpc/voice/channels",
20506 "title": "Gets a list of RTVoiceChannels",
20509 "title": "Example usage:",
20510 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
20514 "name": "RTVoiceChannels",
20515 "group": "RPC_Realtime",
20516 "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>",
20517 "version": "0.0.0",
20518 "filename": "server/api/rpc/index.js",
20519 "groupTitle": "RPC_Realtime"
20523 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
20524 "title": "Gets a single RTVoiceQueueChannel",
20527 "title": "Example usage:",
20528 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
20532 "name": "RTVoiceQueueChannel",
20533 "group": "RPC_Realtime",
20534 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20535 "version": "0.0.0",
20536 "filename": "server/api/rpc/index.js",
20537 "groupTitle": "RPC_Realtime"
20541 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
20542 "title": "Hangup a single RTVoiceQueueChannel",
20545 "title": "Example usage:",
20546 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
20550 "name": "RTVoiceQueueChannelHangup",
20551 "group": "RPC_Realtime",
20552 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20553 "version": "0.0.0",
20554 "filename": "server/api/rpc/index.js",
20555 "groupTitle": "RPC_Realtime"
20559 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
20560 "title": "Hangup a single RTVoiceQueueChannel",
20563 "title": "Example usage:",
20564 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
20568 "name": "RTVoiceQueueChannelRedirect",
20569 "group": "RPC_Realtime",
20570 "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>",
20571 "version": "0.0.0",
20572 "filename": "server/api/rpc/index.js",
20573 "groupTitle": "RPC_Realtime"
20577 "url": "/api/rpc/voice/queues/preview/{id}",
20578 "title": "Gets a single preview contact",
20581 "title": "Example usage:",
20582 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
20586 "name": "RTVoiceQueuePreview",
20587 "group": "RPC_Realtime",
20588 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20589 "version": "0.0.0",
20590 "filename": "server/api/rpc/index.js",
20591 "groupTitle": "RPC_Realtime"
20595 "url": "/api/rpc/voice/queues",
20596 "title": "Gets a list of RTVoiceQueues",
20599 "title": "Example usage:",
20600 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20604 "name": "RTVoiceQueues",
20605 "group": "RPC_Realtime",
20606 "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>",
20607 "version": "0.0.0",
20608 "filename": "server/api/rpc/index.js",
20609 "groupTitle": "RPC_Realtime"
20613 "url": "/api/rpc/outbound",
20614 "title": "Gets a list of RTOutbound",
20617 "title": "Example usage:",
20618 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20622 "name": "RTVoiceQueues",
20623 "group": "RPC_Realtime",
20624 "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>",
20625 "version": "0.0.0",
20626 "filename": "server/api/rpc/index.js",
20627 "groupTitle": "RPC_Realtime"
20631 "url": "/api/rpc/voice/queues/channels",
20632 "title": "Gets a list of RTVoiceQueuesChannels",
20635 "title": "Example usage:",
20636 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20640 "name": "RTVoiceQueuesChannels",
20641 "group": "RPC_Realtime",
20642 "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>",
20643 "version": "0.0.0",
20644 "filename": "server/api/rpc/index.js",
20645 "groupTitle": "RPC_Realtime"
20649 "url": "/api/rpc/chat/queues/{id}",
20650 "title": "Gets a single RTChatQueue",
20653 "title": "Example usage:",
20654 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20658 "name": "ShowRTChatQueues",
20659 "group": "RPC_Realtime",
20660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20661 "version": "0.0.0",
20662 "filename": "server/api/rpc/index.js",
20663 "groupTitle": "RPC_Realtime"
20667 "url": "/api/rpc/fax/queues/{id}",
20668 "title": "Gets a single RTFaxQueue",
20671 "title": "Example usage:",
20672 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20676 "name": "ShowRTFaxQueues",
20677 "group": "RPC_Realtime",
20678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20679 "version": "0.0.0",
20680 "filename": "server/api/rpc/index.js",
20681 "groupTitle": "RPC_Realtime"
20685 "url": "/api/rpc/mail/queues/{id}",
20686 "title": "Gets a single RTMailQueue",
20689 "title": "Example usage:",
20690 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20694 "name": "ShowRTMailQueues",
20695 "group": "RPC_Realtime",
20696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20697 "version": "0.0.0",
20698 "filename": "server/api/rpc/index.js",
20699 "groupTitle": "RPC_Realtime"
20703 "url": "/api/rpc/openchannel/queues/{id}",
20704 "title": "Gets a single RTOpenchannelQueue",
20707 "title": "Example usage:",
20708 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20712 "name": "ShowRTOpenchannelQueues",
20713 "group": "RPC_Realtime",
20714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20715 "version": "0.0.0",
20716 "filename": "server/api/rpc/index.js",
20717 "groupTitle": "RPC_Realtime"
20721 "url": "/api/rpc/sms/queues/{id}",
20722 "title": "Gets a single RTSmsQueue",
20725 "title": "Example usage:",
20726 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20730 "name": "ShowRTSmsQueues",
20731 "group": "RPC_Realtime",
20732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20733 "version": "0.0.0",
20734 "filename": "server/api/rpc/index.js",
20735 "groupTitle": "RPC_Realtime"
20739 "url": "/api/rpc/voice/queues/{id}",
20740 "title": "Gets a single RTVoiceQueue",
20743 "title": "Example usage:",
20744 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20748 "name": "ShowRTVoiceQueues",
20749 "group": "RPC_Realtime",
20750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20751 "version": "0.0.0",
20752 "filename": "server/api/rpc/index.js",
20753 "groupTitle": "RPC_Realtime"
20757 "url": "/api/rpc/voice/{id}/queues",
20758 "title": "Updates a single VoiceQueue",
20761 "title": "Example usage:",
20762 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20766 "name": "UpdateVoiceQueues",
20767 "group": "RPC_Realtime",
20768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20769 "version": "0.0.0",
20770 "filename": "server/api/rpc/index.js",
20771 "groupTitle": "RPC_Realtime"
20775 "url": "/api/rpc/agents/:id/notify",
20776 "title": "Notify message to a specific agent",
20779 "title": "Example usage:",
20780 "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",
20784 "name": "agentNotify",
20785 "group": "RPC_Realtime",
20786 "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>",
20787 "version": "0.0.0",
20788 "filename": "server/api/rpc/index.js",
20789 "groupTitle": "RPC_Realtime"
20793 "url": "/api/rpc/chat/queues/:id/notify",
20794 "title": "Notify message to a specific queue",
20797 "title": "Example usage:",
20798 "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",
20802 "name": "chatQueueNotify",
20803 "group": "RPC_Realtime",
20804 "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>",
20805 "version": "0.0.0",
20806 "filename": "server/api/rpc/index.js",
20807 "groupTitle": "RPC_Realtime"
20811 "url": "/api/rpc/chat/queues/waitinginteractions",
20812 "title": "Gets a list of chatQueuesWaitingInteractions",
20815 "title": "Example usage:",
20816 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20820 "name": "chatQueuesWaitingInteractions",
20821 "group": "RPC_Realtime",
20822 "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>",
20823 "version": "0.0.0",
20824 "filename": "server/api/rpc/index.js",
20825 "groupTitle": "RPC_Realtime"
20829 "url": "/api/rpc/fax/queues/:id/notify",
20830 "title": "Notify message to a specific queue",
20833 "title": "Example usage:",
20834 "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",
20838 "name": "faxQueueNotify",
20839 "group": "RPC_Realtime",
20840 "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>",
20841 "version": "0.0.0",
20842 "filename": "server/api/rpc/index.js",
20843 "groupTitle": "RPC_Realtime"
20847 "url": "/api/rpc/fax/queues/waitinginteractions",
20848 "title": "Gets a list of faxQueuesWaitingInteractions",
20851 "title": "Example usage:",
20852 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20856 "name": "faxQueuesWaitingInteractions",
20857 "group": "RPC_Realtime",
20858 "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>",
20859 "version": "0.0.0",
20860 "filename": "server/api/rpc/index.js",
20861 "groupTitle": "RPC_Realtime"
20865 "url": "/api/rpc/mail/queues/:id/notify",
20866 "title": "Notify message to a specific queue",
20869 "title": "Example usage:",
20870 "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",
20874 "name": "mailQueueNotify",
20875 "group": "RPC_Realtime",
20876 "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>",
20877 "version": "0.0.0",
20878 "filename": "server/api/rpc/index.js",
20879 "groupTitle": "RPC_Realtime"
20883 "url": "/api/rpc/mail/queues/waitinginteractions",
20884 "title": "Gets a list of mailQueuesWaitingInteractions",
20887 "title": "Example usage:",
20888 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20892 "name": "mailQueuesWaitingInteractions",
20893 "group": "RPC_Realtime",
20894 "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>",
20895 "version": "0.0.0",
20896 "filename": "server/api/rpc/index.js",
20897 "groupTitle": "RPC_Realtime"
20901 "url": "/api/rpc/openchannel/queues/:id/notify",
20902 "title": "Notify message to a specific queue",
20905 "title": "Example usage:",
20906 "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",
20910 "name": "openchannelQueueNotify",
20911 "group": "RPC_Realtime",
20912 "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>",
20913 "version": "0.0.0",
20914 "filename": "server/api/rpc/index.js",
20915 "groupTitle": "RPC_Realtime"
20919 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20920 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20923 "title": "Example usage:",
20924 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20928 "name": "openchannelQueuesIdWaitingInteractions",
20929 "group": "RPC_Realtime",
20930 "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>",
20931 "version": "0.0.0",
20932 "filename": "server/api/rpc/index.js",
20933 "groupTitle": "RPC_Realtime"
20937 "url": "/api/rpc/openchannel/queues/waitinginteractions",
20938 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20941 "title": "Example usage:",
20942 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20946 "name": "openchannelQueuesWaitingInteractions",
20947 "group": "RPC_Realtime",
20948 "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>",
20949 "version": "0.0.0",
20950 "filename": "server/api/rpc/index.js",
20951 "groupTitle": "RPC_Realtime"
20955 "url": "/api/rpc/sms/queues/:id/notify",
20956 "title": "Notify message to a specific queue",
20959 "title": "Example usage:",
20960 "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",
20964 "name": "smsQueueNotify",
20965 "group": "RPC_Realtime",
20966 "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>",
20967 "version": "0.0.0",
20968 "filename": "server/api/rpc/index.js",
20969 "groupTitle": "RPC_Realtime"
20973 "url": "/api/rpc/sms/queues/waitinginteractions",
20974 "title": "Gets a list of smsQueuesWaitingInteractions",
20977 "title": "Example usage:",
20978 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20982 "name": "smsQueuesWaitingInteractions",
20983 "group": "RPC_Realtime",
20984 "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>",
20985 "version": "0.0.0",
20986 "filename": "server/api/rpc/index.js",
20987 "groupTitle": "RPC_Realtime"
20991 "url": "/api/realtime/agents",
20992 "title": "Gets realtime agents info",
20995 "title": "Example usage:",
20996 "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password} -X GET",
21000 "name": "getAgents",
21001 "group": "Realtime",
21002 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21003 "version": "0.0.0",
21004 "filename": "server/api/realtime/index.js",
21005 "groupTitle": "Realtime"
21009 "url": "/api/realtime/queues",
21010 "title": "Gets realtime queues info",
21013 "title": "Example usage:",
21014 "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password} -X GET",
21018 "name": "getQueues",
21019 "group": "Realtime",
21020 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21021 "version": "0.0.0",
21022 "filename": "server/api/realtime/index.js",
21023 "groupTitle": "Realtime"
21027 "url": "/api/integrations/salesforce/accounts",
21028 "title": "Creates a new Salesforce Account",
21031 "title": "Example usage:",
21032 "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",
21036 "name": "CreateSalesforce_Accounts",
21037 "group": "Salesforce_Accounts",
21052 "field": "description",
21059 "field": "username",
21066 "field": "remoteUri",
21073 "field": "password",
21080 "field": "clientId",
21087 "field": "clientSecret",
21094 "field": "securityToken",
21101 "field": "serverUrl",
21108 "\"integrationTab\"",
21118 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21119 "version": "0.0.0",
21120 "filename": "server/api/intSalesforceAccount/index.js",
21121 "groupTitle": "Salesforce_Accounts"
21125 "url": "/api/integrations/salesforce/accounts/{id}",
21126 "title": "Deletes a Salesforce Account",
21129 "title": "Example usage:",
21130 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
21134 "name": "DeleteSalesforce_Accounts",
21135 "group": "Salesforce_Accounts",
21136 "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>",
21137 "version": "0.0.0",
21138 "filename": "server/api/intSalesforceAccount/index.js",
21139 "groupTitle": "Salesforce_Accounts"
21143 "url": "/api/integrations/salesforce/accounts",
21144 "title": "Gets a list of Salesforce Accounts",
21147 "title": "Example usage:",
21148 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
21152 "name": "GetSalesforce_Accounts",
21153 "group": "Salesforce_Accounts",
21154 "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>",
21155 "version": "0.0.0",
21156 "filename": "server/api/intSalesforceAccount/index.js",
21157 "groupTitle": "Salesforce_Accounts"
21161 "url": "/api/integrations/salesforce/accounts/{id}",
21162 "title": "Gets a single Salesforce Account",
21165 "title": "Example usage:",
21166 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
21170 "name": "ShowSalesforce_Accounts",
21171 "group": "Salesforce_Accounts",
21172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21173 "version": "0.0.0",
21174 "filename": "server/api/intSalesforceAccount/index.js",
21175 "groupTitle": "Salesforce_Accounts"
21179 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
21180 "title": "Creates new configuration",
21183 "title": "Example usage:",
21184 "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",
21188 "name": "addConfiguration",
21189 "group": "Salesforce_Accounts",
21190 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21191 "version": "0.0.0",
21192 "filename": "server/api/intSalesforceAccount/index.js",
21193 "groupTitle": "Salesforce_Accounts"
21197 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
21198 "title": "Gets account configurations",
21201 "title": "Example usage:",
21202 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21206 "name": "getConfigurations",
21207 "group": "Salesforce_Accounts",
21208 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21209 "version": "0.0.0",
21210 "filename": "server/api/intSalesforceAccount/index.js",
21211 "groupTitle": "Salesforce_Accounts"
21215 "url": "/api/integrations/salesforce/accounts/{id}/fields",
21216 "title": "Gets account fields",
21219 "title": "Example usage:",
21220 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
21224 "name": "getFields",
21225 "group": "Salesforce_Accounts",
21226 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21227 "version": "0.0.0",
21228 "filename": "server/api/intSalesforceAccount/index.js",
21229 "groupTitle": "Salesforce_Accounts"
21233 "url": "/api/integrations/salesforce/accounts/{id}",
21234 "title": "Update an existing Salesforce Account",
21237 "title": "Example usage:",
21238 "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",
21242 "name": "updateSalesforce_Accounts",
21243 "group": "Salesforce_Accounts",
21244 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21245 "version": "0.0.0",
21246 "filename": "server/api/intSalesforceAccount/index.js",
21247 "groupTitle": "Salesforce_Accounts"
21251 "url": "/api/integrations/salesforce/configurations",
21252 "title": "Creates a new Salesforce Configuration",
21255 "title": "Example usage:",
21256 "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",
21260 "name": "CreateSalesforce_Configurations",
21261 "group": "Salesforce_Configurations",
21276 "field": "description",
21287 "field": "ticketType",
21294 "\"contact_lead\"",
21297 "\"account_contact_lead\"",
21301 "field": "moduleSearch",
21314 "field": "moduleCreate",
21328 "field": "additionalSearchAccount",
21335 "field": "additionalSearchContact",
21342 "field": "additionalSearchLead",
21348 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21349 "version": "0.0.0",
21350 "filename": "server/api/intSalesforceConfiguration/index.js",
21351 "groupTitle": "Salesforce_Configurations"
21355 "url": "/api/integrations/salesforce/configurations/{id}",
21356 "title": "Deletes a Salesforce Configuration",
21359 "title": "Example usage:",
21360 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
21364 "name": "DeleteSalesforce_Configurations",
21365 "group": "Salesforce_Configurations",
21366 "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>",
21367 "version": "0.0.0",
21368 "filename": "server/api/intSalesforceConfiguration/index.js",
21369 "groupTitle": "Salesforce_Configurations"
21373 "url": "/api/integrations/salesforce/configurations",
21374 "title": "Gets a list of Salesforce Configurations",
21377 "title": "Example usage:",
21378 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
21382 "name": "GetSalesforce_Configurations",
21383 "group": "Salesforce_Configurations",
21384 "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>",
21385 "version": "0.0.0",
21386 "filename": "server/api/intSalesforceConfiguration/index.js",
21387 "groupTitle": "Salesforce_Configurations"
21391 "url": "/api/integrations/salesforce/configurations/{id}",
21392 "title": "Gets a single Salesforce Configuration",
21395 "title": "Example usage:",
21396 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
21400 "name": "ShowSalesforce_Configurations",
21401 "group": "Salesforce_Configurations",
21402 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21403 "version": "0.0.0",
21404 "filename": "server/api/intSalesforceConfiguration/index.js",
21405 "groupTitle": "Salesforce_Configurations"
21409 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
21410 "title": "Gets configurations descriptions",
21413 "title": "Example usage:",
21414 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21418 "name": "getDescriptions",
21419 "group": "Salesforce_Configurations",
21420 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21421 "version": "0.0.0",
21422 "filename": "server/api/intSalesforceConfiguration/index.js",
21423 "groupTitle": "Salesforce_Configurations"
21427 "url": "/api/integrations/salesforce/configurations/{id}/fields",
21428 "title": "Gets configurations fields",
21431 "title": "Example usage:",
21432 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
21436 "name": "getFields",
21437 "group": "Salesforce_Configurations",
21438 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21439 "version": "0.0.0",
21440 "filename": "server/api/intSalesforceConfiguration/index.js",
21441 "groupTitle": "Salesforce_Configurations"
21445 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
21446 "title": "Gets configurations subjects",
21449 "title": "Example usage:",
21450 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21454 "name": "getSubjects",
21455 "group": "Salesforce_Configurations",
21456 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21457 "version": "0.0.0",
21458 "filename": "server/api/intSalesforceConfiguration/index.js",
21459 "groupTitle": "Salesforce_Configurations"
21463 "url": "/api/integrations/salesforce/configurations/{id}",
21464 "title": "Update an existing Salesforce Configuration",
21467 "title": "Example usage:",
21468 "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",
21472 "name": "updateSalesforce_Configurations",
21473 "group": "Salesforce_Configurations",
21474 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21475 "version": "0.0.0",
21476 "filename": "server/api/intSalesforceConfiguration/index.js",
21477 "groupTitle": "Salesforce_Configurations"
21481 "url": "/api/integrations/salesforce/fields",
21482 "title": "Creates a new Salesforce Field",
21485 "title": "Example usage:",
21486 "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",
21490 "name": "CreateSalesforce_Fields",
21491 "group": "Salesforce_Fields",
21501 "\"customVariable\"",
21513 "field": "content",
21529 "\"customVariable\""
21532 "field": "keyType",
21539 "field": "keyContent",
21546 "field": "idField",
21553 "field": "variableName",
21559 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21560 "version": "0.0.0",
21561 "filename": "server/api/intSalesforceField/index.js",
21562 "groupTitle": "Salesforce_Fields"
21566 "url": "/api/integrations/salesforce/fields/{id}",
21567 "title": "Deletes a Salesforce Field",
21570 "title": "Example usage:",
21571 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
21575 "name": "DeleteSalesforce_Fields",
21576 "group": "Salesforce_Fields",
21577 "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>",
21578 "version": "0.0.0",
21579 "filename": "server/api/intSalesforceField/index.js",
21580 "groupTitle": "Salesforce_Fields"
21584 "url": "/api/integrations/salesforce/fields",
21585 "title": "Gets a list of Salesforce Fields",
21588 "title": "Example usage:",
21589 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
21593 "name": "GetSalesforce_Fields",
21594 "group": "Salesforce_Fields",
21595 "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>",
21596 "version": "0.0.0",
21597 "filename": "server/api/intSalesforceField/index.js",
21598 "groupTitle": "Salesforce_Fields"
21602 "url": "/api/integrations/salesforce/fields/{id}",
21603 "title": "Gets a single Salesforce Field",
21606 "title": "Example usage:",
21607 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21611 "name": "ShowSalesforce_Fields",
21612 "group": "Salesforce_Fields",
21613 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21614 "version": "0.0.0",
21615 "filename": "server/api/intSalesforceField/index.js",
21616 "groupTitle": "Salesforce_Fields"
21620 "url": "/api/integrations/salesforce/fields/{id}",
21621 "title": "Update an existing Salesforce Field",
21624 "title": "Example usage:",
21625 "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",
21629 "name": "updateSalesforce_Fields",
21630 "group": "Salesforce_Fields",
21631 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21632 "version": "0.0.0",
21633 "filename": "server/api/intSalesforceField/index.js",
21634 "groupTitle": "Salesforce_Fields"
21638 "url": "/api/schedules",
21639 "title": "Creates a new Schedule",
21642 "title": "Example usage:",
21643 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21647 "name": "CreateSchedules",
21648 "group": "Schedules",
21663 "field": "description",
21684 "field": "startAt",
21698 "field": "subtractNumber",
21714 "field": "subtractUnit",
21744 "field": "sendMail",
21772 "field": "sendIfEmpty",
21778 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21779 "version": "0.0.0",
21780 "filename": "server/api/schedule/index.js",
21781 "groupTitle": "Schedules"
21785 "url": "/api/schedules/{id}",
21786 "title": "Deletes a Schedule",
21789 "title": "Example usage:",
21790 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21794 "name": "DeleteSchedules",
21795 "group": "Schedules",
21796 "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>",
21797 "version": "0.0.0",
21798 "filename": "server/api/schedule/index.js",
21799 "groupTitle": "Schedules"
21803 "url": "/api/schedules",
21804 "title": "Gets a list of Schedules",
21807 "title": "Example usage:",
21808 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21812 "name": "GetSchedules",
21813 "group": "Schedules",
21814 "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>",
21815 "version": "0.0.0",
21816 "filename": "server/api/schedule/index.js",
21817 "groupTitle": "Schedules"
21821 "url": "/api/schedules/{id}",
21822 "title": "Gets a single Schedule",
21825 "title": "Example usage:",
21826 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21830 "name": "ShowSchedules",
21831 "group": "Schedules",
21832 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21833 "version": "0.0.0",
21834 "filename": "server/api/schedule/index.js",
21835 "groupTitle": "Schedules"
21839 "url": "/api/schedules/{id}/run",
21840 "title": "Run Scheduler",
21843 "title": "Example usage:",
21844 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21849 "group": "Schedules",
21850 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21851 "version": "0.0.0",
21852 "filename": "server/api/schedule/index.js",
21853 "groupTitle": "Schedules"
21857 "url": "/api/schedules/{id}",
21858 "title": "Update an existing Schedule",
21861 "title": "Example usage:",
21862 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21866 "name": "updateSchedules",
21867 "group": "Schedules",
21868 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21869 "version": "0.0.0",
21870 "filename": "server/api/schedule/index.js",
21871 "groupTitle": "Schedules"
21875 "url": "/api/screen/recordings",
21876 "title": "Creates a new Recording",
21879 "title": "Example usage:",
21880 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21884 "name": "CreateRecordings",
21885 "group": "Screen_Recordings",
21900 "field": "interactionid",
21907 "field": "channel",
21928 "field": "duration",
21935 "field": "startedAt",
21942 "field": "closedAt",
21949 "field": "createdAt",
21956 "field": "updatedAt",
21962 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21963 "version": "0.0.0",
21964 "filename": "server/api/screenRecording/index.js",
21965 "groupTitle": "Screen_Recordings"
21969 "url": "/api/screen/recordings/describe",
21970 "title": "Gets table info about Recordings",
21973 "title": "Example usage:",
21974 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21978 "name": "DescribeRecordings",
21979 "group": "Screen_Recordings",
21980 "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>",
21981 "version": "0.0.0",
21982 "filename": "server/api/screenRecording/index.js",
21983 "groupTitle": "Screen_Recordings"
21987 "url": "/api/screen/recordings",
21988 "title": "Gets a list of Recordings",
21991 "title": "Example usage:",
21992 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21996 "name": "GetRecordings",
21997 "group": "Screen_Recordings",
21998 "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>",
21999 "version": "0.0.0",
22000 "filename": "server/api/screenRecording/index.js",
22001 "groupTitle": "Screen_Recordings"
22005 "url": "/api/screen/recordings/{id}",
22006 "title": "Gets a single Recording",
22009 "title": "Example usage:",
22010 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
22014 "name": "ShowRecordings",
22015 "group": "Screen_Recordings",
22016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22017 "version": "0.0.0",
22018 "filename": "server/api/screenRecording/index.js",
22019 "groupTitle": "Screen_Recordings"
22023 "url": "/api/screen/recordings/{id}",
22024 "title": "Delete screen recording",
22027 "title": "Example usage:",
22028 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
22033 "group": "Screen_Recordings",
22034 "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>",
22035 "version": "0.0.0",
22036 "filename": "server/api/screenRecording/index.js",
22037 "groupTitle": "Screen_Recordings"
22041 "url": "/api/screen/recordings/{id}/download",
22042 "title": "Download Recording",
22045 "title": "Example usage:",
22046 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
22050 "name": "download",
22051 "group": "Screen_Recordings",
22052 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22053 "version": "0.0.0",
22054 "filename": "server/api/screenRecording/index.js",
22055 "groupTitle": "Screen_Recordings"
22059 "url": "/api/screen/recordings/{id}",
22060 "title": "Update an existing Recording",
22063 "title": "Example usage:",
22064 "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",
22068 "name": "updateRecordings",
22069 "group": "Screen_Recordings",
22070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22071 "version": "0.0.0",
22072 "filename": "server/api/screenRecording/index.js",
22073 "groupTitle": "Screen_Recordings"
22077 "url": "/api/integrations/servicenow/accounts",
22078 "title": "Creates a new Servicenow Account",
22081 "title": "Example usage:",
22082 "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",
22086 "name": "CreateServicenow_Accounts",
22087 "group": "Servicenow_Accounts",
22102 "field": "description",
22109 "field": "username",
22116 "field": "password",
22130 "field": "remoteUri",
22137 "field": "serverUrl",
22143 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22144 "version": "0.0.0",
22145 "filename": "server/api/intServicenowAccount/index.js",
22146 "groupTitle": "Servicenow_Accounts"
22150 "url": "/api/integrations/servicenow/accounts/{id}",
22151 "title": "Deletes a Servicenow Account",
22154 "title": "Example usage:",
22155 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
22159 "name": "DeleteServicenow_Accounts",
22160 "group": "Servicenow_Accounts",
22161 "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>",
22162 "version": "0.0.0",
22163 "filename": "server/api/intServicenowAccount/index.js",
22164 "groupTitle": "Servicenow_Accounts"
22168 "url": "/api/integrations/servicenow/accounts",
22169 "title": "Gets a list of Servicenow Accounts",
22172 "title": "Example usage:",
22173 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
22177 "name": "GetServicenow_Accounts",
22178 "group": "Servicenow_Accounts",
22179 "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>",
22180 "version": "0.0.0",
22181 "filename": "server/api/intServicenowAccount/index.js",
22182 "groupTitle": "Servicenow_Accounts"
22186 "url": "/api/integrations/servicenow/accounts/{id}",
22187 "title": "Gets a single Servicenow Account",
22190 "title": "Example usage:",
22191 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
22195 "name": "ShowServicenow_Accounts",
22196 "group": "Servicenow_Accounts",
22197 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22198 "version": "0.0.0",
22199 "filename": "server/api/intServicenowAccount/index.js",
22200 "groupTitle": "Servicenow_Accounts"
22204 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22205 "title": "Creates new configuration",
22208 "title": "Example usage:",
22209 "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",
22213 "name": "addConfiguration",
22214 "group": "Servicenow_Accounts",
22215 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22216 "version": "0.0.0",
22217 "filename": "server/api/intServicenowAccount/index.js",
22218 "groupTitle": "Servicenow_Accounts"
22222 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22223 "title": "Gets account configurations",
22226 "title": "Example usage:",
22227 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
22231 "name": "getConfigurations",
22232 "group": "Servicenow_Accounts",
22233 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22234 "version": "0.0.0",
22235 "filename": "server/api/intServicenowAccount/index.js",
22236 "groupTitle": "Servicenow_Accounts"
22240 "url": "/api/integrations/servicenow/accounts/{id}/fields",
22241 "title": "Gets account fields",
22244 "title": "Example usage:",
22245 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
22249 "name": "getFields",
22250 "group": "Servicenow_Accounts",
22251 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22252 "version": "0.0.0",
22253 "filename": "server/api/intServicenowAccount/index.js",
22254 "groupTitle": "Servicenow_Accounts"
22258 "url": "/api/integrations/servicenow/accounts/{id}",
22259 "title": "Update an existing Servicenow Account",
22262 "title": "Example usage:",
22263 "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",
22267 "name": "updateServicenow_Accounts",
22268 "group": "Servicenow_Accounts",
22269 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22270 "version": "0.0.0",
22271 "filename": "server/api/intServicenowAccount/index.js",
22272 "groupTitle": "Servicenow_Accounts"
22276 "url": "/api/integrations/servicenow/configurations",
22277 "title": "Creates a new Servicenow Configuration",
22280 "title": "Example usage:",
22281 "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",
22285 "name": "CreateServicenow_Configurations",
22286 "group": "Servicenow_Configurations",
22301 "field": "description",
22307 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22308 "version": "0.0.0",
22309 "filename": "server/api/intServicenowConfiguration/index.js",
22310 "groupTitle": "Servicenow_Configurations"
22314 "url": "/api/integrations/servicenow/configurations/{id}",
22315 "title": "Deletes a Servicenow Configuration",
22318 "title": "Example usage:",
22319 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
22323 "name": "DeleteServicenow_Configurations",
22324 "group": "Servicenow_Configurations",
22325 "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>",
22326 "version": "0.0.0",
22327 "filename": "server/api/intServicenowConfiguration/index.js",
22328 "groupTitle": "Servicenow_Configurations"
22332 "url": "/api/integrations/servicenow/configurations",
22333 "title": "Gets a list of Servicenow Configurations",
22336 "title": "Example usage:",
22337 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
22341 "name": "GetServicenow_Configurations",
22342 "group": "Servicenow_Configurations",
22343 "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>",
22344 "version": "0.0.0",
22345 "filename": "server/api/intServicenowConfiguration/index.js",
22346 "groupTitle": "Servicenow_Configurations"
22350 "url": "/api/integrations/servicenow/configurations/{id}",
22351 "title": "Gets a single Servicenow Configuration",
22354 "title": "Example usage:",
22355 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
22359 "name": "ShowServicenow_Configurations",
22360 "group": "Servicenow_Configurations",
22361 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22362 "version": "0.0.0",
22363 "filename": "server/api/intServicenowConfiguration/index.js",
22364 "groupTitle": "Servicenow_Configurations"
22368 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
22369 "title": "Gets configurations descriptions",
22372 "title": "Example usage:",
22373 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
22377 "name": "getDescriptions",
22378 "group": "Servicenow_Configurations",
22379 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22380 "version": "0.0.0",
22381 "filename": "server/api/intServicenowConfiguration/index.js",
22382 "groupTitle": "Servicenow_Configurations"
22386 "url": "/api/integrations/servicenow/configurations/{id}/fields",
22387 "title": "Gets configurations fields",
22390 "title": "Example usage:",
22391 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
22395 "name": "getFields",
22396 "group": "Servicenow_Configurations",
22397 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22398 "version": "0.0.0",
22399 "filename": "server/api/intServicenowConfiguration/index.js",
22400 "groupTitle": "Servicenow_Configurations"
22404 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
22405 "title": "Gets configurations subjects",
22408 "title": "Example usage:",
22409 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
22413 "name": "getSubjects",
22414 "group": "Servicenow_Configurations",
22415 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22416 "version": "0.0.0",
22417 "filename": "server/api/intServicenowConfiguration/index.js",
22418 "groupTitle": "Servicenow_Configurations"
22422 "url": "/api/integrations/servicenow/configurations/{id}",
22423 "title": "Update an existing Servicenow Configuration",
22426 "title": "Example usage:",
22427 "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",
22431 "name": "updateServicenow_Configurations",
22432 "group": "Servicenow_Configurations",
22433 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22434 "version": "0.0.0",
22435 "filename": "server/api/intServicenowConfiguration/index.js",
22436 "groupTitle": "Servicenow_Configurations"
22440 "url": "/api/integrations/servicenow/fields",
22441 "title": "Creates a new Servicenow Field",
22444 "title": "Example usage:",
22445 "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",
22449 "name": "CreateServicenow_Fields",
22450 "group": "Servicenow_Fields",
22460 "\"customVariable\"",
22472 "field": "content",
22488 "\"customVariable\""
22491 "field": "keyType",
22498 "field": "keyContent",
22505 "field": "idField",
22512 "field": "nameField",
22519 "field": "customField",
22526 "field": "variableName",
22532 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22533 "version": "0.0.0",
22534 "filename": "server/api/intServicenowField/index.js",
22535 "groupTitle": "Servicenow_Fields"
22539 "url": "/api/integrations/servicenow/fields/{id}",
22540 "title": "Deletes a Servicenow Field",
22543 "title": "Example usage:",
22544 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
22548 "name": "DeleteServicenow_Fields",
22549 "group": "Servicenow_Fields",
22550 "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>",
22551 "version": "0.0.0",
22552 "filename": "server/api/intServicenowField/index.js",
22553 "groupTitle": "Servicenow_Fields"
22557 "url": "/api/integrations/servicenow/fields",
22558 "title": "Gets a list of Servicenow Fields",
22561 "title": "Example usage:",
22562 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
22566 "name": "GetServicenow_Fields",
22567 "group": "Servicenow_Fields",
22568 "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>",
22569 "version": "0.0.0",
22570 "filename": "server/api/intServicenowField/index.js",
22571 "groupTitle": "Servicenow_Fields"
22575 "url": "/api/integrations/servicenow/fields/{id}",
22576 "title": "Gets a single Servicenow Field",
22579 "title": "Example usage:",
22580 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
22584 "name": "ShowServicenow_Fields",
22585 "group": "Servicenow_Fields",
22586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22587 "version": "0.0.0",
22588 "filename": "server/api/intServicenowField/index.js",
22589 "groupTitle": "Servicenow_Fields"
22593 "url": "/api/integrations/servicenow/fields/{id}",
22594 "title": "Update an existing Servicenow Field",
22597 "title": "Example usage:",
22598 "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",
22602 "name": "updateServicenow_Fields",
22603 "group": "Servicenow_Fields",
22604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22605 "version": "0.0.0",
22606 "filename": "server/api/intServicenowField/index.js",
22607 "groupTitle": "Servicenow_Fields"
22611 "url": "/api/settings",
22612 "title": "Gets a list of Settings",
22615 "title": "Example usage:",
22616 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22620 "name": "GetSettings",
22621 "group": "Settings",
22622 "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>",
22623 "version": "0.0.0",
22624 "filename": "server/api/setting/index.js",
22625 "groupTitle": "Settings"
22629 "url": "/api/settings/{id}",
22630 "title": "Gets a single Setting",
22633 "title": "Example usage:",
22634 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22638 "name": "ShowSettings",
22639 "group": "Settings",
22640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22641 "version": "0.0.0",
22642 "filename": "server/api/setting/index.js",
22643 "groupTitle": "Settings"
22647 "url": "/api/settings/{id}/favicon",
22648 "title": "Add Favicon",
22651 "title": "Example usage:",
22652 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22656 "name": "addFavicon",
22657 "group": "Settings",
22658 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22659 "version": "0.0.0",
22660 "filename": "server/api/setting/index.js",
22661 "groupTitle": "Settings"
22665 "url": "/api/settings/{id}/logo",
22666 "title": "Add logo",
22669 "title": "Example usage:",
22670 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22675 "group": "Settings",
22676 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22677 "version": "0.0.0",
22678 "filename": "server/api/setting/index.js",
22679 "groupTitle": "Settings"
22683 "url": "/api/settings/{id}/logo_login",
22684 "title": "Add logo login",
22687 "title": "Example usage:",
22688 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22692 "name": "addLogoLogin",
22693 "group": "Settings",
22694 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22695 "version": "0.0.0",
22696 "filename": "server/api/setting/index.js",
22697 "groupTitle": "Settings"
22701 "url": "/api/settings/{id}/preferred",
22702 "title": "Add Preferred",
22705 "title": "Example usage:",
22706 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22710 "name": "addPreferred",
22711 "group": "Settings",
22712 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22713 "version": "0.0.0",
22714 "filename": "server/api/setting/index.js",
22715 "groupTitle": "Settings"
22719 "url": "/api/settings/now",
22720 "title": "Get Server Current Date",
22723 "title": "Example usage:",
22724 "content": "curl https://{domain}/api/settings/now -v -X GET",
22729 "group": "Settings",
22730 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22731 "version": "0.0.0",
22732 "filename": "server/api/setting/index.js",
22733 "groupTitle": "Settings"
22737 "url": "/api/settings/{id}/favicon",
22738 "title": "Get Favicon",
22741 "title": "Example usage:",
22742 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22746 "name": "getFavicon",
22747 "group": "Settings",
22748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22749 "version": "0.0.0",
22750 "filename": "server/api/setting/index.js",
22751 "groupTitle": "Settings"
22755 "url": "/api/settings/{id}/gdpr",
22756 "title": "Get gdpr settings",
22759 "title": "Example usage:",
22760 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22765 "group": "Settings",
22766 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22767 "version": "0.0.0",
22768 "filename": "server/api/setting/index.js",
22769 "groupTitle": "Settings"
22773 "url": "/api/settings/{id}/logo",
22774 "title": "Get logo",
22777 "title": "Example usage:",
22778 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22783 "group": "Settings",
22784 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22785 "version": "0.0.0",
22786 "filename": "server/api/setting/index.js",
22787 "groupTitle": "Settings"
22791 "url": "/api/settings/{id}/logo_login",
22792 "title": "Get logo login",
22795 "title": "Example usage:",
22796 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22800 "name": "getLogoLogin",
22801 "group": "Settings",
22802 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22803 "version": "0.0.0",
22804 "filename": "server/api/setting/index.js",
22805 "groupTitle": "Settings"
22809 "url": "/api/settings/{id}/preferred",
22810 "title": "Get Preferred",
22813 "title": "Example usage:",
22814 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22818 "name": "getPreferred",
22819 "group": "Settings",
22820 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22821 "version": "0.0.0",
22822 "filename": "server/api/setting/index.js",
22823 "groupTitle": "Settings"
22827 "url": "/api/settings/{id}",
22828 "title": "Update an existing Setting",
22831 "title": "Example usage:",
22832 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22836 "name": "updateSettings",
22837 "group": "Settings",
22838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22839 "version": "0.0.0",
22840 "filename": "server/api/setting/index.js",
22841 "groupTitle": "Settings"
22845 "url": "/api/sms/accounts/{id}/users",
22846 "title": "Add agents to a sms account",
22849 "title": "Example usage:",
22850 "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",
22854 "name": "AddAgents",
22855 "group": "Sms_Accounts",
22856 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22857 "version": "0.0.0",
22858 "filename": "server/api/smsAccount/index.js",
22859 "groupTitle": "Sms_Accounts"
22863 "url": "/api/sms/accounts",
22864 "title": "Creates a new Account",
22867 "title": "Example usage:",
22868 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22872 "name": "CreateAccounts",
22873 "group": "Sms_Accounts",
22935 "field": "accountSid",
22949 "field": "authToken",
22961 "field": "smsMethod",
22968 "field": "username",
22975 "field": "password",
22989 "field": "applicationId",
22996 "field": "accountId",
23003 "field": "senderString",
23010 "field": "deliveryReport",
23017 "field": "description",
23024 "field": "notificationTemplate",
23031 "field": "notificationSound",
23038 "field": "notificationShake",
23045 "field": "waitForTheAssignedAgent",
23052 "field": "queueTransfer",
23059 "field": "queueTransferTimeout",
23066 "field": "agentTransfer",
23073 "field": "agentTransferTimeout",
23080 "field": "baseUrl",
23087 "field": "mandatoryDispositionPauseId",
23088 "description": "<p>Status to put when mandatory disposition is enabled</p>"
23094 "field": "mandatoryDisposition",
23095 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
23100 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23101 "version": "0.0.0",
23102 "filename": "server/api/smsAccount/index.js",
23103 "groupTitle": "Sms_Accounts"
23107 "url": "/api/sms/accounts/{id}",
23108 "title": "Deletes a Account",
23111 "title": "Example usage:",
23112 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
23116 "name": "DeleteAccounts",
23117 "group": "Sms_Accounts",
23118 "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>",
23119 "version": "0.0.0",
23120 "filename": "server/api/smsAccount/index.js",
23121 "groupTitle": "Sms_Accounts"
23125 "url": "/api/sms/accounts/describe",
23126 "title": "Gets table info about Accounts",
23129 "title": "Example usage:",
23130 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
23134 "name": "DescribeAccounts",
23135 "group": "Sms_Accounts",
23136 "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>",
23137 "version": "0.0.0",
23138 "filename": "server/api/smsAccount/index.js",
23139 "groupTitle": "Sms_Accounts"
23143 "url": "/api/sms/accounts",
23144 "title": "Gets a list of Accounts",
23147 "title": "Example usage:",
23148 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
23152 "name": "GetAccounts",
23153 "group": "Sms_Accounts",
23154 "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>",
23155 "version": "0.0.0",
23156 "filename": "server/api/smsAccount/index.js",
23157 "groupTitle": "Sms_Accounts"
23161 "url": "/api/sms/accounts/{id}/users",
23162 "title": "Gets agents from sms account",
23165 "title": "Example usage:",
23166 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
23170 "name": "GetAgents",
23171 "group": "Sms_Accounts",
23172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23173 "version": "0.0.0",
23174 "filename": "server/api/smsAccount/index.js",
23175 "groupTitle": "Sms_Accounts"
23179 "url": "/api/sms/accounts/{id}/users",
23180 "title": "Removes agents from a sms account",
23183 "title": "Example usage:",
23184 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23188 "name": "RemoveAgents",
23189 "group": "Sms_Accounts",
23190 "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>",
23191 "version": "0.0.0",
23192 "filename": "server/api/smsAccount/index.js",
23193 "groupTitle": "Sms_Accounts"
23197 "url": "/api/sms/accounts/{id}/canned_answers",
23198 "title": "Removes canned answers from account",
23201 "title": "Example usage:",
23202 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23206 "name": "RemoveAnswers",
23207 "group": "Sms_Accounts",
23208 "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>",
23209 "version": "0.0.0",
23210 "filename": "server/api/smsAccount/index.js",
23211 "groupTitle": "Sms_Accounts"
23215 "url": "/api/sms/accounts/{id}/dispositions",
23216 "title": "Removes dispositions from account",
23219 "title": "Example usage:",
23220 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23224 "name": "RemoveDispositions",
23225 "group": "Sms_Accounts",
23226 "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>",
23227 "version": "0.0.0",
23228 "filename": "server/api/smsAccount/index.js",
23229 "groupTitle": "Sms_Accounts"
23233 "url": "/api/sms/accounts/{id}",
23234 "title": "Gets a single Account",
23237 "title": "Example usage:",
23238 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
23242 "name": "ShowAccounts",
23243 "group": "Sms_Accounts",
23244 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23245 "version": "0.0.0",
23246 "filename": "server/api/smsAccount/index.js",
23247 "groupTitle": "Sms_Accounts"
23251 "url": "/api/sms/messages/{id}/accept",
23252 "title": "Accepts message",
23255 "title": "Example usage:",
23256 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23260 "name": "acceptMessage",
23261 "group": "Sms_Accounts",
23262 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23263 "version": "0.0.0",
23264 "filename": "server/api/smsMessage/index.js",
23265 "groupTitle": "Sms_Accounts"
23269 "url": "/api/sms/accounts/{id}/canned_answers",
23270 "title": "Creates new canned answer",
23273 "title": "Example usage:",
23274 "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",
23278 "name": "addAnswer",
23279 "group": "Sms_Accounts",
23301 "field": "description",
23314 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23315 "version": "0.0.0",
23316 "filename": "server/api/smsAccount/index.js",
23317 "groupTitle": "Sms_Accounts"
23321 "url": "/api/sms/accounts/{id}/applications",
23322 "title": "Creates new applications",
23325 "title": "Example usage:",
23326 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23330 "name": "addApplications",
23331 "group": "Sms_Accounts",
23339 "field": "priority",
23353 "field": "appdata",
23360 "field": "description",
23367 "field": "interval",
23373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23374 "version": "0.0.0",
23375 "filename": "server/api/smsAccount/index.js",
23376 "groupTitle": "Sms_Accounts"
23380 "url": "/api/sms/accounts/{id}/dispositions",
23381 "title": "Creates new disposition",
23384 "title": "Example usage:",
23385 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23389 "name": "addDisposition",
23390 "group": "Sms_Accounts",
23417 "field": "description",
23423 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23424 "version": "0.0.0",
23425 "filename": "server/api/smsAccount/index.js",
23426 "groupTitle": "Sms_Accounts"
23430 "url": "/api/sms/accounts/{id}/canned_answers",
23431 "title": "Gets account canned answers",
23434 "title": "Example usage:",
23435 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
23439 "name": "getAnswers",
23440 "group": "Sms_Accounts",
23441 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23442 "version": "0.0.0",
23443 "filename": "server/api/smsAccount/index.js",
23444 "groupTitle": "Sms_Accounts"
23448 "url": "/api/sms/accounts/{id}/applications",
23449 "title": "Gets account applications",
23452 "title": "Example usage:",
23453 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
23457 "name": "getApplications",
23458 "group": "Sms_Accounts",
23459 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23460 "version": "0.0.0",
23461 "filename": "server/api/smsAccount/index.js",
23462 "groupTitle": "Sms_Accounts"
23466 "url": "/api/sms/accounts/{id}/dispositions",
23467 "title": "Gets account dispositions",
23470 "title": "Example usage:",
23471 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
23475 "name": "getDispositions",
23476 "group": "Sms_Accounts",
23477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23478 "version": "0.0.0",
23479 "filename": "server/api/smsAccount/index.js",
23480 "groupTitle": "Sms_Accounts"
23484 "url": "/api/sms/accounts/{id}/interactions",
23485 "title": "Gets Sms Account interactions",
23488 "title": "Example usage:",
23489 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
23493 "name": "getInteractions",
23494 "group": "Sms_Accounts",
23495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23496 "version": "0.0.0",
23497 "filename": "server/api/smsAccount/index.js",
23498 "groupTitle": "Sms_Accounts"
23502 "url": "/api/sms/accounts/{id}/notify",
23503 "title": "Notify new message",
23506 "title": "Example usage:",
23507 "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",
23512 "group": "Sms_Accounts",
23513 "description": "<p>Motion 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>",
23514 "version": "0.0.0",
23515 "filename": "server/api/smsAccount/index.js",
23516 "groupTitle": "Sms_Accounts"
23520 "url": "/api/sms/messages/{id}/reject",
23521 "title": "Rejects message",
23524 "title": "Example usage:",
23525 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23529 "name": "rejectMessage",
23530 "group": "Sms_Accounts",
23531 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23532 "version": "0.0.0",
23533 "filename": "server/api/smsMessage/index.js",
23534 "groupTitle": "Sms_Accounts"
23538 "url": "/api/sms/accounts/{id}/send",
23539 "title": "Send new sms message",
23542 "title": "Example usage:",
23543 "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",
23548 "group": "Sms_Accounts",
23549 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23550 "version": "0.0.0",
23551 "filename": "server/api/smsAccount/index.js",
23552 "groupTitle": "Sms_Accounts"
23556 "url": "/api/sms/messages/{id}/status",
23557 "title": "Receive message status",
23560 "title": "Example usage:",
23561 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
23565 "name": "statusMessage",
23566 "group": "Sms_Accounts",
23567 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23568 "version": "0.0.0",
23569 "filename": "server/api/smsMessage/index.js",
23570 "groupTitle": "Sms_Accounts"
23574 "url": "/api/sms/accounts/{id}/status",
23575 "title": "Receive message status",
23578 "title": "Example usage:",
23579 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23583 "name": "statusMessage",
23584 "group": "Sms_Accounts",
23585 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23586 "version": "0.0.0",
23587 "filename": "server/api/smsAccount/index.js",
23588 "groupTitle": "Sms_Accounts"
23592 "url": "/api/sms/accounts/{id}/status",
23593 "title": "Receive message status as get request",
23596 "title": "Example usage:",
23597 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
23601 "name": "statusMessage",
23602 "group": "Sms_Accounts",
23603 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23604 "version": "0.0.0",
23605 "filename": "server/api/smsAccount/index.js",
23606 "groupTitle": "Sms_Accounts"
23610 "url": "/api/sms/accounts/{id}",
23611 "title": "Update an existing Account",
23614 "title": "Example usage:",
23615 "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",
23619 "name": "updateAccounts",
23620 "group": "Sms_Accounts",
23621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23622 "version": "0.0.0",
23623 "filename": "server/api/smsAccount/index.js",
23624 "groupTitle": "Sms_Accounts"
23628 "url": "/api/sms/applications",
23629 "title": "Creates a new Application",
23632 "title": "Example usage:",
23633 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23637 "name": "CreateApplications",
23638 "group": "Sms_Applications",
23646 "field": "priority",
23660 "field": "appdata",
23667 "field": "description",
23674 "field": "interval",
23680 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23681 "version": "0.0.0",
23682 "filename": "server/api/smsApplication/index.js",
23683 "groupTitle": "Sms_Applications"
23687 "url": "/api/sms/applications/{id}",
23688 "title": "Deletes a Application",
23691 "title": "Example usage:",
23692 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23696 "name": "DeleteApplications",
23697 "group": "Sms_Applications",
23698 "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>",
23699 "version": "0.0.0",
23700 "filename": "server/api/smsApplication/index.js",
23701 "groupTitle": "Sms_Applications"
23705 "url": "/api/sms/applications",
23706 "title": "Gets a list of Applications",
23709 "title": "Example usage:",
23710 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23714 "name": "GetApplications",
23715 "group": "Sms_Applications",
23716 "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>",
23717 "version": "0.0.0",
23718 "filename": "server/api/smsApplication/index.js",
23719 "groupTitle": "Sms_Applications"
23723 "url": "/api/sms/applications/{id}",
23724 "title": "Gets a single Application",
23727 "title": "Example usage:",
23728 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23732 "name": "ShowApplications",
23733 "group": "Sms_Applications",
23734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23735 "version": "0.0.0",
23736 "filename": "server/api/smsApplication/index.js",
23737 "groupTitle": "Sms_Applications"
23741 "url": "/api/sms/applications/{id}",
23742 "title": "Update an existing Application",
23745 "title": "Example usage:",
23746 "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",
23750 "name": "updateApplications",
23751 "group": "Sms_Applications",
23752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23753 "version": "0.0.0",
23754 "filename": "server/api/smsApplication/index.js",
23755 "groupTitle": "Sms_Applications"
23759 "url": "/api/sms/interactions/{id}/tags",
23760 "title": "Add tags to the interaction",
23763 "title": "Example usage:",
23764 "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",
23769 "group": "Sms_Interactions",
23770 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23771 "version": "0.0.0",
23772 "filename": "server/api/smsInteraction/index.js",
23773 "groupTitle": "Sms_Interactions"
23777 "url": "/api/sms/interactions",
23778 "title": "Creates a new Interaction",
23781 "title": "Example usage:",
23782 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23786 "name": "CreateInteractions",
23787 "group": "Sms_Interactions",
23802 "field": "closedAt",
23809 "field": "disposition",
23816 "field": "secondDisposition",
23823 "field": "thirdDisposition",
23844 "field": "read1stAt",
23855 "field": "firstMsgDirection",
23862 "field": "lastMsgAt",
23873 "field": "lastMsgDirection",
23880 "field": "autoreplyExecuted",
23886 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23887 "version": "0.0.0",
23888 "filename": "server/api/smsInteraction/index.js",
23889 "groupTitle": "Sms_Interactions"
23893 "url": "/api/sms/interactions/{id}",
23894 "title": "Deletes a Interaction",
23897 "title": "Example usage:",
23898 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23902 "name": "DeleteInteractions",
23903 "group": "Sms_Interactions",
23904 "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>",
23905 "version": "0.0.0",
23906 "filename": "server/api/smsInteraction/index.js",
23907 "groupTitle": "Sms_Interactions"
23911 "url": "/api/sms/interactions/describe",
23912 "title": "Gets table info about Interactions",
23915 "title": "Example usage:",
23916 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23920 "name": "DescribeInteractions",
23921 "group": "Sms_Interactions",
23922 "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>",
23923 "version": "0.0.0",
23924 "filename": "server/api/smsInteraction/index.js",
23925 "groupTitle": "Sms_Interactions"
23929 "url": "/api/sms/interactions",
23930 "title": "Gets a list of Interactions",
23933 "title": "Example usage:",
23934 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23938 "name": "GetInteractions",
23939 "group": "Sms_Interactions",
23940 "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>",
23941 "version": "0.0.0",
23942 "filename": "server/api/smsInteraction/index.js",
23943 "groupTitle": "Sms_Interactions"
23947 "url": "/api/sms/interactions/{id}/tags",
23948 "title": "Removes tags from interaction",
23951 "title": "Example usage:",
23952 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23956 "name": "RemoveTags",
23957 "group": "Sms_Interactions",
23958 "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>",
23959 "version": "0.0.0",
23960 "filename": "server/api/smsInteraction/index.js",
23961 "groupTitle": "Sms_Interactions"
23965 "url": "/api/sms/interactions/{id}",
23966 "title": "Gets a single Interaction",
23969 "title": "Example usage:",
23970 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23974 "name": "ShowInteractions",
23975 "group": "Sms_Interactions",
23976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23977 "version": "0.0.0",
23978 "filename": "server/api/smsInteraction/index.js",
23979 "groupTitle": "Sms_Interactions"
23983 "url": "/api/sms/interactions/{id}/messages",
23984 "title": "Creates new messages",
23987 "title": "Example usage:",
23988 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23992 "name": "addMessage",
23993 "group": "Sms_Interactions",
24019 "field": "direction",
24026 "field": "messageId",
24054 "field": "providerName",
24061 "field": "providerResponse",
24067 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24068 "version": "0.0.0",
24069 "filename": "server/api/smsInteraction/index.js",
24070 "groupTitle": "Sms_Interactions"
24074 "url": "/api/sms/interactions/{id}/download",
24075 "title": "Gets interaction",
24078 "title": "Example usage:",
24079 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
24083 "name": "download",
24084 "group": "Sms_Interactions",
24085 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24086 "version": "0.0.0",
24087 "filename": "server/api/smsInteraction/index.js",
24088 "groupTitle": "Sms_Interactions"
24092 "url": "/api/sms/interactions/{id}/messages",
24093 "title": "Gets interaction messages",
24096 "title": "Example usage:",
24097 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
24101 "name": "getMessages",
24102 "group": "Sms_Interactions",
24103 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24104 "version": "0.0.0",
24105 "filename": "server/api/smsInteraction/index.js",
24106 "groupTitle": "Sms_Interactions"
24110 "url": "/api/sms/interactions/{id}",
24111 "title": "Update an existing Interaction",
24114 "title": "Example usage:",
24115 "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",
24119 "name": "updateInteractions",
24120 "group": "Sms_Interactions",
24121 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24122 "version": "0.0.0",
24123 "filename": "server/api/smsInteraction/index.js",
24124 "groupTitle": "Sms_Interactions"
24128 "url": "/api/sms/messages",
24129 "title": "Creates a new Message",
24132 "title": "Example usage:",
24133 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24137 "name": "CreateMessages",
24138 "group": "Sms_Messages",
24164 "field": "direction",
24171 "field": "messageId",
24199 "field": "providerName",
24206 "field": "providerResponse",
24212 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24213 "version": "0.0.0",
24214 "filename": "server/api/smsMessage/index.js",
24215 "groupTitle": "Sms_Messages"
24219 "url": "/api/sms/messages/{id}",
24220 "title": "Deletes a Message",
24223 "title": "Example usage:",
24224 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
24228 "name": "DeleteMessages",
24229 "group": "Sms_Messages",
24230 "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>",
24231 "version": "0.0.0",
24232 "filename": "server/api/smsMessage/index.js",
24233 "groupTitle": "Sms_Messages"
24237 "url": "/api/sms/messages/describe",
24238 "title": "Gets table info about Messages",
24241 "title": "Example usage:",
24242 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
24246 "name": "DescribeMessages",
24247 "group": "Sms_Messages",
24248 "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>",
24249 "version": "0.0.0",
24250 "filename": "server/api/smsMessage/index.js",
24251 "groupTitle": "Sms_Messages"
24255 "url": "/api/sms/messages",
24256 "title": "Gets a list of Messages",
24259 "title": "Example usage:",
24260 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
24264 "name": "GetMessages",
24265 "group": "Sms_Messages",
24266 "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>",
24267 "version": "0.0.0",
24268 "filename": "server/api/smsMessage/index.js",
24269 "groupTitle": "Sms_Messages"
24273 "url": "/api/sms/messages/{id}",
24274 "title": "Gets a single Message",
24277 "title": "Example usage:",
24278 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
24282 "name": "ShowMessages",
24283 "group": "Sms_Messages",
24284 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24285 "version": "0.0.0",
24286 "filename": "server/api/smsMessage/index.js",
24287 "groupTitle": "Sms_Messages"
24291 "url": "/api/sms/messages/{id}",
24292 "title": "Update an existing Message",
24295 "title": "Example usage:",
24296 "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",
24300 "name": "updateMessages",
24301 "group": "Sms_Messages",
24302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24303 "version": "0.0.0",
24304 "filename": "server/api/smsMessage/index.js",
24305 "groupTitle": "Sms_Messages"
24309 "url": "/api/sms/reports/queue",
24310 "title": "Creates a new Sms Queue Report",
24313 "title": "Example usage:",
24314 "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",
24318 "name": "CreateSms_Queue_Reports",
24319 "group": "Sms_Queue_Reports",
24327 "field": "uniqueid",
24348 "field": "leaveAt",
24355 "field": "acceptAt",
24375 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24376 "version": "0.0.0",
24377 "filename": "server/api/smsQueueReport/index.js",
24378 "groupTitle": "Sms_Queue_Reports"
24382 "url": "/api/sms/reports/queue/{id}",
24383 "title": "Deletes a Sms Queue Report",
24386 "title": "Example usage:",
24387 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
24391 "name": "DeleteSms_Queue_Reports",
24392 "group": "Sms_Queue_Reports",
24393 "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>",
24394 "version": "0.0.0",
24395 "filename": "server/api/smsQueueReport/index.js",
24396 "groupTitle": "Sms_Queue_Reports"
24400 "url": "/api/sms/reports/queue/describe",
24401 "title": "Gets table info about Sms Queue Reports",
24404 "title": "Example usage:",
24405 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
24409 "name": "DescribeSms_Queue_Reports",
24410 "group": "Sms_Queue_Reports",
24411 "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>",
24412 "version": "0.0.0",
24413 "filename": "server/api/smsQueueReport/index.js",
24414 "groupTitle": "Sms_Queue_Reports"
24418 "url": "/api/sms/reports/queue",
24419 "title": "Gets a list of Sms Queue Reports",
24422 "title": "Example usage:",
24423 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
24427 "name": "GetSms_Queue_Reports",
24428 "group": "Sms_Queue_Reports",
24429 "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>",
24430 "version": "0.0.0",
24431 "filename": "server/api/smsQueueReport/index.js",
24432 "groupTitle": "Sms_Queue_Reports"
24436 "url": "/api/sms/reports/queue/{id}",
24437 "title": "Gets a single Sms Queue Report",
24440 "title": "Example usage:",
24441 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
24445 "name": "ShowSms_Queue_Reports",
24446 "group": "Sms_Queue_Reports",
24447 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24448 "version": "0.0.0",
24449 "filename": "server/api/smsQueueReport/index.js",
24450 "groupTitle": "Sms_Queue_Reports"
24454 "url": "/api/sms/reports/queue/{id}",
24455 "title": "Update an existing Sms Queue Report",
24458 "title": "Example usage:",
24459 "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",
24463 "name": "updateSms_Queue_Reports",
24464 "group": "Sms_Queue_Reports",
24465 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24466 "version": "0.0.0",
24467 "filename": "server/api/smsQueueReport/index.js",
24468 "groupTitle": "Sms_Queue_Reports"
24472 "url": "/api/sms/queues/{id}/users",
24473 "title": "Add agents to a queue",
24476 "title": "Example usage:",
24477 "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",
24481 "name": "AddAgents",
24482 "group": "Sms_Queues",
24483 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24484 "version": "0.0.0",
24485 "filename": "server/api/smsQueue/index.js",
24486 "groupTitle": "Sms_Queues"
24490 "url": "/api/sms/queues/{id}/teams",
24491 "title": "Add teams to a queue",
24494 "title": "Example usage:",
24495 "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",
24499 "name": "AddTeams",
24500 "group": "Sms_Queues",
24501 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24502 "version": "0.0.0",
24503 "filename": "server/api/smsQueue/index.js",
24504 "groupTitle": "Sms_Queues"
24508 "url": "/api/sms/queues",
24509 "title": "Creates a new Queue",
24512 "title": "Example usage:",
24513 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24517 "name": "CreateQueues",
24518 "group": "Sms_Queues",
24533 "field": "description",
24540 "field": "timeout",
24552 "field": "strategy",
24558 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24559 "version": "0.0.0",
24560 "filename": "server/api/smsQueue/index.js",
24561 "groupTitle": "Sms_Queues"
24565 "url": "/api/sms/queues/{id}",
24566 "title": "Deletes a Queue",
24569 "title": "Example usage:",
24570 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
24574 "name": "DeleteQueues",
24575 "group": "Sms_Queues",
24576 "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>",
24577 "version": "0.0.0",
24578 "filename": "server/api/smsQueue/index.js",
24579 "groupTitle": "Sms_Queues"
24583 "url": "/api/sms/queues/describe",
24584 "title": "Gets table info about Queues",
24587 "title": "Example usage:",
24588 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
24592 "name": "DescribeQueues",
24593 "group": "Sms_Queues",
24594 "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>",
24595 "version": "0.0.0",
24596 "filename": "server/api/smsQueue/index.js",
24597 "groupTitle": "Sms_Queues"
24601 "url": "/api/sms/queues/{id}/users",
24602 "title": "Gets queue agents",
24605 "title": "Example usage:",
24606 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24610 "name": "GetAgents",
24611 "group": "Sms_Queues",
24612 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24613 "version": "0.0.0",
24614 "filename": "server/api/smsQueue/index.js",
24615 "groupTitle": "Sms_Queues"
24619 "url": "/api/sms/queues/{id}/members",
24620 "title": "GetMembers",
24623 "title": "Example usage:",
24624 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
24628 "name": "GetMembers",
24629 "group": "Sms_Queues",
24630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24631 "version": "0.0.0",
24632 "filename": "server/api/smsQueue/index.js",
24633 "groupTitle": "Sms_Queues"
24637 "url": "/api/sms/queues",
24638 "title": "Gets a list of Queues",
24641 "title": "Example usage:",
24642 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24646 "name": "GetQueues",
24647 "group": "Sms_Queues",
24648 "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>",
24649 "version": "0.0.0",
24650 "filename": "server/api/smsQueue/index.js",
24651 "groupTitle": "Sms_Queues"
24655 "url": "/api/sms/queues/{id}/teams",
24656 "title": "Gets queues list",
24659 "title": "Example usage:",
24660 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24664 "name": "GetTeams",
24665 "group": "Sms_Queues",
24666 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24667 "version": "0.0.0",
24668 "filename": "server/api/smsQueue/index.js",
24669 "groupTitle": "Sms_Queues"
24673 "url": "/api/sms/queues/{id}/users",
24674 "title": "Removes agents from a queue",
24677 "title": "Example usage:",
24678 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24682 "name": "RemoveAgents",
24683 "group": "Sms_Queues",
24684 "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>",
24685 "version": "0.0.0",
24686 "filename": "server/api/smsQueue/index.js",
24687 "groupTitle": "Sms_Queues"
24691 "url": "/api/sms/queues/{id}",
24692 "title": "Gets a single Queue",
24695 "title": "Example usage:",
24696 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24700 "name": "ShowQueues",
24701 "group": "Sms_Queues",
24702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24703 "version": "0.0.0",
24704 "filename": "server/api/smsQueue/index.js",
24705 "groupTitle": "Sms_Queues"
24709 "url": "/api/sms/queues/{id}",
24710 "title": "Update an existing Queue",
24713 "title": "Example usage:",
24714 "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",
24718 "name": "updateQueues",
24719 "group": "Sms_Queues",
24720 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24721 "version": "0.0.0",
24722 "filename": "server/api/smsQueue/index.js",
24723 "groupTitle": "Sms_Queues"
24727 "url": "/api/sms/reports/transfer",
24728 "title": "Creates a new Sms Transfer Report",
24731 "title": "Example usage:",
24732 "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",
24736 "name": "CreateSms_Transfer_Reports",
24737 "group": "Sms_Transfer_Reports",
24745 "field": "uniqueid",
24764 "field": "transferredAt",
24770 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24771 "version": "0.0.0",
24772 "filename": "server/api/smsTransferReport/index.js",
24773 "groupTitle": "Sms_Transfer_Reports"
24777 "url": "/api/sms/reports/transfer/{id}",
24778 "title": "Deletes a Sms Transfer Report",
24781 "title": "Example usage:",
24782 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24786 "name": "DeleteSms_Transfer_Reports",
24787 "group": "Sms_Transfer_Reports",
24788 "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>",
24789 "version": "0.0.0",
24790 "filename": "server/api/smsTransferReport/index.js",
24791 "groupTitle": "Sms_Transfer_Reports"
24795 "url": "/api/sms/reports/transfer/describe",
24796 "title": "Gets table info about Sms Transfer Reports",
24799 "title": "Example usage:",
24800 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24804 "name": "DescribeSms_Transfer_Reports",
24805 "group": "Sms_Transfer_Reports",
24806 "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>",
24807 "version": "0.0.0",
24808 "filename": "server/api/smsTransferReport/index.js",
24809 "groupTitle": "Sms_Transfer_Reports"
24813 "url": "/api/sms/reports/transfer",
24814 "title": "Gets a list of Sms Transfer Reports",
24817 "title": "Example usage:",
24818 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24822 "name": "GetSms_Transfer_Reports",
24823 "group": "Sms_Transfer_Reports",
24824 "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>",
24825 "version": "0.0.0",
24826 "filename": "server/api/smsTransferReport/index.js",
24827 "groupTitle": "Sms_Transfer_Reports"
24831 "url": "/api/sms/reports/transfer/{id}",
24832 "title": "Gets a single Sms Transfer Report",
24835 "title": "Example usage:",
24836 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24840 "name": "ShowSms_Transfer_Reports",
24841 "group": "Sms_Transfer_Reports",
24842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24843 "version": "0.0.0",
24844 "filename": "server/api/smsTransferReport/index.js",
24845 "groupTitle": "Sms_Transfer_Reports"
24849 "url": "/api/sms/reports/transfer/{id}",
24850 "title": "Update an existing Sms Transfer Report",
24853 "title": "Example usage:",
24854 "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",
24858 "name": "updateSms_Transfer_Reports",
24859 "group": "Sms_Transfer_Reports",
24860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24861 "version": "0.0.0",
24862 "filename": "server/api/smsTransferReport/index.js",
24863 "groupTitle": "Sms_Transfer_Reports"
24867 "url": "/api/sounds",
24868 "title": "Gets a list of Sounds",
24871 "title": "Example usage:",
24872 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24876 "name": "GetSounds",
24878 "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>",
24879 "version": "0.0.0",
24880 "filename": "server/api/sound/index.js",
24881 "groupTitle": "Sounds"
24885 "url": "/api/sounds/{id}",
24886 "title": "Gets a single Sound",
24889 "title": "Example usage:",
24890 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24894 "name": "ShowSounds",
24896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24897 "version": "0.0.0",
24898 "filename": "server/api/sound/index.js",
24899 "groupTitle": "Sounds"
24903 "url": "/api/sounds",
24904 "title": "Create a new sound",
24907 "title": "Example usage:",
24908 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24912 "name": "addSound",
24914 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24915 "version": "0.0.0",
24916 "filename": "server/api/sound/index.js",
24917 "groupTitle": "Sounds"
24921 "url": "/api/sounds/{id}",
24922 "title": "Deletes a sound",
24925 "title": "Example usage:",
24926 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24930 "name": "destroySound",
24932 "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>",
24933 "version": "0.0.0",
24934 "filename": "server/api/sound/index.js",
24935 "groupTitle": "Sounds"
24939 "url": "/api/sounds/{id}/download",
24940 "title": "Download Sound",
24943 "title": "Example usage:",
24944 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24948 "name": "download",
24950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24951 "version": "0.0.0",
24952 "filename": "server/api/sound/index.js",
24953 "groupTitle": "Sounds"
24957 "url": "/api/sounds",
24958 "title": "Update an existing new sound",
24961 "title": "Example usage:",
24962 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24966 "name": "updateSound",
24968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24969 "version": "0.0.0",
24970 "filename": "server/api/sound/index.js",
24971 "groupTitle": "Sounds"
24975 "url": "/api/square/details/reports",
24976 "title": "Creates a new Square Detail Report",
24979 "title": "Example usage:",
24980 "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",
24984 "name": "CreateSquare_Detail_Reports",
24985 "group": "Square_Details_Reports",
24993 "field": "uniqueid",
25007 "field": "application",
25021 "field": "project_name",
25028 "field": "callerid",
25034 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25035 "version": "0.0.0",
25036 "filename": "server/api/squareReportDetail/index.js",
25037 "groupTitle": "Square_Details_Reports"
25041 "url": "/api/square/details/reports/{id}",
25042 "title": "Deletes a Square Detail Report",
25045 "title": "Example usage:",
25046 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
25050 "name": "DeleteSquare_Detail_Reports",
25051 "group": "Square_Details_Reports",
25052 "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>",
25053 "version": "0.0.0",
25054 "filename": "server/api/squareReportDetail/index.js",
25055 "groupTitle": "Square_Details_Reports"
25059 "url": "/api/square/details/reports/describe",
25060 "title": "Gets table info about Square Detail Reports",
25063 "title": "Example usage:",
25064 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
25068 "name": "DescribeSquare_Detail_Reports",
25069 "group": "Square_Details_Reports",
25070 "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>",
25071 "version": "0.0.0",
25072 "filename": "server/api/squareReportDetail/index.js",
25073 "groupTitle": "Square_Details_Reports"
25077 "url": "/api/square/details/reports",
25078 "title": "Gets a list of Square Detail Reports",
25081 "title": "Example usage:",
25082 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
25086 "name": "GetSquare_Detail_Reports",
25087 "group": "Square_Details_Reports",
25088 "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>",
25089 "version": "0.0.0",
25090 "filename": "server/api/squareReportDetail/index.js",
25091 "groupTitle": "Square_Details_Reports"
25095 "url": "/api/square/details/reports/{id}",
25096 "title": "Gets a single Square Detail Report",
25099 "title": "Example usage:",
25100 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
25104 "name": "ShowSquare_Detail_Reports",
25105 "group": "Square_Details_Reports",
25106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25107 "version": "0.0.0",
25108 "filename": "server/api/squareReportDetail/index.js",
25109 "groupTitle": "Square_Details_Reports"
25113 "url": "/api/square/details/reports/{id}",
25114 "title": "Update an existing Square Detail Report",
25117 "title": "Example usage:",
25118 "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",
25122 "name": "updateSquare_Detail_Reports",
25123 "group": "Square_Details_Reports",
25124 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25125 "version": "0.0.0",
25126 "filename": "server/api/squareReportDetail/index.js",
25127 "groupTitle": "Square_Details_Reports"
25131 "url": "/api/square/messages",
25132 "title": "Creates a new Message",
25135 "title": "Example usage:",
25136 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25140 "name": "CreateMessages",
25141 "group": "Square_Messages",
25149 "field": "uniqueid",
25167 "field": "direction",
25174 "field": "providerName",
25181 "field": "providerResponse",
25187 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25188 "version": "0.0.0",
25189 "filename": "server/api/squareMessage/index.js",
25190 "groupTitle": "Square_Messages"
25194 "url": "/api/square/messages/{id}",
25195 "title": "Deletes a Message",
25198 "title": "Example usage:",
25199 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
25203 "name": "DeleteMessages",
25204 "group": "Square_Messages",
25205 "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>",
25206 "version": "0.0.0",
25207 "filename": "server/api/squareMessage/index.js",
25208 "groupTitle": "Square_Messages"
25212 "url": "/api/square/messages",
25213 "title": "Gets a list of Messages",
25216 "title": "Example usage:",
25217 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
25221 "name": "GetMessages",
25222 "group": "Square_Messages",
25223 "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>",
25224 "version": "0.0.0",
25225 "filename": "server/api/squareMessage/index.js",
25226 "groupTitle": "Square_Messages"
25230 "url": "/api/square/messages/{id}",
25231 "title": "Gets a single Message",
25234 "title": "Example usage:",
25235 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
25239 "name": "ShowMessages",
25240 "group": "Square_Messages",
25241 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25242 "version": "0.0.0",
25243 "filename": "server/api/squareMessage/index.js",
25244 "groupTitle": "Square_Messages"
25248 "url": "/api/square/messages/{id}",
25249 "title": "Update an existing Message",
25252 "title": "Example usage:",
25253 "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",
25257 "name": "updateMessages",
25258 "group": "Square_Messages",
25259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25260 "version": "0.0.0",
25261 "filename": "server/api/squareMessage/index.js",
25262 "groupTitle": "Square_Messages"
25266 "url": "/api/square/odbc",
25267 "title": "Creates a new ODBC",
25270 "title": "Example usage:",
25271 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25275 "name": "CreateODBCs",
25276 "group": "Square_ODBC",
25298 "field": "description",
25304 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25305 "version": "0.0.0",
25306 "filename": "server/api/squareOdbc/index.js",
25307 "groupTitle": "Square_ODBC"
25311 "url": "/api/square/odbc/{id}",
25312 "title": "Deletes a ODBC",
25315 "title": "Example usage:",
25316 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
25320 "name": "DeleteODBCs",
25321 "group": "Square_ODBC",
25322 "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>",
25323 "version": "0.0.0",
25324 "filename": "server/api/squareOdbc/index.js",
25325 "groupTitle": "Square_ODBC"
25329 "url": "/api/square/odbc",
25330 "title": "Gets a list of ODBCs",
25333 "title": "Example usage:",
25334 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
25338 "name": "GetODBCs",
25339 "group": "Square_ODBC",
25340 "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>",
25341 "version": "0.0.0",
25342 "filename": "server/api/squareOdbc/index.js",
25343 "groupTitle": "Square_ODBC"
25347 "url": "/api/square/odbc/{id}",
25348 "title": "Gets a single ODBC",
25351 "title": "Example usage:",
25352 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
25356 "name": "ShowODBCs",
25357 "group": "Square_ODBC",
25358 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25359 "version": "0.0.0",
25360 "filename": "server/api/squareOdbc/index.js",
25361 "groupTitle": "Square_ODBC"
25365 "url": "/api/square/odbc/{id}/test",
25366 "title": "Test Odbc",
25369 "title": "Example usage:",
25370 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
25375 "group": "Square_ODBC",
25376 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25377 "version": "0.0.0",
25378 "filename": "server/api/squareOdbc/index.js",
25379 "groupTitle": "Square_ODBC"
25383 "url": "/api/square/odbc/{id}",
25384 "title": "Update an existing ODBC",
25387 "title": "Example usage:",
25388 "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",
25392 "name": "updateODBCs",
25393 "group": "Square_ODBC",
25394 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25395 "version": "0.0.0",
25396 "filename": "server/api/squareOdbc/index.js",
25397 "groupTitle": "Square_ODBC"
25401 "url": "/api/square/projects",
25402 "title": "Creates a new Project",
25405 "title": "Example usage:",
25406 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25410 "name": "CreateProjects",
25411 "group": "Square_Projects",
25426 "field": "description",
25440 "field": "preproduction",
25447 "field": "production",
25454 "field": "savedAt",
25461 "field": "publishedAt",
25467 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25468 "version": "0.0.0",
25469 "filename": "server/api/squareProject/index.js",
25470 "groupTitle": "Square_Projects"
25474 "url": "/api/square/projects/{id}",
25475 "title": "Deletes a Project",
25478 "title": "Example usage:",
25479 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
25483 "name": "DeleteProjects",
25484 "group": "Square_Projects",
25485 "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>",
25486 "version": "0.0.0",
25487 "filename": "server/api/squareProject/index.js",
25488 "groupTitle": "Square_Projects"
25492 "url": "/api/square/projects",
25493 "title": "Gets a list of Projects",
25496 "title": "Example usage:",
25497 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
25501 "name": "GetProjects",
25502 "group": "Square_Projects",
25503 "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>",
25504 "version": "0.0.0",
25505 "filename": "server/api/squareProject/index.js",
25506 "groupTitle": "Square_Projects"
25510 "url": "/api/square/projects/{id}",
25511 "title": "Gets a single Project",
25514 "title": "Example usage:",
25515 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
25519 "name": "ShowProjects",
25520 "group": "Square_Projects",
25521 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25522 "version": "0.0.0",
25523 "filename": "server/api/squareProject/index.js",
25524 "groupTitle": "Square_Projects"
25528 "url": "/api/square/projects/{id}/users",
25529 "title": "Adds user permissions to a Project",
25532 "title": "Example usage:",
25533 "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",
25537 "name": "addUsers",
25538 "group": "Square_Projects",
25539 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25540 "version": "0.0.0",
25541 "filename": "server/api/squareProject/index.js",
25542 "groupTitle": "Square_Projects"
25546 "url": "/api/square/projects/{id}/users",
25547 "title": "Gets users permissions from Project",
25550 "title": "Example usage:",
25551 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
25555 "name": "getUsers",
25556 "group": "Square_Projects",
25557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25558 "version": "0.0.0",
25559 "filename": "server/api/squareProject/index.js",
25560 "groupTitle": "Square_Projects"
25564 "url": "/api/square/projects/{id}/users",
25565 "title": "Removes user permissions from a Project",
25568 "title": "Example usage:",
25569 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25573 "name": "removeUsers",
25574 "group": "Square_Projects",
25575 "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>",
25576 "version": "0.0.0",
25577 "filename": "server/api/squareProject/index.js",
25578 "groupTitle": "Square_Projects"
25582 "url": "/api/square/projects/{id}",
25583 "title": "Update an existing Project",
25586 "title": "Example usage:",
25587 "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",
25591 "name": "updateProjects",
25592 "group": "Square_Projects",
25593 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25594 "version": "0.0.0",
25595 "filename": "server/api/squareProject/index.js",
25596 "groupTitle": "Square_Projects"
25600 "url": "/api/square/recordings",
25601 "title": "Creates a new Recording",
25604 "title": "Example usage:",
25605 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25609 "name": "CreateRecordings",
25610 "group": "Square_Recordings",
25618 "field": "uniqueid",
25625 "field": "callerid",
25632 "field": "calleridname",
25639 "field": "context",
25646 "field": "extension",
25653 "field": "priority",
25660 "field": "accountcode",
25674 "field": "projectName",
25681 "field": "saveName",
25688 "field": "filename",
25695 "field": "savePath",
25708 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25709 "version": "0.0.0",
25710 "filename": "server/api/squareRecording/index.js",
25711 "groupTitle": "Square_Recordings"
25715 "url": "/api/square/recordings",
25716 "title": "Gets a list of Recordings",
25719 "title": "Example usage:",
25720 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25724 "name": "GetRecordings",
25725 "group": "Square_Recordings",
25726 "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>",
25727 "version": "0.0.0",
25728 "filename": "server/api/squareRecording/index.js",
25729 "groupTitle": "Square_Recordings"
25733 "url": "/api/square/recordings/{id}",
25734 "title": "Gets a single Recording",
25737 "title": "Example usage:",
25738 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25742 "name": "ShowRecordings",
25743 "group": "Square_Recordings",
25744 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25745 "version": "0.0.0",
25746 "filename": "server/api/squareRecording/index.js",
25747 "groupTitle": "Square_Recordings"
25751 "url": "/api/square/recordings/{id}",
25752 "title": "Delete recording",
25755 "title": "Example usage:",
25756 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25761 "group": "Square_Recordings",
25762 "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>",
25763 "version": "0.0.0",
25764 "filename": "server/api/squareRecording/index.js",
25765 "groupTitle": "Square_Recordings"
25769 "url": "/api/square/recordings/{id}/download",
25770 "title": "Download Recording",
25773 "title": "Example usage:",
25774 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25778 "name": "download",
25779 "group": "Square_Recordings",
25780 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25781 "version": "0.0.0",
25782 "filename": "server/api/squareRecording/index.js",
25783 "groupTitle": "Square_Recordings"
25787 "url": "/api/square/recordings/{id}",
25788 "title": "Update an existing Recording",
25791 "title": "Example usage:",
25792 "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",
25796 "name": "updateRecordings",
25797 "group": "Square_Recordings",
25798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25799 "version": "0.0.0",
25800 "filename": "server/api/squareRecording/index.js",
25801 "groupTitle": "Square_Recordings"
25805 "url": "/api/square/reports",
25806 "title": "Creates a new Square Report",
25809 "title": "Example usage:",
25810 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25814 "name": "CreateSquare_Reports",
25815 "group": "Square_Reports",
25823 "field": "network",
25830 "field": "network_script",
25837 "field": "request",
25844 "field": "channel",
25851 "field": "language",
25865 "field": "uniqueid",
25872 "field": "version",
25879 "field": "callerid",
25886 "field": "calleridname",
25893 "field": "callingpres",
25900 "field": "callingani2",
25907 "field": "callington",
25914 "field": "callingtns",
25935 "field": "context",
25942 "field": "extension",
25949 "field": "priority",
25956 "field": "enhanced",
25963 "field": "accountcode",
25970 "field": "threadid",
25977 "field": "project_name",
25991 "field": "leaveAt",
26004 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26005 "version": "0.0.0",
26006 "filename": "server/api/squareReport/index.js",
26007 "groupTitle": "Square_Reports"
26011 "url": "/api/square/reports/{id}",
26012 "title": "Deletes a Square Report",
26015 "title": "Example usage:",
26016 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
26020 "name": "DeleteSquare_Reports",
26021 "group": "Square_Reports",
26022 "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>",
26023 "version": "0.0.0",
26024 "filename": "server/api/squareReport/index.js",
26025 "groupTitle": "Square_Reports"
26029 "url": "/api/square/reports/describe",
26030 "title": "Gets table info about Square Reports",
26033 "title": "Example usage:",
26034 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
26038 "name": "DescribeSquare_Reports",
26039 "group": "Square_Reports",
26040 "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>",
26041 "version": "0.0.0",
26042 "filename": "server/api/squareReport/index.js",
26043 "groupTitle": "Square_Reports"
26047 "url": "/api/square/reports",
26048 "title": "Gets a list of Square Reports",
26051 "title": "Example usage:",
26052 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
26056 "name": "GetSquare_Reports",
26057 "group": "Square_Reports",
26058 "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>",
26059 "version": "0.0.0",
26060 "filename": "server/api/squareReport/index.js",
26061 "groupTitle": "Square_Reports"
26065 "url": "/api/square/reports/{id}",
26066 "title": "Gets a single Square Report",
26069 "title": "Example usage:",
26070 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
26074 "name": "ShowSquare_Reports",
26075 "group": "Square_Reports",
26076 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26077 "version": "0.0.0",
26078 "filename": "server/api/squareReport/index.js",
26079 "groupTitle": "Square_Reports"
26083 "url": "/api/square/reports/{id}",
26084 "title": "Update an existing Square Report",
26087 "title": "Example usage:",
26088 "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",
26092 "name": "updateSquare_Reports",
26093 "group": "Square_Reports",
26094 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26095 "version": "0.0.0",
26096 "filename": "server/api/squareReport/index.js",
26097 "groupTitle": "Square_Reports"
26101 "url": "/api/integrations/sugarcrm/configurations",
26102 "title": "Creates a new SugarCRM Configuration",
26105 "title": "Example usage:",
26106 "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",
26110 "name": "CreateSugarCRM_Configurations",
26111 "group": "SugarCRM_Configurations",
26126 "field": "description",
26132 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26133 "version": "0.0.0",
26134 "filename": "server/api/intSugarcrmConfiguration/index.js",
26135 "groupTitle": "SugarCRM_Configurations"
26139 "url": "/api/integrations/sugarcrm/configurations/{id}",
26140 "title": "Deletes a SugarCRM Configuration",
26143 "title": "Example usage:",
26144 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
26148 "name": "DeleteSugarCRM_Configurations",
26149 "group": "SugarCRM_Configurations",
26150 "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>",
26151 "version": "0.0.0",
26152 "filename": "server/api/intSugarcrmConfiguration/index.js",
26153 "groupTitle": "SugarCRM_Configurations"
26157 "url": "/api/integrations/sugarcrm/configurations",
26158 "title": "Gets a list of SugarCRM Configurations",
26161 "title": "Example usage:",
26162 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
26166 "name": "GetSugarCRM_Configurations",
26167 "group": "SugarCRM_Configurations",
26168 "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>",
26169 "version": "0.0.0",
26170 "filename": "server/api/intSugarcrmConfiguration/index.js",
26171 "groupTitle": "SugarCRM_Configurations"
26175 "url": "/api/integrations/sugarcrm/configurations/{id}",
26176 "title": "Gets a single SugarCRM Configuration",
26179 "title": "Example usage:",
26180 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
26184 "name": "ShowSugarCRM_Configurations",
26185 "group": "SugarCRM_Configurations",
26186 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26187 "version": "0.0.0",
26188 "filename": "server/api/intSugarcrmConfiguration/index.js",
26189 "groupTitle": "SugarCRM_Configurations"
26193 "url": "/api/integrations/sugarcrm/configurations/{id}",
26194 "title": "Update an existing SugarCRM Configuration",
26197 "title": "Example usage:",
26198 "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",
26202 "name": "updateSugarCRM_Configurations",
26203 "group": "SugarCRM_Configurations",
26204 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26205 "version": "0.0.0",
26206 "filename": "server/api/intSugarcrmConfiguration/index.js",
26207 "groupTitle": "SugarCRM_Configurations"
26211 "url": "/api/integrations/sugarcrm/accounts",
26212 "title": "Creates a new Sugarcrm Account",
26215 "title": "Example usage:",
26216 "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",
26220 "name": "CreateSugarcrm_Accounts",
26221 "group": "Sugarcrm_Accounts",
26236 "field": "description",
26243 "field": "username",
26250 "field": "password",
26257 "field": "remoteUri",
26264 "field": "serverUrl",
26270 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26271 "version": "0.0.0",
26272 "filename": "server/api/intSugarcrmAccount/index.js",
26273 "groupTitle": "Sugarcrm_Accounts"
26277 "url": "/api/integrations/sugarcrm/accounts/{id}",
26278 "title": "Deletes a Sugarcrm Account",
26281 "title": "Example usage:",
26282 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
26286 "name": "DeleteSugarcrm_Accounts",
26287 "group": "Sugarcrm_Accounts",
26288 "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>",
26289 "version": "0.0.0",
26290 "filename": "server/api/intSugarcrmAccount/index.js",
26291 "groupTitle": "Sugarcrm_Accounts"
26295 "url": "/api/integrations/sugarcrm/accounts",
26296 "title": "Gets a list of Sugarcrm Accounts",
26299 "title": "Example usage:",
26300 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
26304 "name": "GetSugarcrm_Accounts",
26305 "group": "Sugarcrm_Accounts",
26306 "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>",
26307 "version": "0.0.0",
26308 "filename": "server/api/intSugarcrmAccount/index.js",
26309 "groupTitle": "Sugarcrm_Accounts"
26313 "url": "/api/integrations/sugarcrm/accounts/{id}",
26314 "title": "Gets a single Sugarcrm Account",
26317 "title": "Example usage:",
26318 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
26322 "name": "ShowSugarcrm_Accounts",
26323 "group": "Sugarcrm_Accounts",
26324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26325 "version": "0.0.0",
26326 "filename": "server/api/intSugarcrmAccount/index.js",
26327 "groupTitle": "Sugarcrm_Accounts"
26331 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26332 "title": "Creates new configuration",
26335 "title": "Example usage:",
26336 "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",
26340 "name": "addConfiguration",
26341 "group": "Sugarcrm_Accounts",
26342 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26343 "version": "0.0.0",
26344 "filename": "server/api/intSugarcrmAccount/index.js",
26345 "groupTitle": "Sugarcrm_Accounts"
26349 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26350 "title": "Gets account configurations",
26353 "title": "Example usage:",
26354 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
26358 "name": "getConfigurations",
26359 "group": "Sugarcrm_Accounts",
26360 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26361 "version": "0.0.0",
26362 "filename": "server/api/intSugarcrmAccount/index.js",
26363 "groupTitle": "Sugarcrm_Accounts"
26367 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
26368 "title": "Gets account fields",
26371 "title": "Example usage:",
26372 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
26376 "name": "getFields",
26377 "group": "Sugarcrm_Accounts",
26378 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26379 "version": "0.0.0",
26380 "filename": "server/api/intSugarcrmAccount/index.js",
26381 "groupTitle": "Sugarcrm_Accounts"
26385 "url": "/api/integrations/sugarcrm/accounts/{id}",
26386 "title": "Update an existing Sugarcrm Account",
26389 "title": "Example usage:",
26390 "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",
26394 "name": "updateSugarcrm_Accounts",
26395 "group": "Sugarcrm_Accounts",
26396 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26397 "version": "0.0.0",
26398 "filename": "server/api/intSugarcrmAccount/index.js",
26399 "groupTitle": "Sugarcrm_Accounts"
26403 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
26404 "title": "Gets configurations descriptions",
26407 "title": "Example usage:",
26408 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
26412 "name": "getDescriptions",
26413 "group": "Sugarcrm_Configurations",
26414 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26415 "version": "0.0.0",
26416 "filename": "server/api/intSugarcrmConfiguration/index.js",
26417 "groupTitle": "Sugarcrm_Configurations"
26421 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
26422 "title": "Gets configurations fields",
26425 "title": "Example usage:",
26426 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
26430 "name": "getFields",
26431 "group": "Sugarcrm_Configurations",
26432 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26433 "version": "0.0.0",
26434 "filename": "server/api/intSugarcrmConfiguration/index.js",
26435 "groupTitle": "Sugarcrm_Configurations"
26439 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
26440 "title": "Gets configurations subjects",
26443 "title": "Example usage:",
26444 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
26448 "name": "getSubjects",
26449 "group": "Sugarcrm_Configurations",
26450 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26451 "version": "0.0.0",
26452 "filename": "server/api/intSugarcrmConfiguration/index.js",
26453 "groupTitle": "Sugarcrm_Configurations"
26457 "url": "/api/integrations/sugarcrm/fields",
26458 "title": "Creates a new Sugarcrm Field",
26461 "title": "Example usage:",
26462 "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",
26466 "name": "CreateSugarcrm_Fields",
26467 "group": "Sugarcrm_Fields",
26477 "\"customVariable\"",
26489 "field": "content",
26505 "\"customVariable\""
26508 "field": "keyType",
26515 "field": "keyContent",
26522 "field": "idField",
26529 "field": "nameField",
26536 "field": "customField",
26543 "field": "variableName",
26549 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26550 "version": "0.0.0",
26551 "filename": "server/api/intSugarcrmField/index.js",
26552 "groupTitle": "Sugarcrm_Fields"
26556 "url": "/api/integrations/sugarcrm/fields/{id}",
26557 "title": "Deletes a Sugarcrm Field",
26560 "title": "Example usage:",
26561 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
26565 "name": "DeleteSugarcrm_Fields",
26566 "group": "Sugarcrm_Fields",
26567 "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>",
26568 "version": "0.0.0",
26569 "filename": "server/api/intSugarcrmField/index.js",
26570 "groupTitle": "Sugarcrm_Fields"
26574 "url": "/api/integrations/sugarcrm/fields",
26575 "title": "Gets a list of Sugarcrm Fields",
26578 "title": "Example usage:",
26579 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
26583 "name": "GetSugarcrm_Fields",
26584 "group": "Sugarcrm_Fields",
26585 "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>",
26586 "version": "0.0.0",
26587 "filename": "server/api/intSugarcrmField/index.js",
26588 "groupTitle": "Sugarcrm_Fields"
26592 "url": "/api/integrations/sugarcrm/fields/{id}",
26593 "title": "Gets a single Sugarcrm Field",
26596 "title": "Example usage:",
26597 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26601 "name": "ShowSugarcrm_Fields",
26602 "group": "Sugarcrm_Fields",
26603 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26604 "version": "0.0.0",
26605 "filename": "server/api/intSugarcrmField/index.js",
26606 "groupTitle": "Sugarcrm_Fields"
26610 "url": "/api/integrations/sugarcrm/fields/{id}",
26611 "title": "Update an existing Sugarcrm Field",
26614 "title": "Example usage:",
26615 "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",
26619 "name": "updateSugarcrm_Fields",
26620 "group": "Sugarcrm_Fields",
26621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26622 "version": "0.0.0",
26623 "filename": "server/api/intSugarcrmField/index.js",
26624 "groupTitle": "Sugarcrm_Fields"
26628 "url": "/api/system/process",
26629 "title": "Gets system information",
26632 "title": "Example usage:",
26633 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26637 "name": "GetSystemInformation",
26638 "group": "System_Information",
26639 "description": "<p>Motion returns the system information.</p>",
26640 "version": "0.0.0",
26641 "filename": "server/api/system/index.js",
26642 "groupTitle": "System_Information"
26646 "url": "/api/system",
26647 "title": "Gets system information",
26650 "title": "Example usage:",
26651 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26655 "name": "GetSystemInformation",
26656 "group": "System_Information",
26657 "description": "<p>Motion returns the system information.</p>",
26658 "version": "0.0.0",
26659 "filename": "server/api/system/index.js",
26660 "groupTitle": "System_Information"
26664 "url": "/api/tags",
26665 "title": "Creates a new Tag",
26668 "title": "Example usage:",
26669 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26673 "name": "CreateTags",
26696 "field": "description",
26702 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26703 "version": "0.0.0",
26704 "filename": "server/api/tag/index.js",
26705 "groupTitle": "Tags"
26709 "url": "/api/tags/{id}",
26710 "title": "Deletes a Tag",
26713 "title": "Example usage:",
26714 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26718 "name": "DeleteTags",
26720 "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>",
26721 "version": "0.0.0",
26722 "filename": "server/api/tag/index.js",
26723 "groupTitle": "Tags"
26727 "url": "/api/tags",
26728 "title": "Gets a list of Tags",
26731 "title": "Example usage:",
26732 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26738 "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>",
26739 "version": "0.0.0",
26740 "filename": "server/api/tag/index.js",
26741 "groupTitle": "Tags"
26745 "url": "/api/tags/{id}",
26746 "title": "Gets a single Tag",
26749 "title": "Example usage:",
26750 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26754 "name": "ShowTags",
26756 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26757 "version": "0.0.0",
26758 "filename": "server/api/tag/index.js",
26759 "groupTitle": "Tags"
26763 "url": "/api/tags/{id}",
26764 "title": "Update an existing Tag",
26767 "title": "Example usage:",
26768 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26772 "name": "updateTags",
26774 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26775 "version": "0.0.0",
26776 "filename": "server/api/tag/index.js",
26777 "groupTitle": "Tags"
26781 "url": "/api/teams/{id}/queues",
26782 "title": "Add queues to a team",
26785 "title": "Example usage:",
26786 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26790 "name": "AddQueues",
26792 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26793 "version": "0.0.0",
26794 "filename": "server/api/team/index.js",
26795 "groupTitle": "Teams"
26799 "url": "/api/teams",
26800 "title": "Creates a new Team",
26803 "title": "Example usage:",
26804 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26808 "name": "CreateTeams",
26824 "field": "description",
26830 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26831 "version": "0.0.0",
26832 "filename": "server/api/team/index.js",
26833 "groupTitle": "Teams"
26837 "url": "/api/teams/{id}",
26838 "title": "Deletes a Team",
26841 "title": "Example usage:",
26842 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26846 "name": "DeleteTeams",
26848 "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>",
26849 "version": "0.0.0",
26850 "filename": "server/api/team/index.js",
26851 "groupTitle": "Teams"
26855 "url": "/api/teams/{id}/users",
26856 "title": "Gets agents from team",
26859 "title": "Example usage:",
26860 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26864 "name": "GetAgents",
26866 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26867 "version": "0.0.0",
26868 "filename": "server/api/team/index.js",
26869 "groupTitle": "Teams"
26873 "url": "/api/teams/{id}/queues?channel={channel}",
26874 "title": "Gets Queues list",
26877 "title": "Example usage:",
26878 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26882 "name": "GetQueues",
26884 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26885 "version": "0.0.0",
26886 "filename": "server/api/team/index.js",
26887 "groupTitle": "Teams"
26891 "url": "/api/teams",
26892 "title": "Gets a list of Teams",
26895 "title": "Example usage:",
26896 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26900 "name": "GetTeams",
26902 "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>",
26903 "version": "0.0.0",
26904 "filename": "server/api/team/index.js",
26905 "groupTitle": "Teams"
26909 "url": "/api/teams/{id}/users",
26910 "title": "Removes agents from a team",
26913 "title": "Example usage:",
26914 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26918 "name": "RemoveAgents",
26920 "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>",
26921 "version": "0.0.0",
26922 "filename": "server/api/team/index.js",
26923 "groupTitle": "Teams"
26927 "url": "/api/teams/{id}/queues",
26928 "title": "Remove queues to a team",
26931 "title": "Example usage:",
26932 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26936 "name": "RemoveQueues",
26938 "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>",
26939 "version": "0.0.0",
26940 "filename": "server/api/team/index.js",
26941 "groupTitle": "Teams"
26945 "url": "/api/mail/queues/{id}/teams",
26946 "title": "Remove teams from a queue",
26949 "title": "Example usage:",
26950 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26954 "name": "RemoveTeams",
26956 "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>",
26957 "version": "0.0.0",
26958 "filename": "server/api/mailQueue/index.js",
26959 "groupTitle": "Teams"
26963 "url": "/api/voice/Prefixes/{id}/teams",
26964 "title": "Remove teams from a voice prefix",
26967 "title": "Example usage:",
26968 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26972 "name": "RemoveTeams",
26974 "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>",
26975 "version": "0.0.0",
26976 "filename": "server/api/voicePrefix/index.js",
26977 "groupTitle": "Teams"
26981 "url": "/api/chat/queues/{id}/teams",
26982 "title": "Remove teams from a queue",
26985 "title": "Example usage:",
26986 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26990 "name": "RemoveTeams",
26992 "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>",
26993 "version": "0.0.0",
26994 "filename": "server/api/chatQueue/index.js",
26995 "groupTitle": "Teams"
26999 "url": "/api/sms/queues/{id}/teams",
27000 "title": "Remove teams from a queue",
27003 "title": "Example usage:",
27004 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27008 "name": "RemoveTeams",
27010 "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>",
27011 "version": "0.0.0",
27012 "filename": "server/api/smsQueue/index.js",
27013 "groupTitle": "Teams"
27017 "url": "/api/fax/queues/{id}/teams",
27018 "title": "Remove teams from a queue",
27021 "title": "Example usage:",
27022 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27026 "name": "RemoveTeams",
27028 "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>",
27029 "version": "0.0.0",
27030 "filename": "server/api/faxQueue/index.js",
27031 "groupTitle": "Teams"
27035 "url": "/api/openchannel/queues/{id}/teams",
27036 "title": "Remove teams from a queue",
27039 "title": "Example usage:",
27040 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27044 "name": "RemoveTeams",
27046 "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>",
27047 "version": "0.0.0",
27048 "filename": "server/api/openchannelQueue/index.js",
27049 "groupTitle": "Teams"
27053 "url": "/api/whatsapp/queues/{id}/teams",
27054 "title": "Remove teams from a queue",
27057 "title": "Example usage:",
27058 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27062 "name": "RemoveTeams",
27064 "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>",
27065 "version": "0.0.0",
27066 "filename": "server/api/whatsappQueue/index.js",
27067 "groupTitle": "Teams"
27071 "url": "/api/voice/queues/{id}/teams",
27072 "title": "Remove teams from a queue",
27075 "title": "Example usage:",
27076 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27080 "name": "RemoveTeams",
27082 "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>",
27083 "version": "0.0.0",
27084 "filename": "server/api/voiceQueue/index.js",
27085 "groupTitle": "Teams"
27089 "url": "/api/teams/{id}",
27090 "title": "Gets a single Team",
27093 "title": "Example usage:",
27094 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
27098 "name": "ShowTeams",
27100 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27101 "version": "0.0.0",
27102 "filename": "server/api/team/index.js",
27103 "groupTitle": "Teams"
27107 "url": "/api/teams/{id}/users",
27108 "title": "Adds agents to a team",
27111 "title": "Example usage:",
27112 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27116 "name": "addAgents",
27118 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27119 "version": "0.0.0",
27120 "filename": "server/api/team/index.js",
27121 "groupTitle": "Teams"
27125 "url": "/api/teams/{id}",
27126 "title": "Update an existing Team",
27129 "title": "Example usage:",
27130 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27134 "name": "updateTeams",
27136 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27137 "version": "0.0.0",
27138 "filename": "server/api/team/index.js",
27139 "groupTitle": "Teams"
27143 "url": "/api/templates",
27144 "title": "Creates a new Template",
27147 "title": "Example usage:",
27148 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27152 "name": "CreateTemplates",
27153 "group": "Templates",
27168 "field": "description",
27181 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27182 "version": "0.0.0",
27183 "filename": "server/api/template/index.js",
27184 "groupTitle": "Templates"
27188 "url": "/api/templates/{id}",
27189 "title": "Deletes a Template",
27192 "title": "Example usage:",
27193 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
27197 "name": "DeleteTemplates",
27198 "group": "Templates",
27199 "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>",
27200 "version": "0.0.0",
27201 "filename": "server/api/template/index.js",
27202 "groupTitle": "Templates"
27206 "url": "/api/templates",
27207 "title": "Gets a list of Templates",
27210 "title": "Example usage:",
27211 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
27215 "name": "GetTemplates",
27216 "group": "Templates",
27217 "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>",
27218 "version": "0.0.0",
27219 "filename": "server/api/template/index.js",
27220 "groupTitle": "Templates"
27224 "url": "/api/templates/{id}",
27225 "title": "Gets a single Template",
27228 "title": "Example usage:",
27229 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
27233 "name": "ShowTemplates",
27234 "group": "Templates",
27235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27236 "version": "0.0.0",
27237 "filename": "server/api/template/index.js",
27238 "groupTitle": "Templates"
27242 "url": "/api/templates/{id}",
27243 "title": "Update an existing Template",
27246 "title": "Example usage:",
27247 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27251 "name": "updateTemplates",
27252 "group": "Templates",
27253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27254 "version": "0.0.0",
27255 "filename": "server/api/template/index.js",
27256 "groupTitle": "Templates"
27260 "url": "/api/triggers",
27261 "title": "Creates a new Trigger",
27264 "title": "Example usage:",
27265 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27269 "name": "CreateTriggers",
27270 "group": "Triggers",
27285 "field": "channel",
27292 "field": "description",
27305 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27306 "version": "0.0.0",
27307 "filename": "server/api/trigger/index.js",
27308 "groupTitle": "Triggers"
27312 "url": "/api/triggers/{id}",
27313 "title": "Deletes a Trigger",
27316 "title": "Example usage:",
27317 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
27321 "name": "DeleteTriggers",
27322 "group": "Triggers",
27323 "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>",
27324 "version": "0.0.0",
27325 "filename": "server/api/trigger/index.js",
27326 "groupTitle": "Triggers"
27330 "url": "/api/triggers",
27331 "title": "Gets a list of Triggers",
27334 "title": "Example usage:",
27335 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
27339 "name": "GetTriggers",
27340 "group": "Triggers",
27341 "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>",
27342 "version": "0.0.0",
27343 "filename": "server/api/trigger/index.js",
27344 "groupTitle": "Triggers"
27348 "url": "/api/triggers/{id}",
27349 "title": "Gets a single Trigger",
27352 "title": "Example usage:",
27353 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
27357 "name": "ShowTriggers",
27358 "group": "Triggers",
27359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27360 "version": "0.0.0",
27361 "filename": "server/api/trigger/index.js",
27362 "groupTitle": "Triggers"
27366 "url": "/api/triggers/{id}/actions",
27367 "title": "Creates new actions",
27370 "title": "Example usage:",
27371 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27375 "name": "addAction",
27376 "group": "Triggers",
27392 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
27399 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
27406 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
27413 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
27446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27447 "version": "0.0.0",
27448 "filename": "server/api/trigger/index.js",
27449 "groupTitle": "Triggers"
27453 "url": "/api/triggers/{id}/all_conditions",
27454 "title": "Creates a new \"AND\"condition",
27457 "title": "Example usage:",
27458 "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",
27462 "name": "addAllCondition",
27463 "group": "Triggers",
27485 "field": "operator",
27498 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27499 "version": "0.0.0",
27500 "filename": "server/api/trigger/index.js",
27501 "groupTitle": "Triggers"
27505 "url": "/api/triggers/{id}/any_conditions",
27506 "title": "Creates a new \"OR\"condition",
27509 "title": "Example usage:",
27510 "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",
27514 "name": "addAnyCondition",
27515 "group": "Triggers",
27537 "field": "operator",
27550 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27551 "version": "0.0.0",
27552 "filename": "server/api/trigger/index.js",
27553 "groupTitle": "Triggers"
27557 "url": "/api/triggers/{id}/actions",
27558 "title": "Gets Trigger Actions",
27561 "title": "Example usage:",
27562 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
27566 "name": "getActions",
27567 "group": "Triggers",
27568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27569 "version": "0.0.0",
27570 "filename": "server/api/trigger/index.js",
27571 "groupTitle": "Triggers"
27575 "url": "/api/triggers/{id}/all_conditions",
27576 "title": "Gets \"AND\" Trigger Conditions",
27579 "title": "Example usage:",
27580 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
27584 "name": "getAllConditions",
27585 "group": "Triggers",
27586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27587 "version": "0.0.0",
27588 "filename": "server/api/trigger/index.js",
27589 "groupTitle": "Triggers"
27593 "url": "/api/triggers/{id}/any_conditions",
27594 "title": "Gets \"OR\" Trigger Conditions",
27597 "title": "Example usage:",
27598 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27602 "name": "getAnyConditions",
27603 "group": "Triggers",
27604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27605 "version": "0.0.0",
27606 "filename": "server/api/trigger/index.js",
27607 "groupTitle": "Triggers"
27611 "url": "/api/triggers/{id}",
27612 "title": "Update an existing Trigger",
27615 "title": "Example usage:",
27616 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27620 "name": "updateTriggers",
27621 "group": "Triggers",
27622 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27623 "version": "0.0.0",
27624 "filename": "server/api/trigger/index.js",
27625 "groupTitle": "Triggers"
27629 "url": "/api/trunks/clone",
27630 "title": "Clone an existing Trunk",
27633 "title": "Example usage:",
27634 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27638 "name": "CloneTrunks",
27640 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27641 "version": "0.0.0",
27642 "filename": "server/api/trunk/index.js",
27643 "groupTitle": "Trunks"
27647 "url": "/api/trunks",
27648 "title": "Create a new trunk",
27651 "title": "Example usage:",
27652 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27684 "field": "context",
27691 "\"ALLOWED_NOT_SCREENED\"",
27692 "\"ALLOWED_PASSED_SCREEN\"",
27693 "\"ALLOWED_FAILED_SCREEN\"",
27695 "\"PROHIB_NOT_SCREENED\"",
27696 "\"PROHIB_PASSED_SCREEN\"",
27697 "\"PROHIB_FAILED_SCREEN\"",
27701 "field": "callingpres",
27729 "field": "md5secret",
27736 "field": "remotesecret",
27743 "field": "transport",
27744 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
27757 "field": "dtmfmode",
27771 "field": "directmedia",
27782 "field": "directrtpsetup",
27789 "field": "directmediapermit",
27796 "field": "directmediadeny",
27804 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
27810 "field": "callgroup",
27817 "field": "namedcallgroup",
27824 "field": "pickupgroup",
27831 "field": "namedpickupgroup",
27838 "field": "language",
27845 "field": "tonezone",
27852 "field": "disallow",
27860 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
27870 "field": "autoframing",
27877 "field": "insecure",
27878 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27888 "field": "trustrpid",
27899 "field": "trust_id_outbound",
27911 "field": "progressinband",
27922 "field": "promiscredir",
27933 "field": "useclientcode",
27940 "field": "accountcode",
27954 "field": "callerid",
27961 "field": "amaflags",
27972 "field": "callcounter",
27979 "field": "busylevel",
27990 "field": "allowoverlap",
28001 "field": "allowsubscribe",
28012 "field": "allowtransfer",
28023 "field": "ignoresdpversion",
28030 "field": "subscribecontext",
28037 "field": "template",
28049 "field": "videosupport",
28056 "field": "maxcallbitrate",
28067 "field": "rfc2833compensate",
28074 "field": "mailbox",
28086 "field": "session_timers",
28093 "field": "session_expires",
28100 "field": "session_minse",
28111 "field": "session_refresher",
28118 "field": "t38pt_usertpsource",
28125 "field": "regexten",
28132 "field": "fromdomain",
28139 "field": "fromuser",
28157 "field": "qualify",
28164 "field": "keepalive",
28171 "field": "defaultip",
28178 "field": "defaultuser",
28185 "field": "rtptimeout",
28192 "field": "rtpholdtimeout",
28199 "field": "rtpkeepalive",
28211 "field": "sendrpid",
28218 "field": "outboundproxy",
28225 "field": "callbackextension",
28232 "field": "timert1",
28246 "field": "qualifyfreq",
28253 "field": "contactpermit",
28260 "field": "contactdeny",
28267 "field": "contactacl",
28274 "field": "unsolicited_mailbox",
28281 "field": "use_q850_reason",
28288 "field": "maxforwards",
28299 "field": "encryption",
28321 "field": "force_avp",
28332 "field": "icesupport",
28343 "field": "dtlsenable",
28356 "field": "dtlsverify",
28363 "field": "dtlsrekey",
28370 "field": "dtlscertfile",
28377 "field": "dtlsprivatekey",
28384 "field": "dtlscipher",
28391 "field": "dtlscafile",
28398 "field": "dtlscapath",
28410 "field": "dtlssetup",
28417 "field": "dtlsfingerprint",
28428 "field": "usereqphone",
28435 "field": "recordonfeature",
28442 "field": "recordofffeature",
28449 "field": "call_limit",
28460 "field": "registertrying",
28471 "field": "subscribemwi",
28478 "field": "vmexten",
28485 "field": "mohinterpret",
28492 "field": "mohsuggest",
28499 "field": "parkinglot",
28506 "field": "description",
28527 "field": "canreinvite",
28534 "field": "registry",
28541 "field": "otherFields",
28555 "field": "t38pt_udptl",
28561 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28562 "version": "0.0.0",
28563 "filename": "server/api/trunk/index.js",
28564 "groupTitle": "Trunks"
28568 "url": "/api/trunks/{id}",
28569 "title": "Deletes a trunk",
28572 "title": "Example usage:",
28573 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
28579 "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>",
28580 "version": "0.0.0",
28581 "filename": "server/api/trunk/index.js",
28582 "groupTitle": "Trunks"
28586 "url": "/api/trunks",
28587 "title": "Gets a list of Trunks",
28590 "title": "Example usage:",
28591 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28595 "name": "GetTrunks",
28597 "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>",
28598 "version": "0.0.0",
28599 "filename": "server/api/trunk/index.js",
28600 "groupTitle": "Trunks"
28604 "url": "/api/trunks/{id}",
28605 "title": "Gets a single Trunk",
28608 "title": "Example usage:",
28609 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28613 "name": "ShowTrunks",
28615 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28616 "version": "0.0.0",
28617 "filename": "server/api/trunk/index.js",
28618 "groupTitle": "Trunks"
28622 "url": "/api/trunks/{id}",
28623 "title": "Update an existing trunk",
28626 "title": "Example usage:",
28627 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28633 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28634 "version": "0.0.0",
28635 "filename": "server/api/trunk/index.js",
28636 "groupTitle": "Trunks"
28640 "url": "/api/userNotifications",
28641 "title": "Send notification to user",
28644 "title": "Example usage:",
28645 "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28650 "group": "UserNotifications",
28651 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28652 "version": "0.0.0",
28653 "filename": "server/api/userNotification/index.js",
28654 "groupTitle": "UserNotifications"
28658 "url": "/api/userProfile/resources",
28659 "title": "Creates a new User Profile Resource",
28662 "title": "Example usage:",
28663 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28667 "name": "CreateUser_Profile_Resources",
28668 "group": "User_Profile_Resources",
28683 "field": "resourceId",
28696 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28697 "version": "0.0.0",
28698 "filename": "server/api/userProfileResource/index.js",
28699 "groupTitle": "User_Profile_Resources"
28703 "url": "/api/userProfile/resources/{id}",
28704 "title": "Deletes a User Profile Resource",
28707 "title": "Example usage:",
28708 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28712 "name": "DeleteUser_Profile_Resources",
28713 "group": "User_Profile_Resources",
28714 "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>",
28715 "version": "0.0.0",
28716 "filename": "server/api/userProfileResource/index.js",
28717 "groupTitle": "User_Profile_Resources"
28721 "url": "/api/userProfile/resources/describe",
28722 "title": "Gets table info about User Profile Resources",
28725 "title": "Example usage:",
28726 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28730 "name": "DescribeUser_Profile_Resources",
28731 "group": "User_Profile_Resources",
28732 "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>",
28733 "version": "0.0.0",
28734 "filename": "server/api/userProfileResource/index.js",
28735 "groupTitle": "User_Profile_Resources"
28739 "url": "/api/userProfile/resources",
28740 "title": "Gets a list of User Profile Resources",
28743 "title": "Example usage:",
28744 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28748 "name": "GetUser_Profile_Resources",
28749 "group": "User_Profile_Resources",
28750 "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>",
28751 "version": "0.0.0",
28752 "filename": "server/api/userProfileResource/index.js",
28753 "groupTitle": "User_Profile_Resources"
28757 "url": "/api/userProfile/resources/{id}",
28758 "title": "Gets a single User Profile Resource",
28761 "title": "Example usage:",
28762 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28766 "name": "ShowUser_Profile_Resources",
28767 "group": "User_Profile_Resources",
28768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28769 "version": "0.0.0",
28770 "filename": "server/api/userProfileResource/index.js",
28771 "groupTitle": "User_Profile_Resources"
28775 "url": "/api/userProfile/resources/{id}",
28776 "title": "Update an existing User Profile Resource",
28779 "title": "Example usage:",
28780 "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",
28784 "name": "updateUser_Profile_Resources",
28785 "group": "User_Profile_Resources",
28786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28787 "version": "0.0.0",
28788 "filename": "server/api/userProfileResource/index.js",
28789 "groupTitle": "User_Profile_Resources"
28793 "url": "/api/userProfile/sections",
28794 "title": "Creates a new User Profile Section",
28797 "title": "Example usage:",
28798 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28802 "name": "CreateUser_Profile_Sections",
28803 "group": "User_Profile_Sections",
28818 "field": "category",
28825 "field": "sectionId",
28832 "field": "enabled",
28839 "field": "autoAssociation",
28846 "field": "crudPermissions",
28852 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28853 "version": "0.0.0",
28854 "filename": "server/api/userProfileSection/index.js",
28855 "groupTitle": "User_Profile_Sections"
28859 "url": "/api/userProfile/sections/{id}",
28860 "title": "Deletes a User Profile Section",
28863 "title": "Example usage:",
28864 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28868 "name": "DeleteUser_Profile_Sections",
28869 "group": "User_Profile_Sections",
28870 "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>",
28871 "version": "0.0.0",
28872 "filename": "server/api/userProfileSection/index.js",
28873 "groupTitle": "User_Profile_Sections"
28877 "url": "/api/userProfile/sections/describe",
28878 "title": "Gets table info about User Profile Sections",
28881 "title": "Example usage:",
28882 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28886 "name": "DescribeUser_Profile_Sections",
28887 "group": "User_Profile_Sections",
28888 "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>",
28889 "version": "0.0.0",
28890 "filename": "server/api/userProfileSection/index.js",
28891 "groupTitle": "User_Profile_Sections"
28895 "url": "/api/userProfile/sections",
28896 "title": "Gets a list of User Profile Sections",
28899 "title": "Example usage:",
28900 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28904 "name": "GetUser_Profile_Sections",
28905 "group": "User_Profile_Sections",
28906 "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>",
28907 "version": "0.0.0",
28908 "filename": "server/api/userProfileSection/index.js",
28909 "groupTitle": "User_Profile_Sections"
28913 "url": "/api/userProfile/sections/{id}",
28914 "title": "Gets a single User Profile Section",
28917 "title": "Example usage:",
28918 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28922 "name": "ShowUser_Profile_Sections",
28923 "group": "User_Profile_Sections",
28924 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28925 "version": "0.0.0",
28926 "filename": "server/api/userProfileSection/index.js",
28927 "groupTitle": "User_Profile_Sections"
28931 "url": "/api/userProfile/sections/{id}",
28932 "title": "Update an existing User Profile Section",
28935 "title": "Example usage:",
28936 "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",
28940 "name": "updateUser_Profile_Sections",
28941 "group": "User_Profile_Sections",
28942 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28943 "version": "0.0.0",
28944 "filename": "server/api/userProfileSection/index.js",
28945 "groupTitle": "User_Profile_Sections"
28949 "url": "/api/userProfiles/{id}/resources",
28950 "title": "Add resources' permissions to User Profile",
28953 "title": "Example usage:",
28954 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28958 "name": "AddResources",
28959 "group": "User_Profiles",
28960 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28961 "version": "0.0.0",
28962 "filename": "server/api/userProfile/index.js",
28963 "groupTitle": "User_Profiles"
28967 "url": "/api/userProfiles/{id}/sections",
28968 "title": "Add sections' permissions to User Profile",
28971 "title": "Example usage:",
28972 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28976 "name": "AddSections",
28977 "group": "User_Profiles",
28978 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28979 "version": "0.0.0",
28980 "filename": "server/api/userProfile/index.js",
28981 "groupTitle": "User_Profiles"
28985 "url": "/api/userProfiles/clone",
28986 "title": "Clone an existing User Profile",
28989 "title": "Example usage:",
28990 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28994 "name": "CloneUser_Profiles",
28995 "group": "User_Profiles",
28996 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28997 "version": "0.0.0",
28998 "filename": "server/api/userProfile/index.js",
28999 "groupTitle": "User_Profiles"
29003 "url": "/api/userProfiles",
29004 "title": "Creates a new User Profile",
29007 "title": "Example usage:",
29008 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29012 "name": "CreateUser_Profiles",
29013 "group": "User_Profiles",
29028 "field": "crudPermissions",
29035 "field": "description",
29042 "field": "privacyEnabled",
29049 "field": "downloadAttachments",
29056 "field": "downloadCallySquareRecordings",
29063 "field": "downloadContactManagerLists",
29070 "field": "downloadJscriptySessions",
29077 "field": "downloadOmnichannelInteractions",
29084 "field": "downloadScreenRecordings",
29091 "field": "downloadVoiceRecordings",
29097 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29098 "version": "0.0.0",
29099 "filename": "server/api/userProfile/index.js",
29100 "groupTitle": "User_Profiles"
29104 "url": "/api/userProfiles/{id}",
29105 "title": "Deletes a User Profile",
29108 "title": "Example usage:",
29109 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
29113 "name": "DeleteUser_Profiles",
29114 "group": "User_Profiles",
29115 "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>",
29116 "version": "0.0.0",
29117 "filename": "server/api/userProfile/index.js",
29118 "groupTitle": "User_Profiles"
29122 "url": "/api/userProfiles/describe",
29123 "title": "Gets table info about User Profiles",
29126 "title": "Example usage:",
29127 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
29131 "name": "DescribeUser_Profiles",
29132 "group": "User_Profiles",
29133 "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>",
29134 "version": "0.0.0",
29135 "filename": "server/api/userProfile/index.js",
29136 "groupTitle": "User_Profiles"
29140 "url": "/api/userProfiles/{id}/resources?section={section}",
29141 "title": "Get Resources assigned to a Section",
29144 "title": "Example usage:",
29145 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
29149 "name": "GetResources",
29150 "group": "User_Profiles",
29151 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29152 "version": "0.0.0",
29153 "filename": "server/api/userProfile/index.js",
29154 "groupTitle": "User_Profiles"
29158 "url": "/api/userProfiles/{id}/sections",
29159 "title": "Get sections associated to a User Profile",
29162 "title": "Example usage:",
29163 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
29167 "name": "GetSections",
29168 "group": "User_Profiles",
29169 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29170 "version": "0.0.0",
29171 "filename": "server/api/userProfile/index.js",
29172 "groupTitle": "User_Profiles"
29176 "url": "/api/userProfiles",
29177 "title": "Gets a list of User Profiles",
29180 "title": "Example usage:",
29181 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
29185 "name": "GetUser_Profiles",
29186 "group": "User_Profiles",
29187 "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>",
29188 "version": "0.0.0",
29189 "filename": "server/api/userProfile/index.js",
29190 "groupTitle": "User_Profiles"
29194 "url": "/api/userProfiles/{id}/resources",
29195 "title": "Removes resources' permissions from User Profile",
29198 "title": "Example usage:",
29199 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29203 "name": "RemoveResources",
29204 "group": "User_Profiles",
29205 "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>",
29206 "version": "0.0.0",
29207 "filename": "server/api/userProfile/index.js",
29208 "groupTitle": "User_Profiles"
29212 "url": "/api/userProfiles/{id}/sections",
29213 "title": "Removes sections' permissions from User Profile",
29216 "title": "Example usage:",
29217 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29221 "name": "RemoveSections",
29222 "group": "User_Profiles",
29223 "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>",
29224 "version": "0.0.0",
29225 "filename": "server/api/userProfile/index.js",
29226 "groupTitle": "User_Profiles"
29230 "url": "/api/userProfiles/{id}",
29231 "title": "Gets a single User Profile",
29234 "title": "Example usage:",
29235 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
29239 "name": "ShowUser_Profiles",
29240 "group": "User_Profiles",
29241 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29242 "version": "0.0.0",
29243 "filename": "server/api/userProfile/index.js",
29244 "groupTitle": "User_Profiles"
29248 "url": "/api/userProfiles/{id}",
29249 "title": "Update an existing User Profile",
29252 "title": "Example usage:",
29253 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29257 "name": "updateUser_Profiles",
29258 "group": "User_Profiles",
29259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29260 "version": "0.0.0",
29261 "filename": "server/api/userProfile/index.js",
29262 "groupTitle": "User_Profiles"
29266 "url": "/api/user-settings/{id}",
29267 "title": "Update an existing User Setting",
29270 "title": "Example usage:",
29271 "content": "curl https://{domain}/api/user-settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29275 "name": "updateUserSettings",
29276 "group": "User_Settings",
29277 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29278 "version": "0.0.0",
29279 "filename": "server/api/user-setting/index.js",
29280 "groupTitle": "User_Settings"
29284 "url": "/api/users/{id}/chat_interactions",
29285 "title": "Add chat interaction tabs to an agent",
29288 "title": "Example usage:",
29289 "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",
29293 "name": "AddChatInteractions",
29295 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29296 "version": "0.0.0",
29297 "filename": "server/api/user/index.js",
29298 "groupTitle": "Users"
29302 "url": "/api/users/{id}/chat_websites",
29303 "title": "Add a Chat Website to a user",
29306 "title": "Example usage:",
29307 "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",
29311 "name": "AddChatWebsites",
29313 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29314 "version": "0.0.0",
29315 "filename": "server/api/user/index.js",
29316 "groupTitle": "Users"
29320 "url": "/api/users/{id}/contacts",
29321 "title": "Add contacts to a user",
29324 "title": "Example usage:",
29325 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29329 "name": "AddContacts",
29331 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29332 "version": "0.0.0",
29333 "filename": "server/api/user/index.js",
29334 "groupTitle": "Users"
29338 "url": "/api/users/{id}/fax_accounts",
29339 "title": "Add a Fax Account to a user",
29342 "title": "Example usage:",
29343 "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",
29347 "name": "AddFaxAccounts",
29349 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29350 "version": "0.0.0",
29351 "filename": "server/api/user/index.js",
29352 "groupTitle": "Users"
29356 "url": "/api/users/{id}/fax_interactions",
29357 "title": "Add fax interaction tabs to an agent",
29360 "title": "Example usage:",
29361 "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",
29365 "name": "AddFaxInteractions",
29367 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29368 "version": "0.0.0",
29369 "filename": "server/api/user/index.js",
29370 "groupTitle": "Users"
29374 "url": "/api/users/{id}/mail_accounts",
29375 "title": "Add a Mail Account to a user",
29378 "title": "Example usage:",
29379 "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",
29383 "name": "AddMailAccounts",
29385 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29386 "version": "0.0.0",
29387 "filename": "server/api/user/index.js",
29388 "groupTitle": "Users"
29392 "url": "/api/users/{id}/mail_interactions",
29393 "title": "Add mail interaction tabs to an agent",
29396 "title": "Example usage:",
29397 "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",
29401 "name": "AddMailInteractions",
29403 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29404 "version": "0.0.0",
29405 "filename": "server/api/user/index.js",
29406 "groupTitle": "Users"
29410 "url": "/api/users/{id}/openchannel_accounts",
29411 "title": "Add a Open Channel Account to a user",
29414 "title": "Example usage:",
29415 "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",
29419 "name": "AddOpenchannelAccounts",
29421 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29422 "version": "0.0.0",
29423 "filename": "server/api/user/index.js",
29424 "groupTitle": "Users"
29428 "url": "/api/users/{id}/openchannel_interactions",
29429 "title": "Add openchannel interaction tabs to an agent",
29432 "title": "Example usage:",
29433 "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",
29437 "name": "AddOpenchannelInteractions",
29439 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29440 "version": "0.0.0",
29441 "filename": "server/api/user/index.js",
29442 "groupTitle": "Users"
29446 "url": "/api/users/{id}/queues",
29447 "title": "Add queues to an agent",
29450 "title": "Example usage:",
29451 "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",
29455 "name": "AddQueues",
29457 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29458 "version": "0.0.0",
29459 "filename": "server/api/user/index.js",
29460 "groupTitle": "Users"
29464 "url": "/api/users/{id}/sms_accounts",
29465 "title": "Add a Sms Account to a user",
29468 "title": "Example usage:",
29469 "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",
29473 "name": "AddSmsAccounts",
29475 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29476 "version": "0.0.0",
29477 "filename": "server/api/user/index.js",
29478 "groupTitle": "Users"
29482 "url": "/api/users/{id}/sms_interactions",
29483 "title": "Add sms interaction tabs to an agent",
29486 "title": "Example usage:",
29487 "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",
29491 "name": "AddSmsInteractions",
29493 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29494 "version": "0.0.0",
29495 "filename": "server/api/user/index.js",
29496 "groupTitle": "Users"
29500 "url": "/api/users/{id}/square_projects",
29501 "title": "Add a Square Project to a user",
29504 "title": "Example usage:",
29505 "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",
29509 "name": "AddSquareProjects",
29511 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29512 "version": "0.0.0",
29513 "filename": "server/api/user/index.js",
29514 "groupTitle": "Users"
29518 "url": "/api/users/{id}/teams",
29519 "title": "Add teams to an agent",
29522 "title": "Example usage:",
29523 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29527 "name": "AddTeams",
29529 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29530 "version": "0.0.0",
29531 "filename": "server/api/user/index.js",
29532 "groupTitle": "Users"
29536 "url": "/api/users/{id}/whatsapp_accounts",
29537 "title": "Add a Whatsapp Account to a user",
29540 "title": "Example usage:",
29541 "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",
29545 "name": "AddWhatsappAccounts",
29547 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29548 "version": "0.0.0",
29549 "filename": "server/api/user/index.js",
29550 "groupTitle": "Users"
29554 "url": "/api/users/{id}/whatsapp_interactions",
29555 "title": "Add Whatsapp interaction tabs to an agent",
29558 "title": "Example usage:",
29559 "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",
29563 "name": "AddWhatsappInteractions",
29565 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29566 "version": "0.0.0",
29567 "filename": "server/api/user/index.js",
29568 "groupTitle": "Users"
29572 "url": "/api/users/{id}/password",
29573 "title": "Change user password",
29576 "title": "Example usage:",
29577 "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",
29581 "name": "ChangePwd",
29583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29584 "version": "0.0.0",
29585 "filename": "server/api/user/index.js",
29586 "groupTitle": "Users"
29590 "url": "/api/users",
29591 "title": "Create a new user",
29594 "title": "Example usage:",
29595 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29601 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29602 "version": "0.0.0",
29603 "filename": "server/api/user/index.js",
29604 "groupTitle": "Users"
29608 "url": "/api/users/{id}/api_key",
29609 "title": "Create a new API access key for the user",
29612 "title": "Example usage:",
29613 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29617 "name": "CreateApiKey",
29619 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29620 "version": "0.0.0",
29621 "filename": "server/api/user/index.js",
29622 "groupTitle": "Users"
29626 "url": "/api/users/{id}",
29627 "title": "Deletes a user",
29630 "title": "Example usage:",
29631 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29637 "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>",
29638 "version": "0.0.0",
29639 "filename": "server/api/user/index.js",
29640 "groupTitle": "Users"
29644 "url": "/api/users/describe",
29645 "title": "Gets table info about Users",
29648 "title": "Example usage:",
29649 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29653 "name": "DescribeUsers",
29655 "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>",
29656 "version": "0.0.0",
29657 "filename": "server/api/user/index.js",
29658 "groupTitle": "Users"
29662 "url": "/api/users/{id}/agents",
29663 "title": "GetAgents",
29666 "title": "Example usage:",
29667 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29671 "name": "GetAgents",
29673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29674 "version": "0.0.0",
29675 "filename": "server/api/user/index.js",
29676 "groupTitle": "Users"
29680 "url": "/api/users/{id}/api_key",
29681 "title": "Get the API access key for the user",
29684 "title": "Example usage:",
29685 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29689 "name": "GetApiKey",
29691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29692 "version": "0.0.0",
29693 "filename": "server/api/user/index.js",
29694 "groupTitle": "Users"
29698 "url": "/api/users/{id}/groups",
29699 "title": "GetChatGroups",
29702 "title": "Example usage:",
29703 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29707 "name": "GetChatGroups",
29709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29710 "version": "0.0.0",
29711 "filename": "server/api/user/index.js",
29712 "groupTitle": "Users"
29716 "url": "/api/users/{id}/chat/interactions",
29717 "title": "GetChatInteractions",
29720 "title": "Example usage:",
29721 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29725 "name": "GetChatInteractions",
29727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29728 "version": "0.0.0",
29729 "filename": "server/api/user/index.js",
29730 "groupTitle": "Users"
29734 "url": "/api/users/{id}/chat_websites",
29735 "title": "GetChatWebsites",
29738 "title": "Example usage:",
29739 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29743 "name": "GetChatWebsites",
29745 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29746 "version": "0.0.0",
29747 "filename": "server/api/user/index.js",
29748 "groupTitle": "Users"
29752 "url": "/api/users/{id}/contacts",
29753 "title": "GetContacts",
29756 "title": "Example usage:",
29757 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29761 "name": "GetContacts",
29763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29764 "version": "0.0.0",
29765 "filename": "server/api/user/index.js",
29766 "groupTitle": "Users"
29770 "url": "/api/users/{id}/fax_accounts",
29771 "title": "GetFaxAccounts",
29774 "title": "Example usage:",
29775 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29779 "name": "GetFaxAccounts",
29781 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29782 "version": "0.0.0",
29783 "filename": "server/api/user/index.js",
29784 "groupTitle": "Users"
29788 "url": "/api/users/{id}/fax/interactions",
29789 "title": "GetFaxInteractions",
29792 "title": "Example usage:",
29793 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29797 "name": "GetFaxInteractions",
29799 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29800 "version": "0.0.0",
29801 "filename": "server/api/user/index.js",
29802 "groupTitle": "Users"
29806 "url": "/api/users/{id}/lists",
29807 "title": "GetLists",
29810 "title": "Example usage:",
29811 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29815 "name": "GetLists",
29817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29818 "version": "0.0.0",
29819 "filename": "server/api/user/index.js",
29820 "groupTitle": "Users"
29824 "url": "/api/users/{id}/mail_accounts",
29825 "title": "GetMailAccounts",
29828 "title": "Example usage:",
29829 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29833 "name": "GetMailAccounts",
29835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29836 "version": "0.0.0",
29837 "filename": "server/api/user/index.js",
29838 "groupTitle": "Users"
29842 "url": "/api/users/{id}/mail/interactions",
29843 "title": "GetMailInteractions",
29846 "title": "Example usage:",
29847 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29851 "name": "GetMailInteractions",
29853 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29854 "version": "0.0.0",
29855 "filename": "server/api/user/index.js",
29856 "groupTitle": "Users"
29860 "url": "/api/users/{id}/openchannel_accounts",
29861 "title": "GetOpenchannelAccounts",
29864 "title": "Example usage:",
29865 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29869 "name": "GetOpenchannelAccounts",
29871 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29872 "version": "0.0.0",
29873 "filename": "server/api/user/index.js",
29874 "groupTitle": "Users"
29878 "url": "/api/users/{id}/openchannel/interactions",
29879 "title": "GetOpenchannelInteractions",
29882 "title": "Example usage:",
29883 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29887 "name": "GetOpenchannelInteractions",
29889 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29890 "version": "0.0.0",
29891 "filename": "server/api/user/index.js",
29892 "groupTitle": "Users"
29896 "url": "/api/users/{id}/prefixes",
29897 "title": "GetPrefixes",
29900 "title": "Example usage:",
29901 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29905 "name": "GetPrefixes",
29907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29908 "version": "0.0.0",
29909 "filename": "server/api/user/index.js",
29910 "groupTitle": "Users"
29914 "url": "/api/users/{id}/queues?channel={channel}",
29915 "title": "Gets Queues list",
29918 "title": "Example usage:",
29919 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29923 "name": "GetQueues",
29925 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29926 "version": "0.0.0",
29927 "filename": "server/api/user/index.js",
29928 "groupTitle": "Users"
29932 "url": "/api/users/{id}/recordings",
29933 "title": "GetRecordings",
29936 "title": "Example usage:",
29937 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29941 "name": "GetRecordings",
29943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29944 "version": "0.0.0",
29945 "filename": "server/api/user/index.js",
29946 "groupTitle": "Users"
29950 "url": "/api/users/{id}/scheduled_calls",
29951 "title": "GetScheduledCalls",
29954 "title": "Example usage:",
29955 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29959 "name": "GetScheduledCalls",
29961 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29962 "version": "0.0.0",
29963 "filename": "server/api/user/index.js",
29964 "groupTitle": "Users"
29968 "url": "/api/users/{id}/screen_recordings",
29969 "title": "GetScreenRecordings",
29972 "title": "Example usage:",
29973 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29977 "name": "GetScreenRecordings",
29979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29980 "version": "0.0.0",
29981 "filename": "server/api/user/index.js",
29982 "groupTitle": "Users"
29986 "url": "/api/users/{id}/sms_accounts",
29987 "title": "GetSmsAccounts",
29990 "title": "Example usage:",
29991 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29995 "name": "GetSmsAccounts",
29997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29998 "version": "0.0.0",
29999 "filename": "server/api/user/index.js",
30000 "groupTitle": "Users"
30004 "url": "/api/users/{id}/sms/interactions",
30005 "title": "GetSmsInteractions",
30008 "title": "Example usage:",
30009 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
30013 "name": "GetSmsInteractions",
30015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30016 "version": "0.0.0",
30017 "filename": "server/api/user/index.js",
30018 "groupTitle": "Users"
30022 "url": "/api/users/{id}/square_projects",
30023 "title": "GetSquareProjects",
30026 "title": "Example usage:",
30027 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
30031 "name": "GetSquareProjects",
30033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30034 "version": "0.0.0",
30035 "filename": "server/api/user/index.js",
30036 "groupTitle": "Users"
30040 "url": "/api/users/{id}/teams",
30041 "title": "GetTeams",
30044 "title": "Example usage:",
30045 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
30049 "name": "GetTeams",
30051 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30052 "version": "0.0.0",
30053 "filename": "server/api/user/index.js",
30054 "groupTitle": "Users"
30058 "url": "/api/users",
30059 "title": "Gets a list of Users",
30062 "title": "Example usage:",
30063 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
30067 "name": "GetUsers",
30069 "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>",
30070 "version": "0.0.0",
30071 "filename": "server/api/user/index.js",
30072 "groupTitle": "Users"
30076 "url": "/api/users/{id}/queues_rt",
30077 "title": "GetVoiceQueuesRt",
30080 "title": "Example usage:",
30081 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
30085 "name": "GetVoiceQueuesRt",
30087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30088 "version": "0.0.0",
30089 "filename": "server/api/user/index.js",
30090 "groupTitle": "Users"
30094 "url": "/api/users/{id}/whatsapp_accounts",
30095 "title": "GetWhatsappAccounts",
30098 "title": "Example usage:",
30099 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
30103 "name": "GetWhatsappAccounts",
30105 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30106 "version": "0.0.0",
30107 "filename": "server/api/user/index.js",
30108 "groupTitle": "Users"
30112 "url": "/api/users/{id}/whatsapp/interactions",
30113 "title": "GetWhatsappInteractions",
30116 "title": "Example usage:",
30117 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
30121 "name": "GetWhatsappInteractions",
30123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30124 "version": "0.0.0",
30125 "filename": "server/api/user/index.js",
30126 "groupTitle": "Users"
30130 "url": "/api/users/{id}/login",
30134 "title": "Example usage:",
30135 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
30141 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30142 "version": "0.0.0",
30143 "filename": "server/api/user/index.js",
30144 "groupTitle": "Users"
30148 "url": "/api/users/{id}/logout",
30152 "title": "Example usage:",
30153 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
30159 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30160 "version": "0.0.0",
30161 "filename": "server/api/user/index.js",
30162 "groupTitle": "Users"
30166 "url": "/api/users/{id}/pause",
30170 "title": "Example usage:",
30171 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
30177 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30178 "version": "0.0.0",
30179 "filename": "server/api/user/index.js",
30180 "groupTitle": "Users"
30184 "url": "/api/users/{id}/api_key",
30185 "title": "Remove API access key for the user",
30188 "title": "Example usage:",
30189 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
30193 "name": "RemoveApiKey",
30195 "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>",
30196 "version": "0.0.0",
30197 "filename": "server/api/user/index.js",
30198 "groupTitle": "Users"
30202 "url": "/api/users/{id}/chat_interactions",
30203 "title": "Removes interactions from an agent",
30206 "title": "Example usage:",
30207 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30211 "name": "RemoveChatInteractions",
30213 "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>",
30214 "version": "0.0.0",
30215 "filename": "server/api/user/index.js",
30216 "groupTitle": "Users"
30220 "url": "/api/users/{id}/chat_websites",
30221 "title": "Removes a Chat Website from a user",
30224 "title": "Example usage:",
30225 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30229 "name": "RemoveChatWebsites",
30231 "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>",
30232 "version": "0.0.0",
30233 "filename": "server/api/user/index.js",
30234 "groupTitle": "Users"
30238 "url": "/api/users/{id}/fax_accounts",
30239 "title": "Removes a Fax Account from a user",
30242 "title": "Example usage:",
30243 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30247 "name": "RemoveFaxAccounts",
30249 "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>",
30250 "version": "0.0.0",
30251 "filename": "server/api/user/index.js",
30252 "groupTitle": "Users"
30256 "url": "/api/users/{id}/fax_interactions",
30257 "title": "Removes interactions from an agent",
30260 "title": "Example usage:",
30261 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30265 "name": "RemoveFaxInteractions",
30267 "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>",
30268 "version": "0.0.0",
30269 "filename": "server/api/user/index.js",
30270 "groupTitle": "Users"
30274 "url": "/api/users/{id}/mail_accounts",
30275 "title": "Removes a Mail Account from a user",
30278 "title": "Example usage:",
30279 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30283 "name": "RemoveMailAccounts",
30285 "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>",
30286 "version": "0.0.0",
30287 "filename": "server/api/user/index.js",
30288 "groupTitle": "Users"
30292 "url": "/api/users/{id}/mail_interactions",
30293 "title": "Removes interactions from an agent",
30296 "title": "Example usage:",
30297 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30301 "name": "RemoveMailInteractions",
30303 "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>",
30304 "version": "0.0.0",
30305 "filename": "server/api/user/index.js",
30306 "groupTitle": "Users"
30310 "url": "/api/users/{id}/openchannel_accounts",
30311 "title": "Removes a Open Channel Account from a user",
30314 "title": "Example usage:",
30315 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30319 "name": "RemoveOpenchannelAccounts",
30321 "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>",
30322 "version": "0.0.0",
30323 "filename": "server/api/user/index.js",
30324 "groupTitle": "Users"
30328 "url": "/api/users/{id}/openchannel_interactions",
30329 "title": "Removes openchannel interactions from an agent",
30332 "title": "Example usage:",
30333 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30337 "name": "RemoveOpenchannelInteractions",
30339 "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>",
30340 "version": "0.0.0",
30341 "filename": "server/api/user/index.js",
30342 "groupTitle": "Users"
30346 "url": "/api/users/{id}/queues",
30347 "title": "Remove queues to an agent",
30350 "title": "Example usage:",
30351 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30355 "name": "RemoveQueues",
30357 "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>",
30358 "version": "0.0.0",
30359 "filename": "server/api/user/index.js",
30360 "groupTitle": "Users"
30364 "url": "/api/users/{id}/sms_accounts",
30365 "title": "Removes a Sms Account from a user",
30368 "title": "Example usage:",
30369 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30373 "name": "RemoveSmsAccounts",
30375 "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>",
30376 "version": "0.0.0",
30377 "filename": "server/api/user/index.js",
30378 "groupTitle": "Users"
30382 "url": "/api/users/{id}/sms_interactions",
30383 "title": "Removes interactions from an agent",
30386 "title": "Example usage:",
30387 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30391 "name": "RemoveSmsInteractions",
30393 "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>",
30394 "version": "0.0.0",
30395 "filename": "server/api/user/index.js",
30396 "groupTitle": "Users"
30400 "url": "/api/users/{id}/square_projects",
30401 "title": "Removes a Square Project from a user",
30404 "title": "Example usage:",
30405 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30409 "name": "RemoveSquareProjects",
30411 "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>",
30412 "version": "0.0.0",
30413 "filename": "server/api/user/index.js",
30414 "groupTitle": "Users"
30418 "url": "/api/users/{id}/teams",
30419 "title": "Removes teams from an agent",
30422 "title": "Example usage:",
30423 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30427 "name": "RemoveTeams",
30429 "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>",
30430 "version": "0.0.0",
30431 "filename": "server/api/user/index.js",
30432 "groupTitle": "Users"
30436 "url": "/api/users/{id}/whatsapp_accounts",
30437 "title": "Removes a Whatsapp Account from a user",
30440 "title": "Example usage:",
30441 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30445 "name": "RemoveWhatsappAccounts",
30447 "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>",
30448 "version": "0.0.0",
30449 "filename": "server/api/user/index.js",
30450 "groupTitle": "Users"
30454 "url": "/api/users/{id}/whatsapp_interactions",
30455 "title": "Removes Whatsapp interactions from an agent",
30458 "title": "Example usage:",
30459 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30463 "name": "RemoveWhatsappInteractions",
30465 "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>",
30466 "version": "0.0.0",
30467 "filename": "server/api/user/index.js",
30468 "groupTitle": "Users"
30472 "url": "/api/users/{id}",
30473 "title": "Gets a single User",
30476 "title": "Example usage:",
30477 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30481 "name": "ShowUsers",
30483 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30484 "version": "0.0.0",
30485 "filename": "server/api/user/index.js",
30486 "groupTitle": "Users"
30490 "url": "/api/users/{id}/unpause",
30491 "title": "Unpause",
30494 "title": "Example usage:",
30495 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30501 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30502 "version": "0.0.0",
30503 "filename": "server/api/user/index.js",
30504 "groupTitle": "Users"
30508 "url": "/api/users/whoami",
30512 "title": "Example usage:",
30513 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30519 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30520 "version": "0.0.0",
30521 "filename": "server/api/user/index.js",
30522 "groupTitle": "Users"
30526 "url": "/api/users/{id}/avatar",
30527 "title": "Add avatar",
30530 "title": "Example usage:",
30531 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30535 "name": "addAvatar",
30537 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30538 "version": "0.0.0",
30539 "filename": "server/api/user/index.js",
30540 "groupTitle": "Users"
30544 "url": "/api/users/create_many",
30545 "title": "Create Users",
30548 "title": "Example usage:",
30549 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
30553 "name": "bulkCreate",
30555 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30556 "version": "0.0.0",
30557 "filename": "server/api/user/index.js",
30558 "groupTitle": "Users"
30562 "url": "/api/users/{id}/avatar",
30563 "title": "Get avatar",
30566 "title": "Example usage:",
30567 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30571 "name": "getAvatar",
30573 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30574 "version": "0.0.0",
30575 "filename": "server/api/user/index.js",
30576 "groupTitle": "Users"
30580 "url": "/api/users/{id}/open_tabs",
30581 "title": "Get interactions opened tabs",
30584 "title": "Example usage:",
30585 "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
30589 "name": "getOpenTabs",
30591 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30592 "version": "0.0.0",
30593 "filename": "server/api/user/index.js",
30594 "groupTitle": "Users"
30598 "url": "/api/users/presence",
30599 "title": "Gets agent presence",
30602 "title": "Example usage:",
30603 "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
30607 "name": "getPresence",
30609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30610 "version": "0.0.0",
30611 "filename": "server/api/user/index.js",
30612 "groupTitle": "Users"
30616 "url": "/api/users/{id}",
30617 "title": "Update an existing User",
30620 "title": "Example usage:",
30621 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30625 "name": "updateUsers",
30627 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30628 "version": "0.0.0",
30629 "filename": "server/api/user/index.js",
30630 "groupTitle": "Users"
30634 "url": "/api/variables",
30635 "title": "Creates a new Variable",
30638 "title": "Example usage:",
30639 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30643 "name": "CreateVariables",
30644 "group": "Variables",
30659 "field": "description",
30665 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30666 "version": "0.0.0",
30667 "filename": "server/api/variable/index.js",
30668 "groupTitle": "Variables"
30672 "url": "/api/variables/{id}",
30673 "title": "Deletes a Variable",
30676 "title": "Example usage:",
30677 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30681 "name": "DeleteVariables",
30682 "group": "Variables",
30683 "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>",
30684 "version": "0.0.0",
30685 "filename": "server/api/variable/index.js",
30686 "groupTitle": "Variables"
30690 "url": "/api/variables",
30691 "title": "Gets a list of Variables",
30694 "title": "Example usage:",
30695 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30699 "name": "GetVariables",
30700 "group": "Variables",
30701 "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>",
30702 "version": "0.0.0",
30703 "filename": "server/api/variable/index.js",
30704 "groupTitle": "Variables"
30708 "url": "/api/variables/{id}",
30709 "title": "Gets a single Variable",
30712 "title": "Example usage:",
30713 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30717 "name": "ShowVariables",
30718 "group": "Variables",
30719 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30720 "version": "0.0.0",
30721 "filename": "server/api/variable/index.js",
30722 "groupTitle": "Variables"
30726 "url": "/api/variables/{id}",
30727 "title": "Update an existing Variable",
30730 "title": "Example usage:",
30731 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30735 "name": "updateVariables",
30736 "group": "Variables",
30737 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30738 "version": "0.0.0",
30739 "filename": "server/api/variable/index.js",
30740 "groupTitle": "Variables"
30744 "url": "/api/version/fetch",
30745 "title": "Fetch git version",
30748 "title": "Example usage:",
30749 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30753 "name": "FetchVersion",
30754 "group": "Version",
30755 "description": "<p>Motion run the following command: git fetch origin master</p>",
30756 "version": "0.0.0",
30757 "filename": "server/api/version/index.js",
30758 "groupTitle": "Version"
30762 "url": "/api/version",
30763 "title": "Gets version",
30766 "title": "Example usage:",
30767 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30771 "name": "GetVersion",
30772 "group": "Version",
30773 "description": "<p>Motion returns the current and latest motion version.</p>",
30774 "version": "0.0.0",
30775 "filename": "server/api/version/index.js",
30776 "groupTitle": "Version"
30780 "url": "/api/version/migrations",
30781 "title": "Launch database migrations",
30784 "title": "Example usage:",
30785 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30789 "name": "MigrateVersion",
30790 "group": "Version",
30791 "description": "<p>Motion launch the database migrations, according to the application version</p>",
30792 "version": "0.0.0",
30793 "filename": "server/api/version/index.js",
30794 "groupTitle": "Version"
30798 "url": "/api/version/pull",
30799 "title": "Pull git version",
30802 "title": "Example usage:",
30803 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30807 "name": "PullVersion",
30808 "group": "Version",
30809 "description": "<p>Motion run the following command: git pull</p>",
30810 "version": "0.0.0",
30811 "filename": "server/api/version/index.js",
30812 "groupTitle": "Version"
30816 "url": "/api/version/reset",
30817 "title": "Reset git version",
30820 "title": "Example usage:",
30821 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30825 "name": "ResetVersion",
30826 "group": "Version",
30827 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30828 "version": "0.0.0",
30829 "filename": "server/api/version/index.js",
30830 "groupTitle": "Version"
30834 "url": "/api/version/restart",
30835 "title": "Restart motion2 after update",
30838 "title": "Example usage:",
30839 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30843 "name": "RestartVersion",
30844 "group": "Version",
30845 "description": "<p>Motion run the following command: pm2 restart motion</p>",
30846 "version": "0.0.0",
30847 "filename": "server/api/version/index.js",
30848 "groupTitle": "Version"
30852 "url": "/api/voice/agents/reports/describe",
30853 "title": "Gets table info about Agent Reports",
30856 "title": "Example usage:",
30857 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30861 "name": "DescribeAgent_Reports",
30862 "group": "Voice_Agent_Reports",
30863 "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>",
30864 "version": "0.0.0",
30865 "filename": "server/api/voiceAgentReport/index.js",
30866 "groupTitle": "Voice_Agent_Reports"
30870 "url": "/api/voice/agents/reports",
30871 "title": "Gets a list of Agent Reports",
30874 "title": "Example usage:",
30875 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30879 "name": "GetAgent_Reports",
30880 "group": "Voice_Agent_Reports",
30881 "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>",
30882 "version": "0.0.0",
30883 "filename": "server/api/voiceAgentReport/index.js",
30884 "groupTitle": "Voice_Agent_Reports"
30888 "url": "/api/voice/agents/reports/{id}",
30889 "title": "Gets a single Agent Report",
30892 "title": "Example usage:",
30893 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30897 "name": "ShowAgent_Reports",
30898 "group": "Voice_Agent_Reports",
30899 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30900 "version": "0.0.0",
30901 "filename": "server/api/voiceAgentReport/index.js",
30902 "groupTitle": "Voice_Agent_Reports"
30906 "url": "/api/voice/calls/reports/describe",
30907 "title": "Gets table info about Call Reports",
30910 "title": "Example usage:",
30911 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30915 "name": "DescribeCall_Reports",
30916 "group": "Voice_Call_Reports",
30917 "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>",
30918 "version": "0.0.0",
30919 "filename": "server/api/voiceCallReport/index.js",
30920 "groupTitle": "Voice_Call_Reports"
30924 "url": "/api/voice/calls/reports",
30925 "title": "Gets a list of Call Reports",
30928 "title": "Example usage:",
30929 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30933 "name": "GetCall_Reports",
30934 "group": "Voice_Call_Reports",
30935 "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>",
30936 "version": "0.0.0",
30937 "filename": "server/api/voiceCallReport/index.js",
30938 "groupTitle": "Voice_Call_Reports"
30942 "url": "/api/voice/calls/reports/{id}",
30943 "title": "Gets a single Call Report",
30946 "title": "Example usage:",
30947 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30951 "name": "ShowCall_Reports",
30952 "group": "Voice_Call_Reports",
30953 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30954 "version": "0.0.0",
30955 "filename": "server/api/voiceCallReport/index.js",
30956 "groupTitle": "Voice_Call_Reports"
30960 "url": "/api/voice/calls/reports/{id}",
30961 "title": "Update a single cdr",
30964 "title": "Example usage:",
30965 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30970 "group": "Voice_Call_Reports",
30971 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30972 "version": "0.0.0",
30973 "filename": "server/api/voiceCallReport/index.js",
30974 "groupTitle": "Voice_Call_Reports"
30978 "url": "/api/voice/chanspy",
30979 "title": "Creates a new ChanSpy",
30982 "title": "Example usage:",
30983 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30987 "name": "CreateChanSpy",
30988 "group": "Voice_ChanSpy",
31010 "field": "options",
31024 "field": "password",
31038 "field": "recordingFormat",
31045 "field": "description",
31051 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31052 "version": "0.0.0",
31053 "filename": "server/api/voiceChanSpy/index.js",
31054 "groupTitle": "Voice_ChanSpy"
31058 "url": "/api/voice/chanspy/{id}",
31059 "title": "Deletes a ChanSpy",
31062 "title": "Example usage:",
31063 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
31067 "name": "DeleteChanSpy",
31068 "group": "Voice_ChanSpy",
31069 "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>",
31070 "version": "0.0.0",
31071 "filename": "server/api/voiceChanSpy/index.js",
31072 "groupTitle": "Voice_ChanSpy"
31076 "url": "/api/voice/chanspy",
31077 "title": "Gets a list of ChanSpy",
31080 "title": "Example usage:",
31081 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
31085 "name": "GetChanSpy",
31086 "group": "Voice_ChanSpy",
31087 "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>",
31088 "version": "0.0.0",
31089 "filename": "server/api/voiceChanSpy/index.js",
31090 "groupTitle": "Voice_ChanSpy"
31094 "url": "/api/voice/chanspy/{id}",
31095 "title": "Gets a single ChanSpy",
31098 "title": "Example usage:",
31099 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
31103 "name": "ShowChanSpy",
31104 "group": "Voice_ChanSpy",
31105 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31106 "version": "0.0.0",
31107 "filename": "server/api/voiceChanSpy/index.js",
31108 "groupTitle": "Voice_ChanSpy"
31112 "url": "/api/voice/chanspy/{id}",
31113 "title": "Update an existing ChanSpy",
31116 "title": "Example usage:",
31117 "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",
31121 "name": "updateChanSpy",
31122 "group": "Voice_ChanSpy",
31123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31124 "version": "0.0.0",
31125 "filename": "server/api/voiceChanSpy/index.js",
31126 "groupTitle": "Voice_ChanSpy"
31130 "url": "/api/voice/contexts",
31131 "title": "Create a new context",
31134 "title": "Example usage:",
31135 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
31140 "group": "Voice_Contexts",
31155 "field": "description",
31162 "field": "defaultEntry",
31168 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31169 "version": "0.0.0",
31170 "filename": "server/api/voiceContext/index.js",
31171 "groupTitle": "Voice_Contexts"
31175 "url": "/api/voice/contexts/{id}",
31176 "title": "Deletes a context",
31179 "title": "Example usage:",
31180 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
31185 "group": "Voice_Contexts",
31186 "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>",
31187 "version": "0.0.0",
31188 "filename": "server/api/voiceContext/index.js",
31189 "groupTitle": "Voice_Contexts"
31193 "url": "/api/voice/contexts",
31194 "title": "Gets a list of Contexts",
31197 "title": "Example usage:",
31198 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
31202 "name": "GetContexts",
31203 "group": "Voice_Contexts",
31204 "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>",
31205 "version": "0.0.0",
31206 "filename": "server/api/voiceContext/index.js",
31207 "groupTitle": "Voice_Contexts"
31211 "url": "/api/voice/contexts/{id}",
31212 "title": "Gets a single Context",
31215 "title": "Example usage:",
31216 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
31220 "name": "ShowContexts",
31221 "group": "Voice_Contexts",
31222 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31223 "version": "0.0.0",
31224 "filename": "server/api/voiceContext/index.js",
31225 "groupTitle": "Voice_Contexts"
31229 "url": "/api/voice/contexts/{id}",
31230 "title": "Update an existing context",
31233 "title": "Example usage:",
31234 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
31239 "group": "Voice_Contexts",
31240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31241 "version": "0.0.0",
31242 "filename": "server/api/voiceContext/index.js",
31243 "groupTitle": "Voice_Contexts"
31247 "url": "/api/voice/dials/reports/describe",
31248 "title": "Gets table info about Dial Reports",
31251 "title": "Example usage:",
31252 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
31256 "name": "DescribeDial_Reports",
31257 "group": "Voice_Dial_Reports",
31258 "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>",
31259 "version": "0.0.0",
31260 "filename": "server/api/voiceDialReport/index.js",
31261 "groupTitle": "Voice_Dial_Reports"
31265 "url": "/api/voice/dials/reports",
31266 "title": "Gets a list of Dial Reports",
31269 "title": "Example usage:",
31270 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
31274 "name": "GetDial_Reports",
31275 "group": "Voice_Dial_Reports",
31276 "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>",
31277 "version": "0.0.0",
31278 "filename": "server/api/voiceDialReport/index.js",
31279 "groupTitle": "Voice_Dial_Reports"
31283 "url": "/api/voice/dials/reports/{id}",
31284 "title": "Gets a single Dial Report",
31287 "title": "Example usage:",
31288 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
31292 "name": "ShowDial_Reports",
31293 "group": "Voice_Dial_Reports",
31294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31295 "version": "0.0.0",
31296 "filename": "server/api/voiceDialReport/index.js",
31297 "groupTitle": "Voice_Dial_Reports"
31301 "url": "/api/voice/extensions/{id}",
31302 "title": "Deletes a Extension",
31305 "title": "Example usage:",
31306 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
31310 "name": "DeleteExtensions",
31311 "group": "Voice_Extensions",
31312 "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>",
31313 "version": "0.0.0",
31314 "filename": "server/api/voiceExtension/index.js",
31315 "groupTitle": "Voice_Extensions"
31319 "url": "/api/voice/extensions",
31320 "title": "Gets a list of Extensions",
31323 "title": "Example usage:",
31324 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
31328 "name": "GetExtensions",
31329 "group": "Voice_Extensions",
31330 "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>",
31331 "version": "0.0.0",
31332 "filename": "server/api/voiceExtension/index.js",
31333 "groupTitle": "Voice_Extensions"
31337 "url": "/api/voice/extensions/{id}",
31338 "title": "Gets a single Extension",
31341 "title": "Example usage:",
31342 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
31346 "name": "ShowExtensions",
31347 "group": "Voice_Extensions",
31348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31349 "version": "0.0.0",
31350 "filename": "server/api/voiceExtension/index.js",
31351 "groupTitle": "Voice_Extensions"
31355 "url": "/api/voice/extensions",
31356 "title": "Create new applications",
31359 "title": "Example usage:",
31360 "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",
31364 "name": "addApplications",
31365 "group": "Voice_Extensions",
31366 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31367 "version": "0.0.0",
31368 "filename": "server/api/voiceExtension/index.js",
31369 "groupTitle": "Voice_Extensions"
31373 "url": "/api/voice/extensions",
31374 "title": "Create an extension",
31377 "title": "Example usage:",
31378 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31383 "group": "Voice_Extensions",
31384 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31385 "version": "0.0.0",
31386 "filename": "server/api/voiceExtension/index.js",
31387 "groupTitle": "Voice_Extensions"
31391 "url": "/api/voice/extensions/{id}",
31392 "title": "Update an extension",
31395 "title": "Example usage:",
31396 "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",
31401 "group": "Voice_Extensions",
31402 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31403 "version": "0.0.0",
31404 "filename": "server/api/voiceExtension/index.js",
31405 "groupTitle": "Voice_Extensions"
31409 "url": "/api/voice/mohs",
31410 "title": "Create a new a new MOH",
31413 "title": "Example usage:",
31414 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31419 "group": "Voice_MOHs",
31420 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31421 "version": "0.0.0",
31422 "filename": "server/api/voiceMusicOnHold/index.js",
31423 "groupTitle": "Voice_MOHs"
31427 "url": "/api/voice/mohs/{id}/sounds",
31428 "title": "Add sound to MOH",
31431 "title": "Example usage:",
31432 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31436 "name": "AddSound",
31437 "group": "Voice_MOHs",
31438 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31439 "version": "0.0.0",
31440 "filename": "server/api/voiceMusicOnHold/index.js",
31441 "groupTitle": "Voice_MOHs"
31445 "url": "/api/voice/mohs/{id}",
31446 "title": "Deletes an MOH",
31449 "title": "Example usage:",
31450 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31454 "name": "DestroyMoh",
31455 "group": "Voice_MOHs",
31456 "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>",
31457 "version": "0.0.0",
31458 "filename": "server/api/voiceMusicOnHold/index.js",
31459 "groupTitle": "Voice_MOHs"
31463 "url": "/api/voice/mohs",
31464 "title": "Gets a list of Music On Holds",
31467 "title": "Example usage:",
31468 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31472 "name": "GetMusic_On_Holds",
31473 "group": "Voice_MOHs",
31474 "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>",
31475 "version": "0.0.0",
31476 "filename": "server/api/voiceMusicOnHold/index.js",
31477 "groupTitle": "Voice_MOHs"
31481 "url": "/api/voice/mohs/{id}/sounds",
31482 "title": "Gets sounds from MOH",
31485 "title": "Example usage:",
31486 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31490 "name": "GetSounds",
31491 "group": "Voice_MOHs",
31492 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31493 "version": "0.0.0",
31494 "filename": "server/api/voiceMusicOnHold/index.js",
31495 "groupTitle": "Voice_MOHs"
31499 "url": "/api/voice/mohs/{id}/sounds/{id2}",
31500 "title": "Remove sound from MOH",
31503 "title": "Example usage:",
31504 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31508 "name": "RemoveSound",
31509 "group": "Voice_MOHs",
31510 "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>",
31511 "version": "0.0.0",
31512 "filename": "server/api/voiceMusicOnHold/index.js",
31513 "groupTitle": "Voice_MOHs"
31517 "url": "/api/voice/mohs/{id}",
31518 "title": "Gets a single Music On Hold",
31521 "title": "Example usage:",
31522 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31526 "name": "ShowMusic_On_Holds",
31527 "group": "Voice_MOHs",
31528 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31529 "version": "0.0.0",
31530 "filename": "server/api/voiceMusicOnHold/index.js",
31531 "groupTitle": "Voice_MOHs"
31535 "url": "/api/voice/mohs/{id}",
31536 "title": "Update an existing Music On Hold",
31539 "title": "Example usage:",
31540 "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",
31544 "name": "updateMusic_On_Holds",
31545 "group": "Voice_MOHs",
31546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31547 "version": "0.0.0",
31548 "filename": "server/api/voiceMusicOnHold/index.js",
31549 "groupTitle": "Voice_MOHs"
31553 "url": "/api/voice/mails",
31554 "title": "Creates a new Mail",
31557 "title": "Example usage:",
31558 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31562 "name": "CreateMails",
31563 "group": "Voice_Mails",
31571 "field": "customer_id",
31578 "field": "context",
31585 "field": "mailbox",
31592 "field": "password",
31599 "field": "fullname",
31649 "field": "dialout",
31656 "field": "callback",
31678 "field": "operator",
31689 "field": "envelope",
31700 "field": "sayduration",
31707 "field": "saydurationm",
31718 "field": "sendvoicemail",
31740 "field": "nextaftercmd",
31751 "field": "forcename",
31762 "field": "forcegreetings",
31773 "field": "hidefromdir",
31787 "field": "emailsubject",
31794 "field": "emailbody",
31801 "field": "maxsecs",
31821 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31822 "version": "0.0.0",
31823 "filename": "server/api/voiceMail/index.js",
31824 "groupTitle": "Voice_Mails"
31828 "url": "/api/voice/mails/{id}",
31829 "title": "Deletes a Mail",
31832 "title": "Example usage:",
31833 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31837 "name": "DeleteMails",
31838 "group": "Voice_Mails",
31839 "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>",
31840 "version": "0.0.0",
31841 "filename": "server/api/voiceMail/index.js",
31842 "groupTitle": "Voice_Mails"
31846 "url": "/api/voice/mails",
31847 "title": "Gets a list of Mails",
31850 "title": "Example usage:",
31851 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31855 "name": "GetMails",
31856 "group": "Voice_Mails",
31857 "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>",
31858 "version": "0.0.0",
31859 "filename": "server/api/voiceMail/index.js",
31860 "groupTitle": "Voice_Mails"
31864 "url": "/api/voice/mails/{id}",
31865 "title": "Gets a single Mail",
31868 "title": "Example usage:",
31869 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31873 "name": "ShowMails",
31874 "group": "Voice_Mails",
31875 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31876 "version": "0.0.0",
31877 "filename": "server/api/voiceMail/index.js",
31878 "groupTitle": "Voice_Mails"
31882 "url": "/api/voice/mails/{id}/messages",
31883 "title": "Gets voice mail messages",
31886 "title": "Example usage:",
31887 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31891 "name": "getMessages",
31892 "group": "Voice_Mails",
31893 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31894 "version": "0.0.0",
31895 "filename": "server/api/voiceMail/index.js",
31896 "groupTitle": "Voice_Mails"
31900 "url": "/api/voice/mails/{id}",
31901 "title": "Update an existing Mail",
31904 "title": "Example usage:",
31905 "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",
31909 "name": "updateMails",
31910 "group": "Voice_Mails",
31911 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31912 "version": "0.0.0",
31913 "filename": "server/api/voiceMail/index.js",
31914 "groupTitle": "Voice_Mails"
31918 "url": "/api/voice/mails/messages",
31919 "title": "Creates a new Message",
31922 "title": "Example usage:",
31923 "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",
31927 "name": "CreateMessages",
31928 "group": "Voice_Messages",
31957 "field": "context",
31964 "field": "macrocontext",
31971 "field": "callerid",
31978 "field": "origtime",
31985 "field": "duration",
31992 "field": "mailboxuser",
31999 "field": "mailboxcontext",
32006 "field": "recording",
32033 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32034 "version": "0.0.0",
32035 "filename": "server/api/voiceMailMessage/index.js",
32036 "groupTitle": "Voice_Messages"
32040 "url": "/api/voice/mails/messages/{id}",
32041 "title": "Deletes a Message",
32044 "title": "Example usage:",
32045 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
32049 "name": "DeleteMessages",
32050 "group": "Voice_Messages",
32051 "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>",
32052 "version": "0.0.0",
32053 "filename": "server/api/voiceMailMessage/index.js",
32054 "groupTitle": "Voice_Messages"
32058 "url": "/api/voice/mails/messages",
32059 "title": "Gets a list of Messages",
32062 "title": "Example usage:",
32063 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
32067 "name": "GetMessages",
32068 "group": "Voice_Messages",
32069 "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>",
32070 "version": "0.0.0",
32071 "filename": "server/api/voiceMailMessage/index.js",
32072 "groupTitle": "Voice_Messages"
32076 "url": "/api/voice/mails/messages/{id}",
32077 "title": "Gets a single Message",
32080 "title": "Example usage:",
32081 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
32085 "name": "ShowMessages",
32086 "group": "Voice_Messages",
32087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32088 "version": "0.0.0",
32089 "filename": "server/api/voiceMailMessage/index.js",
32090 "groupTitle": "Voice_Messages"
32094 "url": "voice/mails/messages/{id}/download",
32095 "title": "Download Voice Message",
32098 "title": "Example usage:",
32099 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
32103 "name": "download",
32104 "group": "Voice_Messages",
32105 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32106 "version": "0.0.0",
32107 "filename": "server/api/voiceMailMessage/index.js",
32108 "groupTitle": "Voice_Messages"
32112 "url": "/api/voice/mails/messages/{id}",
32113 "title": "Update an existing Message",
32116 "title": "Example usage:",
32117 "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",
32121 "name": "updateMessages",
32122 "group": "Voice_Messages",
32123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32124 "version": "0.0.0",
32125 "filename": "server/api/voiceMailMessage/index.js",
32126 "groupTitle": "Voice_Messages"
32130 "url": "/api/voice/prefixes/{id}/teams",
32131 "title": "Add teams to voice prefix",
32134 "title": "Example usage:",
32135 "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",
32139 "name": "AddTeams",
32140 "group": "Voice_Prefix",
32141 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32142 "version": "0.0.0",
32143 "filename": "server/api/voicePrefix/index.js",
32144 "groupTitle": "Voice_Prefix"
32148 "url": "/api/voice/prefixes/{id}/teams",
32149 "title": "Gets voice prefix team",
32152 "title": "Example usage:",
32153 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X GET",
32157 "name": "GetTeams",
32158 "group": "Voice_Prefix",
32159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32160 "version": "0.0.0",
32161 "filename": "server/api/voicePrefix/index.js",
32162 "groupTitle": "Voice_Prefix"
32166 "url": "/api/voice/prefixes/{id}/users",
32167 "title": "Add agents to a prefix",
32170 "title": "Example usage:",
32171 "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",
32175 "name": "AddAgents",
32176 "group": "Voice_Prefixes",
32177 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32178 "version": "0.0.0",
32179 "filename": "server/api/voicePrefix/index.js",
32180 "groupTitle": "Voice_Prefixes"
32184 "url": "/api/voice/prefixes/{id}",
32185 "title": "Deletes a Prefix",
32188 "title": "Example usage:",
32189 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
32193 "name": "DeletePrefixes",
32194 "group": "Voice_Prefixes",
32195 "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>",
32196 "version": "0.0.0",
32197 "filename": "server/api/voicePrefix/index.js",
32198 "groupTitle": "Voice_Prefixes"
32202 "url": "/api/voice/prefixes/describe",
32203 "title": "Gets table info about Prefixes",
32206 "title": "Example usage:",
32207 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
32211 "name": "DescribePrefixes",
32212 "group": "Voice_Prefixes",
32213 "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>",
32214 "version": "0.0.0",
32215 "filename": "server/api/voicePrefix/index.js",
32216 "groupTitle": "Voice_Prefixes"
32220 "url": "/api/voice/prefixes/{id}/users",
32221 "title": "Gets agents from prefix",
32224 "title": "Example usage:",
32225 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
32229 "name": "GetAgents",
32230 "group": "Voice_Prefixes",
32231 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32232 "version": "0.0.0",
32233 "filename": "server/api/voicePrefix/index.js",
32234 "groupTitle": "Voice_Prefixes"
32238 "url": "/api/voice/prefixes",
32239 "title": "Gets a list of Prefixes",
32242 "title": "Example usage:",
32243 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
32247 "name": "GetPrefixes",
32248 "group": "Voice_Prefixes",
32249 "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>",
32250 "version": "0.0.0",
32251 "filename": "server/api/voicePrefix/index.js",
32252 "groupTitle": "Voice_Prefixes"
32256 "url": "/api/voice/prefixes/{id}/users",
32257 "title": "Removes agents from a prefix",
32260 "title": "Example usage:",
32261 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32265 "name": "RemoveAgents",
32266 "group": "Voice_Prefixes",
32267 "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>",
32268 "version": "0.0.0",
32269 "filename": "server/api/voicePrefix/index.js",
32270 "groupTitle": "Voice_Prefixes"
32274 "url": "/api/voice/prefixes/{id}",
32275 "title": "Gets a single Prefix",
32278 "title": "Example usage:",
32279 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
32283 "name": "ShowPrefixes",
32284 "group": "Voice_Prefixes",
32285 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32286 "version": "0.0.0",
32287 "filename": "server/api/voicePrefix/index.js",
32288 "groupTitle": "Voice_Prefixes"
32292 "url": "/api/voice/prefixes/{id}",
32293 "title": "Update an existing prefix",
32296 "title": "Example usage:",
32297 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
32302 "group": "Voice_Prefixes",
32303 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32304 "version": "0.0.0",
32305 "filename": "server/api/voicePrefix/index.js",
32306 "groupTitle": "Voice_Prefixes"
32310 "url": "/api/voice/prefixes",
32311 "title": "Create a prefix",
32314 "title": "Example usage:",
32315 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32320 "group": "Voice_Prefixes",
32321 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32322 "version": "0.0.0",
32323 "filename": "server/api/voicePrefix/index.js",
32324 "groupTitle": "Voice_Prefixes"
32328 "url": "/api/voice/queues/reports/describe",
32329 "title": "Gets table info about Queue Reports",
32332 "title": "Example usage:",
32333 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
32337 "name": "DescribeQueue_Reports",
32338 "group": "Voice_Queue_Reports",
32339 "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>",
32340 "version": "0.0.0",
32341 "filename": "server/api/voiceQueueReport/index.js",
32342 "groupTitle": "Voice_Queue_Reports"
32346 "url": "/api/voice/queues/reports",
32347 "title": "Gets a list of Queue Reports",
32350 "title": "Example usage:",
32351 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
32355 "name": "GetQueue_Reports",
32356 "group": "Voice_Queue_Reports",
32357 "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>",
32358 "version": "0.0.0",
32359 "filename": "server/api/voiceQueueReport/index.js",
32360 "groupTitle": "Voice_Queue_Reports"
32364 "url": "/api/voice/queues/reports/{id}",
32365 "title": "Gets a single Queue Report",
32368 "title": "Example usage:",
32369 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
32373 "name": "ShowQueue_Reports",
32374 "group": "Voice_Queue_Reports",
32375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32376 "version": "0.0.0",
32377 "filename": "server/api/voiceQueueReport/index.js",
32378 "groupTitle": "Voice_Queue_Reports"
32382 "url": "/api/voice/queues/reports/index",
32383 "title": "Get Voice Queues Report",
32386 "title": "Example usage:",
32387 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
32391 "name": "getVoiceQueuesReport",
32392 "group": "Voice_Queue_Reports",
32393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32394 "version": "0.0.0",
32395 "filename": "server/api/voiceQueueReport/index.js",
32396 "groupTitle": "Voice_Queue_Reports"
32400 "url": "/api/voice/queues/{id}/users",
32401 "title": "Add agents to queue",
32404 "title": "Example usage:",
32405 "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",
32409 "name": "AddAgents",
32410 "group": "Voice_Queues",
32411 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32412 "version": "0.0.0",
32413 "filename": "server/api/voiceQueue/index.js",
32414 "groupTitle": "Voice_Queues"
32418 "url": "/api/voice/queues/{id}/blacklists",
32419 "title": "Add blacklists to a queue",
32422 "title": "Example usage:",
32423 "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",
32427 "name": "AddBlackLists",
32428 "group": "Voice_Queues",
32429 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32430 "version": "0.0.0",
32431 "filename": "server/api/voiceQueue/index.js",
32432 "groupTitle": "Voice_Queues"
32436 "url": "/api/voice/queues/{id}/lists",
32437 "title": "Add lists to a queue",
32440 "title": "Example usage:",
32441 "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",
32445 "name": "AddLists",
32446 "group": "Voice_Queues",
32447 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32448 "version": "0.0.0",
32449 "filename": "server/api/voiceQueue/index.js",
32450 "groupTitle": "Voice_Queues"
32454 "url": "/api/voice/queues/{id}/teams",
32455 "title": "Add teams to queue",
32458 "title": "Example usage:",
32459 "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",
32463 "name": "AddTeams",
32464 "group": "Voice_Queues",
32465 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32466 "version": "0.0.0",
32467 "filename": "server/api/voiceQueue/index.js",
32468 "groupTitle": "Voice_Queues"
32472 "url": "/api/voice/queues/clone",
32473 "title": "Clone an existing Queue",
32476 "title": "Example usage:",
32477 "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",
32481 "name": "CloneQueues",
32482 "group": "Voice_Queues",
32483 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32484 "version": "0.0.0",
32485 "filename": "server/api/voiceQueue/index.js",
32486 "groupTitle": "Voice_Queues"
32490 "url": "/api/voice/queues",
32491 "title": "Creates a new Queue",
32494 "title": "Example usage:",
32495 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32499 "name": "CreateQueues",
32500 "group": "Voice_Queues",
32526 "field": "musiconhold",
32533 "field": "announce",
32551 "field": "strategy",
32558 "field": "servicelevel",
32565 "field": "context",
32572 "field": "penaltymemberslimit",
32579 "field": "timeout",
32593 "field": "timeoutpriority",
32607 "field": "wrapuptime",
32618 "field": "autofill",
32630 "field": "autopause",
32637 "field": "autopausedelay",
32648 "field": "autopausebusy",
32659 "field": "autopauseunavail",
32677 "field": "setinterfacevar",
32688 "field": "setqueueentryvar",
32699 "field": "setqueuevar",
32710 "field": "eventmemberstatus",
32717 "field": "membermacro",
32724 "field": "membergosub",
32731 "field": "announce_frequency",
32738 "field": "min_announce_frequency",
32745 "field": "periodic_announce_frequency",
32756 "field": "random_periodic_announce",
32767 "field": "relative_periodic_announce",
32779 "field": "announce_holdtime",
32786 "field": "announce_position",
32797 "field": "announce_to_first_user",
32804 "field": "announce_position_limit",
32819 "field": "announce_round_seconds",
32826 "field": "monitor_format",
32833 "field": "monitor_type",
32840 "field": "queue_youarenext",
32847 "field": "queue_thereare",
32854 "field": "queue_callswaiting",
32861 "field": "queue_holdtime",
32868 "field": "queue_minute",
32875 "field": "queue_minutes",
32882 "field": "queue_seconds",
32889 "field": "queue_thankyou",
32896 "field": "queue_reporthold",
32903 "field": "queue_quantity1",
32910 "field": "queue_quantity2",
32917 "field": "queue_periodic_announce",
32924 "field": "queue_less_than",
32931 "field": "periodic_announce",
32938 "field": "joinempty",
32945 "field": "leavewhenempty",
32956 "field": "reportholdtime",
32967 "field": "ringinuse",
32974 "field": "memberdelay",
32985 "field": "timeoutrestart",
32992 "field": "defaultrule",
32999 "field": "description",
33013 "field": "acwTimeout",
33020 "field": "dialActive",
33021 "description": "<p>Active/Disactive Campaign</p>"
33034 "field": "dialMethod",
33035 "description": "<p>Dial Method.</p>"
33041 "field": "dialLimitChannel",
33042 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
33048 "field": "dialLimitQueue",
33049 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
33055 "field": "dialPowerLevel",
33056 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
33062 "\"agentBusyFactor\"",
33066 "field": "dialPredictiveOptimization",
33067 "description": "<p>Only for predictive method.</p>"
33073 "field": "dialPredictiveOptimizationPercentage",
33074 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
33080 "field": "dialPredictiveInterval",
33081 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
33087 "field": "dialOriginateCallerIdName",
33094 "field": "dialOriginateCallerIdNumber",
33101 "field": "dialOriginateTimeout",
33102 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
33108 "field": "dialQueueOptions",
33109 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
33115 "field": "dialQueueTimeout",
33116 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
33122 "field": "dialQueueProject",
33123 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
33129 "field": "dialCongestionMaxRetry",
33130 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
33136 "field": "dialCongestionRetryFrequency",
33137 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
33143 "field": "dialBusyMaxRetry",
33144 "description": "<p>#Busy Retry (min:1, max:999)</p>"
33150 "field": "dialBusyRetryFrequency",
33151 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
33157 "field": "dialNoAnswerMaxRetry",
33158 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
33164 "field": "dialNoAnswerRetryFrequency",
33165 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
33171 "field": "dialGlobalMaxRetry",
33172 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
33178 "field": "dialTimezone",
33185 "field": "dialGlobalInterval",
33192 "field": "dialPrefix",
33204 "field": "dialCheckDuplicateType",
33211 "field": "dialAMDActive",
33212 "description": "<p>Active/Disactive AMD</p>"
33218 "field": "dialAMDInitialSilence",
33219 "description": "<p>#AMD Initial Silence</p>"
33225 "field": "dialAMDGreeting",
33226 "description": "<p>#AMD Greeting</p>"
33232 "field": "dialAMDAfterGreetingSilence",
33233 "description": "<p>#AMD After Greeting Silence</p>"
33239 "field": "dialAMDTotalAnalysisTime",
33240 "description": "<p>#AMD Total Analysis Time</p>"
33246 "field": "dialAMDMinWordLength",
33247 "description": "<p>#AMD Min Word Length</p>"
33253 "field": "dialAMDBetweenWordsSilence",
33254 "description": "<p>#AMD Between Words Silence</p>"
33260 "field": "dialAMDMaximumNumberOfWords",
33261 "description": "<p>#AMD Maximum Number Of Words</p>"
33267 "field": "dialAMDSilenceThreshold",
33268 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
33274 "field": "dialAMDMaximumWordLength",
33275 "description": "<p>#AMD Maximum Word Length</p>"
33281 "field": "dialRecallMeTimeout",
33282 "description": "<p>#RecallMe Timeout (min:1)</p>"
33288 "field": "dialRecallInQueue",
33289 "description": "<p>Active/Disactive Recall In Queue</p>"
33299 "field": "dialOrderByScheduledAt",
33306 "field": "dialQueueProject2",
33307 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
33313 "field": "dialAgiAfterHangupClient",
33320 "field": "dialAgiAfterHangupAgent",
33327 "field": "dialRandomLastDigitCallerIdNumber",
33328 "description": "<p>Random Last Digit (min:1, max:15)</p>"
33334 "field": "dialCutDigit",
33335 "description": "<p>Cut Digit (min:1, max:15)</p>"
33341 "field": "dialNoSuchNumberMaxRetry",
33342 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
33348 "field": "dialNoSuchNumberRetryFrequency",
33349 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
33355 "field": "dialDropMaxRetry",
33356 "description": "<p>#Drop Retry (min:1, max:999)</p>"
33362 "field": "dialDropRetryFrequency",
33363 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
33369 "field": "dialAbandonedMaxRetry",
33370 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
33376 "field": "dialAbandonedRetryFrequency",
33377 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
33383 "field": "dialMachineMaxRetry",
33384 "description": "<p>#Machine Retry (min:1, max:999)</p>"
33390 "field": "dialMachineRetryFrequency",
33391 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
33397 "field": "dialAgentRejectMaxRetry",
33398 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
33404 "field": "dialAgentRejectRetryFrequency",
33405 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
33411 "field": "mandatoryDispositionPauseId",
33412 "description": "<p>Status to put when mandatory disposition is enabled</p>"
33418 "field": "mandatoryDisposition",
33419 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
33425 "field": "dialPredictiveIntervalMaxThreshold",
33432 "field": "dialPredictiveIntervalMinThreshold",
33439 "field": "dialPreviewAutoRecallMe",
33445 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33446 "version": "0.0.0",
33447 "filename": "server/api/voiceQueue/index.js",
33448 "groupTitle": "Voice_Queues"
33452 "url": "/api/voice/queues/{id}",
33453 "title": "Deletes a Queue",
33456 "title": "Example usage:",
33457 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
33461 "name": "DeleteQueues",
33462 "group": "Voice_Queues",
33463 "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>",
33464 "version": "0.0.0",
33465 "filename": "server/api/voiceQueue/index.js",
33466 "groupTitle": "Voice_Queues"
33470 "url": "/api/voice/queues/{id}/users",
33471 "title": "Gets queue agents",
33474 "title": "Example usage:",
33475 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
33479 "name": "GetAgents",
33480 "group": "Voice_Queues",
33481 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33482 "version": "0.0.0",
33483 "filename": "server/api/voiceQueue/index.js",
33484 "groupTitle": "Voice_Queues"
33488 "url": "/api/voice/queues/{id}/blacklists",
33489 "title": "Get queue blacklists",
33492 "title": "Example usage:",
33493 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
33497 "name": "GetBlackLists",
33498 "group": "Voice_Queues",
33499 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33500 "version": "0.0.0",
33501 "filename": "server/api/voiceQueue/index.js",
33502 "groupTitle": "Voice_Queues"
33506 "url": "/api/voice/queues/{id}/finals",
33507 "title": "Gets queue hopper finals",
33510 "title": "Example usage:",
33511 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
33515 "name": "GetHopperFinals",
33516 "group": "Voice_Queues",
33517 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33518 "version": "0.0.0",
33519 "filename": "server/api/voiceQueue/index.js",
33520 "groupTitle": "Voice_Queues"
33524 "url": "/api/voice/queues/{id}/hopper_histories",
33525 "title": "Gets queue hopper histories",
33528 "title": "Example usage:",
33529 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33533 "name": "GetHopperHistories",
33534 "group": "Voice_Queues",
33535 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33536 "version": "0.0.0",
33537 "filename": "server/api/voiceQueue/index.js",
33538 "groupTitle": "Voice_Queues"
33542 "url": "/api/voice/queues/{id}/hoppers",
33543 "title": "Gets queue hoppers",
33546 "title": "Example usage:",
33547 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33551 "name": "GetHoppers",
33552 "group": "Voice_Queues",
33553 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33554 "version": "0.0.0",
33555 "filename": "server/api/voiceQueue/index.js",
33556 "groupTitle": "Voice_Queues"
33560 "url": "/api/voice/queues/{id}/lists",
33561 "title": "Get queue lists",
33564 "title": "Example usage:",
33565 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33569 "name": "GetLists",
33570 "group": "Voice_Queues",
33571 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33572 "version": "0.0.0",
33573 "filename": "server/api/voiceQueue/index.js",
33574 "groupTitle": "Voice_Queues"
33578 "url": "/api/voice/queues/{id}/members",
33579 "title": "Gets queue members",
33582 "title": "Example usage:",
33583 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33587 "name": "GetMembers",
33588 "group": "Voice_Queues",
33589 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33590 "version": "0.0.0",
33591 "filename": "server/api/voiceQueue/index.js",
33592 "groupTitle": "Voice_Queues"
33596 "url": "/api/voice/queues",
33597 "title": "Gets a list of Queues",
33600 "title": "Example usage:",
33601 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33605 "name": "GetQueues",
33606 "group": "Voice_Queues",
33607 "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>",
33608 "version": "0.0.0",
33609 "filename": "server/api/voiceQueue/index.js",
33610 "groupTitle": "Voice_Queues"
33614 "url": "/api/voice/queues/{id}/teams",
33615 "title": "Gets queue team",
33618 "title": "Example usage:",
33619 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
33623 "name": "GetTeams",
33624 "group": "Voice_Queues",
33625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33626 "version": "0.0.0",
33627 "filename": "server/api/voiceQueue/index.js",
33628 "groupTitle": "Voice_Queues"
33632 "url": "/api/voice/queues/{id}/users",
33633 "title": "Removes agents from a queue",
33636 "title": "Example usage:",
33637 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33641 "name": "RemoveAgents",
33642 "group": "Voice_Queues",
33643 "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>",
33644 "version": "0.0.0",
33645 "filename": "server/api/voiceQueue/index.js",
33646 "groupTitle": "Voice_Queues"
33650 "url": "/api/voice/queues/{id}/blacklists",
33651 "title": "Remove blacklists from a queue",
33654 "title": "Example usage:",
33655 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33659 "name": "RemoveBlackLists",
33660 "group": "Voice_Queues",
33661 "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>",
33662 "version": "0.0.0",
33663 "filename": "server/api/voiceQueue/index.js",
33664 "groupTitle": "Voice_Queues"
33668 "url": "/api/voice/queues/{id}/lists",
33669 "title": "Remove lists from a queue",
33672 "title": "Example usage:",
33673 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33677 "name": "RemoveLists",
33678 "group": "Voice_Queues",
33679 "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>",
33680 "version": "0.0.0",
33681 "filename": "server/api/voiceQueue/index.js",
33682 "groupTitle": "Voice_Queues"
33686 "url": "/api/voice/queues/{id}",
33687 "title": "Gets a single Queue",
33690 "title": "Example usage:",
33691 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33695 "name": "ShowQueues",
33696 "group": "Voice_Queues",
33697 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33698 "version": "0.0.0",
33699 "filename": "server/api/voiceQueue/index.js",
33700 "groupTitle": "Voice_Queues"
33704 "url": "/api/voice/queues/{id}/blacks",
33705 "title": "Gets queue hopper blacks",
33708 "title": "Example usage:",
33709 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
33713 "name": "getHopperBlacks",
33714 "group": "Voice_Queues",
33715 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33716 "version": "0.0.0",
33717 "filename": "server/api/voiceQueue/index.js",
33718 "groupTitle": "Voice_Queues"
33722 "url": "/api/voice/queues/{id}",
33723 "title": "Update an existing Queue",
33726 "title": "Example usage:",
33727 "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",
33731 "name": "updateQueues",
33732 "group": "Voice_Queues",
33733 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33734 "version": "0.0.0",
33735 "filename": "server/api/voiceQueue/index.js",
33736 "groupTitle": "Voice_Queues"
33740 "url": "/api/voice/recordings",
33741 "title": "Creates a new Recording",
33744 "title": "Example usage:",
33745 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33749 "name": "CreateRecordings",
33750 "group": "Voice_Recordings",
33765 "field": "uniqueid",
33772 "field": "channel",
33779 "field": "membername",
33786 "field": "calleridnum",
33793 "field": "calleridname",
33800 "field": "connectedlinenum",
33807 "field": "connectedlinename",
33814 "field": "accountcode",
33821 "field": "context",
33863 "field": "userDisposition",
33870 "field": "userSecondDisposition",
33877 "field": "userThirdDisposition",
33884 "field": "location",
33891 "field": "transcribeName",
33898 "field": "transcribeStatus",
33905 "field": "fileUri",
33912 "field": "fileText",
33919 "field": "failureReason",
33926 "field": "sentiment",
33933 "field": "sPositive",
33940 "field": "sNegative",
33947 "field": "sNeutral",
33961 "field": "tempSentiment",
33968 "field": "createdAt",
33975 "field": "updatedAt",
33981 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33982 "version": "0.0.0",
33983 "filename": "server/api/voiceRecording/index.js",
33984 "groupTitle": "Voice_Recordings"
33988 "url": "/api/voice/recordings/describe",
33989 "title": "Gets table info about Recordings",
33992 "title": "Example usage:",
33993 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33997 "name": "DescribeRecordings",
33998 "group": "Voice_Recordings",
33999 "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>",
34000 "version": "0.0.0",
34001 "filename": "server/api/voiceRecording/index.js",
34002 "groupTitle": "Voice_Recordings"
34006 "url": "/api/voice/recordings",
34007 "title": "Gets a list of Recordings",
34010 "title": "Example usage:",
34011 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
34015 "name": "GetRecordings",
34016 "group": "Voice_Recordings",
34017 "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>",
34018 "version": "0.0.0",
34019 "filename": "server/api/voiceRecording/index.js",
34020 "groupTitle": "Voice_Recordings"
34024 "url": "/api/voice/recordings/{id}",
34025 "title": "Gets a single Recording",
34028 "title": "Example usage:",
34029 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
34033 "name": "ShowRecordings",
34034 "group": "Voice_Recordings",
34035 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34036 "version": "0.0.0",
34037 "filename": "server/api/voiceRecording/index.js",
34038 "groupTitle": "Voice_Recordings"
34042 "url": "/api/voice/recordings/{id}",
34043 "title": "Delete voice recording",
34046 "title": "Example usage:",
34047 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
34052 "group": "Voice_Recordings",
34053 "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>",
34054 "version": "0.0.0",
34055 "filename": "server/api/voiceRecording/index.js",
34056 "groupTitle": "Voice_Recordings"
34060 "url": "/api/voice/recordings/{id}/download",
34061 "title": "Download Recording",
34064 "title": "Example usage:",
34065 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
34069 "name": "download",
34070 "group": "Voice_Recordings",
34071 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/voiceRecording/index.js",
34074 "groupTitle": "Voice_Recordings"
34078 "url": "/api/voice/recordings/{id}/downloads",
34079 "title": "Download Recording",
34082 "title": "Example usage:",
34083 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
34087 "name": "downloads",
34088 "group": "Voice_Recordings",
34089 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34090 "version": "0.0.0",
34091 "filename": "server/api/voiceRecording/index.js",
34092 "groupTitle": "Voice_Recordings"
34096 "url": "/api/voice/recordings/{id}/transcribe",
34097 "title": "Run Transcribe Recording",
34100 "title": "Example usage:",
34101 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
34105 "name": "transcribe",
34106 "group": "Voice_Recordings",
34107 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34108 "version": "0.0.0",
34109 "filename": "server/api/voiceRecording/index.js",
34110 "groupTitle": "Voice_Recordings"
34114 "url": "/api/voice/recordings/{id}/transcribe",
34115 "title": "Run Transcribe Recording",
34118 "title": "Example usage:",
34119 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
34123 "name": "transcribe",
34124 "group": "Voice_Recordings",
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/voiceRecording/index.js",
34128 "groupTitle": "Voice_Recordings"
34132 "url": "/api/voice/recordings/{id}",
34133 "title": "Update an existing Recording",
34136 "title": "Example usage:",
34137 "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",
34141 "name": "updateRecordings",
34142 "group": "Voice_Recordings",
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/voiceRecording/index.js",
34146 "groupTitle": "Voice_Recordings"
34150 "url": "/api/voice/transfers/reports",
34151 "title": "Creates a new Transfer Report",
34154 "title": "Example usage:",
34155 "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",
34159 "name": "CreateTransfer_Reports",
34160 "group": "Voice_Transfer_Reports",
34186 "field": "transfererchannel",
34193 "field": "transferercalleridnum",
34200 "field": "transferercalleridname",
34207 "field": "transfererconnectedlinenum",
34214 "field": "transfererconnectedlinename",
34221 "field": "transfereraccountcode",
34228 "field": "transferercontext",
34235 "field": "transfererexten",
34242 "field": "transfererlinkedid",
34249 "field": "transfereechannel",
34256 "field": "transfereecalleridnum",
34263 "field": "transfereecalleridname",
34270 "field": "transfereeconnectedlinenum",
34277 "field": "transfereeconnectedlinename",
34284 "field": "transfereeaccountcode",
34291 "field": "transfereecontext",
34298 "field": "transfereeexten",
34305 "field": "transfereelinkedid",
34316 "field": "isexternal",
34323 "field": "context",
34330 "field": "extension",
34336 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34337 "version": "0.0.0",
34338 "filename": "server/api/voiceTransferReport/index.js",
34339 "groupTitle": "Voice_Transfer_Reports"
34343 "url": "/api/voice/transfers/reports/{id}",
34344 "title": "Deletes a Transfer Report",
34347 "title": "Example usage:",
34348 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
34352 "name": "DeleteTransfer_Reports",
34353 "group": "Voice_Transfer_Reports",
34354 "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>",
34355 "version": "0.0.0",
34356 "filename": "server/api/voiceTransferReport/index.js",
34357 "groupTitle": "Voice_Transfer_Reports"
34361 "url": "/api/voice/transfers/reports/describe",
34362 "title": "Gets table info about Transfer Reports",
34365 "title": "Example usage:",
34366 "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
34370 "name": "DescribeTransfer_Reports",
34371 "group": "Voice_Transfer_Reports",
34372 "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>",
34373 "version": "0.0.0",
34374 "filename": "server/api/voiceTransferReport/index.js",
34375 "groupTitle": "Voice_Transfer_Reports"
34379 "url": "/api/voice/transfers/reports",
34380 "title": "Gets a list of Transfer Reports",
34383 "title": "Example usage:",
34384 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
34388 "name": "GetTransfer_Reports",
34389 "group": "Voice_Transfer_Reports",
34390 "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>",
34391 "version": "0.0.0",
34392 "filename": "server/api/voiceTransferReport/index.js",
34393 "groupTitle": "Voice_Transfer_Reports"
34397 "url": "/api/voice/transfers/reports/{id}",
34398 "title": "Gets a single Transfer Report",
34401 "title": "Example usage:",
34402 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
34406 "name": "ShowTransfer_Reports",
34407 "group": "Voice_Transfer_Reports",
34408 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34409 "version": "0.0.0",
34410 "filename": "server/api/voiceTransferReport/index.js",
34411 "groupTitle": "Voice_Transfer_Reports"
34415 "url": "/api/voice/transfers/reports/{id}",
34416 "title": "Update an existing Transfer Report",
34419 "title": "Example usage:",
34420 "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",
34424 "name": "updateTransfer_Reports",
34425 "group": "Voice_Transfer_Reports",
34426 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34427 "version": "0.0.0",
34428 "filename": "server/api/voiceTransferReport/index.js",
34429 "groupTitle": "Voice_Transfer_Reports"
34433 "url": "/api/integrations/vtiger/accounts",
34434 "title": "Creates a new Vtiger Account",
34437 "title": "Example usage:",
34438 "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",
34442 "name": "CreateVtiger_Accounts",
34443 "group": "Vtiger_Accounts",
34458 "field": "description",
34465 "field": "username",
34472 "field": "moduleName",
34479 "field": "remoteUri",
34486 "field": "serverUrl",
34493 "field": "accessKey",
34499 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34500 "version": "0.0.0",
34501 "filename": "server/api/intVtigerAccount/index.js",
34502 "groupTitle": "Vtiger_Accounts"
34506 "url": "/api/integrations/vtiger/accounts/{id}",
34507 "title": "Deletes a Vtiger Account",
34510 "title": "Example usage:",
34511 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
34515 "name": "DeleteVtiger_Accounts",
34516 "group": "Vtiger_Accounts",
34517 "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>",
34518 "version": "0.0.0",
34519 "filename": "server/api/intVtigerAccount/index.js",
34520 "groupTitle": "Vtiger_Accounts"
34524 "url": "/api/integrations/vtiger/accounts",
34525 "title": "Gets a list of Vtiger Accounts",
34528 "title": "Example usage:",
34529 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
34533 "name": "GetVtiger_Accounts",
34534 "group": "Vtiger_Accounts",
34535 "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>",
34536 "version": "0.0.0",
34537 "filename": "server/api/intVtigerAccount/index.js",
34538 "groupTitle": "Vtiger_Accounts"
34542 "url": "/api/integrations/vtiger/accounts/{id}",
34543 "title": "Gets a single Vtiger Account",
34546 "title": "Example usage:",
34547 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34551 "name": "ShowVtiger_Accounts",
34552 "group": "Vtiger_Accounts",
34553 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34554 "version": "0.0.0",
34555 "filename": "server/api/intVtigerAccount/index.js",
34556 "groupTitle": "Vtiger_Accounts"
34560 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34561 "title": "Creates new configuration",
34564 "title": "Example usage:",
34565 "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",
34569 "name": "addConfiguration",
34570 "group": "Vtiger_Accounts",
34571 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34572 "version": "0.0.0",
34573 "filename": "server/api/intVtigerAccount/index.js",
34574 "groupTitle": "Vtiger_Accounts"
34578 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34579 "title": "Gets account configurations",
34582 "title": "Example usage:",
34583 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34587 "name": "getConfigurations",
34588 "group": "Vtiger_Accounts",
34589 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34590 "version": "0.0.0",
34591 "filename": "server/api/intVtigerAccount/index.js",
34592 "groupTitle": "Vtiger_Accounts"
34596 "url": "/api/integrations/vtiger/accounts/{id}/fields",
34597 "title": "Gets account fields",
34600 "title": "Example usage:",
34601 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34605 "name": "getFields",
34606 "group": "Vtiger_Accounts",
34607 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34608 "version": "0.0.0",
34609 "filename": "server/api/intVtigerAccount/index.js",
34610 "groupTitle": "Vtiger_Accounts"
34614 "url": "/api/integrations/vtiger/accounts/{id}",
34615 "title": "Update an existing Vtiger Account",
34618 "title": "Example usage:",
34619 "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",
34623 "name": "updateVtiger_Accounts",
34624 "group": "Vtiger_Accounts",
34625 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34626 "version": "0.0.0",
34627 "filename": "server/api/intVtigerAccount/index.js",
34628 "groupTitle": "Vtiger_Accounts"
34632 "url": "/api/integrations/vtiger/configurations",
34633 "title": "Creates a new Vtiger Configuration",
34636 "title": "Example usage:",
34637 "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",
34641 "name": "CreateVtiger_Configurations",
34642 "group": "Vtiger_Configurations",
34657 "field": "description",
34663 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34664 "version": "0.0.0",
34665 "filename": "server/api/intVtigerConfiguration/index.js",
34666 "groupTitle": "Vtiger_Configurations"
34670 "url": "/api/integrations/vtiger/configurations/{id}",
34671 "title": "Deletes a Vtiger Configuration",
34674 "title": "Example usage:",
34675 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34679 "name": "DeleteVtiger_Configurations",
34680 "group": "Vtiger_Configurations",
34681 "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>",
34682 "version": "0.0.0",
34683 "filename": "server/api/intVtigerConfiguration/index.js",
34684 "groupTitle": "Vtiger_Configurations"
34688 "url": "/api/integrations/vtiger/configurations",
34689 "title": "Gets a list of Vtiger Configurations",
34692 "title": "Example usage:",
34693 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34697 "name": "GetVtiger_Configurations",
34698 "group": "Vtiger_Configurations",
34699 "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>",
34700 "version": "0.0.0",
34701 "filename": "server/api/intVtigerConfiguration/index.js",
34702 "groupTitle": "Vtiger_Configurations"
34706 "url": "/api/integrations/vtiger/configurations/{id}",
34707 "title": "Gets a single Vtiger Configuration",
34710 "title": "Example usage:",
34711 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34715 "name": "ShowVtiger_Configurations",
34716 "group": "Vtiger_Configurations",
34717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34718 "version": "0.0.0",
34719 "filename": "server/api/intVtigerConfiguration/index.js",
34720 "groupTitle": "Vtiger_Configurations"
34724 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34725 "title": "Gets configurations descriptions",
34728 "title": "Example usage:",
34729 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34733 "name": "getDescriptions",
34734 "group": "Vtiger_Configurations",
34735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34736 "version": "0.0.0",
34737 "filename": "server/api/intVtigerConfiguration/index.js",
34738 "groupTitle": "Vtiger_Configurations"
34742 "url": "/api/integrations/vtiger/configurations/{id}/fields",
34743 "title": "Gets configurations fields",
34746 "title": "Example usage:",
34747 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34751 "name": "getFields",
34752 "group": "Vtiger_Configurations",
34753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34754 "version": "0.0.0",
34755 "filename": "server/api/intVtigerConfiguration/index.js",
34756 "groupTitle": "Vtiger_Configurations"
34760 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34761 "title": "Gets configurations subjects",
34764 "title": "Example usage:",
34765 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34769 "name": "getSubjects",
34770 "group": "Vtiger_Configurations",
34771 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34772 "version": "0.0.0",
34773 "filename": "server/api/intVtigerConfiguration/index.js",
34774 "groupTitle": "Vtiger_Configurations"
34778 "url": "/api/integrations/vtiger/configurations/{id}",
34779 "title": "Update an existing Vtiger Configuration",
34782 "title": "Example usage:",
34783 "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",
34787 "name": "updateVtiger_Configurations",
34788 "group": "Vtiger_Configurations",
34789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34790 "version": "0.0.0",
34791 "filename": "server/api/intVtigerConfiguration/index.js",
34792 "groupTitle": "Vtiger_Configurations"
34796 "url": "/api/integrations/vtiger/fields",
34797 "title": "Creates a new Vtiger Field",
34800 "title": "Example usage:",
34801 "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",
34805 "name": "CreateVtiger_Fields",
34806 "group": "Vtiger_Fields",
34816 "\"customVariable\"",
34828 "field": "content",
34844 "\"customVariable\""
34847 "field": "keyType",
34854 "field": "keyContent",
34861 "field": "idField",
34868 "field": "nameField",
34875 "field": "customField",
34882 "field": "variableName",
34888 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34889 "version": "0.0.0",
34890 "filename": "server/api/intVtigerField/index.js",
34891 "groupTitle": "Vtiger_Fields"
34895 "url": "/api/integrations/vtiger/fields/{id}",
34896 "title": "Deletes a Vtiger Field",
34899 "title": "Example usage:",
34900 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34904 "name": "DeleteVtiger_Fields",
34905 "group": "Vtiger_Fields",
34906 "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>",
34907 "version": "0.0.0",
34908 "filename": "server/api/intVtigerField/index.js",
34909 "groupTitle": "Vtiger_Fields"
34913 "url": "/api/integrations/vtiger/fields",
34914 "title": "Gets a list of Vtiger Fields",
34917 "title": "Example usage:",
34918 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34922 "name": "GetVtiger_Fields",
34923 "group": "Vtiger_Fields",
34924 "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>",
34925 "version": "0.0.0",
34926 "filename": "server/api/intVtigerField/index.js",
34927 "groupTitle": "Vtiger_Fields"
34931 "url": "/api/integrations/vtiger/fields/{id}",
34932 "title": "Gets a single Vtiger Field",
34935 "title": "Example usage:",
34936 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34940 "name": "ShowVtiger_Fields",
34941 "group": "Vtiger_Fields",
34942 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34943 "version": "0.0.0",
34944 "filename": "server/api/intVtigerField/index.js",
34945 "groupTitle": "Vtiger_Fields"
34949 "url": "/api/integrations/vtiger/fields/{id}",
34950 "title": "Update an existing Vtiger Field",
34953 "title": "Example usage:",
34954 "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",
34958 "name": "updateVtiger_Fields",
34959 "group": "Vtiger_Fields",
34960 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34961 "version": "0.0.0",
34962 "filename": "server/api/intVtigerField/index.js",
34963 "groupTitle": "Vtiger_Fields"
34967 "url": "/api/webbar/answer",
34968 "title": "answer webrtc call",
34971 "title": "Example usage:",
34972 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34976 "name": "Web_Bar_answer",
34985 "field": "sessionId",
34998 "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>",
34999 "version": "0.0.0",
35000 "filename": "server/api/webbar/index.js",
35001 "groupTitle": "WebBar"
35005 "url": "/api/webbar/calls",
35006 "title": "webrtc call list",
35009 "title": "Example usage:",
35010 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35014 "name": "Web_Bar_calls",
35029 "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>",
35030 "version": "0.0.0",
35031 "filename": "server/api/webbar/index.js",
35032 "groupTitle": "WebBar"
35036 "url": "/api/webbar/hangup",
35037 "title": "hangup webrtc call",
35040 "title": "Example usage:",
35041 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35045 "name": "Web_Bar_hangup",
35054 "field": "sessionId",
35067 "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>",
35068 "version": "0.0.0",
35069 "filename": "server/api/webbar/index.js",
35070 "groupTitle": "WebBar"
35074 "url": "/api/webbar/hold",
35075 "title": "hold webrtc call",
35078 "title": "Example usage:",
35079 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35083 "name": "Web_Bar_hold",
35092 "field": "sessionId",
35105 "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>",
35106 "version": "0.0.0",
35107 "filename": "server/api/webbar/index.js",
35108 "groupTitle": "WebBar"
35112 "url": "/api/webbar/unhold",
35113 "title": "unhold webrtc call",
35116 "title": "Example usage:",
35117 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35121 "name": "Web_Bar_hold",
35130 "field": "sessionId",
35143 "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>",
35144 "version": "0.0.0",
35145 "filename": "server/api/webbar/index.js",
35146 "groupTitle": "WebBar"
35150 "url": "/api/webbar/originate",
35151 "title": "Originate new webrtc call",
35154 "title": "Example usage:",
35155 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35159 "name": "Web_Bar_originate",
35168 "field": "callNumber",
35182 "field": "callerId",
35189 "field": "callbackUrl",
35195 "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>",
35196 "version": "0.0.0",
35197 "filename": "server/api/webbar/index.js",
35198 "groupTitle": "WebBar"
35202 "url": "/api/webbar/transfer",
35203 "title": "blind transfer webrtc call",
35206 "title": "Example usage:",
35207 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
35211 "name": "Web_Bar_transfer",
35227 "field": "sessionId",
35234 "field": "transferNumber",
35240 "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>",
35241 "version": "0.0.0",
35242 "filename": "server/api/webbar/index.js",
35243 "groupTitle": "WebBar"
35247 "url": "/api/whatsapp/accounts/{id}/users",
35248 "title": "Add agents to a whatsapp account",
35251 "title": "Example usage:",
35252 "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",
35256 "name": "AddAgents",
35257 "group": "Whatsapp_Accounts",
35258 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35259 "version": "0.0.0",
35260 "filename": "server/api/whatsappAccount/index.js",
35261 "groupTitle": "Whatsapp_Accounts"
35265 "url": "/api/whatsapp/accounts",
35266 "title": "Creates a new Account",
35269 "title": "Example usage:",
35270 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35274 "name": "CreateAccounts",
35275 "group": "Whatsapp_Accounts",
35328 "field": "accountSid",
35335 "field": "authToken",
35342 "field": "notificationTemplate",
35349 "field": "notificationSound",
35356 "field": "notificationShake",
35363 "field": "waitForTheAssignedAgent",
35370 "field": "queueTransfer",
35377 "field": "queueTransferTimeout",
35384 "field": "agentTransfer",
35391 "field": "agentTransferTimeout",
35398 "field": "mandatoryDispositionPauseId",
35399 "description": "<p>Status to put when mandatory disposition is enabled</p>"
35405 "field": "mandatoryDisposition",
35406 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35412 "field": "description",
35418 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35419 "version": "0.0.0",
35420 "filename": "server/api/whatsappAccount/index.js",
35421 "groupTitle": "Whatsapp_Accounts"
35425 "url": "/api/whatsapp/accounts/{id}",
35426 "title": "Deletes a Account",
35429 "title": "Example usage:",
35430 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
35434 "name": "DeleteAccounts",
35435 "group": "Whatsapp_Accounts",
35436 "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>",
35437 "version": "0.0.0",
35438 "filename": "server/api/whatsappAccount/index.js",
35439 "groupTitle": "Whatsapp_Accounts"
35443 "url": "/api/whatsapp/accounts/describe",
35444 "title": "Gets table info about Accounts",
35447 "title": "Example usage:",
35448 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
35452 "name": "DescribeAccounts",
35453 "group": "Whatsapp_Accounts",
35454 "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>",
35455 "version": "0.0.0",
35456 "filename": "server/api/whatsappAccount/index.js",
35457 "groupTitle": "Whatsapp_Accounts"
35461 "url": "/api/whatsapp/accounts",
35462 "title": "Gets a list of Accounts",
35465 "title": "Example usage:",
35466 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
35470 "name": "GetAccounts",
35471 "group": "Whatsapp_Accounts",
35472 "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>",
35473 "version": "0.0.0",
35474 "filename": "server/api/whatsappAccount/index.js",
35475 "groupTitle": "Whatsapp_Accounts"
35479 "url": "/api/whatsapp/accounts/{id}/users",
35480 "title": "Gets agents from whatsapp account",
35483 "title": "Example usage:",
35484 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
35488 "name": "GetAgents",
35489 "group": "Whatsapp_Accounts",
35490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35491 "version": "0.0.0",
35492 "filename": "server/api/whatsappAccount/index.js",
35493 "groupTitle": "Whatsapp_Accounts"
35497 "url": "/api/whatsapp/accounts/{id}/users",
35498 "title": "Removes agents from a whatsapp account",
35501 "title": "Example usage:",
35502 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35506 "name": "RemoveAgents",
35507 "group": "Whatsapp_Accounts",
35508 "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>",
35509 "version": "0.0.0",
35510 "filename": "server/api/whatsappAccount/index.js",
35511 "groupTitle": "Whatsapp_Accounts"
35515 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35516 "title": "Removes canned answers from account",
35519 "title": "Example usage:",
35520 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35524 "name": "RemoveAnswers",
35525 "group": "Whatsapp_Accounts",
35526 "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>",
35527 "version": "0.0.0",
35528 "filename": "server/api/whatsappAccount/index.js",
35529 "groupTitle": "Whatsapp_Accounts"
35533 "url": "/api/whatsapp/accounts/{id}/dispositions",
35534 "title": "Removes dispositions from account",
35537 "title": "Example usage:",
35538 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35542 "name": "RemoveDispositions",
35543 "group": "Whatsapp_Accounts",
35544 "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>",
35545 "version": "0.0.0",
35546 "filename": "server/api/whatsappAccount/index.js",
35547 "groupTitle": "Whatsapp_Accounts"
35551 "url": "/api/whatsapp/accounts/{id}",
35552 "title": "Gets a single Account",
35555 "title": "Example usage:",
35556 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35560 "name": "ShowAccounts",
35561 "group": "Whatsapp_Accounts",
35562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35563 "version": "0.0.0",
35564 "filename": "server/api/whatsappAccount/index.js",
35565 "groupTitle": "Whatsapp_Accounts"
35569 "url": "/api/whatsapp/messages/{id}/accept",
35570 "title": "Accepts message",
35573 "title": "Example usage:",
35574 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35578 "name": "acceptMessage",
35579 "group": "Whatsapp_Accounts",
35580 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35581 "version": "0.0.0",
35582 "filename": "server/api/whatsappMessage/index.js",
35583 "groupTitle": "Whatsapp_Accounts"
35587 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35588 "title": "Creates new canned answer",
35591 "title": "Example usage:",
35592 "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",
35596 "name": "addAnswer",
35597 "group": "Whatsapp_Accounts",
35619 "field": "description",
35632 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35633 "version": "0.0.0",
35634 "filename": "server/api/whatsappAccount/index.js",
35635 "groupTitle": "Whatsapp_Accounts"
35639 "url": "/api/whatsapp/accounts/{id}/applications",
35640 "title": "Creates new applications",
35643 "title": "Example usage:",
35644 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35648 "name": "addApplications",
35649 "group": "Whatsapp_Accounts",
35657 "field": "priority",
35671 "field": "appdata",
35678 "field": "description",
35685 "field": "interval",
35691 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35692 "version": "0.0.0",
35693 "filename": "server/api/whatsappAccount/index.js",
35694 "groupTitle": "Whatsapp_Accounts"
35698 "url": "/api/whatsapp/accounts/{id}/dispositions",
35699 "title": "Creates new disposition",
35702 "title": "Example usage:",
35703 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35707 "name": "addDisposition",
35708 "group": "Whatsapp_Accounts",
35735 "field": "description",
35741 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35742 "version": "0.0.0",
35743 "filename": "server/api/whatsappAccount/index.js",
35744 "groupTitle": "Whatsapp_Accounts"
35748 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35749 "title": "Gets account canned answers",
35752 "title": "Example usage:",
35753 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35757 "name": "getAnswers",
35758 "group": "Whatsapp_Accounts",
35759 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35760 "version": "0.0.0",
35761 "filename": "server/api/whatsappAccount/index.js",
35762 "groupTitle": "Whatsapp_Accounts"
35766 "url": "/api/whatsapp/accounts/{id}/applications",
35767 "title": "Gets account applications",
35770 "title": "Example usage:",
35771 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35775 "name": "getApplications",
35776 "group": "Whatsapp_Accounts",
35777 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35778 "version": "0.0.0",
35779 "filename": "server/api/whatsappAccount/index.js",
35780 "groupTitle": "Whatsapp_Accounts"
35784 "url": "/api/whatsapp/accounts/{id}/dispositions",
35785 "title": "Gets account dispositions",
35788 "title": "Example usage:",
35789 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35793 "name": "getDispositions",
35794 "group": "Whatsapp_Accounts",
35795 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35796 "version": "0.0.0",
35797 "filename": "server/api/whatsappAccount/index.js",
35798 "groupTitle": "Whatsapp_Accounts"
35802 "url": "/api/whatsapp/accounts/{id}/notify",
35803 "title": "Notify new message",
35806 "title": "Example usage:",
35807 "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",
35812 "group": "Whatsapp_Accounts",
35813 "description": "<p>Motion 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>",
35814 "version": "0.0.0",
35815 "filename": "server/api/whatsappAccount/index.js",
35816 "groupTitle": "Whatsapp_Accounts"
35820 "url": "/api/whatsapp/messages/{id}/reject",
35821 "title": "Rejects message",
35824 "title": "Example usage:",
35825 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35829 "name": "rejectMessage",
35830 "group": "Whatsapp_Accounts",
35831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35832 "version": "0.0.0",
35833 "filename": "server/api/whatsappMessage/index.js",
35834 "groupTitle": "Whatsapp_Accounts"
35838 "url": "/api/whatsapp/accounts/{id}/send",
35839 "title": "Send new whatsapp message",
35842 "title": "Example usage:",
35843 "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",
35847 "name": "sendWhatsapp",
35848 "group": "Whatsapp_Accounts",
35849 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35850 "version": "0.0.0",
35851 "filename": "server/api/whatsappAccount/index.js",
35852 "groupTitle": "Whatsapp_Accounts"
35856 "url": "/api/whatsapp/messages/{id}/status",
35857 "title": "Receive message status",
35860 "title": "Example usage:",
35861 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35865 "name": "statusMessage",
35866 "group": "Whatsapp_Accounts",
35867 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35868 "version": "0.0.0",
35869 "filename": "server/api/whatsappMessage/index.js",
35870 "groupTitle": "Whatsapp_Accounts"
35874 "url": "/api/whatsapp/accounts/{id}",
35875 "title": "Update an existing Account",
35878 "title": "Example usage:",
35879 "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",
35883 "name": "updateAccounts",
35884 "group": "Whatsapp_Accounts",
35885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35886 "version": "0.0.0",
35887 "filename": "server/api/whatsappAccount/index.js",
35888 "groupTitle": "Whatsapp_Accounts"
35892 "url": "/api/whatsapp/applications",
35893 "title": "Creates a new Application",
35896 "title": "Example usage:",
35897 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35901 "name": "CreateApplications",
35902 "group": "Whatsapp_Applications",
35910 "field": "priority",
35924 "field": "appdata",
35931 "field": "description",
35938 "field": "interval",
35944 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35945 "version": "0.0.0",
35946 "filename": "server/api/whatsappApplication/index.js",
35947 "groupTitle": "Whatsapp_Applications"
35951 "url": "/api/whatsapp/applications/{id}",
35952 "title": "Deletes a Application",
35955 "title": "Example usage:",
35956 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35960 "name": "DeleteApplications",
35961 "group": "Whatsapp_Applications",
35962 "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>",
35963 "version": "0.0.0",
35964 "filename": "server/api/whatsappApplication/index.js",
35965 "groupTitle": "Whatsapp_Applications"
35969 "url": "/api/whatsapp/applications",
35970 "title": "Gets a list of Applications",
35973 "title": "Example usage:",
35974 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35978 "name": "GetApplications",
35979 "group": "Whatsapp_Applications",
35980 "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>",
35981 "version": "0.0.0",
35982 "filename": "server/api/whatsappApplication/index.js",
35983 "groupTitle": "Whatsapp_Applications"
35987 "url": "/api/whatsapp/applications/{id}",
35988 "title": "Gets a single Application",
35991 "title": "Example usage:",
35992 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35996 "name": "ShowApplications",
35997 "group": "Whatsapp_Applications",
35998 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35999 "version": "0.0.0",
36000 "filename": "server/api/whatsappApplication/index.js",
36001 "groupTitle": "Whatsapp_Applications"
36005 "url": "/api/whatsapp/applications/{id}",
36006 "title": "Update an existing Application",
36009 "title": "Example usage:",
36010 "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",
36014 "name": "updateApplications",
36015 "group": "Whatsapp_Applications",
36016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36017 "version": "0.0.0",
36018 "filename": "server/api/whatsappApplication/index.js",
36019 "groupTitle": "Whatsapp_Applications"
36023 "url": "/api/whatsapp/interactions/{id}/tags",
36024 "title": "Add tags to the interaction",
36027 "title": "Example usage:",
36028 "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",
36033 "group": "Whatsapp_Interactions",
36034 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36035 "version": "0.0.0",
36036 "filename": "server/api/whatsappInteraction/index.js",
36037 "groupTitle": "Whatsapp_Interactions"
36041 "url": "/api/whatsapp/interactions",
36042 "title": "Creates a new Interaction",
36045 "title": "Example usage:",
36046 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36050 "name": "CreateInteractions",
36051 "group": "Whatsapp_Interactions",
36066 "field": "closedAt",
36073 "field": "disposition",
36080 "field": "secondDisposition",
36087 "field": "thirdDisposition",
36108 "field": "read1stAt",
36119 "field": "firstMsgDirection",
36126 "field": "lastMsgAt",
36137 "field": "lastMsgDirection",
36144 "field": "autoreplyExecuted",
36150 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36151 "version": "0.0.0",
36152 "filename": "server/api/whatsappInteraction/index.js",
36153 "groupTitle": "Whatsapp_Interactions"
36157 "url": "/api/whatsapp/interactions/{id}",
36158 "title": "Deletes a Interaction",
36161 "title": "Example usage:",
36162 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
36166 "name": "DeleteInteractions",
36167 "group": "Whatsapp_Interactions",
36168 "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>",
36169 "version": "0.0.0",
36170 "filename": "server/api/whatsappInteraction/index.js",
36171 "groupTitle": "Whatsapp_Interactions"
36175 "url": "/api/whatsapp/interactions/describe",
36176 "title": "Gets table info about Interactions",
36179 "title": "Example usage:",
36180 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
36184 "name": "DescribeInteractions",
36185 "group": "Whatsapp_Interactions",
36186 "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>",
36187 "version": "0.0.0",
36188 "filename": "server/api/whatsappInteraction/index.js",
36189 "groupTitle": "Whatsapp_Interactions"
36193 "url": "/api/whatsapp/interactions",
36194 "title": "Gets a list of Interactions",
36197 "title": "Example usage:",
36198 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
36202 "name": "GetInteractions",
36203 "group": "Whatsapp_Interactions",
36204 "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>",
36205 "version": "0.0.0",
36206 "filename": "server/api/whatsappInteraction/index.js",
36207 "groupTitle": "Whatsapp_Interactions"
36211 "url": "/api/whatsapp/interactions/{id}/tags",
36212 "title": "Removes tags from interaction",
36215 "title": "Example usage:",
36216 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36220 "name": "RemoveTags",
36221 "group": "Whatsapp_Interactions",
36222 "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>",
36223 "version": "0.0.0",
36224 "filename": "server/api/whatsappInteraction/index.js",
36225 "groupTitle": "Whatsapp_Interactions"
36229 "url": "/api/whatsapp/interactions/{id}",
36230 "title": "Gets a single Interaction",
36233 "title": "Example usage:",
36234 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
36238 "name": "ShowInteractions",
36239 "group": "Whatsapp_Interactions",
36240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36241 "version": "0.0.0",
36242 "filename": "server/api/whatsappInteraction/index.js",
36243 "groupTitle": "Whatsapp_Interactions"
36247 "url": "/api/whatsapp/interactions/{id}/messages",
36248 "title": "Creates new messages",
36251 "title": "Example usage:",
36252 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36256 "name": "addMessage",
36257 "group": "Whatsapp_Interactions",
36283 "field": "direction",
36290 "field": "messageId",
36318 "field": "providerName",
36325 "field": "providerResponse",
36331 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36332 "version": "0.0.0",
36333 "filename": "server/api/whatsappInteraction/index.js",
36334 "groupTitle": "Whatsapp_Interactions"
36338 "url": "/api/whatsapp/interactions/{id}/download",
36339 "title": "Gets interaction",
36342 "title": "Example usage:",
36343 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
36347 "name": "download",
36348 "group": "Whatsapp_Interactions",
36349 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36350 "version": "0.0.0",
36351 "filename": "server/api/whatsappInteraction/index.js",
36352 "groupTitle": "Whatsapp_Interactions"
36356 "url": "/api/whatsapp/interactions/{id}/messages",
36357 "title": "Gets interaction messages",
36360 "title": "Example usage:",
36361 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
36365 "name": "getMessages",
36366 "group": "Whatsapp_Interactions",
36367 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36368 "version": "0.0.0",
36369 "filename": "server/api/whatsappInteraction/index.js",
36370 "groupTitle": "Whatsapp_Interactions"
36374 "url": "/api/whatsapp/interactions/{id}",
36375 "title": "Update an existing Interaction",
36378 "title": "Example usage:",
36379 "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",
36383 "name": "updateInteractions",
36384 "group": "Whatsapp_Interactions",
36385 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36386 "version": "0.0.0",
36387 "filename": "server/api/whatsappInteraction/index.js",
36388 "groupTitle": "Whatsapp_Interactions"
36392 "url": "/api/whatsapp/messages",
36393 "title": "Creates a new Message",
36396 "title": "Example usage:",
36397 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36401 "name": "CreateMessages",
36402 "group": "Whatsapp_Messages",
36428 "field": "direction",
36435 "field": "messageId",
36463 "field": "providerName",
36470 "field": "providerResponse",
36476 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36477 "version": "0.0.0",
36478 "filename": "server/api/whatsappMessage/index.js",
36479 "groupTitle": "Whatsapp_Messages"
36483 "url": "/api/whatsapp/messages/{id}",
36484 "title": "Deletes a Message",
36487 "title": "Example usage:",
36488 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
36492 "name": "DeleteMessages",
36493 "group": "Whatsapp_Messages",
36494 "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>",
36495 "version": "0.0.0",
36496 "filename": "server/api/whatsappMessage/index.js",
36497 "groupTitle": "Whatsapp_Messages"
36501 "url": "/api/whatsapp/messages/describe",
36502 "title": "Gets table info about Messages",
36505 "title": "Example usage:",
36506 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
36510 "name": "DescribeMessages",
36511 "group": "Whatsapp_Messages",
36512 "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>",
36513 "version": "0.0.0",
36514 "filename": "server/api/whatsappMessage/index.js",
36515 "groupTitle": "Whatsapp_Messages"
36519 "url": "/api/whatsapp/messages",
36520 "title": "Gets a list of Messages",
36523 "title": "Example usage:",
36524 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
36528 "name": "GetMessages",
36529 "group": "Whatsapp_Messages",
36530 "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>",
36531 "version": "0.0.0",
36532 "filename": "server/api/whatsappMessage/index.js",
36533 "groupTitle": "Whatsapp_Messages"
36537 "url": "/api/whatsapp/messages/{id}",
36538 "title": "Gets a single Message",
36541 "title": "Example usage:",
36542 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
36546 "name": "ShowMessages",
36547 "group": "Whatsapp_Messages",
36548 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36549 "version": "0.0.0",
36550 "filename": "server/api/whatsappMessage/index.js",
36551 "groupTitle": "Whatsapp_Messages"
36555 "url": "/api/whatsapp/messages/{id}",
36556 "title": "Update an existing Message",
36559 "title": "Example usage:",
36560 "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",
36564 "name": "updateMessages",
36565 "group": "Whatsapp_Messages",
36566 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36567 "version": "0.0.0",
36568 "filename": "server/api/whatsappMessage/index.js",
36569 "groupTitle": "Whatsapp_Messages"
36573 "url": "/api/whatsapp/reports/queue",
36574 "title": "Creates a new Whatsapp Queue Report",
36577 "title": "Example usage:",
36578 "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",
36582 "name": "CreateWhatsapp_Queue_Reports",
36583 "group": "Whatsapp_Queue_Reports",
36591 "field": "uniqueid",
36612 "field": "leaveAt",
36619 "field": "acceptAt",
36639 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36640 "version": "0.0.0",
36641 "filename": "server/api/whatsappQueueReport/index.js",
36642 "groupTitle": "Whatsapp_Queue_Reports"
36646 "url": "/api/whatsapp/reports/queue/{id}",
36647 "title": "Deletes a Whatsapp Queue Report",
36650 "title": "Example usage:",
36651 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36655 "name": "DeleteWhatsapp_Queue_Reports",
36656 "group": "Whatsapp_Queue_Reports",
36657 "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>",
36658 "version": "0.0.0",
36659 "filename": "server/api/whatsappQueueReport/index.js",
36660 "groupTitle": "Whatsapp_Queue_Reports"
36664 "url": "/api/whatsapp/reports/queue/describe",
36665 "title": "Gets table info about Whatsapp Queue Reports",
36668 "title": "Example usage:",
36669 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36673 "name": "DescribeWhatsapp_Queue_Reports",
36674 "group": "Whatsapp_Queue_Reports",
36675 "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>",
36676 "version": "0.0.0",
36677 "filename": "server/api/whatsappQueueReport/index.js",
36678 "groupTitle": "Whatsapp_Queue_Reports"
36682 "url": "/api/whatsapp/reports/queue",
36683 "title": "Gets a list of Whatsapp Queue Reports",
36686 "title": "Example usage:",
36687 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36691 "name": "GetWhatsapp_Queue_Reports",
36692 "group": "Whatsapp_Queue_Reports",
36693 "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>",
36694 "version": "0.0.0",
36695 "filename": "server/api/whatsappQueueReport/index.js",
36696 "groupTitle": "Whatsapp_Queue_Reports"
36700 "url": "/api/whatsapp/reports/queue/{id}",
36701 "title": "Gets a single Whatsapp Queue Report",
36704 "title": "Example usage:",
36705 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36709 "name": "ShowWhatsapp_Queue_Reports",
36710 "group": "Whatsapp_Queue_Reports",
36711 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36712 "version": "0.0.0",
36713 "filename": "server/api/whatsappQueueReport/index.js",
36714 "groupTitle": "Whatsapp_Queue_Reports"
36718 "url": "/api/whatsapp/reports/queue/{id}",
36719 "title": "Update an existing Whatsapp Queue Report",
36722 "title": "Example usage:",
36723 "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",
36727 "name": "updateWhatsapp_Queue_Reports",
36728 "group": "Whatsapp_Queue_Reports",
36729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36730 "version": "0.0.0",
36731 "filename": "server/api/whatsappQueueReport/index.js",
36732 "groupTitle": "Whatsapp_Queue_Reports"
36736 "url": "/api/whatsapp/queues/{id}/users",
36737 "title": "Add agents to a queue",
36740 "title": "Example usage:",
36741 "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",
36745 "name": "AddAgents",
36746 "group": "Whatsapp_Queues",
36747 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36748 "version": "0.0.0",
36749 "filename": "server/api/whatsappQueue/index.js",
36750 "groupTitle": "Whatsapp_Queues"
36754 "url": "/api/whatsapp/queues/{id}/teams",
36755 "title": "Add teams to a queue",
36758 "title": "Example usage:",
36759 "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",
36763 "name": "AddTeams",
36764 "group": "Whatsapp_Queues",
36765 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36766 "version": "0.0.0",
36767 "filename": "server/api/whatsappQueue/index.js",
36768 "groupTitle": "Whatsapp_Queues"
36772 "url": "/api/whatsapp/queues",
36773 "title": "Creates a new Queue",
36776 "title": "Example usage:",
36777 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36781 "name": "CreateQueues",
36782 "group": "Whatsapp_Queues",
36797 "field": "timeout",
36809 "field": "strategy",
36816 "field": "description",
36822 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36823 "version": "0.0.0",
36824 "filename": "server/api/whatsappQueue/index.js",
36825 "groupTitle": "Whatsapp_Queues"
36829 "url": "/api/whatsapp/queues/{id}",
36830 "title": "Deletes a Queue",
36833 "title": "Example usage:",
36834 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36838 "name": "DeleteQueues",
36839 "group": "Whatsapp_Queues",
36840 "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>",
36841 "version": "0.0.0",
36842 "filename": "server/api/whatsappQueue/index.js",
36843 "groupTitle": "Whatsapp_Queues"
36847 "url": "/api/whatsapp/queues/describe",
36848 "title": "Gets table info about Queues",
36851 "title": "Example usage:",
36852 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36856 "name": "DescribeQueues",
36857 "group": "Whatsapp_Queues",
36858 "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>",
36859 "version": "0.0.0",
36860 "filename": "server/api/whatsappQueue/index.js",
36861 "groupTitle": "Whatsapp_Queues"
36865 "url": "/api/whatsapp/queues/{id}/users",
36866 "title": "Gets queue agents",
36869 "title": "Example usage:",
36870 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36874 "name": "GetAgents",
36875 "group": "Whatsapp_Queues",
36876 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36877 "version": "0.0.0",
36878 "filename": "server/api/whatsappQueue/index.js",
36879 "groupTitle": "Whatsapp_Queues"
36883 "url": "/api/whatsapp/queues/{id}/members",
36884 "title": "GetMembers",
36887 "title": "Example usage:",
36888 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
36892 "name": "GetMembers",
36893 "group": "Whatsapp_Queues",
36894 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36895 "version": "0.0.0",
36896 "filename": "server/api/whatsappQueue/index.js",
36897 "groupTitle": "Whatsapp_Queues"
36901 "url": "/api/whatsapp/queues",
36902 "title": "Gets a list of Queues",
36905 "title": "Example usage:",
36906 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36910 "name": "GetQueues",
36911 "group": "Whatsapp_Queues",
36912 "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>",
36913 "version": "0.0.0",
36914 "filename": "server/api/whatsappQueue/index.js",
36915 "groupTitle": "Whatsapp_Queues"
36919 "url": "/api/whatsapp/queues/{id}/teams",
36920 "title": "Gets queues list",
36923 "title": "Example usage:",
36924 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36928 "name": "GetTeams",
36929 "group": "Whatsapp_Queues",
36930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36931 "version": "0.0.0",
36932 "filename": "server/api/whatsappQueue/index.js",
36933 "groupTitle": "Whatsapp_Queues"
36937 "url": "/api/whatsapp/queues/{id}/users",
36938 "title": "Removes agents from a queue",
36941 "title": "Example usage:",
36942 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36946 "name": "RemoveAgents",
36947 "group": "Whatsapp_Queues",
36948 "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>",
36949 "version": "0.0.0",
36950 "filename": "server/api/whatsappQueue/index.js",
36951 "groupTitle": "Whatsapp_Queues"
36955 "url": "/api/whatsapp/queues/{id}",
36956 "title": "Gets a single Queue",
36959 "title": "Example usage:",
36960 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36964 "name": "ShowQueues",
36965 "group": "Whatsapp_Queues",
36966 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36967 "version": "0.0.0",
36968 "filename": "server/api/whatsappQueue/index.js",
36969 "groupTitle": "Whatsapp_Queues"
36973 "url": "/api/whatsapp/queues/{id}",
36974 "title": "Update an existing Queue",
36977 "title": "Example usage:",
36978 "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",
36982 "name": "updateQueues",
36983 "group": "Whatsapp_Queues",
36984 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36985 "version": "0.0.0",
36986 "filename": "server/api/whatsappQueue/index.js",
36987 "groupTitle": "Whatsapp_Queues"
36991 "url": "/api/whatsapp/reports/transfer",
36992 "title": "Creates a new Whatsapp Transfer Report",
36995 "title": "Example usage:",
36996 "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",
37000 "name": "CreateWhatsapp_Transfer_Reports",
37001 "group": "Whatsapp_Transfer_Reports",
37009 "field": "uniqueid",
37028 "field": "transferredAt",
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/whatsappTransferReport/index.js",
37037 "groupTitle": "Whatsapp_Transfer_Reports"
37041 "url": "/api/whatsapp/reports/transfer/{id}",
37042 "title": "Deletes a Whatsapp Transfer Report",
37045 "title": "Example usage:",
37046 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
37050 "name": "DeleteWhatsapp_Transfer_Reports",
37051 "group": "Whatsapp_Transfer_Reports",
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/whatsappTransferReport/index.js",
37055 "groupTitle": "Whatsapp_Transfer_Reports"
37059 "url": "/api/whatsapp/reports/transfer/describe",
37060 "title": "Gets table info about Whatsapp Transfer Reports",
37063 "title": "Example usage:",
37064 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
37068 "name": "DescribeWhatsapp_Transfer_Reports",
37069 "group": "Whatsapp_Transfer_Reports",
37070 "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>",
37071 "version": "0.0.0",
37072 "filename": "server/api/whatsappTransferReport/index.js",
37073 "groupTitle": "Whatsapp_Transfer_Reports"
37077 "url": "/api/whatsapp/reports/transfer",
37078 "title": "Gets a list of Whatsapp Transfer Reports",
37081 "title": "Example usage:",
37082 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
37086 "name": "GetWhatsapp_Transfer_Reports",
37087 "group": "Whatsapp_Transfer_Reports",
37088 "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>",
37089 "version": "0.0.0",
37090 "filename": "server/api/whatsappTransferReport/index.js",
37091 "groupTitle": "Whatsapp_Transfer_Reports"
37095 "url": "/api/whatsapp/reports/transfer/{id}",
37096 "title": "Gets a single Whatsapp Transfer Report",
37099 "title": "Example usage:",
37100 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
37104 "name": "ShowWhatsapp_Transfer_Reports",
37105 "group": "Whatsapp_Transfer_Reports",
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/whatsappTransferReport/index.js",
37109 "groupTitle": "Whatsapp_Transfer_Reports"
37113 "url": "/api/whatsapp/reports/transfer/{id}",
37114 "title": "Update an existing Whatsapp Transfer Report",
37117 "title": "Example usage:",
37118 "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",
37122 "name": "updateWhatsapp_Transfer_Reports",
37123 "group": "Whatsapp_Transfer_Reports",
37124 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37125 "version": "0.0.0",
37126 "filename": "server/api/whatsappTransferReport/index.js",
37127 "groupTitle": "Whatsapp_Transfer_Reports"
37131 "url": "/api/integrations/zendesk/accounts",
37132 "title": "Creates a new Zendesk Account",
37135 "title": "Example usage:",
37136 "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",
37140 "name": "CreateZendesk_Accounts",
37141 "group": "Zendesk_Accounts",
37156 "field": "description",
37163 "field": "username",
37170 "field": "password",
37184 "field": "remoteUri",
37195 "field": "authType",
37202 "field": "serverUrl",
37209 "\"integrationTab\"",
37219 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37220 "version": "0.0.0",
37221 "filename": "server/api/intZendeskAccount/index.js",
37222 "groupTitle": "Zendesk_Accounts"
37226 "url": "/api/integrations/zendesk/accounts/{id}",
37227 "title": "Deletes a Zendesk Account",
37230 "title": "Example usage:",
37231 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
37235 "name": "DeleteZendesk_Accounts",
37236 "group": "Zendesk_Accounts",
37237 "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>",
37238 "version": "0.0.0",
37239 "filename": "server/api/intZendeskAccount/index.js",
37240 "groupTitle": "Zendesk_Accounts"
37244 "url": "/api/integrations/zendesk/accounts",
37245 "title": "Gets a list of Zendesk Accounts",
37248 "title": "Example usage:",
37249 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
37253 "name": "GetZendesk_Accounts",
37254 "group": "Zendesk_Accounts",
37255 "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>",
37256 "version": "0.0.0",
37257 "filename": "server/api/intZendeskAccount/index.js",
37258 "groupTitle": "Zendesk_Accounts"
37262 "url": "/api/integrations/zendesk/accounts/{id}",
37263 "title": "Gets a single Zendesk Account",
37266 "title": "Example usage:",
37267 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
37271 "name": "ShowZendesk_Accounts",
37272 "group": "Zendesk_Accounts",
37273 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37274 "version": "0.0.0",
37275 "filename": "server/api/intZendeskAccount/index.js",
37276 "groupTitle": "Zendesk_Accounts"
37280 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37281 "title": "Creates new configuration",
37284 "title": "Example usage:",
37285 "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",
37289 "name": "addConfiguration",
37290 "group": "Zendesk_Accounts",
37291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37292 "version": "0.0.0",
37293 "filename": "server/api/intZendeskAccount/index.js",
37294 "groupTitle": "Zendesk_Accounts"
37298 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37299 "title": "Gets account configurations",
37302 "title": "Example usage:",
37303 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37307 "name": "getConfigurations",
37308 "group": "Zendesk_Accounts",
37309 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37310 "version": "0.0.0",
37311 "filename": "server/api/intZendeskAccount/index.js",
37312 "groupTitle": "Zendesk_Accounts"
37316 "url": "/api/integrations/zendesk/accounts/{id}/fields",
37317 "title": "Gets account fields",
37320 "title": "Example usage:",
37321 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
37325 "name": "getFields",
37326 "group": "Zendesk_Accounts",
37327 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37328 "version": "0.0.0",
37329 "filename": "server/api/intZendeskAccount/index.js",
37330 "groupTitle": "Zendesk_Accounts"
37334 "url": "/api/integrations/zendesk/accounts/{id}",
37335 "title": "Update an existing Zendesk Account",
37338 "title": "Example usage:",
37339 "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",
37343 "name": "updateZendesk_Accounts",
37344 "group": "Zendesk_Accounts",
37345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37346 "version": "0.0.0",
37347 "filename": "server/api/intZendeskAccount/index.js",
37348 "groupTitle": "Zendesk_Accounts"
37352 "url": "/api/integrations/zendesk/configurations",
37353 "title": "Creates a new Zendesk Configuration",
37356 "title": "Example usage:",
37357 "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",
37361 "name": "CreateZendesk_Configurations",
37362 "group": "Zendesk_Configurations",
37377 "field": "description",
37383 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37384 "version": "0.0.0",
37385 "filename": "server/api/intZendeskConfiguration/index.js",
37386 "groupTitle": "Zendesk_Configurations"
37390 "url": "/api/integrations/zendesk/configurations/{id}",
37391 "title": "Deletes a Zendesk Configuration",
37394 "title": "Example usage:",
37395 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
37399 "name": "DeleteZendesk_Configurations",
37400 "group": "Zendesk_Configurations",
37401 "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>",
37402 "version": "0.0.0",
37403 "filename": "server/api/intZendeskConfiguration/index.js",
37404 "groupTitle": "Zendesk_Configurations"
37408 "url": "/api/integrations/zendesk/configurations",
37409 "title": "Gets a list of Zendesk Configurations",
37412 "title": "Example usage:",
37413 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
37417 "name": "GetZendesk_Configurations",
37418 "group": "Zendesk_Configurations",
37419 "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>",
37420 "version": "0.0.0",
37421 "filename": "server/api/intZendeskConfiguration/index.js",
37422 "groupTitle": "Zendesk_Configurations"
37426 "url": "/api/integrations/zendesk/configurations/{id}",
37427 "title": "Gets a single Zendesk Configuration",
37430 "title": "Example usage:",
37431 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
37435 "name": "ShowZendesk_Configurations",
37436 "group": "Zendesk_Configurations",
37437 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37438 "version": "0.0.0",
37439 "filename": "server/api/intZendeskConfiguration/index.js",
37440 "groupTitle": "Zendesk_Configurations"
37444 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
37445 "title": "Gets configurations descriptions",
37448 "title": "Example usage:",
37449 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37453 "name": "getDescriptions",
37454 "group": "Zendesk_Configurations",
37455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37456 "version": "0.0.0",
37457 "filename": "server/api/intZendeskConfiguration/index.js",
37458 "groupTitle": "Zendesk_Configurations"
37462 "url": "/api/integrations/zendesk/configurations/{id}/fields",
37463 "title": "Gets configurations fields",
37466 "title": "Example usage:",
37467 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
37471 "name": "getFields",
37472 "group": "Zendesk_Configurations",
37473 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37474 "version": "0.0.0",
37475 "filename": "server/api/intZendeskConfiguration/index.js",
37476 "groupTitle": "Zendesk_Configurations"
37480 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
37481 "title": "Gets configurations subjects",
37484 "title": "Example usage:",
37485 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37489 "name": "getSubjects",
37490 "group": "Zendesk_Configurations",
37491 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37492 "version": "0.0.0",
37493 "filename": "server/api/intZendeskConfiguration/index.js",
37494 "groupTitle": "Zendesk_Configurations"
37498 "url": "/api/integrations/zendesk/configurations/{id}/tags",
37499 "title": "Gets configurations tags",
37502 "title": "Example usage:",
37503 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
37508 "group": "Zendesk_Configurations",
37509 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37510 "version": "0.0.0",
37511 "filename": "server/api/intZendeskConfiguration/index.js",
37512 "groupTitle": "Zendesk_Configurations"
37516 "url": "/api/integrations/zendesk/configurations/{id}/tags",
37517 "title": "Sets new tags",
37520 "title": "Example usage:",
37521 "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",
37526 "group": "Zendesk_Configurations",
37527 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37528 "version": "0.0.0",
37529 "filename": "server/api/intZendeskConfiguration/index.js",
37530 "groupTitle": "Zendesk_Configurations"
37534 "url": "/api/integrations/zendesk/configurations/{id}",
37535 "title": "Update an existing Zendesk Configuration",
37538 "title": "Example usage:",
37539 "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",
37543 "name": "updateZendesk_Configurations",
37544 "group": "Zendesk_Configurations",
37545 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37546 "version": "0.0.0",
37547 "filename": "server/api/intZendeskConfiguration/index.js",
37548 "groupTitle": "Zendesk_Configurations"
37552 "url": "/api/integrations/zendesk/fields",
37553 "title": "Creates a new Zendesk Field",
37556 "title": "Example usage:",
37557 "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",
37561 "name": "CreateZendesk_Fields",
37562 "group": "Zendesk_Fields",
37572 "\"customVariable\"",
37584 "field": "content",
37600 "\"customVariable\""
37603 "field": "keyType",
37610 "field": "keyContent",
37617 "field": "idField",
37624 "field": "nameField",
37631 "field": "customField",
37638 "field": "variableName",
37644 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37645 "version": "0.0.0",
37646 "filename": "server/api/intZendeskField/index.js",
37647 "groupTitle": "Zendesk_Fields"
37651 "url": "/api/integrations/zendesk/fields/{id}",
37652 "title": "Deletes a Zendesk Field",
37655 "title": "Example usage:",
37656 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37660 "name": "DeleteZendesk_Fields",
37661 "group": "Zendesk_Fields",
37662 "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>",
37663 "version": "0.0.0",
37664 "filename": "server/api/intZendeskField/index.js",
37665 "groupTitle": "Zendesk_Fields"
37669 "url": "/api/integrations/zendesk/fields",
37670 "title": "Gets a list of Zendesk Fields",
37673 "title": "Example usage:",
37674 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37678 "name": "GetZendesk_Fields",
37679 "group": "Zendesk_Fields",
37680 "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>",
37681 "version": "0.0.0",
37682 "filename": "server/api/intZendeskField/index.js",
37683 "groupTitle": "Zendesk_Fields"
37687 "url": "/api/integrations/zendesk/fields/{id}",
37688 "title": "Gets a single Zendesk Field",
37691 "title": "Example usage:",
37692 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37696 "name": "ShowZendesk_Fields",
37697 "group": "Zendesk_Fields",
37698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37699 "version": "0.0.0",
37700 "filename": "server/api/intZendeskField/index.js",
37701 "groupTitle": "Zendesk_Fields"
37705 "url": "/api/integrations/zendesk/fields/{id}",
37706 "title": "Update an existing Zendesk Field",
37709 "title": "Example usage:",
37710 "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",
37714 "name": "updateZendesk_Fields",
37715 "group": "Zendesk_Fields",
37716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37717 "version": "0.0.0",
37718 "filename": "server/api/intZendeskField/index.js",
37719 "groupTitle": "Zendesk_Fields"
37723 "url": "/api/integrations/zoho/accounts",
37724 "title": "Creates a new Zoho Account",
37727 "title": "Example usage:",
37728 "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",
37732 "name": "CreateZoho_Accounts",
37733 "group": "Zoho_Accounts",
37748 "field": "description",
37769 "field": "clientId",
37776 "field": "clientSecret",
37783 "field": "serverUrl",
37797 "field": "refreshToken",
37803 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37804 "version": "0.0.0",
37805 "filename": "server/api/intZohoAccount/index.js",
37806 "groupTitle": "Zoho_Accounts"
37810 "url": "/api/integrations/zoho/accounts/{id}",
37811 "title": "Deletes a Zoho Account",
37814 "title": "Example usage:",
37815 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37819 "name": "DeleteZoho_Accounts",
37820 "group": "Zoho_Accounts",
37821 "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>",
37822 "version": "0.0.0",
37823 "filename": "server/api/intZohoAccount/index.js",
37824 "groupTitle": "Zoho_Accounts"
37828 "url": "/api/integrations/zoho/accounts",
37829 "title": "Gets a list of Zoho Accounts",
37832 "title": "Example usage:",
37833 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37837 "name": "GetZoho_Accounts",
37838 "group": "Zoho_Accounts",
37839 "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>",
37840 "version": "0.0.0",
37841 "filename": "server/api/intZohoAccount/index.js",
37842 "groupTitle": "Zoho_Accounts"
37846 "url": "/api/integrations/zoho/accounts/{id}",
37847 "title": "Gets a single Zoho Account",
37850 "title": "Example usage:",
37851 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37855 "name": "ShowZoho_Accounts",
37856 "group": "Zoho_Accounts",
37857 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37858 "version": "0.0.0",
37859 "filename": "server/api/intZohoAccount/index.js",
37860 "groupTitle": "Zoho_Accounts"
37864 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37865 "title": "Creates new configuration",
37868 "title": "Example usage:",
37869 "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",
37873 "name": "addConfiguration",
37874 "group": "Zoho_Accounts",
37875 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37876 "version": "0.0.0",
37877 "filename": "server/api/intZohoAccount/index.js",
37878 "groupTitle": "Zoho_Accounts"
37882 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37883 "title": "Gets account configurations",
37886 "title": "Example usage:",
37887 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37891 "name": "getConfigurations",
37892 "group": "Zoho_Accounts",
37893 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37894 "version": "0.0.0",
37895 "filename": "server/api/intZohoAccount/index.js",
37896 "groupTitle": "Zoho_Accounts"
37900 "url": "/api/integrations/zoho/accounts/{id}/fields",
37901 "title": "Gets account fields",
37904 "title": "Example usage:",
37905 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37909 "name": "getFields",
37910 "group": "Zoho_Accounts",
37911 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37912 "version": "0.0.0",
37913 "filename": "server/api/intZohoAccount/index.js",
37914 "groupTitle": "Zoho_Accounts"
37918 "url": "/api/integrations/zoho/accounts/{id}",
37919 "title": "Update an existing Zoho Account",
37922 "title": "Example usage:",
37923 "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",
37927 "name": "updateZoho_Accounts",
37928 "group": "Zoho_Accounts",
37929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37930 "version": "0.0.0",
37931 "filename": "server/api/intZohoAccount/index.js",
37932 "groupTitle": "Zoho_Accounts"
37936 "url": "/api/integrations/zoho/configurations",
37937 "title": "Creates a new Zoho Configuration",
37940 "title": "Example usage:",
37941 "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",
37945 "name": "CreateZoho_Configurations",
37946 "group": "Zoho_Configurations",
37966 "field": "moduleCreate",
37973 "\"contact_lead\"",
37978 "field": "moduleSearch",
37985 "field": "description",
37991 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37992 "version": "0.0.0",
37993 "filename": "server/api/intZohoConfiguration/index.js",
37994 "groupTitle": "Zoho_Configurations"
37998 "url": "/api/integrations/zoho/configurations/{id}",
37999 "title": "Deletes a Zoho Configuration",
38002 "title": "Example usage:",
38003 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
38007 "name": "DeleteZoho_Configurations",
38008 "group": "Zoho_Configurations",
38009 "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>",
38010 "version": "0.0.0",
38011 "filename": "server/api/intZohoConfiguration/index.js",
38012 "groupTitle": "Zoho_Configurations"
38016 "url": "/api/integrations/zoho/configurations",
38017 "title": "Gets a list of Zoho Configurations",
38020 "title": "Example usage:",
38021 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
38025 "name": "GetZoho_Configurations",
38026 "group": "Zoho_Configurations",
38027 "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>",
38028 "version": "0.0.0",
38029 "filename": "server/api/intZohoConfiguration/index.js",
38030 "groupTitle": "Zoho_Configurations"
38034 "url": "/api/integrations/zoho/configurations/{id}",
38035 "title": "Gets a single Zoho Configuration",
38038 "title": "Example usage:",
38039 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
38043 "name": "ShowZoho_Configurations",
38044 "group": "Zoho_Configurations",
38045 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38046 "version": "0.0.0",
38047 "filename": "server/api/intZohoConfiguration/index.js",
38048 "groupTitle": "Zoho_Configurations"
38052 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
38053 "title": "Gets configurations descriptions",
38056 "title": "Example usage:",
38057 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
38061 "name": "getDescriptions",
38062 "group": "Zoho_Configurations",
38063 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38064 "version": "0.0.0",
38065 "filename": "server/api/intZohoConfiguration/index.js",
38066 "groupTitle": "Zoho_Configurations"
38070 "url": "/api/integrations/zoho/configurations/{id}/fields",
38071 "title": "Gets configurations fields",
38074 "title": "Example usage:",
38075 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
38079 "name": "getFields",
38080 "group": "Zoho_Configurations",
38081 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38082 "version": "0.0.0",
38083 "filename": "server/api/intZohoConfiguration/index.js",
38084 "groupTitle": "Zoho_Configurations"
38088 "url": "/api/integrations/zoho/configurations/{id}/subjects",
38089 "title": "Gets configurations subjects",
38092 "title": "Example usage:",
38093 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
38097 "name": "getSubjects",
38098 "group": "Zoho_Configurations",
38099 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38100 "version": "0.0.0",
38101 "filename": "server/api/intZohoConfiguration/index.js",
38102 "groupTitle": "Zoho_Configurations"
38106 "url": "/api/integrations/zoho/configurations/{id}",
38107 "title": "Update an existing Zoho Configuration",
38110 "title": "Example usage:",
38111 "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",
38115 "name": "updateZoho_Configurations",
38116 "group": "Zoho_Configurations",
38117 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38118 "version": "0.0.0",
38119 "filename": "server/api/intZohoConfiguration/index.js",
38120 "groupTitle": "Zoho_Configurations"
38124 "url": "/api/integrations/zoho/fields",
38125 "title": "Creates a new Zoho Field",
38128 "title": "Example usage:",
38129 "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",
38133 "name": "CreateZoho_Fields",
38134 "group": "Zoho_Fields",
38144 "\"customVariable\"",
38156 "field": "content",
38172 "\"customVariable\""
38175 "field": "keyType",
38182 "field": "keyContent",
38189 "field": "idField",
38196 "field": "nameField",
38203 "field": "customField",
38210 "field": "variableName",
38216 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38217 "version": "0.0.0",
38218 "filename": "server/api/intZohoField/index.js",
38219 "groupTitle": "Zoho_Fields"
38223 "url": "/api/integrations/zoho/fields/{id}",
38224 "title": "Deletes a Zoho Field",
38227 "title": "Example usage:",
38228 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
38232 "name": "DeleteZoho_Fields",
38233 "group": "Zoho_Fields",
38234 "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>",
38235 "version": "0.0.0",
38236 "filename": "server/api/intZohoField/index.js",
38237 "groupTitle": "Zoho_Fields"
38241 "url": "/api/integrations/zoho/fields",
38242 "title": "Gets a list of Zoho Fields",
38245 "title": "Example usage:",
38246 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
38250 "name": "GetZoho_Fields",
38251 "group": "Zoho_Fields",
38252 "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>",
38253 "version": "0.0.0",
38254 "filename": "server/api/intZohoField/index.js",
38255 "groupTitle": "Zoho_Fields"
38259 "url": "/api/integrations/zoho/fields/{id}",
38260 "title": "Gets a single Zoho Field",
38263 "title": "Example usage:",
38264 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
38268 "name": "ShowZoho_Fields",
38269 "group": "Zoho_Fields",
38270 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38271 "version": "0.0.0",
38272 "filename": "server/api/intZohoField/index.js",
38273 "groupTitle": "Zoho_Fields"
38277 "url": "/api/integrations/zoho/fields/{id}",
38278 "title": "Update an existing Zoho Field",
38281 "title": "Example usage:",
38282 "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",
38286 "name": "updateZoho_Fields",
38287 "group": "Zoho_Fields",
38288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38289 "version": "0.0.0",
38290 "filename": "server/api/intZohoField/index.js",
38291 "groupTitle": "Zoho_Fields"
38296 "title": "Creates a new Cdr",
38299 "title": "Example usage:",
38300 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38304 "name": "CreateCdrs",
38313 "field": "calldate",
38341 "field": "dcontext",
38348 "field": "channel",
38355 "field": "dstchannel",
38362 "field": "lastapp",
38369 "field": "lastdata",
38376 "field": "duration",
38383 "field": "billsec",
38390 "field": "disposition",
38397 "field": "amaflags",
38404 "field": "accountcode",
38411 "field": "userfield",
38418 "field": "uniqueid",
38425 "field": "linkedid",
38432 "field": "sequence",
38439 "field": "peeraccount",
38459 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38460 "version": "0.0.0",
38461 "filename": "server/api/cdr/index.js",
38462 "groupTitle": "cdr"
38466 "url": "/api/cdr/{id}",
38467 "title": "Deletes a Cdr",
38470 "title": "Example usage:",
38471 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
38475 "name": "DeleteCdrs",
38477 "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>",
38478 "version": "0.0.0",
38479 "filename": "server/api/cdr/index.js",
38480 "groupTitle": "cdr"
38484 "url": "/api/cdr/describe",
38485 "title": "Gets table info about Cdrs",
38488 "title": "Example usage:",
38489 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
38493 "name": "DescribeCdrs",
38495 "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>",
38496 "version": "0.0.0",
38497 "filename": "server/api/cdr/index.js",
38498 "groupTitle": "cdr"
38503 "title": "Gets a list of Cdrs",
38506 "title": "Example usage:",
38507 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
38513 "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>",
38514 "version": "0.0.0",
38515 "filename": "server/api/cdr/index.js",
38516 "groupTitle": "cdr"
38520 "url": "/api/cdr/{id}",
38521 "title": "Gets a single Cdr",
38524 "title": "Example usage:",
38525 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
38529 "name": "ShowCdrs",
38531 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38532 "version": "0.0.0",
38533 "filename": "server/api/cdr/index.js",
38534 "groupTitle": "cdr"
38538 "url": "/api/cdr/{id}",
38539 "title": "Update an existing Cdr",
38542 "title": "Example usage:",
38543 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38547 "name": "updateCdrs",
38549 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38550 "version": "0.0.0",
38551 "filename": "server/api/cdr/index.js",
38552 "groupTitle": "cdr"
38556 "url": "/api/voiceQueuesLog",
38557 "title": "Creates a new VoiceQueuesLog",
38560 "title": "Example usage:",
38561 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38565 "name": "CreateVoiceQueuesLogs",
38566 "group": "voiceQueuesLog",
38588 "field": "queuename",
38657 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38658 "version": "0.0.0",
38659 "filename": "server/api/voiceQueuesLog/index.js",
38660 "groupTitle": "voiceQueuesLog"
38664 "url": "/api/voiceQueuesLog/{id}",
38665 "title": "Deletes a VoiceQueuesLog",
38668 "title": "Example usage:",
38669 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38673 "name": "DeleteVoiceQueuesLogs",
38674 "group": "voiceQueuesLog",
38675 "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>",
38676 "version": "0.0.0",
38677 "filename": "server/api/voiceQueuesLog/index.js",
38678 "groupTitle": "voiceQueuesLog"
38682 "url": "/api/voiceQueuesLog",
38683 "title": "Gets a list of VoiceQueuesLogs",
38686 "title": "Example usage:",
38687 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38691 "name": "GetVoiceQueuesLogs",
38692 "group": "voiceQueuesLog",
38693 "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>",
38694 "version": "0.0.0",
38695 "filename": "server/api/voiceQueuesLog/index.js",
38696 "groupTitle": "voiceQueuesLog"
38700 "url": "/api/voiceQueuesLog/{id}",
38701 "title": "Gets a single VoiceQueuesLog",
38704 "title": "Example usage:",
38705 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38709 "name": "ShowVoiceQueuesLogs",
38710 "group": "voiceQueuesLog",
38711 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38712 "version": "0.0.0",
38713 "filename": "server/api/voiceQueuesLog/index.js",
38714 "groupTitle": "voiceQueuesLog"
38718 "url": "/api/voiceQueuesLog/{id}",
38719 "title": "Update an existing VoiceQueuesLog",
38722 "title": "Example usage:",
38723 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38727 "name": "updateVoiceQueuesLogs",
38728 "group": "voiceQueuesLog",
38729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38730 "version": "0.0.0",
38731 "filename": "server/api/voiceQueuesLog/index.js",
38732 "groupTitle": "voiceQueuesLog"