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}/close",
2501 "title": "Close Interaction",
2504 "title": "Example usage:",
2505 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2509 "name": "addMessage",
2510 "group": "Chat_Interactions",
2511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2513 "filename": "server/api/chatInteraction/index.js",
2514 "groupTitle": "Chat_Interactions"
2518 "url": "/api/chat/interactions/{id}/messages",
2519 "title": "Creates new messages",
2522 "title": "Example usage:",
2523 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2527 "name": "addMessage",
2528 "group": "Chat_Interactions",
2561 "field": "direction",
2575 "field": "providerName",
2582 "field": "providerResponse",
2588 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/companies",
5624 "title": "Creates a new Company",
5627 "title": "Example usage:",
5628 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5632 "name": "CreateCompanies",
5633 "group": "Cm_Companies",
5655 "field": "companyId",
5697 "field": "postalCode",
5725 "field": "emailDomain",
5739 "field": "sPostalCode",
5753 "field": "sCountry",
5760 "field": "description",
5766 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5768 "filename": "server/api/cmCompany/index.js",
5769 "groupTitle": "Cm_Companies"
5773 "url": "/api/cm/companies/{id}",
5774 "title": "Deletes a Company",
5777 "title": "Example usage:",
5778 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5782 "name": "DeleteCompanies",
5783 "group": "Cm_Companies",
5784 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5786 "filename": "server/api/cmCompany/index.js",
5787 "groupTitle": "Cm_Companies"
5791 "url": "/api/cm/companies/describe",
5792 "title": "Gets table info about Companies",
5795 "title": "Example usage:",
5796 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5800 "name": "DescribeCompanies",
5801 "group": "Cm_Companies",
5802 "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>",
5804 "filename": "server/api/cmCompany/index.js",
5805 "groupTitle": "Cm_Companies"
5809 "url": "/api/cm/companies",
5810 "title": "Gets a list of Companies",
5813 "title": "Example usage:",
5814 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5818 "name": "GetCompanies",
5819 "group": "Cm_Companies",
5820 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5822 "filename": "server/api/cmCompany/index.js",
5823 "groupTitle": "Cm_Companies"
5827 "url": "/api/cm/companies/{id}",
5828 "title": "Gets a single Company",
5831 "title": "Example usage:",
5832 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5836 "name": "ShowCompanies",
5837 "group": "Cm_Companies",
5838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5840 "filename": "server/api/cmCompany/index.js",
5841 "groupTitle": "Cm_Companies"
5845 "url": "/api/cm/companies/{id}/contacts",
5846 "title": "Creates new contacts",
5849 "title": "Example usage:",
5850 "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",
5854 "name": "addContacts",
5855 "group": "Cm_Companies",
5863 "field": "firstName",
5870 "field": "lastName",
5884 "field": "postalCode",
5905 "field": "dateOfBirth",
5912 "field": "description",
5954 "field": "facebook",
6010 "field": "telegram",
6024 "field": "priority",
6031 "field": "scheduledat",
6037 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6039 "filename": "server/api/cmCompany/index.js",
6040 "groupTitle": "Cm_Companies"
6044 "url": "/api/cm/companies/{id}/contacts",
6045 "title": "Gets List Contacts",
6048 "title": "Example usage:",
6049 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6053 "name": "getContacts",
6054 "group": "Cm_Companies",
6055 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6057 "filename": "server/api/cmCompany/index.js",
6058 "groupTitle": "Cm_Companies"
6062 "url": "/api/cm/companies/{id}",
6063 "title": "Update an existing Company",
6066 "title": "Example usage:",
6067 "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",
6071 "name": "updateCompanies",
6072 "group": "Cm_Companies",
6073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6075 "filename": "server/api/cmCompany/index.js",
6076 "groupTitle": "Cm_Companies"
6080 "url": "/api/cm/contacts/{id}",
6081 "title": "Deletes a Contact",
6084 "title": "Example usage:",
6085 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6089 "name": "DeleteContacts",
6090 "group": "Cm_Contacts",
6091 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6093 "filename": "server/api/cmContact/index.js",
6094 "groupTitle": "Cm_Contacts"
6098 "url": "/api/cm/contacts/describe",
6099 "title": "Gets table info about Contacts",
6102 "title": "Example usage:",
6103 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6107 "name": "DescribeContacts",
6108 "group": "Cm_Contacts",
6109 "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>",
6111 "filename": "server/api/cmContact/index.js",
6112 "groupTitle": "Cm_Contacts"
6116 "url": "/api/cm/contacts",
6117 "title": "Gets a list of Contacts",
6120 "title": "Example usage:",
6121 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6125 "name": "GetContacts",
6126 "group": "Cm_Contacts",
6127 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6129 "filename": "server/api/cmContact/index.js",
6130 "groupTitle": "Cm_Contacts"
6134 "url": "/api/cm/contacts/{id}/finals",
6135 "title": "Gets contact hopper finals",
6138 "title": "Example usage:",
6139 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6143 "name": "GetHopperFinals",
6144 "group": "Cm_Contacts",
6145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6147 "filename": "server/api/cmContact/index.js",
6148 "groupTitle": "Cm_Contacts"
6152 "url": "/api/cm/contacts/{id}/hopper_histories",
6153 "title": "Gets contact hopper histories",
6156 "title": "Example usage:",
6157 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6161 "name": "GetHopperHistories",
6162 "group": "Cm_Contacts",
6163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6165 "filename": "server/api/cmContact/index.js",
6166 "groupTitle": "Cm_Contacts"
6170 "url": "/api/cm/contacts/{id}/hoppers",
6171 "title": "Gets contact hoppers",
6174 "title": "Example usage:",
6175 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6179 "name": "GetHoppers",
6180 "group": "Cm_Contacts",
6181 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6183 "filename": "server/api/cmContact/index.js",
6184 "groupTitle": "Cm_Contacts"
6188 "url": "/api/cm/contacts/create_many",
6189 "title": "Create Contacts",
6192 "title": "Example usage:",
6193 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6197 "name": "bulkCreate",
6198 "group": "Cm_Contacts",
6199 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6201 "filename": "server/api/cmContact/index.js",
6202 "groupTitle": "Cm_Contacts"
6206 "url": "/api/cm/contacts",
6207 "title": "Create Contact",
6210 "title": "Example usage:",
6211 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6216 "group": "Cm_Contacts",
6217 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6219 "filename": "server/api/cmContact/index.js",
6220 "groupTitle": "Cm_Contacts"
6224 "url": "/api/cm/contacts/{id}/journey",
6225 "title": "Gets customer journey",
6228 "title": "Example usage:",
6229 "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
6233 "name": "getJourney",
6234 "group": "Cm_Contacts",
6235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6237 "filename": "server/api/cmContact/index.js",
6238 "groupTitle": "Cm_Contacts"
6242 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6243 "title": "Gets contact hopper blacks",
6246 "title": "Example usage:",
6247 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6251 "name": "getJscriptySessions",
6252 "group": "Cm_Contacts",
6253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6255 "filename": "server/api/cmContact/index.js",
6256 "groupTitle": "Cm_Contacts"
6260 "url": "/api/cm/contacts/{id}/tags",
6261 "title": "Gets configurations tags",
6264 "title": "Example usage:",
6265 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6270 "group": "Cm_Contacts",
6271 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6273 "filename": "server/api/cmContact/index.js",
6274 "groupTitle": "Cm_Contacts"
6278 "url": "/api/cm/contacts/merge",
6279 "title": "Merge Contact",
6282 "title": "Example usage:",
6283 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6288 "group": "Cm_Contacts",
6289 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6291 "filename": "server/api/cmContact/index.js",
6292 "groupTitle": "Cm_Contacts"
6296 "url": "/api/cm/contacts/{id}/tags",
6297 "title": "Sets new tags",
6300 "title": "Example usage:",
6301 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6306 "group": "Cm_Contacts",
6307 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6309 "filename": "server/api/cmContact/index.js",
6310 "groupTitle": "Cm_Contacts"
6314 "url": "/api/cm/contacts/{id}",
6315 "title": "Gets a single Contact",
6318 "title": "Example usage:",
6319 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6324 "group": "Cm_Contacts",
6325 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6327 "filename": "server/api/cmContact/index.js",
6328 "groupTitle": "Cm_Contacts"
6332 "url": "/api/cm/contacts/{id}",
6333 "title": "Update a single Contact",
6336 "title": "Example usage:",
6337 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6342 "group": "Cm_Contacts",
6343 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6345 "filename": "server/api/cmContact/index.js",
6346 "groupTitle": "Cm_Contacts"
6350 "url": "/api/cm/custom_fields/{id}",
6351 "title": "Deletes a Custom Field",
6354 "title": "Example usage:",
6355 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6359 "name": "DeleteCustom_Fields",
6360 "group": "Cm_Custom_Fields",
6361 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6363 "filename": "server/api/cmCustomField/index.js",
6364 "groupTitle": "Cm_Custom_Fields"
6368 "url": "/api/cm/custom_fields",
6369 "title": "Gets a list of Custom Fields",
6372 "title": "Example usage:",
6373 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6377 "name": "GetCustom_Fields",
6378 "group": "Cm_Custom_Fields",
6379 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6381 "filename": "server/api/cmCustomField/index.js",
6382 "groupTitle": "Cm_Custom_Fields"
6386 "url": "/api/cm/custom_fields/{id}",
6387 "title": "Gets a single Custom Field",
6390 "title": "Example usage:",
6391 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6395 "name": "ShowCustom_Fields",
6396 "group": "Cm_Custom_Fields",
6397 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6399 "filename": "server/api/cmCustomField/index.js",
6400 "groupTitle": "Cm_Custom_Fields"
6404 "url": "/api/cm/custom_fields/{id}",
6405 "title": "Update an existing Custom Field",
6408 "title": "Example usage:",
6409 "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",
6413 "name": "updateCustom_Fields",
6414 "group": "Cm_Custom_Fields",
6415 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6417 "filename": "server/api/cmCustomField/index.js",
6418 "groupTitle": "Cm_Custom_Fields"
6422 "url": "/api/cm/hopper",
6423 "title": "Creates a new Hopper",
6426 "title": "Example usage:",
6427 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6431 "name": "CreateHopper",
6432 "group": "Cm_Hopper",
6454 "field": "scheduledat",
6461 "field": "countbusyretry",
6468 "field": "countcongestionretry",
6475 "field": "countnoanswerretry",
6482 "field": "callback",
6489 "field": "callbackuniqueid",
6496 "field": "callbackat",
6503 "field": "priority",
6510 "field": "recallme",
6517 "field": "ContactId",
6538 "field": "VoiceQueueId",
6545 "field": "CampaignId",
6552 "field": "countnosuchnumberretry",
6559 "field": "countdropretry",
6566 "field": "countabandonedretry",
6573 "field": "countmachineretry",
6580 "field": "countagentrejectretry",
6587 "field": "dialTimezone",
6593 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6595 "filename": "server/api/cmHopper/index.js",
6596 "groupTitle": "Cm_Hopper"
6600 "url": "/api/cm/hopper/describe",
6601 "title": "Gets table info about Hopper",
6604 "title": "Example usage:",
6605 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6609 "name": "DescribeHopper",
6610 "group": "Cm_Hopper",
6611 "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>",
6613 "filename": "server/api/cmHopper/index.js",
6614 "groupTitle": "Cm_Hopper"
6618 "url": "/api/cm/hopper",
6619 "title": "Gets a list of Hopper",
6622 "title": "Example usage:",
6623 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6627 "name": "GetHopper",
6628 "group": "Cm_Hopper",
6629 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6631 "filename": "server/api/cmHopper/index.js",
6632 "groupTitle": "Cm_Hopper"
6636 "url": "/api/cm/hopper/{id}",
6637 "title": "Gets a single Hopper",
6640 "title": "Example usage:",
6641 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6645 "name": "ShowHopper",
6646 "group": "Cm_Hopper",
6647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6649 "filename": "server/api/cmHopper/index.js",
6650 "groupTitle": "Cm_Hopper"
6654 "url": "/api/cm/hopper_black/{id}",
6655 "title": "Deletes a Hopper Black",
6658 "title": "Example usage:",
6659 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6663 "name": "DeleteHopper_Black",
6664 "group": "Cm_Hopper_Black",
6665 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6667 "filename": "server/api/cmHopperBlack/index.js",
6668 "groupTitle": "Cm_Hopper_Black"
6672 "url": "/api/cm/hopper_black/describe",
6673 "title": "Gets table info about Hopper Black",
6676 "title": "Example usage:",
6677 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6681 "name": "DescribeHopper_Black",
6682 "group": "Cm_Hopper_Black",
6683 "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>",
6685 "filename": "server/api/cmHopperBlack/index.js",
6686 "groupTitle": "Cm_Hopper_Black"
6690 "url": "/api/cm/hopper_black",
6691 "title": "Gets a list of Hopper Black",
6694 "title": "Example usage:",
6695 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6699 "name": "GetHopper_Black",
6700 "group": "Cm_Hopper_Black",
6701 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6703 "filename": "server/api/cmHopperBlack/index.js",
6704 "groupTitle": "Cm_Hopper_Black"
6708 "url": "/api/cm/hopper_black/{id}",
6709 "title": "Gets a single Hopper Black",
6712 "title": "Example usage:",
6713 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6717 "name": "ShowHopper_Black",
6718 "group": "Cm_Hopper_Black",
6719 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6721 "filename": "server/api/cmHopperBlack/index.js",
6722 "groupTitle": "Cm_Hopper_Black"
6726 "url": "/api/cm/hopper_black/{id}",
6727 "title": "Update an existing Hopper Black",
6730 "title": "Example usage:",
6731 "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",
6735 "name": "updateHopper_Black",
6736 "group": "Cm_Hopper_Black",
6737 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6739 "filename": "server/api/cmHopperBlack/index.js",
6740 "groupTitle": "Cm_Hopper_Black"
6744 "url": "/api/cm/hopper_final/checkContactHopper",
6745 "title": "Check if contact is in hopper",
6748 "title": "Example usage:",
6749 "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",
6753 "name": "/checkContactHopper",
6754 "group": "Cm_Hopper_Final",
6755 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6757 "filename": "server/api/cmHopperFinal/index.js",
6758 "groupTitle": "Cm_Hopper_Final"
6762 "url": "/api/cm/hopper_final/describe",
6763 "title": "Gets table info about HopperFinal",
6766 "title": "Example usage:",
6767 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6771 "name": "DescribeHopperFinal",
6772 "group": "Cm_Hopper_Final",
6773 "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>",
6775 "filename": "server/api/cmHopperFinal/index.js",
6776 "groupTitle": "Cm_Hopper_Final"
6780 "url": "/api/cm/hopper_final",
6781 "title": "Gets a list of HopperFinal",
6784 "title": "Example usage:",
6785 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6789 "name": "GetHopperFinal",
6790 "group": "Cm_Hopper_Final",
6791 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6793 "filename": "server/api/cmHopperFinal/index.js",
6794 "groupTitle": "Cm_Hopper_Final"
6798 "url": "/api/cm/hopper_final/{id}",
6799 "title": "Gets a single HopperFinal",
6802 "title": "Example usage:",
6803 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6807 "name": "ShowHopperFinal",
6808 "group": "Cm_Hopper_Final",
6809 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6811 "filename": "server/api/cmHopperFinal/index.js",
6812 "groupTitle": "Cm_Hopper_Final"
6816 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6817 "title": "Return number contacts for attributes",
6820 "title": "Example usage:",
6821 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6825 "name": "countContactsIvrCampaignHopperFinal",
6826 "group": "Cm_Hopper_Final",
6827 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6829 "filename": "server/api/cmHopperFinal/index.js",
6830 "groupTitle": "Cm_Hopper_Final"
6834 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6835 "title": "Return number contacts for attributes",
6838 "title": "Example usage:",
6839 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6843 "name": "countContactsQueueCampaignHopperFinal",
6844 "group": "Cm_Hopper_Final",
6845 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6847 "filename": "server/api/cmHopperFinal/index.js",
6848 "groupTitle": "Cm_Hopper_Final"
6852 "url": "/api/cm/hopper_final/campaign/{id}",
6853 "title": "Move contacts in hopper",
6856 "title": "Example usage:",
6857 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6861 "name": "moveContactsIvrCampaignHopperFinal",
6862 "group": "Cm_Hopper_Final",
6863 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6865 "filename": "server/api/cmHopperFinal/index.js",
6866 "groupTitle": "Cm_Hopper_Final"
6870 "url": "/api/cm/hopper_final/voice/queue/{id}",
6871 "title": "Move contacts in hopper",
6874 "title": "Example usage:",
6875 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6879 "name": "moveContactsQueueCampaignHopperFinal",
6880 "group": "Cm_Hopper_Final",
6881 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6883 "filename": "server/api/cmHopperFinal/index.js",
6884 "groupTitle": "Cm_Hopper_Final"
6888 "url": "/api/cm/hopper_final/{id}",
6889 "title": "Update a single hopper final",
6892 "title": "Example usage:",
6893 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6898 "group": "Cm_Hopper_Final",
6899 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6901 "filename": "server/api/cmHopperFinal/index.js",
6902 "groupTitle": "Cm_Hopper_Final"
6906 "url": "/api/cm/hopper_history",
6907 "title": "Creates a new HopperHistory",
6910 "title": "Example usage:",
6911 "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",
6915 "name": "CreateHopperHistory",
6916 "group": "Cm_Hopper_History",
6931 "field": "statedesc",
6938 "field": "scheduledat",
6945 "field": "countbusyretry",
6952 "field": "countcongestionretry",
6959 "field": "countnoanswerretry",
6966 "field": "countglobal",
6973 "field": "uniqueid",
6980 "field": "originatecalleridnum",
6987 "field": "originatecalleridname",
6994 "field": "calleridnum",
7001 "field": "calleridname",
7008 "field": "starttime",
7015 "field": "responsetime",
7022 "field": "answertime",
7029 "field": "droptime",
7043 "field": "ringtime",
7050 "field": "holdtime",
7057 "field": "talktime",
7064 "field": "followuptime",
7071 "field": "dropreason",
7078 "field": "campaign",
7085 "field": "campaigntype",
7092 "field": "membername",
7120 "field": "callback",
7127 "field": "callbackuniqueid",
7134 "field": "callbackat",
7141 "field": "recallme",
7148 "field": "editedat",
7162 "field": "countnosuchnumberretry",
7169 "field": "countdropretry",
7176 "field": "countabandonedretry",
7183 "field": "countmachineretry",
7190 "field": "countagentrejectretry",
7196 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7198 "filename": "server/api/cmHopperHistory/index.js",
7199 "groupTitle": "Cm_Hopper_History"
7203 "url": "/api/cm/hopper_history/describe",
7204 "title": "Gets table info about HopperHistory",
7207 "title": "Example usage:",
7208 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7212 "name": "DescribeHopperHistory",
7213 "group": "Cm_Hopper_History",
7214 "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>",
7216 "filename": "server/api/cmHopperHistory/index.js",
7217 "groupTitle": "Cm_Hopper_History"
7221 "url": "/api/cm/hopper_history",
7222 "title": "Gets a list of HopperHistory",
7225 "title": "Example usage:",
7226 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7230 "name": "GetHopperHistory",
7231 "group": "Cm_Hopper_History",
7232 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7234 "filename": "server/api/cmHopperHistory/index.js",
7235 "groupTitle": "Cm_Hopper_History"
7239 "url": "/api/cm/hopper_history/{id}",
7240 "title": "Gets a single HopperHistory",
7243 "title": "Example usage:",
7244 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7248 "name": "ShowHopperHistory",
7249 "group": "Cm_Hopper_History",
7250 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7252 "filename": "server/api/cmHopperHistory/index.js",
7253 "groupTitle": "Cm_Hopper_History"
7257 "url": "/api/cm/hopper_history/{id}",
7258 "title": "Update a single hopper history",
7261 "title": "Example usage:",
7262 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7267 "group": "Cm_Hopper_History",
7268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7270 "filename": "server/api/cmHopperHistory/index.js",
7271 "groupTitle": "Cm_Hopper_History"
7275 "url": "/api/cm/hopper/{id}",
7276 "title": "Delete Hopper",
7279 "title": "Example usage:",
7280 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7285 "group": "Cm_Hopper",
7286 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7288 "filename": "server/api/cmHopper/index.js",
7289 "groupTitle": "Cm_Hopper"
7293 "url": "/api/cm/hopper/opencontacts",
7294 "title": "Gets Open Contacts",
7297 "title": "Example usage:",
7298 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7302 "name": "getOpenContacts",
7303 "group": "Cm_Hopper",
7304 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7306 "filename": "server/api/cmHopper/index.js",
7307 "groupTitle": "Cm_Hopper"
7311 "url": "/api/cm/hopper/preview",
7312 "title": "Gets Preview Dialer Contacts",
7315 "title": "Example usage:",
7316 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7320 "name": "getPreview",
7321 "group": "Cm_Hopper",
7322 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7324 "filename": "server/api/cmHopper/index.js",
7325 "groupTitle": "Cm_Hopper"
7329 "url": "/api/cm/hopper/previewrecall",
7330 "title": "Gets Preview Dialer Contacts for Recall",
7333 "title": "Example usage:",
7334 "content": "curl https://{domain}/api/cm/hopper/previewrecall -d '{\"hopperId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7338 "name": "getPreviewRecall",
7339 "group": "Cm_Hopper",
7340 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7342 "filename": "server/api/cmHopper/index.js",
7343 "groupTitle": "Cm_Hopper"
7347 "url": "/api/cm/hopper/timezones",
7348 "title": "Gets TZs list",
7351 "title": "Example usage:",
7352 "content": "curl https://{domain}/api/cm/hopper/timezones -v -u {name}:{password} -X GET",
7356 "name": "getTimezones",
7357 "group": "Cm_Hopper",
7358 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7360 "filename": "server/api/cmHopper/index.js",
7361 "groupTitle": "Cm_Hopper"
7365 "url": "/api/cm/hopper/{id}",
7366 "title": "Update an existing Hopper",
7369 "title": "Example usage:",
7370 "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",
7374 "name": "updateHopper",
7375 "group": "Cm_Hopper",
7376 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7378 "filename": "server/api/cmHopper/index.js",
7379 "groupTitle": "Cm_Hopper"
7383 "url": "/api/cm/lists",
7384 "title": "Creates a new List",
7387 "title": "Example usage:",
7388 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7392 "name": "CreateLists",
7393 "group": "Cm_Lists",
7408 "field": "description",
7415 "field": "dialPrefix",
7421 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7423 "filename": "server/api/cmList/index.js",
7424 "groupTitle": "Cm_Lists"
7428 "url": "/api/cm/lists/{id}",
7429 "title": "Deletes a List",
7432 "title": "Example usage:",
7433 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7437 "name": "DeleteLists",
7438 "group": "Cm_Lists",
7439 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7441 "filename": "server/api/cmList/index.js",
7442 "groupTitle": "Cm_Lists"
7446 "url": "/api/cm/lists/describe",
7447 "title": "Gets table info about Lists",
7450 "title": "Example usage:",
7451 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7455 "name": "DescribeLists",
7456 "group": "Cm_Lists",
7457 "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>",
7459 "filename": "server/api/cmList/index.js",
7460 "groupTitle": "Cm_Lists"
7464 "url": "/api/cm/lists/{id}/users",
7465 "title": "Gets agents from list",
7468 "title": "Example usage:",
7469 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7473 "name": "GetAgents",
7474 "group": "Cm_Lists",
7475 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7477 "filename": "server/api/cmList/index.js",
7478 "groupTitle": "Cm_Lists"
7482 "url": "/api/cm/lists",
7483 "title": "Gets a list of Lists",
7486 "title": "Example usage:",
7487 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7492 "group": "Cm_Lists",
7493 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7495 "filename": "server/api/cmList/index.js",
7496 "groupTitle": "Cm_Lists"
7500 "url": "/api/cm/lists/{id}/users",
7501 "title": "Removes agents from a list",
7504 "title": "Example usage:",
7505 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7509 "name": "RemoveAgents",
7510 "group": "Cm_Lists",
7511 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7513 "filename": "server/api/cmList/index.js",
7514 "groupTitle": "Cm_Lists"
7518 "url": "/api/cm/lists/{id}/dispositions",
7519 "title": "Removes dispositions from account",
7522 "title": "Example usage:",
7523 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7527 "name": "RemoveDispositions",
7528 "group": "Cm_Lists",
7529 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7531 "filename": "server/api/cmList/index.js",
7532 "groupTitle": "Cm_Lists"
7536 "url": "/api/cm/lists/{id}",
7537 "title": "Gets a single List",
7540 "title": "Example usage:",
7541 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7545 "name": "ShowLists",
7546 "group": "Cm_Lists",
7547 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7549 "filename": "server/api/cmList/index.js",
7550 "groupTitle": "Cm_Lists"
7554 "url": "/api/cm/lists/{id}/users",
7555 "title": "Adds agents to a list",
7558 "title": "Example usage:",
7559 "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",
7563 "name": "addAgents",
7564 "group": "Cm_Lists",
7565 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7567 "filename": "server/api/cmList/index.js",
7568 "groupTitle": "Cm_Lists"
7572 "url": "/api/cm/lists/{id}/contacts",
7573 "title": "Creates new contacts",
7576 "title": "Example usage:",
7577 "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",
7581 "name": "addContacts",
7582 "group": "Cm_Lists",
7590 "field": "firstName",
7597 "field": "lastName",
7611 "field": "postalCode",
7632 "field": "dateOfBirth",
7639 "field": "description",
7681 "field": "facebook",
7737 "field": "telegram",
7751 "field": "priority",
7758 "field": "scheduledat",
7764 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7766 "filename": "server/api/cmList/index.js",
7767 "groupTitle": "Cm_Lists"
7771 "url": "/api/cm/lists/{id}/fields",
7772 "title": "Creates a new custom field",
7775 "title": "Example usage:",
7776 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7780 "name": "addCustomField",
7781 "group": "Cm_Lists",
7782 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7784 "filename": "server/api/cmList/index.js",
7785 "groupTitle": "Cm_Lists"
7789 "url": "/api/cm/lists/{id}/dispositions",
7790 "title": "Creates new disposition",
7793 "title": "Example usage:",
7794 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7798 "name": "addDisposition",
7799 "group": "Cm_Lists",
7826 "field": "description",
7832 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7834 "filename": "server/api/cmList/index.js",
7835 "groupTitle": "Cm_Lists"
7839 "url": "/api/cm/lists/{id}/contacts",
7840 "title": "Gets List Contacts",
7843 "title": "Example usage:",
7844 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7848 "name": "getContacts",
7849 "group": "Cm_Lists",
7850 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7852 "filename": "server/api/cmList/index.js",
7853 "groupTitle": "Cm_Lists"
7857 "url": "/api/cm/lists/{id}/fields",
7858 "title": "Gets Custom Fields",
7861 "title": "Example usage:",
7862 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7866 "name": "getCustomFields",
7867 "group": "Cm_Lists",
7868 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7870 "filename": "server/api/cmList/index.js",
7871 "groupTitle": "Cm_Lists"
7875 "url": "/api/cm/lists/{id}/dispositions",
7876 "title": "Gets list dispositions",
7879 "title": "Example usage:",
7880 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7884 "name": "getDispositions",
7885 "group": "Cm_Lists",
7886 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7888 "filename": "server/api/cmList/index.js",
7889 "groupTitle": "Cm_Lists"
7893 "url": "/api/cm/lists/{id}/contacts/csv",
7894 "title": "Gets CSV List Contacts",
7897 "title": "Example usage:",
7898 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7903 "group": "Cm_Lists",
7904 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7906 "filename": "server/api/cmList/index.js",
7907 "groupTitle": "Cm_Lists"
7911 "url": "/api/cm/lists/{id}",
7912 "title": "Update an existing List",
7915 "title": "Example usage:",
7916 "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",
7920 "name": "updateLists",
7921 "group": "Cm_Lists",
7922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7924 "filename": "server/api/cmList/index.js",
7925 "groupTitle": "Cm_Lists"
7929 "url": "/api/cm/contacts/upload/:id",
7930 "title": "Import new contacts by csv",
7933 "title": "Example usage:",
7934 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7939 "group": "Cm_contacts",
7940 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7942 "filename": "server/api/cmContact/index.js",
7943 "groupTitle": "Cm_contacts"
7947 "url": "/api/cm/contacts/upload",
7948 "title": "Upload csv",
7951 "title": "Example usage:",
7952 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7957 "group": "Cm_contacts",
7958 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7960 "filename": "server/api/cmContact/index.js",
7961 "groupTitle": "Cm_contacts"
7965 "url": "/api/cm/contacts/csv",
7966 "title": "Create new contacts by csv",
7969 "title": "Example usage:",
7970 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7974 "name": "uploadCsv",
7975 "group": "Cm_contacts",
7976 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7978 "filename": "server/api/cmContact/index.js",
7979 "groupTitle": "Cm_contacts"
7983 "url": "/api/conditions/{id}",
7984 "title": "Deletes a Condition",
7987 "title": "Example usage:",
7988 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7992 "name": "DeleteConditions",
7993 "group": "Conditions",
7994 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7996 "filename": "server/api/condition/index.js",
7997 "groupTitle": "Conditions"
8001 "url": "/api/conditions/{id}",
8002 "title": "Update an existing Condition",
8005 "title": "Example usage:",
8006 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8010 "name": "updateConditions",
8011 "group": "Conditions",
8012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8014 "filename": "server/api/condition/index.js",
8015 "groupTitle": "Conditions"
8019 "url": "/api/cm/custom_field",
8020 "title": "Create a new custom field",
8023 "title": "Example usage:",
8024 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8028 "name": "CreateCustomField",
8029 "group": "Custom_Fields",
8030 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8032 "filename": "server/api/cmCustomField/index.js",
8033 "groupTitle": "Custom_Fields"
8037 "url": "/api/dashboards/items",
8038 "title": "Create dasboard item",
8041 "title": "Example usage:",
8042 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8047 "group": "Dashboard_Items",
8048 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8050 "filename": "server/api/dashboardItem/index.js",
8051 "groupTitle": "Dashboard_Items"
8055 "url": "/api/dashboards/items/{id}",
8056 "title": "Deletes a Dashboard Item",
8059 "title": "Example usage:",
8060 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8064 "name": "DeleteDashboard_Items",
8065 "group": "Dashboard_Items",
8066 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8068 "filename": "server/api/dashboardItem/index.js",
8069 "groupTitle": "Dashboard_Items"
8073 "url": "/api/dashboards/items/{id}",
8074 "title": "Gets a single Dashboard Item",
8077 "title": "Example usage:",
8078 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8082 "name": "ShowDashboard_Items",
8083 "group": "Dashboard_Items",
8084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8086 "filename": "server/api/dashboardItem/index.js",
8087 "groupTitle": "Dashboard_Items"
8091 "url": "/api/dashboards/items/{id}",
8092 "title": "Update an existing item",
8095 "title": "Example usage:",
8096 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8101 "group": "Dashboard_Items",
8102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8104 "filename": "server/api/dashboardItem/index.js",
8105 "groupTitle": "Dashboard_Items"
8109 "url": "/api/dashboards/clone",
8110 "title": "Clone an existing Dashboard",
8113 "title": "Example usage:",
8114 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8118 "name": "CloneDashboards",
8119 "group": "Dashboards",
8120 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8122 "filename": "server/api/dashboard/index.js",
8123 "groupTitle": "Dashboards"
8127 "url": "/api/dashboards",
8128 "title": "Creates a new Dashboard",
8131 "title": "Example usage:",
8132 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8136 "name": "CreateDashboards",
8137 "group": "Dashboards",
8152 "field": "description",
8158 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8160 "filename": "server/api/dashboard/index.js",
8161 "groupTitle": "Dashboards"
8165 "url": "/api/dashboards/{id}",
8166 "title": "Deletes a Dashboard",
8169 "title": "Example usage:",
8170 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8174 "name": "DeleteDashboards",
8175 "group": "Dashboards",
8176 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8178 "filename": "server/api/dashboard/index.js",
8179 "groupTitle": "Dashboards"
8183 "url": "/api/dashboards",
8184 "title": "Gets a list of Dashboards",
8187 "title": "Example usage:",
8188 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8192 "name": "GetDashboards",
8193 "group": "Dashboards",
8194 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8196 "filename": "server/api/dashboard/index.js",
8197 "groupTitle": "Dashboards"
8201 "url": "/api/dashboards/{id}",
8202 "title": "Gets a single Dashboard",
8205 "title": "Example usage:",
8206 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8210 "name": "ShowDashboards",
8211 "group": "Dashboards",
8212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8214 "filename": "server/api/dashboard/index.js",
8215 "groupTitle": "Dashboards"
8219 "url": "/api/dashboards/{id}/items",
8220 "title": "Creates new item",
8223 "title": "Example usage:",
8224 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8229 "group": "Dashboards",
8230 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8232 "filename": "server/api/dashboard/index.js",
8233 "groupTitle": "Dashboards"
8237 "url": "/api/dashboards/{id}/items",
8238 "title": "Gets items",
8241 "title": "Example usage:",
8242 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8247 "group": "Dashboards",
8248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8250 "filename": "server/api/dashboard/index.js",
8251 "groupTitle": "Dashboards"
8255 "url": "/api/dashboards/{id}",
8256 "title": "Update an existing Dashboard",
8259 "title": "Example usage:",
8260 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8264 "name": "updateDashboards",
8265 "group": "Dashboards",
8266 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8268 "filename": "server/api/dashboard/index.js",
8269 "groupTitle": "Dashboards"
8273 "url": "/api/integrations/desk/accounts",
8274 "title": "Creates a new Desk Account",
8277 "title": "Example usage:",
8278 "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",
8282 "name": "CreateDesk_Accounts",
8283 "group": "Desk_Accounts",
8298 "field": "description",
8305 "field": "username",
8312 "field": "remoteUri",
8322 "field": "authType",
8329 "field": "password",
8336 "field": "consumerKey",
8343 "field": "consumerSecret",
8357 "field": "tokenSecret",
8364 "field": "serverUrl",
8371 "\"integrationTab\"",
8381 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8383 "filename": "server/api/intDeskAccount/index.js",
8384 "groupTitle": "Desk_Accounts"
8388 "url": "/api/integrations/desk/accounts/{id}",
8389 "title": "Deletes a Desk Account",
8392 "title": "Example usage:",
8393 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8397 "name": "DeleteDesk_Accounts",
8398 "group": "Desk_Accounts",
8399 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8401 "filename": "server/api/intDeskAccount/index.js",
8402 "groupTitle": "Desk_Accounts"
8406 "url": "/api/integrations/desk/accounts",
8407 "title": "Gets a list of Desk Accounts",
8410 "title": "Example usage:",
8411 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8415 "name": "GetDesk_Accounts",
8416 "group": "Desk_Accounts",
8417 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8419 "filename": "server/api/intDeskAccount/index.js",
8420 "groupTitle": "Desk_Accounts"
8424 "url": "/api/integrations/desk/accounts/{id}",
8425 "title": "Gets a single Desk Account",
8428 "title": "Example usage:",
8429 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8433 "name": "ShowDesk_Accounts",
8434 "group": "Desk_Accounts",
8435 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8437 "filename": "server/api/intDeskAccount/index.js",
8438 "groupTitle": "Desk_Accounts"
8442 "url": "/api/integrations/desk/accounts/{id}/configurations",
8443 "title": "Creates new configuration",
8446 "title": "Example usage:",
8447 "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",
8451 "name": "addConfiguration",
8452 "group": "Desk_Accounts",
8453 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8455 "filename": "server/api/intDeskAccount/index.js",
8456 "groupTitle": "Desk_Accounts"
8460 "url": "/api/integrations/desk/accounts/{id}/configurations",
8461 "title": "Gets account configurations",
8464 "title": "Example usage:",
8465 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8469 "name": "getConfigurations",
8470 "group": "Desk_Accounts",
8471 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8473 "filename": "server/api/intDeskAccount/index.js",
8474 "groupTitle": "Desk_Accounts"
8478 "url": "/api/integrations/desk/accounts/{id}/fields",
8479 "title": "Gets account fields",
8482 "title": "Example usage:",
8483 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8487 "name": "getFields",
8488 "group": "Desk_Accounts",
8489 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8491 "filename": "server/api/intDeskAccount/index.js",
8492 "groupTitle": "Desk_Accounts"
8496 "url": "/api/integrations/desk/accounts/{id}",
8497 "title": "Update an existing Desk Account",
8500 "title": "Example usage:",
8501 "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",
8505 "name": "updateDesk_Accounts",
8506 "group": "Desk_Accounts",
8507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8509 "filename": "server/api/intDeskAccount/index.js",
8510 "groupTitle": "Desk_Accounts"
8514 "url": "/api/integrations/desk/configurations",
8515 "title": "Creates a new Desk Configuration",
8518 "title": "Example usage:",
8519 "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",
8523 "name": "CreateDesk_Configurations",
8524 "group": "Desk_Configurations",
8539 "field": "description",
8545 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8547 "filename": "server/api/intDeskConfiguration/index.js",
8548 "groupTitle": "Desk_Configurations"
8552 "url": "/api/integrations/desk/configurations/{id}",
8553 "title": "Deletes a Desk Configuration",
8556 "title": "Example usage:",
8557 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8561 "name": "DeleteDesk_Configurations",
8562 "group": "Desk_Configurations",
8563 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8565 "filename": "server/api/intDeskConfiguration/index.js",
8566 "groupTitle": "Desk_Configurations"
8570 "url": "/api/integrations/desk/configurations",
8571 "title": "Gets a list of Desk Configurations",
8574 "title": "Example usage:",
8575 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8579 "name": "GetDesk_Configurations",
8580 "group": "Desk_Configurations",
8581 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8583 "filename": "server/api/intDeskConfiguration/index.js",
8584 "groupTitle": "Desk_Configurations"
8588 "url": "/api/integrations/desk/configurations/{id}",
8589 "title": "Gets a single Desk Configuration",
8592 "title": "Example usage:",
8593 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8597 "name": "ShowDesk_Configurations",
8598 "group": "Desk_Configurations",
8599 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8601 "filename": "server/api/intDeskConfiguration/index.js",
8602 "groupTitle": "Desk_Configurations"
8606 "url": "/api/integrations/desk/configurations/{id}/descriptions",
8607 "title": "Gets configurations descriptions",
8610 "title": "Example usage:",
8611 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8615 "name": "getDescriptions",
8616 "group": "Desk_Configurations",
8617 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8619 "filename": "server/api/intDeskConfiguration/index.js",
8620 "groupTitle": "Desk_Configurations"
8624 "url": "/api/integrations/desk/configurations/{id}/fields",
8625 "title": "Gets configurations fields",
8628 "title": "Example usage:",
8629 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8633 "name": "getFields",
8634 "group": "Desk_Configurations",
8635 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8637 "filename": "server/api/intDeskConfiguration/index.js",
8638 "groupTitle": "Desk_Configurations"
8642 "url": "/api/integrations/desk/configurations/{id}/subjects",
8643 "title": "Gets configurations subjects",
8646 "title": "Example usage:",
8647 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8651 "name": "getSubjects",
8652 "group": "Desk_Configurations",
8653 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8655 "filename": "server/api/intDeskConfiguration/index.js",
8656 "groupTitle": "Desk_Configurations"
8660 "url": "/api/integrations/desk/configurations/{id}/tags",
8661 "title": "Gets configurations tags",
8664 "title": "Example usage:",
8665 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8670 "group": "Desk_Configurations",
8671 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8673 "filename": "server/api/intDeskConfiguration/index.js",
8674 "groupTitle": "Desk_Configurations"
8678 "url": "/api/integrations/desk/configurations/{id}/tags",
8679 "title": "Sets new tags",
8682 "title": "Example usage:",
8683 "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",
8688 "group": "Desk_Configurations",
8689 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8691 "filename": "server/api/intDeskConfiguration/index.js",
8692 "groupTitle": "Desk_Configurations"
8696 "url": "/api/integrations/desk/configurations/{id}",
8697 "title": "Update an existing Desk Configuration",
8700 "title": "Example usage:",
8701 "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",
8705 "name": "updateDesk_Configurations",
8706 "group": "Desk_Configurations",
8707 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8709 "filename": "server/api/intDeskConfiguration/index.js",
8710 "groupTitle": "Desk_Configurations"
8714 "url": "/api/integrations/desk/fields",
8715 "title": "Creates a new Desk Field",
8718 "title": "Example usage:",
8719 "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",
8723 "name": "CreateDesk_Fields",
8724 "group": "Desk_Fields",
8734 "\"customVariable\"",
8762 "\"customVariable\""
8772 "field": "keyContent",
8786 "field": "nameField",
8793 "field": "customField",
8800 "field": "variableName",
8806 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8808 "filename": "server/api/intDeskField/index.js",
8809 "groupTitle": "Desk_Fields"
8813 "url": "/api/integrations/desk/fields/{id}",
8814 "title": "Deletes a Desk Field",
8817 "title": "Example usage:",
8818 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8822 "name": "DeleteDesk_Fields",
8823 "group": "Desk_Fields",
8824 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8826 "filename": "server/api/intDeskField/index.js",
8827 "groupTitle": "Desk_Fields"
8831 "url": "/api/integrations/desk/fields",
8832 "title": "Gets a list of Desk Fields",
8835 "title": "Example usage:",
8836 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8840 "name": "GetDesk_Fields",
8841 "group": "Desk_Fields",
8842 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8844 "filename": "server/api/intDeskField/index.js",
8845 "groupTitle": "Desk_Fields"
8849 "url": "/api/integrations/desk/fields/{id}",
8850 "title": "Gets a single Desk Field",
8853 "title": "Example usage:",
8854 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8858 "name": "ShowDesk_Fields",
8859 "group": "Desk_Fields",
8860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8862 "filename": "server/api/intDeskField/index.js",
8863 "groupTitle": "Desk_Fields"
8867 "url": "/api/integrations/desk/fields/{id}",
8868 "title": "Update an existing Desk Field",
8871 "title": "Example usage:",
8872 "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",
8876 "name": "updateDesk_Fields",
8877 "group": "Desk_Fields",
8878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8880 "filename": "server/api/intDeskField/index.js",
8881 "groupTitle": "Desk_Fields"
8885 "url": "/api/dispositions",
8886 "title": "Creates a new Disposition",
8889 "title": "Example usage:",
8890 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8894 "name": "CreateDispositions",
8895 "group": "Dispositions",
8922 "field": "description",
8928 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8930 "filename": "server/api/disposition/index.js",
8931 "groupTitle": "Dispositions"
8935 "url": "/api/dispositions/{id}",
8936 "title": "Deletes a Disposition",
8939 "title": "Example usage:",
8940 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8944 "name": "DeleteDispositions",
8945 "group": "Dispositions",
8946 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8948 "filename": "server/api/disposition/index.js",
8949 "groupTitle": "Dispositions"
8953 "url": "/api/dispositions",
8954 "title": "Gets a list of Dispositions",
8957 "title": "Example usage:",
8958 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8962 "name": "GetDispositions",
8963 "group": "Dispositions",
8964 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8966 "filename": "server/api/disposition/index.js",
8967 "groupTitle": "Dispositions"
8971 "url": "/api/dispositions/{id}",
8972 "title": "Gets a single Disposition",
8975 "title": "Example usage:",
8976 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8980 "name": "ShowDispositions",
8981 "group": "Dispositions",
8982 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8984 "filename": "server/api/disposition/index.js",
8985 "groupTitle": "Dispositions"
8989 "url": "/api/dispositions/{id}",
8990 "title": "Update an existing Disposition",
8993 "title": "Example usage:",
8994 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8998 "name": "updateDispositions",
8999 "group": "Dispositions",
9000 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9002 "filename": "server/api/disposition/index.js",
9003 "groupTitle": "Dispositions"
9007 "url": "/api/integrations/dynamics365/accounts",
9008 "title": "Creates a new Dynamics365 Account",
9011 "title": "Example usage:",
9012 "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",
9016 "name": "CreateDynamics365_Accounts",
9017 "group": "Dynamics365_Accounts",
9032 "field": "username",
9039 "field": "password",
9046 "field": "remoteUri",
9053 "field": "tenantId",
9060 "field": "clientId",
9067 "field": "clientSecret",
9074 "field": "serverUrl",
9081 "field": "description",
9087 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9089 "filename": "server/api/intDynamics365Account/index.js",
9090 "groupTitle": "Dynamics365_Accounts"
9094 "url": "/api/integrations/dynamics365/accounts/{id}",
9095 "title": "Deletes a Dynamics365 Account",
9098 "title": "Example usage:",
9099 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9103 "name": "DeleteDynamics365_Accounts",
9104 "group": "Dynamics365_Accounts",
9105 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9107 "filename": "server/api/intDynamics365Account/index.js",
9108 "groupTitle": "Dynamics365_Accounts"
9112 "url": "/api/integrations/dynamics365/accounts",
9113 "title": "Gets a list of Dynamics365 Accounts",
9116 "title": "Example usage:",
9117 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9121 "name": "GetDynamics365_Accounts",
9122 "group": "Dynamics365_Accounts",
9123 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9125 "filename": "server/api/intDynamics365Account/index.js",
9126 "groupTitle": "Dynamics365_Accounts"
9130 "url": "/api/integrations/dynamics365/accounts/{id}",
9131 "title": "Gets a single Dynamics365 Account",
9134 "title": "Example usage:",
9135 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9139 "name": "ShowDynamics365_Accounts",
9140 "group": "Dynamics365_Accounts",
9141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9143 "filename": "server/api/intDynamics365Account/index.js",
9144 "groupTitle": "Dynamics365_Accounts"
9148 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9149 "title": "Creates new configuration",
9152 "title": "Example usage:",
9153 "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",
9157 "name": "addConfiguration",
9158 "group": "Dynamics365_Accounts",
9159 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9161 "filename": "server/api/intDynamics365Account/index.js",
9162 "groupTitle": "Dynamics365_Accounts"
9166 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9167 "title": "Gets account configurations",
9170 "title": "Example usage:",
9171 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9175 "name": "getConfigurations",
9176 "group": "Dynamics365_Accounts",
9177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9179 "filename": "server/api/intDynamics365Account/index.js",
9180 "groupTitle": "Dynamics365_Accounts"
9184 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9185 "title": "Gets account fields",
9188 "title": "Example usage:",
9189 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9193 "name": "getFields",
9194 "group": "Dynamics365_Accounts",
9195 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9197 "filename": "server/api/intDynamics365Account/index.js",
9198 "groupTitle": "Dynamics365_Accounts"
9202 "url": "/api/integrations/dynamics365/accounts/{id}",
9203 "title": "Update an existing Dynamics365 Account",
9206 "title": "Example usage:",
9207 "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",
9211 "name": "updateDynamics365_Accounts",
9212 "group": "Dynamics365_Accounts",
9213 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9215 "filename": "server/api/intDynamics365Account/index.js",
9216 "groupTitle": "Dynamics365_Accounts"
9220 "url": "/api/integrations/dynamics365/configurations",
9221 "title": "Creates a new Dynamics365 Configuration",
9224 "title": "Example usage:",
9225 "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",
9229 "name": "CreateDynamics365_Configurations",
9230 "group": "Dynamics365_Configurations",
9245 "field": "description",
9256 "field": "ticketType",
9262 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9264 "filename": "server/api/intDynamics365Configuration/index.js",
9265 "groupTitle": "Dynamics365_Configurations"
9269 "url": "/api/integrations/dynamics365/configurations/{id}",
9270 "title": "Deletes a Dynamics365 Configuration",
9273 "title": "Example usage:",
9274 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9278 "name": "DeleteDynamics365_Configurations",
9279 "group": "Dynamics365_Configurations",
9280 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9282 "filename": "server/api/intDynamics365Configuration/index.js",
9283 "groupTitle": "Dynamics365_Configurations"
9287 "url": "/api/integrations/dynamics365/configurations",
9288 "title": "Gets a list of Dynamics365 Configurations",
9291 "title": "Example usage:",
9292 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9296 "name": "GetDynamics365_Configurations",
9297 "group": "Dynamics365_Configurations",
9298 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9300 "filename": "server/api/intDynamics365Configuration/index.js",
9301 "groupTitle": "Dynamics365_Configurations"
9305 "url": "/api/integrations/dynamics365/configurations/{id}",
9306 "title": "Gets a single Dynamics365 Configuration",
9309 "title": "Example usage:",
9310 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9314 "name": "ShowDynamics365_Configurations",
9315 "group": "Dynamics365_Configurations",
9316 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9318 "filename": "server/api/intDynamics365Configuration/index.js",
9319 "groupTitle": "Dynamics365_Configurations"
9323 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9324 "title": "Gets configurations descriptions",
9327 "title": "Example usage:",
9328 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9332 "name": "getDescriptions",
9333 "group": "Dynamics365_Configurations",
9334 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9336 "filename": "server/api/intDynamics365Configuration/index.js",
9337 "groupTitle": "Dynamics365_Configurations"
9341 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9342 "title": "Gets configurations fields",
9345 "title": "Example usage:",
9346 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9350 "name": "getFields",
9351 "group": "Dynamics365_Configurations",
9352 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9354 "filename": "server/api/intDynamics365Configuration/index.js",
9355 "groupTitle": "Dynamics365_Configurations"
9359 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9360 "title": "Gets configurations subjects",
9363 "title": "Example usage:",
9364 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9368 "name": "getSubjects",
9369 "group": "Dynamics365_Configurations",
9370 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9372 "filename": "server/api/intDynamics365Configuration/index.js",
9373 "groupTitle": "Dynamics365_Configurations"
9377 "url": "/api/integrations/dynamics365/configurations/{id}",
9378 "title": "Update an existing Dynamics365 Configuration",
9381 "title": "Example usage:",
9382 "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",
9386 "name": "updateDynamics365_Configurations",
9387 "group": "Dynamics365_Configurations",
9388 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9390 "filename": "server/api/intDynamics365Configuration/index.js",
9391 "groupTitle": "Dynamics365_Configurations"
9395 "url": "/api/integrations/dynamics365/fields",
9396 "title": "Creates a new Dynamics365 Field",
9399 "title": "Example usage:",
9400 "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",
9404 "name": "CreateDynamics365_Fields",
9405 "group": "Dynamics365_Fields",
9415 "\"customVariable\"",
9443 "\"customVariable\""
9453 "field": "keyContent",
9467 "field": "nameField",
9474 "field": "customField",
9481 "field": "variableName",
9487 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9489 "filename": "server/api/intDynamics365Field/index.js",
9490 "groupTitle": "Dynamics365_Fields"
9494 "url": "/api/integrations/dynamics365/fields/{id}",
9495 "title": "Deletes a Dynamics365 Field",
9498 "title": "Example usage:",
9499 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9503 "name": "DeleteDynamics365_Fields",
9504 "group": "Dynamics365_Fields",
9505 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9507 "filename": "server/api/intDynamics365Field/index.js",
9508 "groupTitle": "Dynamics365_Fields"
9512 "url": "/api/integrations/dynamics365/fields",
9513 "title": "Gets a list of Dynamics365 Fields",
9516 "title": "Example usage:",
9517 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9521 "name": "GetDynamics365_Fields",
9522 "group": "Dynamics365_Fields",
9523 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9525 "filename": "server/api/intDynamics365Field/index.js",
9526 "groupTitle": "Dynamics365_Fields"
9530 "url": "/api/integrations/dynamics365/fields/{id}",
9531 "title": "Gets a single Dynamics365 Field",
9534 "title": "Example usage:",
9535 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9539 "name": "ShowDynamics365_Fields",
9540 "group": "Dynamics365_Fields",
9541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9543 "filename": "server/api/intDynamics365Field/index.js",
9544 "groupTitle": "Dynamics365_Fields"
9548 "url": "/api/integrations/dynamics365/fields/{id}",
9549 "title": "Update an existing Dynamics365 Field",
9552 "title": "Example usage:",
9553 "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",
9557 "name": "updateDynamics365_Fields",
9558 "group": "Dynamics365_Fields",
9559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9561 "filename": "server/api/intDynamics365Field/index.js",
9562 "groupTitle": "Dynamics365_Fields"
9566 "url": "/api/fax/accounts/{id}/users",
9567 "title": "Add agents to a fax account",
9570 "title": "Example usage:",
9571 "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",
9575 "name": "AddAgents",
9576 "group": "Fax_Accounts",
9577 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9579 "filename": "server/api/faxAccount/index.js",
9580 "groupTitle": "Fax_Accounts"
9584 "url": "/api/fax/accounts",
9585 "title": "Creates a new Account",
9588 "title": "Example usage:",
9589 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9593 "name": "CreateAccounts",
9594 "group": "Fax_Accounts",
9609 "field": "description",
9627 "field": "headerinfo",
9634 "field": "localstationid",
9685 "field": "faxdetect",
9692 "field": "t38timeout",
9719 "field": "notificationTemplate",
9726 "field": "notificationSound",
9733 "field": "notificationShake",
9740 "field": "waitForTheAssignedAgent",
9747 "field": "queueTransfer",
9754 "field": "queueTransferTimeout",
9761 "field": "agentTransfer",
9768 "field": "agentTransferTimeout",
9775 "field": "mandatoryDispositionPauseId",
9776 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9782 "field": "mandatoryDisposition",
9783 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9788 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9790 "filename": "server/api/faxAccount/index.js",
9791 "groupTitle": "Fax_Accounts"
9795 "url": "/api/fax/accounts/{id}",
9796 "title": "Deletes a Account",
9799 "title": "Example usage:",
9800 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9804 "name": "DeleteAccounts",
9805 "group": "Fax_Accounts",
9806 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9808 "filename": "server/api/faxAccount/index.js",
9809 "groupTitle": "Fax_Accounts"
9813 "url": "/api/fax/accounts/describe",
9814 "title": "Gets table info about Accounts",
9817 "title": "Example usage:",
9818 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9822 "name": "DescribeAccounts",
9823 "group": "Fax_Accounts",
9824 "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>",
9826 "filename": "server/api/faxAccount/index.js",
9827 "groupTitle": "Fax_Accounts"
9831 "url": "/api/fax/accounts",
9832 "title": "Gets a list of Accounts",
9835 "title": "Example usage:",
9836 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9840 "name": "GetAccounts",
9841 "group": "Fax_Accounts",
9842 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9844 "filename": "server/api/faxAccount/index.js",
9845 "groupTitle": "Fax_Accounts"
9849 "url": "/api/fax/accounts/{id}/users",
9850 "title": "Gets agents from fax account",
9853 "title": "Example usage:",
9854 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9858 "name": "GetAgents",
9859 "group": "Fax_Accounts",
9860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9862 "filename": "server/api/faxAccount/index.js",
9863 "groupTitle": "Fax_Accounts"
9867 "url": "/api/fax/accounts/{id}/users",
9868 "title": "Removes agents from a fax account",
9871 "title": "Example usage:",
9872 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9876 "name": "RemoveAgents",
9877 "group": "Fax_Accounts",
9878 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9880 "filename": "server/api/faxAccount/index.js",
9881 "groupTitle": "Fax_Accounts"
9885 "url": "/api/fax/accounts/{id}/canned_answers",
9886 "title": "Removes canned answers from account",
9889 "title": "Example usage:",
9890 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9894 "name": "RemoveAnswers",
9895 "group": "Fax_Accounts",
9896 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9898 "filename": "server/api/faxAccount/index.js",
9899 "groupTitle": "Fax_Accounts"
9903 "url": "/api/fax/accounts/{id}/dispositions",
9904 "title": "Removes dispositions from account",
9907 "title": "Example usage:",
9908 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9912 "name": "RemoveDispositions",
9913 "group": "Fax_Accounts",
9914 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9916 "filename": "server/api/faxAccount/index.js",
9917 "groupTitle": "Fax_Accounts"
9921 "url": "/api/fax/accounts/{id}",
9922 "title": "Gets a single Account",
9925 "title": "Example usage:",
9926 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9930 "name": "ShowAccounts",
9931 "group": "Fax_Accounts",
9932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9934 "filename": "server/api/faxAccount/index.js",
9935 "groupTitle": "Fax_Accounts"
9939 "url": "/api/fax/accounts/{id}/canned_answers",
9940 "title": "Creates new canned answer",
9943 "title": "Example usage:",
9944 "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",
9948 "name": "addAnswer",
9949 "group": "Fax_Accounts",
9971 "field": "description",
9984 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9986 "filename": "server/api/faxAccount/index.js",
9987 "groupTitle": "Fax_Accounts"
9991 "url": "/api/fax/accounts/{id}/applications",
9992 "title": "Creates new applications",
9995 "title": "Example usage:",
9996 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10000 "name": "addApplications",
10001 "group": "Fax_Accounts",
10009 "field": "priority",
10023 "field": "appdata",
10030 "field": "description",
10037 "field": "interval",
10043 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10044 "version": "0.0.0",
10045 "filename": "server/api/faxAccount/index.js",
10046 "groupTitle": "Fax_Accounts"
10050 "url": "/api/fax/accounts/addaccountapplications",
10051 "title": "Creates new account and applications",
10054 "title": "Example usage:",
10055 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10059 "name": "addApplications",
10060 "group": "Fax_Accounts",
10068 "field": "priority",
10082 "field": "appdata",
10089 "field": "description",
10096 "field": "interval",
10102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10103 "version": "0.0.0",
10104 "filename": "server/api/faxAccount/index.js",
10105 "groupTitle": "Fax_Accounts"
10109 "url": "/api/fax/accounts/{id}/dispositions",
10110 "title": "Creates new disposition",
10113 "title": "Example usage:",
10114 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10118 "name": "addDisposition",
10119 "group": "Fax_Accounts",
10146 "field": "description",
10152 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10153 "version": "0.0.0",
10154 "filename": "server/api/faxAccount/index.js",
10155 "groupTitle": "Fax_Accounts"
10159 "url": "/api/fax/accounts/{id}/interactions",
10160 "title": "Creates new interactions",
10163 "title": "Example usage:",
10164 "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",
10168 "name": "addInteraction",
10169 "group": "Fax_Accounts",
10184 "field": "closedAt",
10191 "field": "disposition",
10198 "field": "secondDisposition",
10205 "field": "thirdDisposition",
10219 "field": "read1stAt",
10237 "field": "firstMsgDirection",
10244 "field": "lastMsgAt",
10255 "field": "lastMsgDirection",
10261 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10262 "version": "0.0.0",
10263 "filename": "server/api/faxAccount/index.js",
10264 "groupTitle": "Fax_Accounts"
10268 "url": "/api/fax/accounts/{id}/canned_answers",
10269 "title": "Gets account canned answers",
10272 "title": "Example usage:",
10273 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10277 "name": "getAnswers",
10278 "group": "Fax_Accounts",
10279 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10280 "version": "0.0.0",
10281 "filename": "server/api/faxAccount/index.js",
10282 "groupTitle": "Fax_Accounts"
10286 "url": "/api/fax/accounts/{id}/applications",
10287 "title": "Gets account pplications",
10290 "title": "Example usage:",
10291 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10295 "name": "getApplications",
10296 "group": "Fax_Accounts",
10297 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10298 "version": "0.0.0",
10299 "filename": "server/api/faxAccount/index.js",
10300 "groupTitle": "Fax_Accounts"
10304 "url": "/api/fax/accounts/{id}/dispositions",
10305 "title": "Gets account dispositions",
10308 "title": "Example usage:",
10309 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10313 "name": "getDispositions",
10314 "group": "Fax_Accounts",
10315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10316 "version": "0.0.0",
10317 "filename": "server/api/faxAccount/index.js",
10318 "groupTitle": "Fax_Accounts"
10322 "url": "/api/fax/accounts/{id}/interactions",
10323 "title": "Gets account interactions",
10326 "title": "Example usage:",
10327 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10331 "name": "getInteraction",
10332 "group": "Fax_Accounts",
10333 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10334 "version": "0.0.0",
10335 "filename": "server/api/faxAccount/index.js",
10336 "groupTitle": "Fax_Accounts"
10340 "url": "/api/fax/accounts/{id}/messages",
10341 "title": "Gets account messages",
10344 "title": "Example usage:",
10345 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10349 "name": "getMessages",
10350 "group": "Fax_Accounts",
10351 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10352 "version": "0.0.0",
10353 "filename": "server/api/faxAccount/index.js",
10354 "groupTitle": "Fax_Accounts"
10358 "url": "/api/fax/accounts/{id}/send",
10359 "title": "Send new fax",
10362 "title": "Example usage:",
10363 "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",
10368 "group": "Fax_Accounts",
10369 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10370 "version": "0.0.0",
10371 "filename": "server/api/faxAccount/index.js",
10372 "groupTitle": "Fax_Accounts"
10376 "url": "/api/fax/accounts/{id}",
10377 "title": "Update an existing Account",
10380 "title": "Example usage:",
10381 "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",
10385 "name": "updateAccounts",
10386 "group": "Fax_Accounts",
10387 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10388 "version": "0.0.0",
10389 "filename": "server/api/faxAccount/index.js",
10390 "groupTitle": "Fax_Accounts"
10394 "url": "/api/fax/accounts/updateaccountapplications",
10395 "title": "Update account and applications",
10398 "title": "Example usage:",
10399 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10403 "name": "updateApplications",
10404 "group": "Fax_Accounts",
10412 "field": "priority",
10426 "field": "appdata",
10433 "field": "description",
10440 "field": "interval",
10446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/applications",
10454 "title": "Creates a new Application",
10457 "title": "Example usage:",
10458 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10462 "name": "CreateApplications",
10463 "group": "Fax_Applications",
10471 "field": "priority",
10485 "field": "appdata",
10492 "field": "description",
10499 "field": "interval",
10505 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10506 "version": "0.0.0",
10507 "filename": "server/api/faxApplication/index.js",
10508 "groupTitle": "Fax_Applications"
10512 "url": "/api/fax/applications/{id}",
10513 "title": "Deletes a Application",
10516 "title": "Example usage:",
10517 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10521 "name": "DeleteApplications",
10522 "group": "Fax_Applications",
10523 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10524 "version": "0.0.0",
10525 "filename": "server/api/faxApplication/index.js",
10526 "groupTitle": "Fax_Applications"
10530 "url": "/api/fax/applications",
10531 "title": "Gets a list of Applications",
10534 "title": "Example usage:",
10535 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10539 "name": "GetApplications",
10540 "group": "Fax_Applications",
10541 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10542 "version": "0.0.0",
10543 "filename": "server/api/faxApplication/index.js",
10544 "groupTitle": "Fax_Applications"
10548 "url": "/api/fax/applications/{id}",
10549 "title": "Gets a single Application",
10552 "title": "Example usage:",
10553 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10557 "name": "ShowApplications",
10558 "group": "Fax_Applications",
10559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10560 "version": "0.0.0",
10561 "filename": "server/api/faxApplication/index.js",
10562 "groupTitle": "Fax_Applications"
10566 "url": "/api/fax/applications/{id}",
10567 "title": "Update an existing Application",
10570 "title": "Example usage:",
10571 "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",
10575 "name": "updateApplications",
10576 "group": "Fax_Applications",
10577 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10578 "version": "0.0.0",
10579 "filename": "server/api/faxApplication/index.js",
10580 "groupTitle": "Fax_Applications"
10584 "url": "/api/fax/interactions/{id}/tags",
10585 "title": "Add tags to the interaction",
10588 "title": "Example usage:",
10589 "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",
10594 "group": "Fax_Interactions",
10595 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10596 "version": "0.0.0",
10597 "filename": "server/api/faxInteraction/index.js",
10598 "groupTitle": "Fax_Interactions"
10602 "url": "/api/fax/interactions",
10603 "title": "Creates a new Interaction",
10606 "title": "Example usage:",
10607 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10611 "name": "CreateInteractions",
10612 "group": "Fax_Interactions",
10627 "field": "closedAt",
10634 "field": "disposition",
10641 "field": "secondDisposition",
10648 "field": "thirdDisposition",
10662 "field": "read1stAt",
10680 "field": "firstMsgDirection",
10687 "field": "lastMsgAt",
10698 "field": "lastMsgDirection",
10704 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10705 "version": "0.0.0",
10706 "filename": "server/api/faxInteraction/index.js",
10707 "groupTitle": "Fax_Interactions"
10711 "url": "/api/fax/interactions/{id}",
10712 "title": "Deletes a Interaction",
10715 "title": "Example usage:",
10716 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10720 "name": "DeleteInteractions",
10721 "group": "Fax_Interactions",
10722 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10723 "version": "0.0.0",
10724 "filename": "server/api/faxInteraction/index.js",
10725 "groupTitle": "Fax_Interactions"
10729 "url": "/api/fax/interactions/describe",
10730 "title": "Gets table info about Interactions",
10733 "title": "Example usage:",
10734 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10738 "name": "DescribeInteractions",
10739 "group": "Fax_Interactions",
10740 "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>",
10741 "version": "0.0.0",
10742 "filename": "server/api/faxInteraction/index.js",
10743 "groupTitle": "Fax_Interactions"
10747 "url": "/api/fax/interactions",
10748 "title": "Gets a list of Interactions",
10751 "title": "Example usage:",
10752 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10756 "name": "GetInteractions",
10757 "group": "Fax_Interactions",
10758 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10759 "version": "0.0.0",
10760 "filename": "server/api/faxInteraction/index.js",
10761 "groupTitle": "Fax_Interactions"
10765 "url": "/api/fax/interactions/{id}/tags",
10766 "title": "Removes tags from interaction",
10769 "title": "Example usage:",
10770 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10774 "name": "RemoveTags",
10775 "group": "Fax_Interactions",
10776 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10777 "version": "0.0.0",
10778 "filename": "server/api/faxInteraction/index.js",
10779 "groupTitle": "Fax_Interactions"
10783 "url": "/api/fax/interactions/{id}",
10784 "title": "Gets a single Interaction",
10787 "title": "Example usage:",
10788 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10792 "name": "ShowInteractions",
10793 "group": "Fax_Interactions",
10794 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10795 "version": "0.0.0",
10796 "filename": "server/api/faxInteraction/index.js",
10797 "groupTitle": "Fax_Interactions"
10801 "url": "/api/fax/interactions/{id}/messages",
10802 "title": "Creates new messages",
10805 "title": "Example usage:",
10806 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10810 "name": "addMessage",
10811 "group": "Fax_Interactions",
10837 "field": "direction",
10844 "field": "failMessage",
10857 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10858 "version": "0.0.0",
10859 "filename": "server/api/faxInteraction/index.js",
10860 "groupTitle": "Fax_Interactions"
10864 "url": "/api/fax/interactions/{id}/download",
10865 "title": "Get interactions",
10868 "title": "Example usage:",
10869 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10873 "name": "download",
10874 "group": "Fax_Interactions",
10875 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10876 "version": "0.0.0",
10877 "filename": "server/api/faxInteraction/index.js",
10878 "groupTitle": "Fax_Interactions"
10882 "url": "/api/fax/interactions/{id}/messages",
10883 "title": "Gets interaction messages",
10886 "title": "Example usage:",
10887 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10891 "name": "getMessages",
10892 "group": "Fax_Interactions",
10893 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10894 "version": "0.0.0",
10895 "filename": "server/api/faxInteraction/index.js",
10896 "groupTitle": "Fax_Interactions"
10900 "url": "/api/fax/interactions/{id}",
10901 "title": "Update an existing Interaction",
10904 "title": "Example usage:",
10905 "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",
10909 "name": "updateInteractions",
10910 "group": "Fax_Interactions",
10911 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10912 "version": "0.0.0",
10913 "filename": "server/api/faxInteraction/index.js",
10914 "groupTitle": "Fax_Interactions"
10918 "url": "/api/fax/messages/{id}/download",
10919 "title": "Get message",
10922 "title": "Example usage:",
10923 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10927 "name": "download",
10928 "group": "Fax_Message",
10929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10930 "version": "0.0.0",
10931 "filename": "server/api/faxMessage/index.js",
10932 "groupTitle": "Fax_Message"
10936 "url": "/api/fax/messages/{id}",
10937 "title": "Deletes a Message",
10940 "title": "Example usage:",
10941 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10945 "name": "DeleteMessages",
10946 "group": "Fax_Messages",
10947 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10948 "version": "0.0.0",
10949 "filename": "server/api/faxMessage/index.js",
10950 "groupTitle": "Fax_Messages"
10954 "url": "/api/fax/messages/describe",
10955 "title": "Gets table info about Messages",
10958 "title": "Example usage:",
10959 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10963 "name": "DescribeMessages",
10964 "group": "Fax_Messages",
10965 "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>",
10966 "version": "0.0.0",
10967 "filename": "server/api/faxMessage/index.js",
10968 "groupTitle": "Fax_Messages"
10972 "url": "/api/fax/messages",
10973 "title": "Gets a list of Messages",
10976 "title": "Example usage:",
10977 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10981 "name": "GetMessages",
10982 "group": "Fax_Messages",
10983 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10984 "version": "0.0.0",
10985 "filename": "server/api/faxMessage/index.js",
10986 "groupTitle": "Fax_Messages"
10990 "url": "/api/fax/messages/{id}",
10991 "title": "Gets a single Message",
10994 "title": "Example usage:",
10995 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10999 "name": "ShowMessages",
11000 "group": "Fax_Messages",
11001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11002 "version": "0.0.0",
11003 "filename": "server/api/faxMessage/index.js",
11004 "groupTitle": "Fax_Messages"
11008 "url": "/api/fax/messages/{id}/accept",
11009 "title": "Accepts message",
11012 "title": "Example usage:",
11013 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11017 "name": "acceptMessage",
11018 "group": "Fax_Messages",
11019 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11020 "version": "0.0.0",
11021 "filename": "server/api/faxMessage/index.js",
11022 "groupTitle": "Fax_Messages"
11026 "url": "/api/fax/messages/{id}/reject",
11027 "title": "Rejects message",
11030 "title": "Example usage:",
11031 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11035 "name": "rejectMessage",
11036 "group": "Fax_Messages",
11037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11038 "version": "0.0.0",
11039 "filename": "server/api/faxMessage/index.js",
11040 "groupTitle": "Fax_Messages"
11044 "url": "/api/fax/messages",
11045 "title": "Create message and send Fax",
11048 "title": "Example usage:",
11049 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11053 "name": "rejectMessage",
11054 "group": "Fax_Messages",
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/faxMessage/index.js",
11058 "groupTitle": "Fax_Messages"
11062 "url": "/api/fax/messages/{id}",
11063 "title": "Update an existing Message",
11066 "title": "Example usage:",
11067 "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",
11071 "name": "updateMessages",
11072 "group": "Fax_Messages",
11073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/faxMessage/index.js",
11076 "groupTitle": "Fax_Messages"
11080 "url": "/api/fax/reports/queue",
11081 "title": "Creates a new Fax Queue Report",
11084 "title": "Example usage:",
11085 "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",
11089 "name": "CreateFax_Queue_Reports",
11090 "group": "Fax_Queue_Reports",
11098 "field": "uniqueid",
11119 "field": "leaveAt",
11126 "field": "acceptAt",
11146 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11147 "version": "0.0.0",
11148 "filename": "server/api/faxQueueReport/index.js",
11149 "groupTitle": "Fax_Queue_Reports"
11153 "url": "/api/fax/reports/queue/{id}",
11154 "title": "Deletes a Fax Queue Report",
11157 "title": "Example usage:",
11158 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11162 "name": "DeleteFax_Queue_Reports",
11163 "group": "Fax_Queue_Reports",
11164 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11165 "version": "0.0.0",
11166 "filename": "server/api/faxQueueReport/index.js",
11167 "groupTitle": "Fax_Queue_Reports"
11171 "url": "/api/fax/reports/queue/describe",
11172 "title": "Gets table info about Fax Queue Reports",
11175 "title": "Example usage:",
11176 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11180 "name": "DescribeFax_Queue_Reports",
11181 "group": "Fax_Queue_Reports",
11182 "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>",
11183 "version": "0.0.0",
11184 "filename": "server/api/faxQueueReport/index.js",
11185 "groupTitle": "Fax_Queue_Reports"
11189 "url": "/api/fax/reports/queue",
11190 "title": "Gets a list of Fax Queue Reports",
11193 "title": "Example usage:",
11194 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11198 "name": "GetFax_Queue_Reports",
11199 "group": "Fax_Queue_Reports",
11200 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11201 "version": "0.0.0",
11202 "filename": "server/api/faxQueueReport/index.js",
11203 "groupTitle": "Fax_Queue_Reports"
11207 "url": "/api/fax/reports/queue/{id}",
11208 "title": "Gets a single Fax Queue Report",
11211 "title": "Example usage:",
11212 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11216 "name": "ShowFax_Queue_Reports",
11217 "group": "Fax_Queue_Reports",
11218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11219 "version": "0.0.0",
11220 "filename": "server/api/faxQueueReport/index.js",
11221 "groupTitle": "Fax_Queue_Reports"
11225 "url": "/api/fax/reports/queue/{id}",
11226 "title": "Update an existing Fax Queue Report",
11229 "title": "Example usage:",
11230 "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",
11234 "name": "updateFax_Queue_Reports",
11235 "group": "Fax_Queue_Reports",
11236 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11237 "version": "0.0.0",
11238 "filename": "server/api/faxQueueReport/index.js",
11239 "groupTitle": "Fax_Queue_Reports"
11243 "url": "/api/fax/queues/{id}/users",
11244 "title": "Add agents to a queue",
11247 "title": "Example usage:",
11248 "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",
11252 "name": "AddAgents",
11253 "group": "Fax_Queues",
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/faxQueue/index.js",
11257 "groupTitle": "Fax_Queues"
11261 "url": "/api/fax/queues/{id}/teams",
11262 "title": "Add teams to a queue",
11265 "title": "Example usage:",
11266 "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",
11270 "name": "AddTeams",
11271 "group": "Fax_Queues",
11272 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11273 "version": "0.0.0",
11274 "filename": "server/api/faxQueue/index.js",
11275 "groupTitle": "Fax_Queues"
11279 "url": "/api/fax/queues",
11280 "title": "Creates a new Queue",
11283 "title": "Example usage:",
11284 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11288 "name": "CreateQueues",
11289 "group": "Fax_Queues",
11304 "field": "description",
11311 "field": "timeout",
11323 "field": "strategy",
11330 "field": "lastAgent",
11336 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11337 "version": "0.0.0",
11338 "filename": "server/api/faxQueue/index.js",
11339 "groupTitle": "Fax_Queues"
11343 "url": "/api/fax/queues/{id}",
11344 "title": "Deletes a Queue",
11347 "title": "Example usage:",
11348 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11352 "name": "DeleteQueues",
11353 "group": "Fax_Queues",
11354 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11355 "version": "0.0.0",
11356 "filename": "server/api/faxQueue/index.js",
11357 "groupTitle": "Fax_Queues"
11361 "url": "/api/fax/queues/describe",
11362 "title": "Gets table info about Queues",
11365 "title": "Example usage:",
11366 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11370 "name": "DescribeQueues",
11371 "group": "Fax_Queues",
11372 "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>",
11373 "version": "0.0.0",
11374 "filename": "server/api/faxQueue/index.js",
11375 "groupTitle": "Fax_Queues"
11379 "url": "/api/fax/queues/{id}/users",
11380 "title": "Gets queue agents",
11383 "title": "Example usage:",
11384 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11388 "name": "GetAgents",
11389 "group": "Fax_Queues",
11390 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11391 "version": "0.0.0",
11392 "filename": "server/api/faxQueue/index.js",
11393 "groupTitle": "Fax_Queues"
11397 "url": "/api/fax/queues/{id}/members",
11398 "title": "GetMembers",
11401 "title": "Example usage:",
11402 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11406 "name": "GetMembers",
11407 "group": "Fax_Queues",
11408 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11409 "version": "0.0.0",
11410 "filename": "server/api/faxQueue/index.js",
11411 "groupTitle": "Fax_Queues"
11415 "url": "/api/fax/queues",
11416 "title": "Gets a list of Queues",
11419 "title": "Example usage:",
11420 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11424 "name": "GetQueues",
11425 "group": "Fax_Queues",
11426 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11427 "version": "0.0.0",
11428 "filename": "server/api/faxQueue/index.js",
11429 "groupTitle": "Fax_Queues"
11433 "url": "/api/fax/queues/{id}/teams",
11434 "title": "Gets queues list",
11437 "title": "Example usage:",
11438 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11442 "name": "GetTeams",
11443 "group": "Fax_Queues",
11444 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11445 "version": "0.0.0",
11446 "filename": "server/api/faxQueue/index.js",
11447 "groupTitle": "Fax_Queues"
11451 "url": "/api/fax/queues/{id}/users",
11452 "title": "Removes agents from a queue",
11455 "title": "Example usage:",
11456 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11460 "name": "RemoveAgents",
11461 "group": "Fax_Queues",
11462 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11463 "version": "0.0.0",
11464 "filename": "server/api/faxQueue/index.js",
11465 "groupTitle": "Fax_Queues"
11469 "url": "/api/fax/queues/{id}",
11470 "title": "Gets a single Queue",
11473 "title": "Example usage:",
11474 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11478 "name": "ShowQueues",
11479 "group": "Fax_Queues",
11480 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11481 "version": "0.0.0",
11482 "filename": "server/api/faxQueue/index.js",
11483 "groupTitle": "Fax_Queues"
11487 "url": "/api/fax/queues/{id}",
11488 "title": "Update an existing Queue",
11491 "title": "Example usage:",
11492 "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",
11496 "name": "updateQueues",
11497 "group": "Fax_Queues",
11498 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11499 "version": "0.0.0",
11500 "filename": "server/api/faxQueue/index.js",
11501 "groupTitle": "Fax_Queues"
11505 "url": "/api/fax/reports/transfer",
11506 "title": "Creates a new Fax Transfer Report",
11509 "title": "Example usage:",
11510 "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",
11514 "name": "CreateFax_Transfer_Reports",
11515 "group": "Fax_Transfer_Reports",
11523 "field": "uniqueid",
11542 "field": "transferredAt",
11548 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11549 "version": "0.0.0",
11550 "filename": "server/api/faxTransferReport/index.js",
11551 "groupTitle": "Fax_Transfer_Reports"
11555 "url": "/api/fax/reports/transfer/{id}",
11556 "title": "Deletes a Fax Transfer Report",
11559 "title": "Example usage:",
11560 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11564 "name": "DeleteFax_Transfer_Reports",
11565 "group": "Fax_Transfer_Reports",
11566 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11567 "version": "0.0.0",
11568 "filename": "server/api/faxTransferReport/index.js",
11569 "groupTitle": "Fax_Transfer_Reports"
11573 "url": "/api/fax/reports/transfer/describe",
11574 "title": "Gets table info about Fax Transfer Reports",
11577 "title": "Example usage:",
11578 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11582 "name": "DescribeFax_Transfer_Reports",
11583 "group": "Fax_Transfer_Reports",
11584 "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>",
11585 "version": "0.0.0",
11586 "filename": "server/api/faxTransferReport/index.js",
11587 "groupTitle": "Fax_Transfer_Reports"
11591 "url": "/api/fax/reports/transfer",
11592 "title": "Gets a list of Fax Transfer Reports",
11595 "title": "Example usage:",
11596 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11600 "name": "GetFax_Transfer_Reports",
11601 "group": "Fax_Transfer_Reports",
11602 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11603 "version": "0.0.0",
11604 "filename": "server/api/faxTransferReport/index.js",
11605 "groupTitle": "Fax_Transfer_Reports"
11609 "url": "/api/fax/reports/transfer/{id}",
11610 "title": "Gets a single Fax Transfer Report",
11613 "title": "Example usage:",
11614 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11618 "name": "ShowFax_Transfer_Reports",
11619 "group": "Fax_Transfer_Reports",
11620 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11621 "version": "0.0.0",
11622 "filename": "server/api/faxTransferReport/index.js",
11623 "groupTitle": "Fax_Transfer_Reports"
11627 "url": "/api/fax/reports/transfer/{id}",
11628 "title": "Update an existing Fax Transfer Report",
11631 "title": "Example usage:",
11632 "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",
11636 "name": "updateFax_Transfer_Reports",
11637 "group": "Fax_Transfer_Reports",
11638 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11639 "version": "0.0.0",
11640 "filename": "server/api/faxTransferReport/index.js",
11641 "groupTitle": "Fax_Transfer_Reports"
11645 "url": "/api/integrations/freshdesk/accounts",
11646 "title": "Creates a new Freshdesk Account",
11649 "title": "Example usage:",
11650 "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",
11654 "name": "CreateFreshdesk_Accounts",
11655 "group": "Freshdesk_Accounts",
11670 "field": "description",
11677 "field": "username",
11691 "field": "remoteUri",
11698 "field": "serverUrl",
11704 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11705 "version": "0.0.0",
11706 "filename": "server/api/intFreshdeskAccount/index.js",
11707 "groupTitle": "Freshdesk_Accounts"
11711 "url": "/api/integrations/freshdesk/accounts/{id}",
11712 "title": "Deletes a Freshdesk Account",
11715 "title": "Example usage:",
11716 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11720 "name": "DeleteFreshdesk_Accounts",
11721 "group": "Freshdesk_Accounts",
11722 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11723 "version": "0.0.0",
11724 "filename": "server/api/intFreshdeskAccount/index.js",
11725 "groupTitle": "Freshdesk_Accounts"
11729 "url": "/api/integrations/freshdesk/accounts",
11730 "title": "Gets a list of Freshdesk Accounts",
11733 "title": "Example usage:",
11734 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11738 "name": "GetFreshdesk_Accounts",
11739 "group": "Freshdesk_Accounts",
11740 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11741 "version": "0.0.0",
11742 "filename": "server/api/intFreshdeskAccount/index.js",
11743 "groupTitle": "Freshdesk_Accounts"
11747 "url": "/api/integrations/freshdesk/accounts/{id}",
11748 "title": "Gets a single Freshdesk Account",
11751 "title": "Example usage:",
11752 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11756 "name": "ShowFreshdesk_Accounts",
11757 "group": "Freshdesk_Accounts",
11758 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11759 "version": "0.0.0",
11760 "filename": "server/api/intFreshdeskAccount/index.js",
11761 "groupTitle": "Freshdesk_Accounts"
11765 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11766 "title": "Creates new configuration",
11769 "title": "Example usage:",
11770 "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",
11774 "name": "addConfiguration",
11775 "group": "Freshdesk_Accounts",
11776 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11777 "version": "0.0.0",
11778 "filename": "server/api/intFreshdeskAccount/index.js",
11779 "groupTitle": "Freshdesk_Accounts"
11783 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11784 "title": "Gets account configurations",
11787 "title": "Example usage:",
11788 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11792 "name": "getConfigurations",
11793 "group": "Freshdesk_Accounts",
11794 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11795 "version": "0.0.0",
11796 "filename": "server/api/intFreshdeskAccount/index.js",
11797 "groupTitle": "Freshdesk_Accounts"
11801 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11802 "title": "Gets account fields",
11805 "title": "Example usage:",
11806 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11810 "name": "getFields",
11811 "group": "Freshdesk_Accounts",
11812 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11813 "version": "0.0.0",
11814 "filename": "server/api/intFreshdeskAccount/index.js",
11815 "groupTitle": "Freshdesk_Accounts"
11819 "url": "/api/integrations/freshdesk/accounts/{id}",
11820 "title": "Update an existing Freshdesk Account",
11823 "title": "Example usage:",
11824 "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",
11828 "name": "updateFreshdesk_Accounts",
11829 "group": "Freshdesk_Accounts",
11830 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11831 "version": "0.0.0",
11832 "filename": "server/api/intFreshdeskAccount/index.js",
11833 "groupTitle": "Freshdesk_Accounts"
11837 "url": "/api/integrations/freshdesk/configurations",
11838 "title": "Creates a new Freshdesk Configuration",
11841 "title": "Example usage:",
11842 "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",
11846 "name": "CreateFreshdesk_Configurations",
11847 "group": "Freshdesk_Configurations",
11862 "field": "description",
11868 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11869 "version": "0.0.0",
11870 "filename": "server/api/intFreshdeskConfiguration/index.js",
11871 "groupTitle": "Freshdesk_Configurations"
11875 "url": "/api/integrations/freshdesk/configurations/{id}",
11876 "title": "Deletes a Freshdesk Configuration",
11879 "title": "Example usage:",
11880 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11884 "name": "DeleteFreshdesk_Configurations",
11885 "group": "Freshdesk_Configurations",
11886 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11887 "version": "0.0.0",
11888 "filename": "server/api/intFreshdeskConfiguration/index.js",
11889 "groupTitle": "Freshdesk_Configurations"
11893 "url": "/api/integrations/freshdesk/configurations",
11894 "title": "Gets a list of Freshdesk Configurations",
11897 "title": "Example usage:",
11898 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11902 "name": "GetFreshdesk_Configurations",
11903 "group": "Freshdesk_Configurations",
11904 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11905 "version": "0.0.0",
11906 "filename": "server/api/intFreshdeskConfiguration/index.js",
11907 "groupTitle": "Freshdesk_Configurations"
11911 "url": "/api/integrations/freshdesk/configurations/{id}",
11912 "title": "Gets a single Freshdesk Configuration",
11915 "title": "Example usage:",
11916 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11920 "name": "ShowFreshdesk_Configurations",
11921 "group": "Freshdesk_Configurations",
11922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11923 "version": "0.0.0",
11924 "filename": "server/api/intFreshdeskConfiguration/index.js",
11925 "groupTitle": "Freshdesk_Configurations"
11929 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11930 "title": "Gets configurations descriptions",
11933 "title": "Example usage:",
11934 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11938 "name": "getDescriptions",
11939 "group": "Freshdesk_Configurations",
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/intFreshdeskConfiguration/index.js",
11943 "groupTitle": "Freshdesk_Configurations"
11947 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11948 "title": "Gets configurations fields",
11951 "title": "Example usage:",
11952 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11956 "name": "getFields",
11957 "group": "Freshdesk_Configurations",
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/intFreshdeskConfiguration/index.js",
11961 "groupTitle": "Freshdesk_Configurations"
11965 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11966 "title": "Gets configurations subjects",
11969 "title": "Example usage:",
11970 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11974 "name": "getSubjects",
11975 "group": "Freshdesk_Configurations",
11976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11977 "version": "0.0.0",
11978 "filename": "server/api/intFreshdeskConfiguration/index.js",
11979 "groupTitle": "Freshdesk_Configurations"
11983 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11984 "title": "Gets configurations tags",
11987 "title": "Example usage:",
11988 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11993 "group": "Freshdesk_Configurations",
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/intFreshdeskConfiguration/index.js",
11997 "groupTitle": "Freshdesk_Configurations"
12001 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12002 "title": "Sets new tags",
12005 "title": "Example usage:",
12006 "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",
12011 "group": "Freshdesk_Configurations",
12012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12013 "version": "0.0.0",
12014 "filename": "server/api/intFreshdeskConfiguration/index.js",
12015 "groupTitle": "Freshdesk_Configurations"
12019 "url": "/api/integrations/freshdesk/configurations/{id}",
12020 "title": "Update an existing Freshdesk Configuration",
12023 "title": "Example usage:",
12024 "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",
12028 "name": "updateFreshdesk_Configurations",
12029 "group": "Freshdesk_Configurations",
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/intFreshdeskConfiguration/index.js",
12033 "groupTitle": "Freshdesk_Configurations"
12037 "url": "/api/integrations/freshdesk/fields",
12038 "title": "Creates a new Freshdesk Field",
12041 "title": "Example usage:",
12042 "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",
12046 "name": "CreateFreshdesk_Fields",
12047 "group": "Freshdesk_Fields",
12057 "\"customVariable\"",
12069 "field": "content",
12085 "\"customVariable\""
12088 "field": "keyType",
12095 "field": "keyContent",
12102 "field": "idField",
12109 "field": "nameField",
12116 "field": "customField",
12123 "field": "variableName",
12129 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12130 "version": "0.0.0",
12131 "filename": "server/api/intFreshdeskField/index.js",
12132 "groupTitle": "Freshdesk_Fields"
12136 "url": "/api/integrations/freshdesk/fields/{id}",
12137 "title": "Deletes a Freshdesk Field",
12140 "title": "Example usage:",
12141 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12145 "name": "DeleteFreshdesk_Fields",
12146 "group": "Freshdesk_Fields",
12147 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12148 "version": "0.0.0",
12149 "filename": "server/api/intFreshdeskField/index.js",
12150 "groupTitle": "Freshdesk_Fields"
12154 "url": "/api/integrations/freshdesk/fields",
12155 "title": "Gets a list of Freshdesk Fields",
12158 "title": "Example usage:",
12159 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12163 "name": "GetFreshdesk_Fields",
12164 "group": "Freshdesk_Fields",
12165 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12166 "version": "0.0.0",
12167 "filename": "server/api/intFreshdeskField/index.js",
12168 "groupTitle": "Freshdesk_Fields"
12172 "url": "/api/integrations/freshdesk/fields/{id}",
12173 "title": "Gets a single Freshdesk Field",
12176 "title": "Example usage:",
12177 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12181 "name": "ShowFreshdesk_Fields",
12182 "group": "Freshdesk_Fields",
12183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12184 "version": "0.0.0",
12185 "filename": "server/api/intFreshdeskField/index.js",
12186 "groupTitle": "Freshdesk_Fields"
12190 "url": "/api/integrations/freshdesk/fields/{id}",
12191 "title": "Update an existing Freshdesk Field",
12194 "title": "Example usage:",
12195 "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",
12199 "name": "updateFreshdesk_Fields",
12200 "group": "Freshdesk_Fields",
12201 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12202 "version": "0.0.0",
12203 "filename": "server/api/intFreshdeskField/index.js",
12204 "groupTitle": "Freshdesk_Fields"
12208 "url": "/api/integrations/freshsales/accounts",
12209 "title": "Creates a new Freshsales Account",
12212 "title": "Example usage:",
12213 "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",
12217 "name": "CreateFreshsales_Accounts",
12218 "group": "Freshsales_Accounts",
12233 "field": "description",
12240 "field": "username",
12254 "field": "remoteUri",
12261 "field": "serverUrl",
12267 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12268 "version": "0.0.0",
12269 "filename": "server/api/intFreshsalesAccount/index.js",
12270 "groupTitle": "Freshsales_Accounts"
12274 "url": "/api/integrations/freshsales/accounts/{id}",
12275 "title": "Deletes a Freshsales Account",
12278 "title": "Example usage:",
12279 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12283 "name": "DeleteFreshsales_Accounts",
12284 "group": "Freshsales_Accounts",
12285 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12286 "version": "0.0.0",
12287 "filename": "server/api/intFreshsalesAccount/index.js",
12288 "groupTitle": "Freshsales_Accounts"
12292 "url": "/api/integrations/freshsales/accounts",
12293 "title": "Gets a list of Freshsales Accounts",
12296 "title": "Example usage:",
12297 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12301 "name": "GetFreshsales_Accounts",
12302 "group": "Freshsales_Accounts",
12303 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12304 "version": "0.0.0",
12305 "filename": "server/api/intFreshsalesAccount/index.js",
12306 "groupTitle": "Freshsales_Accounts"
12310 "url": "/api/integrations/freshsales/accounts/{id}",
12311 "title": "Gets a single Freshsales Account",
12314 "title": "Example usage:",
12315 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12319 "name": "ShowFreshsales_Accounts",
12320 "group": "Freshsales_Accounts",
12321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12322 "version": "0.0.0",
12323 "filename": "server/api/intFreshsalesAccount/index.js",
12324 "groupTitle": "Freshsales_Accounts"
12328 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12329 "title": "Creates new configuration",
12332 "title": "Example usage:",
12333 "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",
12337 "name": "addConfiguration",
12338 "group": "Freshsales_Accounts",
12339 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12340 "version": "0.0.0",
12341 "filename": "server/api/intFreshsalesAccount/index.js",
12342 "groupTitle": "Freshsales_Accounts"
12346 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12347 "title": "Gets account configurations",
12350 "title": "Example usage:",
12351 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12355 "name": "getConfigurations",
12356 "group": "Freshsales_Accounts",
12357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12358 "version": "0.0.0",
12359 "filename": "server/api/intFreshsalesAccount/index.js",
12360 "groupTitle": "Freshsales_Accounts"
12364 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12365 "title": "Gets account fields",
12368 "title": "Example usage:",
12369 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12373 "name": "getFields",
12374 "group": "Freshsales_Accounts",
12375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12376 "version": "0.0.0",
12377 "filename": "server/api/intFreshsalesAccount/index.js",
12378 "groupTitle": "Freshsales_Accounts"
12382 "url": "/api/integrations/freshsales/accounts/{id}",
12383 "title": "Update an existing Freshsales Account",
12386 "title": "Example usage:",
12387 "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",
12391 "name": "updateFreshsales_Accounts",
12392 "group": "Freshsales_Accounts",
12393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12394 "version": "0.0.0",
12395 "filename": "server/api/intFreshsalesAccount/index.js",
12396 "groupTitle": "Freshsales_Accounts"
12400 "url": "/api/integrations/freshsales/configurations",
12401 "title": "Creates a new Freshsales Configuration",
12404 "title": "Example usage:",
12405 "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",
12409 "name": "CreateFreshsales_Configurations",
12410 "group": "Freshsales_Configurations",
12425 "field": "description",
12431 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12432 "version": "0.0.0",
12433 "filename": "server/api/intFreshsalesConfiguration/index.js",
12434 "groupTitle": "Freshsales_Configurations"
12438 "url": "/api/integrations/freshsales/configurations/{id}",
12439 "title": "Deletes a Freshsales Configuration",
12442 "title": "Example usage:",
12443 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12447 "name": "DeleteFreshsales_Configurations",
12448 "group": "Freshsales_Configurations",
12449 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12450 "version": "0.0.0",
12451 "filename": "server/api/intFreshsalesConfiguration/index.js",
12452 "groupTitle": "Freshsales_Configurations"
12456 "url": "/api/integrations/freshsales/configurations",
12457 "title": "Gets a list of Freshsales Configurations",
12460 "title": "Example usage:",
12461 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12465 "name": "GetFreshsales_Configurations",
12466 "group": "Freshsales_Configurations",
12467 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12468 "version": "0.0.0",
12469 "filename": "server/api/intFreshsalesConfiguration/index.js",
12470 "groupTitle": "Freshsales_Configurations"
12474 "url": "/api/integrations/freshsales/configurations/{id}",
12475 "title": "Gets a single Freshsales Configuration",
12478 "title": "Example usage:",
12479 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12483 "name": "ShowFreshsales_Configurations",
12484 "group": "Freshsales_Configurations",
12485 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12486 "version": "0.0.0",
12487 "filename": "server/api/intFreshsalesConfiguration/index.js",
12488 "groupTitle": "Freshsales_Configurations"
12492 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12493 "title": "Gets configurations descriptions",
12496 "title": "Example usage:",
12497 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12501 "name": "getDescriptions",
12502 "group": "Freshsales_Configurations",
12503 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12504 "version": "0.0.0",
12505 "filename": "server/api/intFreshsalesConfiguration/index.js",
12506 "groupTitle": "Freshsales_Configurations"
12510 "url": "/api/integrations/freshsales/configurations/{id}/fields",
12511 "title": "Gets configurations fields",
12514 "title": "Example usage:",
12515 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12519 "name": "getFields",
12520 "group": "Freshsales_Configurations",
12521 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12522 "version": "0.0.0",
12523 "filename": "server/api/intFreshsalesConfiguration/index.js",
12524 "groupTitle": "Freshsales_Configurations"
12528 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12529 "title": "Gets configurations subjects",
12532 "title": "Example usage:",
12533 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12537 "name": "getSubjects",
12538 "group": "Freshsales_Configurations",
12539 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12540 "version": "0.0.0",
12541 "filename": "server/api/intFreshsalesConfiguration/index.js",
12542 "groupTitle": "Freshsales_Configurations"
12546 "url": "/api/integrations/freshsales/configurations/{id}",
12547 "title": "Update an existing Freshsales Configuration",
12550 "title": "Example usage:",
12551 "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",
12555 "name": "updateFreshsales_Configurations",
12556 "group": "Freshsales_Configurations",
12557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12558 "version": "0.0.0",
12559 "filename": "server/api/intFreshsalesConfiguration/index.js",
12560 "groupTitle": "Freshsales_Configurations"
12564 "url": "/api/integrations/freshsales/fields",
12565 "title": "Creates a new Freshsales Field",
12568 "title": "Example usage:",
12569 "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",
12573 "name": "CreateFreshsales_Fields",
12574 "group": "Freshsales_Fields",
12584 "\"customVariable\"",
12596 "field": "content",
12612 "\"customVariable\""
12615 "field": "keyType",
12622 "field": "keyContent",
12629 "field": "idField",
12636 "field": "nameField",
12643 "field": "customField",
12650 "field": "variableName",
12656 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12657 "version": "0.0.0",
12658 "filename": "server/api/intFreshsalesField/index.js",
12659 "groupTitle": "Freshsales_Fields"
12663 "url": "/api/integrations/freshsales/fields/{id}",
12664 "title": "Deletes a Freshsales Field",
12667 "title": "Example usage:",
12668 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12672 "name": "DeleteFreshsales_Fields",
12673 "group": "Freshsales_Fields",
12674 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12675 "version": "0.0.0",
12676 "filename": "server/api/intFreshsalesField/index.js",
12677 "groupTitle": "Freshsales_Fields"
12681 "url": "/api/integrations/freshsales/fields",
12682 "title": "Gets a list of Freshsales Fields",
12685 "title": "Example usage:",
12686 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12690 "name": "GetFreshsales_Fields",
12691 "group": "Freshsales_Fields",
12692 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12693 "version": "0.0.0",
12694 "filename": "server/api/intFreshsalesField/index.js",
12695 "groupTitle": "Freshsales_Fields"
12699 "url": "/api/integrations/freshsales/fields/{id}",
12700 "title": "Gets a single Freshsales Field",
12703 "title": "Example usage:",
12704 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12708 "name": "ShowFreshsales_Fields",
12709 "group": "Freshsales_Fields",
12710 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12711 "version": "0.0.0",
12712 "filename": "server/api/intFreshsalesField/index.js",
12713 "groupTitle": "Freshsales_Fields"
12717 "url": "/api/integrations/freshsales/fields/{id}",
12718 "title": "Update an existing Freshsales Field",
12721 "title": "Example usage:",
12722 "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",
12726 "name": "updateFreshsales_Fields",
12727 "group": "Freshsales_Fields",
12728 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12729 "version": "0.0.0",
12730 "filename": "server/api/intFreshsalesField/index.js",
12731 "groupTitle": "Freshsales_Fields"
12735 "url": "/api/campaigns/{id}/blacklists",
12736 "title": "Add blacklists to an IVR campaign",
12739 "title": "Example usage:",
12740 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12744 "name": "AddBlackLists",
12745 "group": "IVR_Campaigns",
12746 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12747 "version": "0.0.0",
12748 "filename": "server/api/campaign/index.js",
12749 "groupTitle": "IVR_Campaigns"
12753 "url": "/api/campaigns/{id}/lists",
12754 "title": "Add lists to an IVR campaign",
12757 "title": "Example usage:",
12758 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12762 "name": "AddLists",
12763 "group": "IVR_Campaigns",
12764 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12765 "version": "0.0.0",
12766 "filename": "server/api/campaign/index.js",
12767 "groupTitle": "IVR_Campaigns"
12771 "url": "/api/campaigns/clone",
12772 "title": "Clone an existing IVR Campaign",
12775 "title": "Example usage:",
12776 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12780 "name": "CloneIVR_Campaigns",
12781 "group": "IVR_Campaigns",
12782 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12783 "version": "0.0.0",
12784 "filename": "server/api/campaign/index.js",
12785 "groupTitle": "IVR_Campaigns"
12789 "url": "/api/campaigns",
12790 "title": "Creates a new IVR Campaign",
12793 "title": "Example usage:",
12794 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12798 "name": "CreateIVR_Campaigns",
12799 "group": "IVR_Campaigns",
12824 "field": "description",
12832 "description": "<p>Active/Disactive Campaign</p>"
12838 "field": "limitCalls",
12839 "description": "<p>Max 200 calls.</p>"
12845 "field": "dialOriginateCallerIdName",
12852 "field": "dialOriginateCallerIdNumber",
12859 "field": "dialOriginateTimeout",
12860 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12866 "field": "dialCongestionMaxRetry",
12867 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12873 "field": "dialCongestionRetryFrequency",
12874 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12880 "field": "dialBusyMaxRetry",
12881 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12887 "field": "dialBusyRetryFrequency",
12888 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12894 "field": "dialNoAnswerMaxRetry",
12895 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12901 "field": "dialNoAnswerRetryFrequency",
12902 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12908 "field": "dialGlobalMaxRetry",
12909 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12915 "field": "dialTimezone",
12922 "field": "dialGlobalInterval",
12934 "field": "dialCheckDuplicateType",
12941 "field": "dialAMDActive",
12942 "description": "<p>Active/Disactive AMD</p>"
12948 "field": "dialAMDInitialSilence",
12949 "description": "<p>#AMD Initial Silence</p>"
12955 "field": "dialAMDGreeting",
12956 "description": "<p>#AMD Greeting</p>"
12962 "field": "dialAMDAfterGreetingSilence",
12963 "description": "<p>#AMD After Greeting Silence</p>"
12969 "field": "dialAMDTotalAnalysisTime",
12970 "description": "<p>#AMD Total Analysis Time</p>"
12976 "field": "dialAMDMinWordLength",
12977 "description": "<p>#AMD Min Word Length</p>"
12983 "field": "dialAMDBetweenWordsSilence",
12984 "description": "<p>#AMD Between Words Silence</p>"
12990 "field": "dialAMDMaximumNumberOfWords",
12991 "description": "<p>#AMD Maximum Number Of Words</p>"
12997 "field": "dialAMDSilenceThreshold",
12998 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
13004 "field": "dialAMDMaximumWordLength",
13005 "description": "<p>#AMD Maximum Word Length</p>"
13015 "field": "dialOrderByScheduledAt",
13022 "field": "dialPrefix",
13029 "field": "dialRandomLastDigitCallerIdNumber",
13030 "description": "<p>Random Last Digit (min:1, max:15)</p>"
13036 "field": "dialCutDigit",
13037 "description": "<p>Cut Digit (min:1, max:15)</p>"
13043 "field": "dialNoSuchNumberMaxRetry",
13044 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13050 "field": "dialNoSuchNumberRetryFrequency",
13051 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13057 "field": "dialDropMaxRetry",
13058 "description": "<p>#Drop Retry (min:1, max:999)</p>"
13064 "field": "dialDropRetryFrequency",
13065 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13071 "field": "dialAbandonedMaxRetry",
13072 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13078 "field": "dialAbandonedRetryFrequency",
13079 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13085 "field": "dialMachineMaxRetry",
13086 "description": "<p>#Machine Retry (min:1, max:999)</p>"
13092 "field": "dialMachineRetryFrequency",
13093 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13099 "field": "dialAgentRejectMaxRetry",
13100 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13106 "field": "dialAgentRejectRetryFrequency",
13107 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13112 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13113 "version": "0.0.0",
13114 "filename": "server/api/campaign/index.js",
13115 "groupTitle": "IVR_Campaigns"
13119 "url": "/api/campaigns/{id}",
13120 "title": "Deletes a IVR Campaign",
13123 "title": "Example usage:",
13124 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13128 "name": "DeleteIVR_Campaigns",
13129 "group": "IVR_Campaigns",
13130 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13131 "version": "0.0.0",
13132 "filename": "server/api/campaign/index.js",
13133 "groupTitle": "IVR_Campaigns"
13137 "url": "/api/campaigns/{id}/blacklists",
13138 "title": "Get IVR campaign blacklists",
13141 "title": "Example usage:",
13142 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13146 "name": "GetBlackLists",
13147 "group": "IVR_Campaigns",
13148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13149 "version": "0.0.0",
13150 "filename": "server/api/campaign/index.js",
13151 "groupTitle": "IVR_Campaigns"
13155 "url": "/api/campaigns/{id}/finals",
13156 "title": "Gets IVR campaign hopper finals",
13159 "title": "Example usage:",
13160 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
13164 "name": "GetHopperFinals",
13165 "group": "IVR_Campaigns",
13166 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13167 "version": "0.0.0",
13168 "filename": "server/api/campaign/index.js",
13169 "groupTitle": "IVR_Campaigns"
13173 "url": "/api/campaigns/{id}/hopper_histories",
13174 "title": "Gets IVR campaign hopper histories",
13177 "title": "Example usage:",
13178 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13182 "name": "GetHopperHistories",
13183 "group": "IVR_Campaigns",
13184 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13185 "version": "0.0.0",
13186 "filename": "server/api/campaign/index.js",
13187 "groupTitle": "IVR_Campaigns"
13191 "url": "/api/campaigns/{id}/hoppers",
13192 "title": "Gets IVR campaign hoppers",
13195 "title": "Example usage:",
13196 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13200 "name": "GetHoppers",
13201 "group": "IVR_Campaigns",
13202 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13203 "version": "0.0.0",
13204 "filename": "server/api/campaign/index.js",
13205 "groupTitle": "IVR_Campaigns"
13209 "url": "/api/campaigns",
13210 "title": "Gets a list of IVR Campaigns",
13213 "title": "Example usage:",
13214 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13218 "name": "GetIVR_Campaigns",
13219 "group": "IVR_Campaigns",
13220 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13221 "version": "0.0.0",
13222 "filename": "server/api/campaign/index.js",
13223 "groupTitle": "IVR_Campaigns"
13227 "url": "/api/campaigns/{id}/lists",
13228 "title": "Get IVR campaign lists",
13231 "title": "Example usage:",
13232 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13236 "name": "GetLists",
13237 "group": "IVR_Campaigns",
13238 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13239 "version": "0.0.0",
13240 "filename": "server/api/campaign/index.js",
13241 "groupTitle": "IVR_Campaigns"
13245 "url": "/api/campaigns/{id}/blacklists",
13246 "title": "Remove blacklists from an IVR Campaign",
13249 "title": "Example usage:",
13250 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13254 "name": "RemoveBlackLists",
13255 "group": "IVR_Campaigns",
13256 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13257 "version": "0.0.0",
13258 "filename": "server/api/campaign/index.js",
13259 "groupTitle": "IVR_Campaigns"
13263 "url": "/api/campaigns/{id}/lists",
13264 "title": "Remove lists from an IVR Campaign",
13267 "title": "Example usage:",
13268 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13272 "name": "RemoveLists",
13273 "group": "IVR_Campaigns",
13274 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13275 "version": "0.0.0",
13276 "filename": "server/api/campaign/index.js",
13277 "groupTitle": "IVR_Campaigns"
13281 "url": "/api/campaigns/{id}",
13282 "title": "Gets a single IVR Campaign",
13285 "title": "Example usage:",
13286 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13290 "name": "ShowIVR_Campaigns",
13291 "group": "IVR_Campaigns",
13292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13293 "version": "0.0.0",
13294 "filename": "server/api/campaign/index.js",
13295 "groupTitle": "IVR_Campaigns"
13299 "url": "/api/campaigns/{id}/blacks",
13300 "title": "Gets IVR campaign hopper blacks",
13303 "title": "Example usage:",
13304 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13308 "name": "getHopperBlacks",
13309 "group": "IVR_Campaigns",
13310 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13311 "version": "0.0.0",
13312 "filename": "server/api/campaign/index.js",
13313 "groupTitle": "IVR_Campaigns"
13317 "url": "/api/campaigns/{id}",
13318 "title": "Update an existing IVR Campaign",
13321 "title": "Example usage:",
13322 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13326 "name": "updateIVR_Campaigns",
13327 "group": "IVR_Campaigns",
13328 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13329 "version": "0.0.0",
13330 "filename": "server/api/campaign/index.js",
13331 "groupTitle": "IVR_Campaigns"
13335 "url": "/api/integrations/reports",
13336 "title": "Creates a new Integration Report",
13339 "title": "Example usage:",
13340 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13344 "name": "CreateIntegration_Reports",
13345 "group": "Integration_Reports",
13353 "field": "integration",
13360 "field": "eventChannel",
13367 "field": "exitStatus",
13374 "field": "ticketId",
13381 "field": "integrationId",
13388 "field": "contacts",
13395 "field": "uniqueid",
13402 "field": "calleridnum",
13409 "field": "calleridname",
13423 "field": "interface",
13430 "field": "membername",
13437 "field": "agentcalledAt",
13444 "field": "agentconnectAt",
13451 "field": "holdtime",
13458 "field": "agentcomplete",
13465 "field": "agentcompleteAt",
13472 "field": "talktime",
13479 "field": "agentacw",
13486 "field": "acwtime",
13500 "field": "agentringnoanswer",
13507 "field": "agentringnoanswerAt",
13514 "field": "agentdump",
13521 "field": "agentdumpAt",
13528 "field": "lastevent",
13535 "field": "channel",
13542 "field": "channelstate",
13549 "field": "channelstatedesc",
13556 "field": "connectedlinenum",
13563 "field": "connectedlinename",
13570 "field": "language",
13577 "field": "accountcode",
13584 "field": "context",
13598 "field": "priority",
13605 "field": "destchannel",
13612 "field": "destchannelstate",
13619 "field": "destchannelstatedesc",
13626 "field": "destcalleridnum",
13633 "field": "destcalleridname",
13640 "field": "destconnectedlinenum",
13647 "field": "destconnectedlinename",
13654 "field": "destlanguage",
13661 "field": "destaccountcode",
13668 "field": "destcontext",
13675 "field": "destexten",
13682 "field": "destpriority",
13689 "field": "destuniqueid",
13696 "field": "messageId",
13703 "field": "inReplyTo",
13710 "field": "subject",
13738 "field": "attachment",
13786 "field": "appdata",
13793 "field": "projectId",
13799 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13800 "version": "0.0.0",
13801 "filename": "server/api/integrationReport/index.js",
13802 "groupTitle": "Integration_Reports"
13806 "url": "/api/integrations/reports/{id}",
13807 "title": "Deletes a Integration Report",
13810 "title": "Example usage:",
13811 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13815 "name": "DeleteIntegration_Reports",
13816 "group": "Integration_Reports",
13817 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13818 "version": "0.0.0",
13819 "filename": "server/api/integrationReport/index.js",
13820 "groupTitle": "Integration_Reports"
13824 "url": "/api/integrations/reports/describe",
13825 "title": "Gets table info about Integration Reports",
13828 "title": "Example usage:",
13829 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13833 "name": "DescribeIntegration_Reports",
13834 "group": "Integration_Reports",
13835 "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>",
13836 "version": "0.0.0",
13837 "filename": "server/api/integrationReport/index.js",
13838 "groupTitle": "Integration_Reports"
13842 "url": "/api/integrations/reports",
13843 "title": "Gets a list of Integration Reports",
13846 "title": "Example usage:",
13847 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13851 "name": "GetIntegration_Reports",
13852 "group": "Integration_Reports",
13853 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13854 "version": "0.0.0",
13855 "filename": "server/api/integrationReport/index.js",
13856 "groupTitle": "Integration_Reports"
13860 "url": "/api/integrations/reports/{id}",
13861 "title": "Gets a single Integration Report",
13864 "title": "Example usage:",
13865 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13869 "name": "ShowIntegration_Reports",
13870 "group": "Integration_Reports",
13871 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13872 "version": "0.0.0",
13873 "filename": "server/api/integrationReport/index.js",
13874 "groupTitle": "Integration_Reports"
13878 "url": "/api/integrations/reports/{id}",
13879 "title": "Update an existing Integration Report",
13882 "title": "Example usage:",
13883 "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",
13887 "name": "updateIntegration_Reports",
13888 "group": "Integration_Reports",
13889 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13890 "version": "0.0.0",
13891 "filename": "server/api/integrationReport/index.js",
13892 "groupTitle": "Integration_Reports"
13896 "url": "/api/intervals",
13897 "title": "Creates a new Interval",
13900 "title": "Example usage:",
13901 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13905 "name": "CreateIntervals",
13906 "group": "Intervals",
13921 "field": "description",
13928 "field": "interval",
13934 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13935 "version": "0.0.0",
13936 "filename": "server/api/interval/index.js",
13937 "groupTitle": "Intervals"
13941 "url": "/api/intervals/{id}",
13942 "title": "Deletes a Interval",
13945 "title": "Example usage:",
13946 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13950 "name": "DeleteIntervals",
13951 "group": "Intervals",
13952 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13953 "version": "0.0.0",
13954 "filename": "server/api/interval/index.js",
13955 "groupTitle": "Intervals"
13959 "url": "/api/intervals",
13960 "title": "Gets a list of Intervals",
13963 "title": "Example usage:",
13964 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13968 "name": "GetIntervals",
13969 "group": "Intervals",
13970 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13971 "version": "0.0.0",
13972 "filename": "server/api/interval/index.js",
13973 "groupTitle": "Intervals"
13977 "url": "/api/intervals/{id}",
13978 "title": "Gets a single Interval",
13981 "title": "Example usage:",
13982 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13986 "name": "ShowIntervals",
13987 "group": "Intervals",
13988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13989 "version": "0.0.0",
13990 "filename": "server/api/interval/index.js",
13991 "groupTitle": "Intervals"
13995 "url": "/api/intervals/{id}/sub_intervals",
13996 "title": "Creates a new sub interval",
13999 "title": "Example usage:",
14000 "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",
14004 "name": "addInterval",
14005 "group": "Intervals",
14006 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14007 "version": "0.0.0",
14008 "filename": "server/api/interval/index.js",
14009 "groupTitle": "Intervals"
14013 "url": "/api/intervals/{id}/sub_intervals/create_many",
14014 "title": "Create new sub intervals set",
14017 "title": "Example usage:",
14018 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14022 "name": "addIntervals",
14023 "group": "Intervals",
14024 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14025 "version": "0.0.0",
14026 "filename": "server/api/interval/index.js",
14027 "groupTitle": "Intervals"
14031 "url": "/api/intervals/{id}/sub_intervals",
14032 "title": "Get sub intervals set",
14035 "title": "Example usage:",
14036 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
14040 "name": "getIntervals",
14041 "group": "Intervals",
14042 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14043 "version": "0.0.0",
14044 "filename": "server/api/interval/index.js",
14045 "groupTitle": "Intervals"
14049 "url": "/api/intervals/{id}",
14050 "title": "Update an existing Interval",
14053 "title": "Example usage:",
14054 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14058 "name": "updateIntervals",
14059 "group": "Intervals",
14060 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14061 "version": "0.0.0",
14062 "filename": "server/api/interval/index.js",
14063 "groupTitle": "Intervals"
14067 "url": "/api/jira",
14068 "title": "Creates a new issue",
14071 "title": "Example usage:",
14072 "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}",
14076 "name": "Creates_Issue",
14088 "field": "issuetype",
14095 "field": "summary",
14102 "field": "description",
14108 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14109 "version": "0.0.0",
14110 "filename": "server/api/jira/index.js",
14111 "groupTitle": "Issue"
14115 "url": "/api/jscripty/answers/reports",
14116 "title": "Creates a new Report",
14119 "title": "Example usage:",
14120 "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",
14124 "name": "CreateReports",
14125 "group": "JscriptyAnswerReport",
14133 "field": "question",
14147 "field": "membername",
14154 "field": "projectname",
14168 "field": "uniqueid",
14175 "field": "calleridname",
14182 "field": "calleridnum",
14189 "field": "questionId",
14195 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14196 "version": "0.0.0",
14197 "filename": "server/api/jscriptyAnswerReport/index.js",
14198 "groupTitle": "JscriptyAnswerReport"
14202 "url": "/api/jscripty/answers/reports/{id}",
14203 "title": "Deletes a Report",
14206 "title": "Example usage:",
14207 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14211 "name": "DeleteReports",
14212 "group": "JscriptyAnswerReport",
14213 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14214 "version": "0.0.0",
14215 "filename": "server/api/jscriptyAnswerReport/index.js",
14216 "groupTitle": "JscriptyAnswerReport"
14220 "url": "/api/jscripty/answers/reports/describe",
14221 "title": "Gets table info about Reports",
14224 "title": "Example usage:",
14225 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14229 "name": "DescribeReports",
14230 "group": "JscriptyAnswerReport",
14231 "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>",
14232 "version": "0.0.0",
14233 "filename": "server/api/jscriptyAnswerReport/index.js",
14234 "groupTitle": "JscriptyAnswerReport"
14238 "url": "/api/jscripty/answers/reports",
14239 "title": "Gets a list of Reports",
14242 "title": "Example usage:",
14243 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14247 "name": "GetReports",
14248 "group": "JscriptyAnswerReport",
14249 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14250 "version": "0.0.0",
14251 "filename": "server/api/jscriptyAnswerReport/index.js",
14252 "groupTitle": "JscriptyAnswerReport"
14256 "url": "/api/jscripty/answers/reports/{id}",
14257 "title": "Gets a single Report",
14260 "title": "Example usage:",
14261 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14265 "name": "ShowReports",
14266 "group": "JscriptyAnswerReport",
14267 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14268 "version": "0.0.0",
14269 "filename": "server/api/jscriptyAnswerReport/index.js",
14270 "groupTitle": "JscriptyAnswerReport"
14274 "url": "/api/jscripty/answers/reports/{id}",
14275 "title": "Update an existing Report",
14278 "title": "Example usage:",
14279 "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",
14283 "name": "updateReports",
14284 "group": "JscriptyAnswerReport",
14285 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14286 "version": "0.0.0",
14287 "filename": "server/api/jscriptyAnswerReport/index.js",
14288 "groupTitle": "JscriptyAnswerReport"
14292 "url": "/api/jscripty/questions/reports",
14293 "title": "Creates a new Report",
14296 "title": "Example usage:",
14297 "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",
14301 "name": "CreateReports",
14302 "group": "JscriptyQuestionReport",
14310 "field": "question",
14324 "field": "membername",
14331 "field": "projectname",
14345 "field": "uniqueid",
14352 "field": "calleridname",
14359 "field": "calleridnum",
14366 "field": "questionId",
14372 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14373 "version": "0.0.0",
14374 "filename": "server/api/jscriptyQuestionReport/index.js",
14375 "groupTitle": "JscriptyQuestionReport"
14379 "url": "/api/jscripty/questions/reports/{id}",
14380 "title": "Deletes a Report",
14383 "title": "Example usage:",
14384 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14388 "name": "DeleteReports",
14389 "group": "JscriptyQuestionReport",
14390 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14391 "version": "0.0.0",
14392 "filename": "server/api/jscriptyQuestionReport/index.js",
14393 "groupTitle": "JscriptyQuestionReport"
14397 "url": "/api/jscripty/questions/reports/describe",
14398 "title": "Gets table info about Reports",
14401 "title": "Example usage:",
14402 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14406 "name": "DescribeReports",
14407 "group": "JscriptyQuestionReport",
14408 "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>",
14409 "version": "0.0.0",
14410 "filename": "server/api/jscriptyQuestionReport/index.js",
14411 "groupTitle": "JscriptyQuestionReport"
14415 "url": "/api/jscripty/questions/reports",
14416 "title": "Gets a list of Reports",
14419 "title": "Example usage:",
14420 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14424 "name": "GetReports",
14425 "group": "JscriptyQuestionReport",
14426 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14427 "version": "0.0.0",
14428 "filename": "server/api/jscriptyQuestionReport/index.js",
14429 "groupTitle": "JscriptyQuestionReport"
14433 "url": "/api/jscripty/questions/reports/{id}",
14434 "title": "Gets a single Report",
14437 "title": "Example usage:",
14438 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14442 "name": "ShowReports",
14443 "group": "JscriptyQuestionReport",
14444 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14445 "version": "0.0.0",
14446 "filename": "server/api/jscriptyQuestionReport/index.js",
14447 "groupTitle": "JscriptyQuestionReport"
14451 "url": "/api/jscripty/questions/reports/{id}",
14452 "title": "Update an existing Report",
14455 "title": "Example usage:",
14456 "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",
14460 "name": "updateReports",
14461 "group": "JscriptyQuestionReport",
14462 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14463 "version": "0.0.0",
14464 "filename": "server/api/jscriptyQuestionReport/index.js",
14465 "groupTitle": "JscriptyQuestionReport"
14469 "url": "/api/jscripty/sessions/reports",
14470 "title": "Creates a new Report",
14473 "title": "Example usage:",
14474 "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",
14478 "name": "CreateReports",
14479 "group": "JscriptySessionReport",
14487 "field": "starttime",
14494 "field": "endtime",
14501 "field": "membername",
14508 "field": "projectname",
14522 "field": "uniqueid",
14529 "field": "calleridname",
14536 "field": "calleridnum",
14543 "field": "completed",
14549 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14550 "version": "0.0.0",
14551 "filename": "server/api/jscriptySessionReport/index.js",
14552 "groupTitle": "JscriptySessionReport"
14556 "url": "/api/jscripty/sessions/reports/{id}",
14557 "title": "Deletes a Report",
14560 "title": "Example usage:",
14561 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14565 "name": "DeleteReports",
14566 "group": "JscriptySessionReport",
14567 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14568 "version": "0.0.0",
14569 "filename": "server/api/jscriptySessionReport/index.js",
14570 "groupTitle": "JscriptySessionReport"
14574 "url": "/api/jscripty/sessions/reports/describe",
14575 "title": "Gets table info about Reports",
14578 "title": "Example usage:",
14579 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14583 "name": "DescribeReports",
14584 "group": "JscriptySessionReport",
14585 "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>",
14586 "version": "0.0.0",
14587 "filename": "server/api/jscriptySessionReport/index.js",
14588 "groupTitle": "JscriptySessionReport"
14592 "url": "/api/jscripty/sessions/reports",
14593 "title": "Gets a list of Reports",
14596 "title": "Example usage:",
14597 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14601 "name": "GetReports",
14602 "group": "JscriptySessionReport",
14603 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14604 "version": "0.0.0",
14605 "filename": "server/api/jscriptySessionReport/index.js",
14606 "groupTitle": "JscriptySessionReport"
14610 "url": "/api/jscripty/sessions/reports/{id}",
14611 "title": "Gets a single Report",
14614 "title": "Example usage:",
14615 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14619 "name": "ShowReports",
14620 "group": "JscriptySessionReport",
14621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14622 "version": "0.0.0",
14623 "filename": "server/api/jscriptySessionReport/index.js",
14624 "groupTitle": "JscriptySessionReport"
14628 "url": "/api/jscripty/sessions/reports/{id}/questions",
14629 "title": "Gets Jscripty Session questions",
14632 "title": "Example usage:",
14633 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14637 "name": "getQuestions",
14638 "group": "JscriptySessionReport",
14639 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14640 "version": "0.0.0",
14641 "filename": "server/api/jscriptySessionReport/index.js",
14642 "groupTitle": "JscriptySessionReport"
14646 "url": "/api/jscripty/sessions/reports/{id}",
14647 "title": "Update an existing Report",
14650 "title": "Example usage:",
14651 "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",
14655 "name": "updateReports",
14656 "group": "JscriptySessionReport",
14657 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14658 "version": "0.0.0",
14659 "filename": "server/api/jscriptySessionReport/index.js",
14660 "groupTitle": "JscriptySessionReport"
14664 "url": "/api/jscripty/projects/clone",
14665 "title": "Clone an existing Project",
14668 "title": "Example usage:",
14669 "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",
14673 "name": "CloneProjects",
14674 "group": "Jscripty_Projects",
14675 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14676 "version": "0.0.0",
14677 "filename": "server/api/jscriptyProject/index.js",
14678 "groupTitle": "Jscripty_Projects"
14682 "url": "/api/jscripty/projects",
14683 "title": "Creates a new Project",
14686 "title": "Example usage:",
14687 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14691 "name": "CreateProjects",
14692 "group": "Jscripty_Projects",
14707 "field": "description",
14714 "field": "formData",
14721 "field": "enableUncompleteSave",
14728 "field": "sendUnpauseOnSubmit",
14734 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14735 "version": "0.0.0",
14736 "filename": "server/api/jscriptyProject/index.js",
14737 "groupTitle": "Jscripty_Projects"
14741 "url": "/api/jscripty/projects/{id}",
14742 "title": "Deletes a Project",
14745 "title": "Example usage:",
14746 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14750 "name": "DeleteProjects",
14751 "group": "Jscripty_Projects",
14752 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14753 "version": "0.0.0",
14754 "filename": "server/api/jscriptyProject/index.js",
14755 "groupTitle": "Jscripty_Projects"
14759 "url": "/api/jscripty/projects",
14760 "title": "Gets a list of Projects",
14763 "title": "Example usage:",
14764 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14768 "name": "GetProjects",
14769 "group": "Jscripty_Projects",
14770 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14771 "version": "0.0.0",
14772 "filename": "server/api/jscriptyProject/index.js",
14773 "groupTitle": "Jscripty_Projects"
14777 "url": "/api/jscripty/projects/{id}",
14778 "title": "Gets a single Project",
14781 "title": "Example usage:",
14782 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14786 "name": "ShowProjects",
14787 "group": "Jscripty_Projects",
14788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14789 "version": "0.0.0",
14790 "filename": "server/api/jscriptyProject/index.js",
14791 "groupTitle": "Jscripty_Projects"
14795 "url": "/api/jscripty/projects/{id}/answers",
14796 "title": "Gets jscripty project answers",
14799 "title": "Example usage:",
14800 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14804 "name": "getAnswers",
14805 "group": "Jscripty_Projects",
14806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14807 "version": "0.0.0",
14808 "filename": "server/api/jscriptyProject/index.js",
14809 "groupTitle": "Jscripty_Projects"
14813 "url": "/api/jscripty/projects/{id}/sessions",
14814 "title": "Gets jscripty project sessions",
14817 "title": "Example usage:",
14818 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14822 "name": "getSessions",
14823 "group": "Jscripty_Projects",
14824 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14825 "version": "0.0.0",
14826 "filename": "server/api/jscriptyProject/index.js",
14827 "groupTitle": "Jscripty_Projects"
14831 "url": "/api/jscripty/projects/{id}/summary",
14832 "title": "Gets jscripty project summary",
14835 "title": "Example usage:",
14836 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14840 "name": "getSummary",
14841 "group": "Jscripty_Projects",
14842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14843 "version": "0.0.0",
14844 "filename": "server/api/jscriptyProject/index.js",
14845 "groupTitle": "Jscripty_Projects"
14849 "url": "/api/jscripty/projects/{id}",
14850 "title": "Update an existing Project",
14853 "title": "Example usage:",
14854 "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",
14858 "name": "updateProjects",
14859 "group": "Jscripty_Projects",
14860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14861 "version": "0.0.0",
14862 "filename": "server/api/jscriptyProject/index.js",
14863 "groupTitle": "Jscripty_Projects"
14867 "url": "/api/license",
14868 "title": "Gets License Info",
14871 "title": "Example usage:",
14872 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14877 "group": "License",
14878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14879 "version": "0.0.0",
14880 "filename": "server/api/license/index.js",
14881 "groupTitle": "License"
14885 "url": "/api/license/{id}",
14886 "title": "Update License Info",
14889 "title": "Example usage:",
14890 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14895 "group": "License",
14896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14897 "version": "0.0.0",
14898 "filename": "server/api/license/index.js",
14899 "groupTitle": "License"
14903 "url": "/api/mail/accounts/{id}/users",
14904 "title": "Add agents to a mail account",
14907 "title": "Example usage:",
14908 "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",
14912 "name": "AddAgents",
14913 "group": "Mail_Accounts",
14914 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14915 "version": "0.0.0",
14916 "filename": "server/api/mailAccount/index.js",
14917 "groupTitle": "Mail_Accounts"
14921 "url": "/api/mail/accounts/{id}/in_servers",
14922 "title": "Creates a new IMAP server",
14925 "title": "Example usage:",
14926 "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",
14931 "group": "Mail_Accounts",
14939 "field": "description",
14953 "field": "authentication",
14967 "field": "password",
14988 "field": "mailbox",
14995 "field": "connTimeout",
15002 "field": "authTimeout",
15009 "field": "service",
15015 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15016 "version": "0.0.0",
15017 "filename": "server/api/mailAccount/index.js",
15018 "groupTitle": "Mail_Accounts"
15022 "url": "/api/mail/accounts/{id}/out_servers",
15023 "title": "Creates a new SMTP server",
15026 "title": "Example usage:",
15027 "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",
15032 "group": "Mail_Accounts",
15040 "field": "description",
15082 "field": "service",
15089 "field": "authentication",
15095 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15096 "version": "0.0.0",
15097 "filename": "server/api/mailAccount/index.js",
15098 "groupTitle": "Mail_Accounts"
15102 "url": "/api/mail/accounts/{id}",
15103 "title": "Deletes a mail account",
15106 "title": "Example usage:",
15107 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15111 "name": "DeleteMailAccounts",
15112 "group": "Mail_Accounts",
15113 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15114 "version": "0.0.0",
15115 "filename": "server/api/mailAccount/index.js",
15116 "groupTitle": "Mail_Accounts"
15120 "url": "/api/mail/accounts/describe",
15121 "title": "Gets table info about Accounts",
15124 "title": "Example usage:",
15125 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15129 "name": "DescribeAccounts",
15130 "group": "Mail_Accounts",
15131 "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>",
15132 "version": "0.0.0",
15133 "filename": "server/api/mailAccount/index.js",
15134 "groupTitle": "Mail_Accounts"
15138 "url": "/api/mail/accounts",
15139 "title": "Gets a list of Accounts",
15142 "title": "Example usage:",
15143 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15147 "name": "GetAccounts",
15148 "group": "Mail_Accounts",
15149 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15150 "version": "0.0.0",
15151 "filename": "server/api/mailAccount/index.js",
15152 "groupTitle": "Mail_Accounts"
15156 "url": "/api/mail/accounts/{id}/users",
15157 "title": "Gets agents from mail account",
15160 "title": "Example usage:",
15161 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15165 "name": "GetAgents",
15166 "group": "Mail_Accounts",
15167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15168 "version": "0.0.0",
15169 "filename": "server/api/mailAccount/index.js",
15170 "groupTitle": "Mail_Accounts"
15174 "url": "/api/mail/accounts/{id}/in_servers",
15175 "title": "Gets account IMAP server",
15178 "title": "Example usage:",
15179 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15184 "group": "Mail_Accounts",
15185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15186 "version": "0.0.0",
15187 "filename": "server/api/mailAccount/index.js",
15188 "groupTitle": "Mail_Accounts"
15192 "url": "/api/mail/accounts/{id}/out_servers",
15193 "title": "Gets account SMTP server",
15196 "title": "Example usage:",
15197 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15202 "group": "Mail_Accounts",
15203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15204 "version": "0.0.0",
15205 "filename": "server/api/mailAccount/index.js",
15206 "groupTitle": "Mail_Accounts"
15210 "url": "/api/mail/accounts/{id}/users",
15211 "title": "Removes agents from a mail account",
15214 "title": "Example usage:",
15215 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15219 "name": "RemoveAgents",
15220 "group": "Mail_Accounts",
15221 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15222 "version": "0.0.0",
15223 "filename": "server/api/mailAccount/index.js",
15224 "groupTitle": "Mail_Accounts"
15228 "url": "/api/mail/accounts/{id}/canned_answers",
15229 "title": "Removes canned answers from account",
15232 "title": "Example usage:",
15233 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15237 "name": "RemoveAnswers",
15238 "group": "Mail_Accounts",
15239 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15240 "version": "0.0.0",
15241 "filename": "server/api/mailAccount/index.js",
15242 "groupTitle": "Mail_Accounts"
15246 "url": "/api/mail/accounts/{id}/dispositions",
15247 "title": "Removes dispositions from account",
15250 "title": "Example usage:",
15251 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15255 "name": "RemoveDispositions",
15256 "group": "Mail_Accounts",
15257 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15258 "version": "0.0.0",
15259 "filename": "server/api/mailAccount/index.js",
15260 "groupTitle": "Mail_Accounts"
15264 "url": "/api/mail/accounts/{id}/in_servers",
15265 "title": "Removes IMAP server from an account",
15268 "title": "Example usage:",
15269 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15273 "name": "RemoveImmap",
15274 "group": "Mail_Accounts",
15275 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15276 "version": "0.0.0",
15277 "filename": "server/api/mailAccount/index.js",
15278 "groupTitle": "Mail_Accounts"
15282 "url": "/api/mail/accounts/{id}/out_servers",
15283 "title": "Removes SMTP server from an account",
15286 "title": "Example usage:",
15287 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15291 "name": "RemoveSmtp",
15292 "group": "Mail_Accounts",
15293 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15294 "version": "0.0.0",
15295 "filename": "server/api/mailAccount/index.js",
15296 "groupTitle": "Mail_Accounts"
15300 "url": "/api/mail/accounts/{id}",
15301 "title": "Gets a single Account",
15304 "title": "Example usage:",
15305 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15309 "name": "ShowAccounts",
15310 "group": "Mail_Accounts",
15311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15312 "version": "0.0.0",
15313 "filename": "server/api/mailAccount/index.js",
15314 "groupTitle": "Mail_Accounts"
15318 "url": "/api/mail/accounts/{id}/canned_answers",
15319 "title": "Creates new canned answer",
15322 "title": "Example usage:",
15323 "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",
15327 "name": "addAnswer",
15328 "group": "Mail_Accounts",
15350 "field": "description",
15363 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15364 "version": "0.0.0",
15365 "filename": "server/api/mailAccount/index.js",
15366 "groupTitle": "Mail_Accounts"
15370 "url": "/api/mail/accounts/{id}/applications",
15371 "title": "Creates new applications",
15374 "title": "Example usage:",
15375 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15379 "name": "addApplications",
15380 "group": "Mail_Accounts",
15388 "field": "priority",
15402 "field": "appdata",
15409 "field": "description",
15416 "field": "interval",
15422 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15423 "version": "0.0.0",
15424 "filename": "server/api/mailAccount/index.js",
15425 "groupTitle": "Mail_Accounts"
15429 "url": "/api/mail/accounts/{id}/dispositions",
15430 "title": "Creates new disposition",
15433 "title": "Example usage:",
15434 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15438 "name": "addDisposition",
15439 "group": "Mail_Accounts",
15466 "field": "description",
15472 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15473 "version": "0.0.0",
15474 "filename": "server/api/mailAccount/index.js",
15475 "groupTitle": "Mail_Accounts"
15479 "url": "/api/mail/accounts/{id}/interactions",
15480 "title": "Creates new interactions",
15483 "title": "Example usage:",
15484 "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",
15488 "name": "addInteraction",
15489 "group": "Mail_Accounts",
15504 "field": "closedAt",
15511 "field": "disposition",
15518 "field": "secondDisposition",
15525 "field": "thirdDisposition",
15539 "field": "inReplyTo",
15560 "field": "subject",
15574 "field": "read1stAt",
15581 "field": "substatus",
15588 "field": "substatusAt",
15599 "field": "firstMsgDirection",
15606 "field": "lastMsgAt",
15617 "field": "lastMsgDirection",
15624 "field": "autoreplyExecuted",
15630 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15631 "version": "0.0.0",
15632 "filename": "server/api/mailAccount/index.js",
15633 "groupTitle": "Mail_Accounts"
15637 "url": "/api/mail/accounts",
15638 "title": "Create a mail account",
15641 "title": "Example usage:",
15642 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15647 "group": "Mail_Accounts",
15648 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15649 "version": "0.0.0",
15650 "filename": "server/api/mailAccount/index.js",
15651 "groupTitle": "Mail_Accounts"
15655 "url": "/api/mail/accounts/{id}/canned_answers",
15656 "title": "Gets account canned answers",
15659 "title": "Example usage:",
15660 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15664 "name": "getAnswers",
15665 "group": "Mail_Accounts",
15666 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15667 "version": "0.0.0",
15668 "filename": "server/api/mailAccount/index.js",
15669 "groupTitle": "Mail_Accounts"
15673 "url": "/api/mail/accounts/{id}/applications",
15674 "title": "Gets account applications",
15677 "title": "Example usage:",
15678 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15682 "name": "getApplications",
15683 "group": "Mail_Accounts",
15684 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15685 "version": "0.0.0",
15686 "filename": "server/api/mailAccount/index.js",
15687 "groupTitle": "Mail_Accounts"
15691 "url": "/api/mail/accounts/{id}/dispositions",
15692 "title": "Gets account dispositions",
15695 "title": "Example usage:",
15696 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15700 "name": "getDispositions",
15701 "group": "Mail_Accounts",
15702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15703 "version": "0.0.0",
15704 "filename": "server/api/mailAccount/index.js",
15705 "groupTitle": "Mail_Accounts"
15709 "url": "/api/mail/accounts/{id}/interactions",
15710 "title": "Gets account interactions",
15713 "title": "Example usage:",
15714 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15718 "name": "getInteraction",
15719 "group": "Mail_Accounts",
15720 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15721 "version": "0.0.0",
15722 "filename": "server/api/mailAccount/index.js",
15723 "groupTitle": "Mail_Accounts"
15727 "url": "/api/mail/accounts/{id}/messages",
15728 "title": "Gets account messages",
15731 "title": "Example usage:",
15732 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15736 "name": "getMessages",
15737 "group": "Mail_Accounts",
15738 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15739 "version": "0.0.0",
15740 "filename": "server/api/mailAccount/index.js",
15741 "groupTitle": "Mail_Accounts"
15745 "url": "/api/mail/accounts/{id}/send",
15746 "title": "Send new mail",
15749 "title": "Example usage:",
15750 "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",
15754 "name": "sendMail",
15755 "group": "Mail_Accounts",
15756 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15757 "version": "0.0.0",
15758 "filename": "server/api/mailAccount/index.js",
15759 "groupTitle": "Mail_Accounts"
15763 "url": "/api/mail/accounts/{id}",
15764 "title": "Update an existing Account",
15767 "title": "Example usage:",
15768 "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",
15772 "name": "updateAccounts",
15773 "group": "Mail_Accounts",
15774 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15775 "version": "0.0.0",
15776 "filename": "server/api/mailAccount/index.js",
15777 "groupTitle": "Mail_Accounts"
15781 "url": "/api/mail/accounts/{id}/verify",
15782 "title": "Verify mail account",
15785 "title": "Example usage:",
15786 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15790 "name": "verifySmtp",
15791 "group": "Mail_Accounts",
15792 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15793 "version": "0.0.0",
15794 "filename": "server/api/mailAccount/index.js",
15795 "groupTitle": "Mail_Accounts"
15799 "url": "/api/mail/applications/{id}",
15800 "title": "Deletes a Application",
15803 "title": "Example usage:",
15804 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15808 "name": "DeleteApplications",
15809 "group": "Mail_Applications",
15810 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15811 "version": "0.0.0",
15812 "filename": "server/api/mailApplication/index.js",
15813 "groupTitle": "Mail_Applications"
15817 "url": "/api/mail/applications/{id}",
15818 "title": "Gets a single Application",
15821 "title": "Example usage:",
15822 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15826 "name": "ShowApplications",
15827 "group": "Mail_Applications",
15828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15829 "version": "0.0.0",
15830 "filename": "server/api/mailApplication/index.js",
15831 "groupTitle": "Mail_Applications"
15835 "url": "/api/mail/applications/{id}",
15836 "title": "Update an existing Application",
15839 "title": "Example usage:",
15840 "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",
15844 "name": "updateApplications",
15845 "group": "Mail_Applications",
15846 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15847 "version": "0.0.0",
15848 "filename": "server/api/mailApplication/index.js",
15849 "groupTitle": "Mail_Applications"
15853 "url": "/api/mail/interactions/{id}/tags",
15854 "title": "Add tags to the interaction",
15857 "title": "Example usage:",
15858 "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",
15863 "group": "Mail_Interactions",
15864 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15865 "version": "0.0.0",
15866 "filename": "server/api/mailInteraction/index.js",
15867 "groupTitle": "Mail_Interactions"
15871 "url": "/api/mail/interactions",
15872 "title": "Creates a new Interaction",
15875 "title": "Example usage:",
15876 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15880 "name": "CreateInteractions",
15881 "group": "Mail_Interactions",
15896 "field": "closedAt",
15903 "field": "disposition",
15910 "field": "secondDisposition",
15917 "field": "thirdDisposition",
15931 "field": "inReplyTo",
15952 "field": "subject",
15966 "field": "read1stAt",
15973 "field": "substatus",
15980 "field": "substatusAt",
15991 "field": "firstMsgDirection",
15998 "field": "lastMsgAt",
16009 "field": "lastMsgDirection",
16016 "field": "autoreplyExecuted",
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/mailInteraction/index.js",
16025 "groupTitle": "Mail_Interactions"
16029 "url": "/api/mail/interactions/{id}",
16030 "title": "Deletes a Interaction",
16033 "title": "Example usage:",
16034 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
16038 "name": "DeleteInteractions",
16039 "group": "Mail_Interactions",
16040 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16041 "version": "0.0.0",
16042 "filename": "server/api/mailInteraction/index.js",
16043 "groupTitle": "Mail_Interactions"
16047 "url": "/api/mail/interactions/describe",
16048 "title": "Gets table info about Interactions",
16051 "title": "Example usage:",
16052 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16056 "name": "DescribeInteractions",
16057 "group": "Mail_Interactions",
16058 "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>",
16059 "version": "0.0.0",
16060 "filename": "server/api/mailInteraction/index.js",
16061 "groupTitle": "Mail_Interactions"
16065 "url": "/api/mail/interactions",
16066 "title": "Gets a list of Interactions",
16069 "title": "Example usage:",
16070 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16074 "name": "GetInteractions",
16075 "group": "Mail_Interactions",
16076 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16077 "version": "0.0.0",
16078 "filename": "server/api/mailInteraction/index.js",
16079 "groupTitle": "Mail_Interactions"
16083 "url": "/api/mail/interactions/{id}/tags",
16084 "title": "Removes tags from interaction",
16087 "title": "Example usage:",
16088 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16092 "name": "RemoveTags",
16093 "group": "Mail_Interactions",
16094 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16095 "version": "0.0.0",
16096 "filename": "server/api/mailInteraction/index.js",
16097 "groupTitle": "Mail_Interactions"
16101 "url": "/api/mail/interactions/{id}",
16102 "title": "Gets a single Interaction",
16105 "title": "Example usage:",
16106 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16110 "name": "ShowInteractions",
16111 "group": "Mail_Interactions",
16112 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16113 "version": "0.0.0",
16114 "filename": "server/api/mailInteraction/index.js",
16115 "groupTitle": "Mail_Interactions"
16119 "url": "/api/mail/interactions/{id}/messages",
16120 "title": "Creates new message",
16123 "title": "Example usage:",
16124 "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",
16128 "name": "addMessage",
16129 "group": "Mail_Interactions",
16144 "field": "plainBody",
16162 "field": "direction",
16169 "field": "messageId",
16204 "field": "subject",
16239 "field": "originTo",
16246 "field": "originCc",
16257 "field": "originChannel",
16263 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16264 "version": "0.0.0",
16265 "filename": "server/api/mailInteraction/index.js",
16266 "groupTitle": "Mail_Interactions"
16270 "url": "/api/mail/interactions/{id}/download",
16271 "title": "Gets interaction",
16274 "title": "Example usage:",
16275 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16279 "name": "download",
16280 "group": "Mail_Interactions",
16281 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16282 "version": "0.0.0",
16283 "filename": "server/api/mailInteraction/index.js",
16284 "groupTitle": "Mail_Interactions"
16288 "url": "/api/mail/interactions/{id}/messages",
16289 "title": "Gets interaction messages",
16292 "title": "Example usage:",
16293 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16297 "name": "getMessages",
16298 "group": "Mail_Interactions",
16299 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16300 "version": "0.0.0",
16301 "filename": "server/api/mailInteraction/index.js",
16302 "groupTitle": "Mail_Interactions"
16306 "url": "/api/mail/interactions/{id}",
16307 "title": "Update an existing Interaction",
16310 "title": "Example usage:",
16311 "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",
16315 "name": "updateInteractions",
16316 "group": "Mail_Interactions",
16317 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16318 "version": "0.0.0",
16319 "filename": "server/api/mailInteraction/index.js",
16320 "groupTitle": "Mail_Interactions"
16324 "url": "/api/mail/messages/{id}",
16325 "title": "Deletes a Message",
16328 "title": "Example usage:",
16329 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16333 "name": "DeleteMessages",
16334 "group": "Mail_Messages",
16335 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16336 "version": "0.0.0",
16337 "filename": "server/api/mailMessage/index.js",
16338 "groupTitle": "Mail_Messages"
16342 "url": "/api/mail/messages/describe",
16343 "title": "Gets table info about Messages",
16346 "title": "Example usage:",
16347 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16351 "name": "DescribeMessages",
16352 "group": "Mail_Messages",
16353 "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>",
16354 "version": "0.0.0",
16355 "filename": "server/api/mailMessage/index.js",
16356 "groupTitle": "Mail_Messages"
16360 "url": "/api/mail/messages",
16361 "title": "Gets a list of Messages",
16364 "title": "Example usage:",
16365 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16369 "name": "GetMessages",
16370 "group": "Mail_Messages",
16371 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16372 "version": "0.0.0",
16373 "filename": "server/api/mailMessage/index.js",
16374 "groupTitle": "Mail_Messages"
16378 "url": "/api/mail/messages/{id}",
16379 "title": "Gets a single Message",
16382 "title": "Example usage:",
16383 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16387 "name": "ShowMessages",
16388 "group": "Mail_Messages",
16389 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16390 "version": "0.0.0",
16391 "filename": "server/api/mailMessage/index.js",
16392 "groupTitle": "Mail_Messages"
16396 "url": "/api/mail/messages/{id}/accept",
16397 "title": "Accepts message",
16400 "title": "Example usage:",
16401 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16405 "name": "acceptMessage",
16406 "group": "Mail_Messages",
16407 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16408 "version": "0.0.0",
16409 "filename": "server/api/mailMessage/index.js",
16410 "groupTitle": "Mail_Messages"
16414 "url": "/api/mail/messages",
16415 "title": "Create a message",
16418 "title": "Example usage:",
16419 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16423 "name": "createMessage",
16424 "group": "Mail_Messages",
16425 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16426 "version": "0.0.0",
16427 "filename": "server/api/mailMessage/index.js",
16428 "groupTitle": "Mail_Messages"
16432 "url": "/api/mail/messages/{id}/download",
16433 "title": "Gets message",
16436 "title": "Example usage:",
16437 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16441 "name": "download",
16442 "group": "Mail_Messages",
16443 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16444 "version": "0.0.0",
16445 "filename": "server/api/mailMessage/index.js",
16446 "groupTitle": "Mail_Messages"
16450 "url": "/api/mail/messages/{id}/reject",
16451 "title": "Rejects message",
16454 "title": "Example usage:",
16455 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16459 "name": "rejectMessage",
16460 "group": "Mail_Messages",
16461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16462 "version": "0.0.0",
16463 "filename": "server/api/mailMessage/index.js",
16464 "groupTitle": "Mail_Messages"
16468 "url": "/api/mail/messages/{id}",
16469 "title": "Update an existing Message",
16472 "title": "Example usage:",
16473 "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",
16477 "name": "updateMessages",
16478 "group": "Mail_Messages",
16479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16480 "version": "0.0.0",
16481 "filename": "server/api/mailMessage/index.js",
16482 "groupTitle": "Mail_Messages"
16486 "url": "/api/mail/reports/queue",
16487 "title": "Creates a new Mail Queue Report",
16490 "title": "Example usage:",
16491 "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",
16495 "name": "CreateMail_Queue_Reports",
16496 "group": "Mail_Queue_Reports",
16504 "field": "uniqueid",
16525 "field": "leaveAt",
16532 "field": "acceptAt",
16552 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16553 "version": "0.0.0",
16554 "filename": "server/api/mailQueueReport/index.js",
16555 "groupTitle": "Mail_Queue_Reports"
16559 "url": "/api/mail/reports/queue/{id}",
16560 "title": "Deletes a Mail Queue Report",
16563 "title": "Example usage:",
16564 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16568 "name": "DeleteMail_Queue_Reports",
16569 "group": "Mail_Queue_Reports",
16570 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16571 "version": "0.0.0",
16572 "filename": "server/api/mailQueueReport/index.js",
16573 "groupTitle": "Mail_Queue_Reports"
16577 "url": "/api/mail/reports/queue/describe",
16578 "title": "Gets table info about Mail Queue Reports",
16581 "title": "Example usage:",
16582 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16586 "name": "DescribeMail_Queue_Reports",
16587 "group": "Mail_Queue_Reports",
16588 "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>",
16589 "version": "0.0.0",
16590 "filename": "server/api/mailQueueReport/index.js",
16591 "groupTitle": "Mail_Queue_Reports"
16595 "url": "/api/mail/reports/queue",
16596 "title": "Gets a list of Mail Queue Reports",
16599 "title": "Example usage:",
16600 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16604 "name": "GetMail_Queue_Reports",
16605 "group": "Mail_Queue_Reports",
16606 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16607 "version": "0.0.0",
16608 "filename": "server/api/mailQueueReport/index.js",
16609 "groupTitle": "Mail_Queue_Reports"
16613 "url": "/api/mail/reports/queue/{id}",
16614 "title": "Gets a single Mail Queue Report",
16617 "title": "Example usage:",
16618 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16622 "name": "ShowMail_Queue_Reports",
16623 "group": "Mail_Queue_Reports",
16624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16625 "version": "0.0.0",
16626 "filename": "server/api/mailQueueReport/index.js",
16627 "groupTitle": "Mail_Queue_Reports"
16631 "url": "/api/mail/reports/queue/{id}",
16632 "title": "Update an existing Mail Queue Report",
16635 "title": "Example usage:",
16636 "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",
16640 "name": "updateMail_Queue_Reports",
16641 "group": "Mail_Queue_Reports",
16642 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16643 "version": "0.0.0",
16644 "filename": "server/api/mailQueueReport/index.js",
16645 "groupTitle": "Mail_Queue_Reports"
16649 "url": "/api/mail/queues/{id}/users",
16650 "title": "Add agents to a queue",
16653 "title": "Example usage:",
16654 "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",
16658 "name": "AddAgents",
16659 "group": "Mail_Queues",
16660 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16661 "version": "0.0.0",
16662 "filename": "server/api/mailQueue/index.js",
16663 "groupTitle": "Mail_Queues"
16667 "url": "/api/mail/queues/{id}/teams",
16668 "title": "Add teams to a queue",
16671 "title": "Example usage:",
16672 "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",
16676 "name": "AddTeams",
16677 "group": "Mail_Queues",
16678 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16679 "version": "0.0.0",
16680 "filename": "server/api/mailQueue/index.js",
16681 "groupTitle": "Mail_Queues"
16685 "url": "/api/mail/queues",
16686 "title": "Creates a new Queue",
16689 "title": "Example usage:",
16690 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16694 "name": "CreateQueues",
16695 "group": "Mail_Queues",
16710 "field": "description",
16717 "field": "timeout",
16729 "field": "strategy",
16735 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16736 "version": "0.0.0",
16737 "filename": "server/api/mailQueue/index.js",
16738 "groupTitle": "Mail_Queues"
16742 "url": "/api/mail/queues/{id}",
16743 "title": "Deletes a Queue",
16746 "title": "Example usage:",
16747 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16751 "name": "DeleteQueues",
16752 "group": "Mail_Queues",
16753 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16754 "version": "0.0.0",
16755 "filename": "server/api/mailQueue/index.js",
16756 "groupTitle": "Mail_Queues"
16760 "url": "/api/mail/queues/describe",
16761 "title": "Gets table info about Queues",
16764 "title": "Example usage:",
16765 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16769 "name": "DescribeQueues",
16770 "group": "Mail_Queues",
16771 "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>",
16772 "version": "0.0.0",
16773 "filename": "server/api/mailQueue/index.js",
16774 "groupTitle": "Mail_Queues"
16778 "url": "/api/mail/queues/{id}/users",
16779 "title": "Gets queue agents",
16782 "title": "Example usage:",
16783 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16787 "name": "GetAgents",
16788 "group": "Mail_Queues",
16789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16790 "version": "0.0.0",
16791 "filename": "server/api/mailQueue/index.js",
16792 "groupTitle": "Mail_Queues"
16796 "url": "/api/mail/queues/{id}/members",
16797 "title": "GetMembers",
16800 "title": "Example usage:",
16801 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16805 "name": "GetMembers",
16806 "group": "Mail_Queues",
16807 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16808 "version": "0.0.0",
16809 "filename": "server/api/mailQueue/index.js",
16810 "groupTitle": "Mail_Queues"
16814 "url": "/api/mail/queues",
16815 "title": "Gets a list of Queues",
16818 "title": "Example usage:",
16819 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16823 "name": "GetQueues",
16824 "group": "Mail_Queues",
16825 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16826 "version": "0.0.0",
16827 "filename": "server/api/mailQueue/index.js",
16828 "groupTitle": "Mail_Queues"
16832 "url": "/api/mail/queues/{id}/teams",
16833 "title": "Gets queues list",
16836 "title": "Example usage:",
16837 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16841 "name": "GetTeams",
16842 "group": "Mail_Queues",
16843 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16844 "version": "0.0.0",
16845 "filename": "server/api/mailQueue/index.js",
16846 "groupTitle": "Mail_Queues"
16850 "url": "/api/mail/queues/{id}/users",
16851 "title": "Removes agents from a queue",
16854 "title": "Example usage:",
16855 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16859 "name": "RemoveAgents",
16860 "group": "Mail_Queues",
16861 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16862 "version": "0.0.0",
16863 "filename": "server/api/mailQueue/index.js",
16864 "groupTitle": "Mail_Queues"
16868 "url": "/api/mail/queues/{id}",
16869 "title": "Gets a single Queue",
16872 "title": "Example usage:",
16873 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16877 "name": "ShowQueues",
16878 "group": "Mail_Queues",
16879 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16880 "version": "0.0.0",
16881 "filename": "server/api/mailQueue/index.js",
16882 "groupTitle": "Mail_Queues"
16886 "url": "/api/mail/queues/{id}",
16887 "title": "Update an existing Queue",
16890 "title": "Example usage:",
16891 "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",
16895 "name": "updateQueues",
16896 "group": "Mail_Queues",
16897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16898 "version": "0.0.0",
16899 "filename": "server/api/mailQueue/index.js",
16900 "groupTitle": "Mail_Queues"
16904 "url": "/api/mail/out_servers",
16905 "title": "Creates a new SMTP",
16908 "title": "Example usage:",
16909 "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",
16913 "name": "CreateSMTPs",
16914 "group": "Mail_SMTP",
16922 "field": "description",
16964 "field": "service",
16971 "field": "authentication",
16977 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16978 "version": "0.0.0",
16979 "filename": "server/api/mailServerOut/index.js",
16980 "groupTitle": "Mail_SMTP"
16984 "url": "/api/mail/out_servers/{id}",
16985 "title": "Deletes a SMTP",
16988 "title": "Example usage:",
16989 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16993 "name": "DeleteSMTPs",
16994 "group": "Mail_SMTP",
16995 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16996 "version": "0.0.0",
16997 "filename": "server/api/mailServerOut/index.js",
16998 "groupTitle": "Mail_SMTP"
17002 "url": "/api/mail/out_servers",
17003 "title": "Gets a list of SMTPs",
17006 "title": "Example usage:",
17007 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
17011 "name": "GetSMTPs",
17012 "group": "Mail_SMTP",
17013 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17014 "version": "0.0.0",
17015 "filename": "server/api/mailServerOut/index.js",
17016 "groupTitle": "Mail_SMTP"
17020 "url": "/api/mail/out_servers/{id}",
17021 "title": "Gets a single SMTP",
17024 "title": "Example usage:",
17025 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
17029 "name": "ShowSMTPs",
17030 "group": "Mail_SMTP",
17031 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17032 "version": "0.0.0",
17033 "filename": "server/api/mailServerOut/index.js",
17034 "groupTitle": "Mail_SMTP"
17038 "url": "/api/mail/out_servers/{id}",
17039 "title": "Update an existing SMTP",
17042 "title": "Example usage:",
17043 "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",
17047 "name": "updateSMTPs",
17048 "group": "Mail_SMTP",
17049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17050 "version": "0.0.0",
17051 "filename": "server/api/mailServerOut/index.js",
17052 "groupTitle": "Mail_SMTP"
17056 "url": "/api/mail/substatuses",
17057 "title": "Creates a new Queue",
17060 "title": "Example usage:",
17061 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17065 "name": "CreateSubstatuses",
17066 "group": "Mail_Substatuses",
17081 "field": "description",
17087 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17088 "version": "0.0.0",
17089 "filename": "server/api/mailSubstatus/index.js",
17090 "groupTitle": "Mail_Substatuses"
17094 "url": "/api/mail/substatuses/{id}",
17095 "title": "Deletes a Queue",
17098 "title": "Example usage:",
17099 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17103 "name": "DeleteSubstatuses",
17104 "group": "Mail_Substatuses",
17105 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17106 "version": "0.0.0",
17107 "filename": "server/api/mailSubstatus/index.js",
17108 "groupTitle": "Mail_Substatuses"
17112 "url": "/api/mail/substatuses/describe",
17113 "title": "Gets table info about Substatuses",
17116 "title": "Example usage:",
17117 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17121 "name": "DescribeSubstatuses",
17122 "group": "Mail_Substatuses",
17123 "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>",
17124 "version": "0.0.0",
17125 "filename": "server/api/mailSubstatus/index.js",
17126 "groupTitle": "Mail_Substatuses"
17130 "url": "/api/mail/substatuses",
17131 "title": "Gets a list of Substatuses",
17134 "title": "Example usage:",
17135 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17139 "name": "GetSubstatuses",
17140 "group": "Mail_Substatuses",
17141 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17142 "version": "0.0.0",
17143 "filename": "server/api/mailSubstatus/index.js",
17144 "groupTitle": "Mail_Substatuses"
17148 "url": "/api/mail/substatuses/{id}",
17149 "title": "Gets a single Queue",
17152 "title": "Example usage:",
17153 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17157 "name": "ShowSubstatuses",
17158 "group": "Mail_Substatuses",
17159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17160 "version": "0.0.0",
17161 "filename": "server/api/mailSubstatus/index.js",
17162 "groupTitle": "Mail_Substatuses"
17166 "url": "/api/mail/substatuses/{id}",
17167 "title": "Update an existing Queue",
17170 "title": "Example usage:",
17171 "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",
17175 "name": "updateSubstatuses",
17176 "group": "Mail_Substatuses",
17177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17178 "version": "0.0.0",
17179 "filename": "server/api/mailSubstatus/index.js",
17180 "groupTitle": "Mail_Substatuses"
17184 "url": "/api/mail/reports/transfer",
17185 "title": "Creates a new Mail Transfer Report",
17188 "title": "Example usage:",
17189 "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",
17193 "name": "CreateMail_Transfer_Reports",
17194 "group": "Mail_Transfer_Reports",
17202 "field": "uniqueid",
17221 "field": "transferredAt",
17227 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17228 "version": "0.0.0",
17229 "filename": "server/api/mailTransferReport/index.js",
17230 "groupTitle": "Mail_Transfer_Reports"
17234 "url": "/api/mail/reports/transfer/{id}",
17235 "title": "Deletes a Mail Transfer Report",
17238 "title": "Example usage:",
17239 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17243 "name": "DeleteMail_Transfer_Reports",
17244 "group": "Mail_Transfer_Reports",
17245 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17246 "version": "0.0.0",
17247 "filename": "server/api/mailTransferReport/index.js",
17248 "groupTitle": "Mail_Transfer_Reports"
17252 "url": "/api/mail/reports/transfer/describe",
17253 "title": "Gets table info about Mail Transfer Reports",
17256 "title": "Example usage:",
17257 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17261 "name": "DescribeMail_Transfer_Reports",
17262 "group": "Mail_Transfer_Reports",
17263 "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>",
17264 "version": "0.0.0",
17265 "filename": "server/api/mailTransferReport/index.js",
17266 "groupTitle": "Mail_Transfer_Reports"
17270 "url": "/api/mail/reports/transfer",
17271 "title": "Gets a list of Mail Transfer Reports",
17274 "title": "Example usage:",
17275 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17279 "name": "GetMail_Transfer_Reports",
17280 "group": "Mail_Transfer_Reports",
17281 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17282 "version": "0.0.0",
17283 "filename": "server/api/mailTransferReport/index.js",
17284 "groupTitle": "Mail_Transfer_Reports"
17288 "url": "/api/mail/reports/transfer/{id}",
17289 "title": "Gets a single Mail Transfer Report",
17292 "title": "Example usage:",
17293 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17297 "name": "ShowMail_Transfer_Reports",
17298 "group": "Mail_Transfer_Reports",
17299 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17300 "version": "0.0.0",
17301 "filename": "server/api/mailTransferReport/index.js",
17302 "groupTitle": "Mail_Transfer_Reports"
17306 "url": "/api/mail/reports/transfer/{id}",
17307 "title": "Update an existing Mail Transfer Report",
17310 "title": "Example usage:",
17311 "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",
17315 "name": "updateMail_Transfer_Reports",
17316 "group": "Mail_Transfer_Reports",
17317 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17318 "version": "0.0.0",
17319 "filename": "server/api/mailTransferReport/index.js",
17320 "groupTitle": "Mail_Transfer_Reports"
17324 "url": "/api/members/reports/describe",
17325 "title": "Gets table info about Member Reports",
17328 "title": "Example usage:",
17329 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17333 "name": "DescribeMember_Reports",
17334 "group": "Member_Reports",
17335 "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>",
17336 "version": "0.0.0",
17337 "filename": "server/api/memberReport/index.js",
17338 "groupTitle": "Member_Reports"
17342 "url": "/api/members/reports",
17343 "title": "Gets a list of Member Reports",
17346 "title": "Example usage:",
17347 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17351 "name": "GetMember_Reports",
17352 "group": "Member_Reports",
17353 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17354 "version": "0.0.0",
17355 "filename": "server/api/memberReport/index.js",
17356 "groupTitle": "Member_Reports"
17360 "url": "/api/members/reports/{id}",
17361 "title": "Gets a single Member Report",
17364 "title": "Example usage:",
17365 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17369 "name": "ShowMember_Reports",
17370 "group": "Member_Reports",
17371 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17372 "version": "0.0.0",
17373 "filename": "server/api/memberReport/index.js",
17374 "groupTitle": "Member_Reports"
17378 "url": "/api/migrations",
17379 "title": "Gets a list of Migrations",
17382 "title": "Example usage:",
17383 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17387 "name": "GetMigrations",
17388 "group": "Migrations",
17389 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17390 "version": "0.0.0",
17391 "filename": "server/api/migration/index.js",
17392 "groupTitle": "Migrations"
17396 "url": "/api/voice/networks",
17397 "title": "Create a new network",
17400 "title": "Example usage:",
17401 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17406 "group": "Networks",
17407 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17408 "version": "0.0.0",
17409 "filename": "server/api/network/index.js",
17410 "groupTitle": "Networks"
17414 "url": "/api/voice/networks/{id}",
17415 "title": "Deletes a network",
17418 "title": "Example usage:",
17419 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17424 "group": "Networks",
17425 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17426 "version": "0.0.0",
17427 "filename": "server/api/network/index.js",
17428 "groupTitle": "Networks"
17432 "url": "/api/networks",
17433 "title": "Gets a list of Networks",
17436 "title": "Example usage:",
17437 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17441 "name": "GetNetworks",
17442 "group": "Networks",
17443 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17444 "version": "0.0.0",
17445 "filename": "server/api/network/index.js",
17446 "groupTitle": "Networks"
17450 "url": "/api/networks/{id}",
17451 "title": "Gets a single Network",
17454 "title": "Example usage:",
17455 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17459 "name": "ShowNetworks",
17460 "group": "Networks",
17461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17462 "version": "0.0.0",
17463 "filename": "server/api/network/index.js",
17464 "groupTitle": "Networks"
17468 "url": "/api/voice/networks/{id}",
17469 "title": "Update an existing network",
17472 "title": "Example usage:",
17473 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17478 "group": "Networks",
17479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17480 "version": "0.0.0",
17481 "filename": "server/api/network/index.js",
17482 "groupTitle": "Networks"
17486 "url": "/api/openchannel/accounts/{id}/users",
17487 "title": "Add agents to a openchannel account",
17490 "title": "Example usage:",
17491 "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",
17495 "name": "AddAgents",
17496 "group": "Openchannel_Accounts",
17497 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17498 "version": "0.0.0",
17499 "filename": "server/api/openchannelAccount/index.js",
17500 "groupTitle": "Openchannel_Accounts"
17504 "url": "/api/openchannel/accounts",
17505 "title": "Creates a new Account",
17508 "title": "Example usage:",
17509 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17513 "name": "CreateAccounts",
17514 "group": "Openchannel_Accounts",
17529 "field": "description",
17543 "field": "replyUri",
17557 "field": "notificationTemplate",
17564 "field": "notificationSound",
17571 "field": "notificationShake",
17578 "field": "waitForTheAssignedAgent",
17592 "field": "queueTransfer",
17599 "field": "queueTransferTimeout",
17606 "field": "agentTransfer",
17613 "field": "agentTransferTimeout",
17620 "field": "mandatoryDispositionPauseId",
17621 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17627 "field": "mandatoryDisposition",
17628 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17633 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17634 "version": "0.0.0",
17635 "filename": "server/api/openchannelAccount/index.js",
17636 "groupTitle": "Openchannel_Accounts"
17640 "url": "/api/openchannel/accounts/{id}",
17641 "title": "Deletes a Account",
17644 "title": "Example usage:",
17645 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17649 "name": "DeleteAccounts",
17650 "group": "Openchannel_Accounts",
17651 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17652 "version": "0.0.0",
17653 "filename": "server/api/openchannelAccount/index.js",
17654 "groupTitle": "Openchannel_Accounts"
17658 "url": "/api/openchannel/accounts/describe",
17659 "title": "Gets table info about Accounts",
17662 "title": "Example usage:",
17663 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17667 "name": "DescribeAccounts",
17668 "group": "Openchannel_Accounts",
17669 "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>",
17670 "version": "0.0.0",
17671 "filename": "server/api/openchannelAccount/index.js",
17672 "groupTitle": "Openchannel_Accounts"
17676 "url": "/api/openchannel/accounts",
17677 "title": "Gets a list of Accounts",
17680 "title": "Example usage:",
17681 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17685 "name": "GetAccounts",
17686 "group": "Openchannel_Accounts",
17687 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17688 "version": "0.0.0",
17689 "filename": "server/api/openchannelAccount/index.js",
17690 "groupTitle": "Openchannel_Accounts"
17694 "url": "/api/openchannel/accounts/{id}/users",
17695 "title": "Gets agents from openchannel account",
17698 "title": "Example usage:",
17699 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17703 "name": "GetAgents",
17704 "group": "Openchannel_Accounts",
17705 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17706 "version": "0.0.0",
17707 "filename": "server/api/openchannelAccount/index.js",
17708 "groupTitle": "Openchannel_Accounts"
17712 "url": "/api/openchannel/accounts/{id}/users",
17713 "title": "Removes agents from a openchannel account",
17716 "title": "Example usage:",
17717 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17721 "name": "RemoveAgents",
17722 "group": "Openchannel_Accounts",
17723 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17724 "version": "0.0.0",
17725 "filename": "server/api/openchannelAccount/index.js",
17726 "groupTitle": "Openchannel_Accounts"
17730 "url": "/api/openchannel/accounts/{id}/canned_answers",
17731 "title": "Removes canned answers from account",
17734 "title": "Example usage:",
17735 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17739 "name": "RemoveAnswers",
17740 "group": "Openchannel_Accounts",
17741 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17742 "version": "0.0.0",
17743 "filename": "server/api/openchannelAccount/index.js",
17744 "groupTitle": "Openchannel_Accounts"
17748 "url": "/api/openchannel/accounts/{id}/dispositions",
17749 "title": "Removes dispositions from account",
17752 "title": "Example usage:",
17753 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17757 "name": "RemoveDispositions",
17758 "group": "Openchannel_Accounts",
17759 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17760 "version": "0.0.0",
17761 "filename": "server/api/openchannelAccount/index.js",
17762 "groupTitle": "Openchannel_Accounts"
17766 "url": "/api/openchannel/accounts/{id}",
17767 "title": "Gets a single Account",
17770 "title": "Example usage:",
17771 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17775 "name": "ShowAccounts",
17776 "group": "Openchannel_Accounts",
17777 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17778 "version": "0.0.0",
17779 "filename": "server/api/openchannelAccount/index.js",
17780 "groupTitle": "Openchannel_Accounts"
17784 "url": "/api/openchannel/accounts/{id}/canned_answers",
17785 "title": "Creates new canned answer",
17788 "title": "Example usage:",
17789 "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",
17793 "name": "addAnswer",
17794 "group": "Openchannel_Accounts",
17816 "field": "description",
17829 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17830 "version": "0.0.0",
17831 "filename": "server/api/openchannelAccount/index.js",
17832 "groupTitle": "Openchannel_Accounts"
17836 "url": "/api/openchannel/accounts/{id}/applications",
17837 "title": "Creates new applications",
17840 "title": "Example usage:",
17841 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17845 "name": "addApplications",
17846 "group": "Openchannel_Accounts",
17854 "field": "priority",
17868 "field": "appdata",
17875 "field": "description",
17882 "field": "interval",
17888 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17889 "version": "0.0.0",
17890 "filename": "server/api/openchannelAccount/index.js",
17891 "groupTitle": "Openchannel_Accounts"
17895 "url": "/api/openchannel/accounts/{id}/dispositions",
17896 "title": "Creates new disposition",
17899 "title": "Example usage:",
17900 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17904 "name": "addDisposition",
17905 "group": "Openchannel_Accounts",
17932 "field": "description",
17938 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17939 "version": "0.0.0",
17940 "filename": "server/api/openchannelAccount/index.js",
17941 "groupTitle": "Openchannel_Accounts"
17945 "url": "/api/openchannel/accounts/{id}/canned_answers",
17946 "title": "Gets account canned answers",
17949 "title": "Example usage:",
17950 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17954 "name": "getAnswers",
17955 "group": "Openchannel_Accounts",
17956 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17957 "version": "0.0.0",
17958 "filename": "server/api/openchannelAccount/index.js",
17959 "groupTitle": "Openchannel_Accounts"
17963 "url": "/api/openchannel/accounts/{id}/applications",
17964 "title": "Gets account applications",
17967 "title": "Example usage:",
17968 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17972 "name": "getApplications",
17973 "group": "Openchannel_Accounts",
17974 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17975 "version": "0.0.0",
17976 "filename": "server/api/openchannelAccount/index.js",
17977 "groupTitle": "Openchannel_Accounts"
17981 "url": "/api/openchannel/accounts/{id}/dispositions",
17982 "title": "Gets account dispositions",
17985 "title": "Example usage:",
17986 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17990 "name": "getDispositions",
17991 "group": "Openchannel_Accounts",
17992 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17993 "version": "0.0.0",
17994 "filename": "server/api/openchannelAccount/index.js",
17995 "groupTitle": "Openchannel_Accounts"
17999 "url": "/api/openchannel/accounts/{id}/interactions",
18000 "title": "Gets Openchannel Account Interactions",
18003 "title": "Example usage:",
18004 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
18008 "name": "getInteractions",
18009 "group": "Openchannel_Accounts",
18010 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18011 "version": "0.0.0",
18012 "filename": "server/api/openchannelAccount/index.js",
18013 "groupTitle": "Openchannel_Accounts"
18017 "url": "/api/openchannel/accounts/{id}/notify",
18018 "title": "Notify new message",
18021 "title": "Example usage:",
18022 "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",
18027 "group": "Openchannel_Accounts",
18028 "description": "<p>Motion 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>",
18029 "version": "0.0.0",
18030 "filename": "server/api/openchannelAccount/index.js",
18031 "groupTitle": "Openchannel_Accounts"
18035 "url": "/api/openchannel/accounts/{id}/send",
18036 "title": "Send new openchannel message",
18039 "title": "Example usage:",
18040 "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",
18044 "name": "sendOpenchannel",
18045 "group": "Openchannel_Accounts",
18046 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18047 "version": "0.0.0",
18048 "filename": "server/api/openchannelAccount/index.js",
18049 "groupTitle": "Openchannel_Accounts"
18053 "url": "/api/openchannel/accounts/{id}",
18054 "title": "Update an existing Account",
18057 "title": "Example usage:",
18058 "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",
18062 "name": "updateAccounts",
18063 "group": "Openchannel_Accounts",
18064 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18065 "version": "0.0.0",
18066 "filename": "server/api/openchannelAccount/index.js",
18067 "groupTitle": "Openchannel_Accounts"
18071 "url": "/api/openchannel/applications",
18072 "title": "Creates a new Application",
18075 "title": "Example usage:",
18076 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18080 "name": "CreateApplications",
18081 "group": "Openchannel_Applications",
18089 "field": "priority",
18103 "field": "appdata",
18110 "field": "description",
18117 "field": "interval",
18123 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18124 "version": "0.0.0",
18125 "filename": "server/api/openchannelApplication/index.js",
18126 "groupTitle": "Openchannel_Applications"
18130 "url": "/api/openchannel/applications/{id}",
18131 "title": "Deletes a Application",
18134 "title": "Example usage:",
18135 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18139 "name": "DeleteApplications",
18140 "group": "Openchannel_Applications",
18141 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18142 "version": "0.0.0",
18143 "filename": "server/api/openchannelApplication/index.js",
18144 "groupTitle": "Openchannel_Applications"
18148 "url": "/api/openchannel/applications",
18149 "title": "Gets a list of Applications",
18152 "title": "Example usage:",
18153 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18157 "name": "GetApplications",
18158 "group": "Openchannel_Applications",
18159 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18160 "version": "0.0.0",
18161 "filename": "server/api/openchannelApplication/index.js",
18162 "groupTitle": "Openchannel_Applications"
18166 "url": "/api/openchannel/applications/{id}",
18167 "title": "Gets a single Application",
18170 "title": "Example usage:",
18171 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18175 "name": "ShowApplications",
18176 "group": "Openchannel_Applications",
18177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18178 "version": "0.0.0",
18179 "filename": "server/api/openchannelApplication/index.js",
18180 "groupTitle": "Openchannel_Applications"
18184 "url": "/api/openchannel/applications/{id}",
18185 "title": "Update an existing Application",
18188 "title": "Example usage:",
18189 "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",
18193 "name": "updateApplications",
18194 "group": "Openchannel_Applications",
18195 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18196 "version": "0.0.0",
18197 "filename": "server/api/openchannelApplication/index.js",
18198 "groupTitle": "Openchannel_Applications"
18202 "url": "/api/openchannel/interactions/{id}/tags",
18203 "title": "Add tags to the interaction",
18206 "title": "Example usage:",
18207 "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",
18212 "group": "Openchannel_Interactions",
18213 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18214 "version": "0.0.0",
18215 "filename": "server/api/openchannelInteraction/index.js",
18216 "groupTitle": "Openchannel_Interactions"
18220 "url": "/api/openchannel/interactions",
18221 "title": "Creates a new Interaction",
18224 "title": "Example usage:",
18225 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18229 "name": "CreateInteractions",
18230 "group": "Openchannel_Interactions",
18245 "field": "closedAt",
18252 "field": "disposition",
18259 "field": "secondDisposition",
18266 "field": "thirdDisposition",
18280 "field": "read1stAt",
18287 "field": "threadId",
18294 "field": "externalUrl",
18301 "field": "lastMsgAt",
18312 "field": "lastMsgDirection",
18326 "field": "autoreplyExecuted",
18332 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18333 "version": "0.0.0",
18334 "filename": "server/api/openchannelInteraction/index.js",
18335 "groupTitle": "Openchannel_Interactions"
18339 "url": "/api/openchannel/interactions/{id}",
18340 "title": "Deletes a Interaction",
18343 "title": "Example usage:",
18344 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18348 "name": "DeleteInteractions",
18349 "group": "Openchannel_Interactions",
18350 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18351 "version": "0.0.0",
18352 "filename": "server/api/openchannelInteraction/index.js",
18353 "groupTitle": "Openchannel_Interactions"
18357 "url": "/api/openchannel/interactions/describe",
18358 "title": "Gets table info about Interactions",
18361 "title": "Example usage:",
18362 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18366 "name": "DescribeInteractions",
18367 "group": "Openchannel_Interactions",
18368 "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>",
18369 "version": "0.0.0",
18370 "filename": "server/api/openchannelInteraction/index.js",
18371 "groupTitle": "Openchannel_Interactions"
18375 "url": "/api/openchannel/interactions",
18376 "title": "Gets a list of Interactions",
18379 "title": "Example usage:",
18380 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18384 "name": "GetInteractions",
18385 "group": "Openchannel_Interactions",
18386 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18387 "version": "0.0.0",
18388 "filename": "server/api/openchannelInteraction/index.js",
18389 "groupTitle": "Openchannel_Interactions"
18393 "url": "/api/openchannel/interactions/{id}/tags",
18394 "title": "Removes tags from interaction",
18397 "title": "Example usage:",
18398 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18402 "name": "RemoveTags",
18403 "group": "Openchannel_Interactions",
18404 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18405 "version": "0.0.0",
18406 "filename": "server/api/openchannelInteraction/index.js",
18407 "groupTitle": "Openchannel_Interactions"
18411 "url": "/api/openchannel/interactions/{id}",
18412 "title": "Gets a single Interaction",
18415 "title": "Example usage:",
18416 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18420 "name": "ShowInteractions",
18421 "group": "Openchannel_Interactions",
18422 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18423 "version": "0.0.0",
18424 "filename": "server/api/openchannelInteraction/index.js",
18425 "groupTitle": "Openchannel_Interactions"
18429 "url": "/api/openchannel/interactions/{id}/messages",
18430 "title": "Creates new messages",
18433 "title": "Example usage:",
18434 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18438 "name": "addMessage",
18439 "group": "Openchannel_Interactions",
18472 "field": "direction",
18486 "field": "providerName",
18493 "field": "providerResponse",
18499 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18500 "version": "0.0.0",
18501 "filename": "server/api/openchannelInteraction/index.js",
18502 "groupTitle": "Openchannel_Interactions"
18506 "url": "/api/openchannel/interactions/{id}/download",
18507 "title": "Gets interaction",
18510 "title": "Example usage:",
18511 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18515 "name": "download",
18516 "group": "Openchannel_Interactions",
18517 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18518 "version": "0.0.0",
18519 "filename": "server/api/openchannelInteraction/index.js",
18520 "groupTitle": "Openchannel_Interactions"
18524 "url": "/api/openchannel/interactions/{id}/messages",
18525 "title": "Gets interaction messages",
18528 "title": "Example usage:",
18529 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18533 "name": "getMessages",
18534 "group": "Openchannel_Interactions",
18535 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18536 "version": "0.0.0",
18537 "filename": "server/api/openchannelInteraction/index.js",
18538 "groupTitle": "Openchannel_Interactions"
18542 "url": "/api/openchannel/interactions/{id}",
18543 "title": "Update an existing Interaction",
18546 "title": "Example usage:",
18547 "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",
18551 "name": "updateInteractions",
18552 "group": "Openchannel_Interactions",
18553 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18554 "version": "0.0.0",
18555 "filename": "server/api/openchannelInteraction/index.js",
18556 "groupTitle": "Openchannel_Interactions"
18560 "url": "/api/openchannel/messages",
18561 "title": "Creates a new Message",
18564 "title": "Example usage:",
18565 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18569 "name": "CreateMessages",
18570 "group": "Openchannel_Messages",
18603 "field": "direction",
18617 "field": "providerName",
18624 "field": "providerResponse",
18630 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18631 "version": "0.0.0",
18632 "filename": "server/api/openchannelMessage/index.js",
18633 "groupTitle": "Openchannel_Messages"
18637 "url": "/api/openchannel/messages/{id}",
18638 "title": "Deletes a Message",
18641 "title": "Example usage:",
18642 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18646 "name": "DeleteMessages",
18647 "group": "Openchannel_Messages",
18648 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18649 "version": "0.0.0",
18650 "filename": "server/api/openchannelMessage/index.js",
18651 "groupTitle": "Openchannel_Messages"
18655 "url": "/api/openchannel/messages/describe",
18656 "title": "Gets table info about Messages",
18659 "title": "Example usage:",
18660 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18664 "name": "DescribeMessages",
18665 "group": "Openchannel_Messages",
18666 "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>",
18667 "version": "0.0.0",
18668 "filename": "server/api/openchannelMessage/index.js",
18669 "groupTitle": "Openchannel_Messages"
18673 "url": "/api/openchannel/messages",
18674 "title": "Gets a list of Messages",
18677 "title": "Example usage:",
18678 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18682 "name": "GetMessages",
18683 "group": "Openchannel_Messages",
18684 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18685 "version": "0.0.0",
18686 "filename": "server/api/openchannelMessage/index.js",
18687 "groupTitle": "Openchannel_Messages"
18691 "url": "/api/openchannel/messages/{id}",
18692 "title": "Gets a single Message",
18695 "title": "Example usage:",
18696 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18700 "name": "ShowMessages",
18701 "group": "Openchannel_Messages",
18702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18703 "version": "0.0.0",
18704 "filename": "server/api/openchannelMessage/index.js",
18705 "groupTitle": "Openchannel_Messages"
18709 "url": "/api/openchannel/messages/{id}/accept",
18710 "title": "Accepts message",
18713 "title": "Example usage:",
18714 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18718 "name": "acceptMessage",
18719 "group": "Openchannel_Messages",
18720 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18721 "version": "0.0.0",
18722 "filename": "server/api/openchannelMessage/index.js",
18723 "groupTitle": "Openchannel_Messages"
18727 "url": "/api/openchannel/messages/{id}/reject",
18728 "title": "Rejects message",
18731 "title": "Example usage:",
18732 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18736 "name": "rejectMessage",
18737 "group": "Openchannel_Messages",
18738 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18739 "version": "0.0.0",
18740 "filename": "server/api/openchannelMessage/index.js",
18741 "groupTitle": "Openchannel_Messages"
18745 "url": "/api/openchannel/messages/{id}",
18746 "title": "Update an existing Message",
18749 "title": "Example usage:",
18750 "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",
18754 "name": "updateMessages",
18755 "group": "Openchannel_Messages",
18756 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18757 "version": "0.0.0",
18758 "filename": "server/api/openchannelMessage/index.js",
18759 "groupTitle": "Openchannel_Messages"
18763 "url": "/api/openchannel/reports/queue",
18764 "title": "Creates a new Openchannel Queue Report",
18767 "title": "Example usage:",
18768 "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",
18772 "name": "CreateOpenchannel_Queue_Reports",
18773 "group": "Openchannel_Queue_Reports",
18781 "field": "uniqueid",
18802 "field": "leaveAt",
18809 "field": "acceptAt",
18829 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18830 "version": "0.0.0",
18831 "filename": "server/api/openchannelQueueReport/index.js",
18832 "groupTitle": "Openchannel_Queue_Reports"
18836 "url": "/api/openchannel/reports/queue/{id}",
18837 "title": "Deletes a Openchannel Queue Report",
18840 "title": "Example usage:",
18841 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18845 "name": "DeleteOpenchannel_Queue_Reports",
18846 "group": "Openchannel_Queue_Reports",
18847 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18848 "version": "0.0.0",
18849 "filename": "server/api/openchannelQueueReport/index.js",
18850 "groupTitle": "Openchannel_Queue_Reports"
18854 "url": "/api/openchannel/reports/queue/describe",
18855 "title": "Gets table info about Openchannel Queue Reports",
18858 "title": "Example usage:",
18859 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18863 "name": "DescribeOpenchannel_Queue_Reports",
18864 "group": "Openchannel_Queue_Reports",
18865 "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>",
18866 "version": "0.0.0",
18867 "filename": "server/api/openchannelQueueReport/index.js",
18868 "groupTitle": "Openchannel_Queue_Reports"
18872 "url": "/api/openchannel/reports/queue",
18873 "title": "Gets a list of Openchannel Queue Reports",
18876 "title": "Example usage:",
18877 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18881 "name": "GetOpenchannel_Queue_Reports",
18882 "group": "Openchannel_Queue_Reports",
18883 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18884 "version": "0.0.0",
18885 "filename": "server/api/openchannelQueueReport/index.js",
18886 "groupTitle": "Openchannel_Queue_Reports"
18890 "url": "/api/openchannel/reports/queue/{id}",
18891 "title": "Gets a single Openchannel Queue Report",
18894 "title": "Example usage:",
18895 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18899 "name": "ShowOpenchannel_Queue_Reports",
18900 "group": "Openchannel_Queue_Reports",
18901 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18902 "version": "0.0.0",
18903 "filename": "server/api/openchannelQueueReport/index.js",
18904 "groupTitle": "Openchannel_Queue_Reports"
18908 "url": "/api/openchannel/reports/queue/{id}",
18909 "title": "Update an existing Openchannel Queue Report",
18912 "title": "Example usage:",
18913 "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",
18917 "name": "updateOpenchannel_Queue_Reports",
18918 "group": "Openchannel_Queue_Reports",
18919 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18920 "version": "0.0.0",
18921 "filename": "server/api/openchannelQueueReport/index.js",
18922 "groupTitle": "Openchannel_Queue_Reports"
18926 "url": "/api/openchannel/queues/{id}/users",
18927 "title": "Add agents to a queue",
18930 "title": "Example usage:",
18931 "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",
18935 "name": "AddAgents",
18936 "group": "Openchannel_Queues",
18937 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18938 "version": "0.0.0",
18939 "filename": "server/api/openchannelQueue/index.js",
18940 "groupTitle": "Openchannel_Queues"
18944 "url": "/api/openchannel/queues/{id}/teams",
18945 "title": "Add teams to a queue",
18948 "title": "Example usage:",
18949 "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",
18953 "name": "AddTeams",
18954 "group": "Openchannel_Queues",
18955 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18956 "version": "0.0.0",
18957 "filename": "server/api/openchannelQueue/index.js",
18958 "groupTitle": "Openchannel_Queues"
18962 "url": "/api/openchannel/queues",
18963 "title": "Creates a new Queue",
18966 "title": "Example usage:",
18967 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18971 "name": "CreateQueues",
18972 "group": "Openchannel_Queues",
18987 "field": "description",
18994 "field": "timeout",
19006 "field": "strategy",
19012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19013 "version": "0.0.0",
19014 "filename": "server/api/openchannelQueue/index.js",
19015 "groupTitle": "Openchannel_Queues"
19019 "url": "/api/openchannel/queues/{id}",
19020 "title": "Deletes a Queue",
19023 "title": "Example usage:",
19024 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
19028 "name": "DeleteQueues",
19029 "group": "Openchannel_Queues",
19030 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19031 "version": "0.0.0",
19032 "filename": "server/api/openchannelQueue/index.js",
19033 "groupTitle": "Openchannel_Queues"
19037 "url": "/api/openchannel/queues/describe",
19038 "title": "Gets table info about Queues",
19041 "title": "Example usage:",
19042 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19046 "name": "DescribeQueues",
19047 "group": "Openchannel_Queues",
19048 "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>",
19049 "version": "0.0.0",
19050 "filename": "server/api/openchannelQueue/index.js",
19051 "groupTitle": "Openchannel_Queues"
19055 "url": "/api/openchannel/queues/{id}/users",
19056 "title": "Gets queue agents",
19059 "title": "Example usage:",
19060 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19064 "name": "GetAgents",
19065 "group": "Openchannel_Queues",
19066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19067 "version": "0.0.0",
19068 "filename": "server/api/openchannelQueue/index.js",
19069 "groupTitle": "Openchannel_Queues"
19073 "url": "/api/openchannel/queues/{id}/members",
19074 "title": "GetMembers",
19077 "title": "Example usage:",
19078 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
19082 "name": "GetMembers",
19083 "group": "Openchannel_Queues",
19084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19085 "version": "0.0.0",
19086 "filename": "server/api/openchannelQueue/index.js",
19087 "groupTitle": "Openchannel_Queues"
19091 "url": "/api/openchannel/queues",
19092 "title": "Gets a list of Queues",
19095 "title": "Example usage:",
19096 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19100 "name": "GetQueues",
19101 "group": "Openchannel_Queues",
19102 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19103 "version": "0.0.0",
19104 "filename": "server/api/openchannelQueue/index.js",
19105 "groupTitle": "Openchannel_Queues"
19109 "url": "/api/openchannel/queues/{id}/teams",
19110 "title": "Gets queues list",
19113 "title": "Example usage:",
19114 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19118 "name": "GetTeams",
19119 "group": "Openchannel_Queues",
19120 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19121 "version": "0.0.0",
19122 "filename": "server/api/openchannelQueue/index.js",
19123 "groupTitle": "Openchannel_Queues"
19127 "url": "/api/openchannel/queues/{id}/users",
19128 "title": "Removes agents from a queue",
19131 "title": "Example usage:",
19132 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19136 "name": "RemoveAgents",
19137 "group": "Openchannel_Queues",
19138 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19139 "version": "0.0.0",
19140 "filename": "server/api/openchannelQueue/index.js",
19141 "groupTitle": "Openchannel_Queues"
19145 "url": "/api/openchannel/queues/{id}",
19146 "title": "Gets a single Queue",
19149 "title": "Example usage:",
19150 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19154 "name": "ShowQueues",
19155 "group": "Openchannel_Queues",
19156 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19157 "version": "0.0.0",
19158 "filename": "server/api/openchannelQueue/index.js",
19159 "groupTitle": "Openchannel_Queues"
19163 "url": "/api/openchannel/queues/{id}",
19164 "title": "Update an existing Queue",
19167 "title": "Example usage:",
19168 "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",
19172 "name": "updateQueues",
19173 "group": "Openchannel_Queues",
19174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19175 "version": "0.0.0",
19176 "filename": "server/api/openchannelQueue/index.js",
19177 "groupTitle": "Openchannel_Queues"
19181 "url": "/api/openchannel/reports/transfer",
19182 "title": "Creates a new Openchannel Transfer Report",
19185 "title": "Example usage:",
19186 "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",
19190 "name": "CreateOpenchannel_Transfer_Reports",
19191 "group": "Openchannel_Transfer_Reports",
19199 "field": "uniqueid",
19218 "field": "transferredAt",
19224 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19225 "version": "0.0.0",
19226 "filename": "server/api/openchannelTransferReport/index.js",
19227 "groupTitle": "Openchannel_Transfer_Reports"
19231 "url": "/api/openchannel/reports/transfer/{id}",
19232 "title": "Deletes a Openchannel Transfer Report",
19235 "title": "Example usage:",
19236 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19240 "name": "DeleteOpenchannel_Transfer_Reports",
19241 "group": "Openchannel_Transfer_Reports",
19242 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19243 "version": "0.0.0",
19244 "filename": "server/api/openchannelTransferReport/index.js",
19245 "groupTitle": "Openchannel_Transfer_Reports"
19249 "url": "/api/openchannel/reports/transfer/describe",
19250 "title": "Gets table info about Openchannel Transfer Reports",
19253 "title": "Example usage:",
19254 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19258 "name": "DescribeOpenchannel_Transfer_Reports",
19259 "group": "Openchannel_Transfer_Reports",
19260 "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>",
19261 "version": "0.0.0",
19262 "filename": "server/api/openchannelTransferReport/index.js",
19263 "groupTitle": "Openchannel_Transfer_Reports"
19267 "url": "/api/openchannel/reports/transfer",
19268 "title": "Gets a list of Openchannel Transfer Reports",
19271 "title": "Example usage:",
19272 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19276 "name": "GetOpenchannel_Transfer_Reports",
19277 "group": "Openchannel_Transfer_Reports",
19278 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19279 "version": "0.0.0",
19280 "filename": "server/api/openchannelTransferReport/index.js",
19281 "groupTitle": "Openchannel_Transfer_Reports"
19285 "url": "/api/openchannel/reports/transfer/{id}",
19286 "title": "Gets a single Openchannel Transfer Report",
19289 "title": "Example usage:",
19290 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19294 "name": "ShowOpenchannel_Transfer_Reports",
19295 "group": "Openchannel_Transfer_Reports",
19296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19297 "version": "0.0.0",
19298 "filename": "server/api/openchannelTransferReport/index.js",
19299 "groupTitle": "Openchannel_Transfer_Reports"
19303 "url": "/api/openchannel/reports/transfer/{id}",
19304 "title": "Update an existing Openchannel Transfer Report",
19307 "title": "Example usage:",
19308 "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",
19312 "name": "updateOpenchannel_Transfer_Reports",
19313 "group": "Openchannel_Transfer_Reports",
19314 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19315 "version": "0.0.0",
19316 "filename": "server/api/openchannelTransferReport/index.js",
19317 "groupTitle": "Openchannel_Transfer_Reports"
19321 "url": "/api/pauses",
19322 "title": "Creates a new Pause",
19325 "title": "Example usage:",
19326 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19330 "name": "CreatePauses",
19346 "field": "description",
19352 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19353 "version": "0.0.0",
19354 "filename": "server/api/pause/index.js",
19355 "groupTitle": "Pauses"
19359 "url": "/api/pauses/{id}",
19360 "title": "Deletes a Pause",
19363 "title": "Example usage:",
19364 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19368 "name": "DeletePauses",
19370 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19371 "version": "0.0.0",
19372 "filename": "server/api/pause/index.js",
19373 "groupTitle": "Pauses"
19377 "url": "/api/pauses",
19378 "title": "Gets a list of Pauses",
19381 "title": "Example usage:",
19382 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19386 "name": "GetPauses",
19388 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19389 "version": "0.0.0",
19390 "filename": "server/api/pause/index.js",
19391 "groupTitle": "Pauses"
19395 "url": "/api/pauses/{id}",
19396 "title": "Gets a single Pause",
19399 "title": "Example usage:",
19400 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19404 "name": "ShowPauses",
19406 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19407 "version": "0.0.0",
19408 "filename": "server/api/pause/index.js",
19409 "groupTitle": "Pauses"
19413 "url": "/api/pauses/{id}",
19414 "title": "Update an existing Pause",
19417 "title": "Example usage:",
19418 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19422 "name": "updatePauses",
19424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19425 "version": "0.0.0",
19426 "filename": "server/api/pause/index.js",
19427 "groupTitle": "Pauses"
19431 "url": "/api/plugins",
19432 "title": "Gets a list of Plugins",
19435 "title": "Example usage:",
19436 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19440 "name": "GetPlugins",
19441 "group": "Plugins",
19442 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19443 "version": "0.0.0",
19444 "filename": "server/api/plugin/index.js",
19445 "groupTitle": "Plugins"
19449 "url": "/api/plugins/{id}",
19450 "title": "Gets a single Plugin",
19453 "title": "Example usage:",
19454 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19458 "name": "ShowPlugins",
19459 "group": "Plugins",
19460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19461 "version": "0.0.0",
19462 "filename": "server/api/plugin/index.js",
19463 "groupTitle": "Plugins"
19467 "url": "/api/plugins/{id}",
19468 "title": "Delete a plugin",
19471 "title": "Example usage:",
19472 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19476 "name": "destroyPlugin",
19477 "group": "Plugins",
19478 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19479 "version": "0.0.0",
19480 "filename": "server/api/plugin/index.js",
19481 "groupTitle": "Plugins"
19485 "url": "/api/plugins/{id}/download",
19486 "title": "Download plugin source code",
19489 "title": "Example usage:",
19490 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19494 "name": "download",
19495 "group": "Plugins",
19496 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19497 "version": "0.0.0",
19498 "filename": "server/api/plugin/index.js",
19499 "groupTitle": "Plugins"
19503 "url": "/api/plugins/{id}",
19504 "title": "Update an existing plugin",
19507 "title": "Example usage:",
19508 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19512 "name": "updatePlugin",
19513 "group": "Plugins",
19514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19515 "version": "0.0.0",
19516 "filename": "server/api/plugin/index.js",
19517 "groupTitle": "Plugins"
19521 "url": "/api/plugins",
19522 "title": "Upload new plugin",
19525 "title": "Example usage:",
19526 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19530 "name": "uploadPlugin",
19531 "group": "Plugins",
19532 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19533 "version": "0.0.0",
19534 "filename": "server/api/plugin/index.js",
19535 "groupTitle": "Plugins"
19539 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19540 "title": "Redirect a plugin request to the specified path",
19543 "title": "Example usage:",
19544 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19548 "name": "webhookPlugin",
19549 "group": "Plugins",
19550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19551 "version": "0.0.0",
19552 "filename": "server/api/plugin/index.js",
19553 "groupTitle": "Plugins"
19557 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19558 "title": "Redirect a plugin request to the specified path",
19561 "title": "Example usage:",
19562 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19566 "name": "webhookPlugin",
19567 "group": "Plugins",
19568 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19569 "version": "0.0.0",
19570 "filename": "server/api/plugin/index.js",
19571 "groupTitle": "Plugins"
19575 "url": "/api/pm2/{id}",
19576 "title": "Deletes an existing process",
19579 "title": "Example usage:",
19580 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19584 "name": "DeletePm2Process",
19586 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19587 "version": "0.0.0",
19588 "filename": "server/api/pm2/index.js",
19589 "groupTitle": "Pm2"
19593 "url": "/api/pm2/{id}",
19594 "title": "Gets a single pm2 process",
19597 "title": "Example usage:",
19598 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19602 "name": "GetPm2Process",
19604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19605 "version": "0.0.0",
19606 "filename": "server/api/pm2/index.js",
19607 "groupTitle": "Pm2"
19612 "title": "Gets pm2 processes",
19615 "title": "Example usage:",
19616 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19620 "name": "GetPm2Processes",
19622 "description": "<p>Motion returns the pm2 processes list.</p>",
19623 "version": "0.0.0",
19624 "filename": "server/api/pm2/index.js",
19625 "groupTitle": "Pm2"
19630 "title": "Start a single pm2 process",
19633 "title": "Example usage:",
19634 "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",
19638 "name": "StartPm2Process",
19660 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19661 "version": "0.0.0",
19662 "filename": "server/api/pm2/index.js",
19663 "groupTitle": "Pm2"
19667 "url": "/api/pm2/{id}",
19668 "title": "Update an existing process",
19671 "title": "Example usage:",
19672 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19676 "name": "UpdatePm2Process",
19678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19679 "version": "0.0.0",
19680 "filename": "server/api/pm2/index.js",
19681 "groupTitle": "Pm2"
19685 "url": "/api/rpc/campaigns/",
19686 "title": "Gets a list of campaigns",
19689 "title": "Example usage:",
19690 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19694 "name": "Campaigns",
19695 "group": "RPC_Realtime",
19696 "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>",
19697 "version": "0.0.0",
19698 "filename": "server/api/rpc/index.js",
19699 "groupTitle": "RPC_Realtime"
19703 "url": "/api/rpc/fax/accounts",
19704 "title": "Gets a list of FaxAccounts",
19707 "title": "Example usage:",
19708 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19712 "name": "FaxAccounts",
19713 "group": "RPC_Realtime",
19714 "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>",
19715 "version": "0.0.0",
19716 "filename": "server/api/rpc/index.js",
19717 "groupTitle": "RPC_Realtime"
19721 "url": "/api/rpc/agents/:id/capacity",
19722 "title": "Sets agent capacity",
19725 "title": "Example usage:",
19726 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19730 "name": "RTAgentCapacity",
19731 "group": "RPC_Realtime",
19732 "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>",
19733 "version": "0.0.0",
19734 "filename": "server/api/rpc/index.js",
19735 "groupTitle": "RPC_Realtime"
19739 "url": "/api/rpc/agents",
19740 "title": "Gets a list of RTAgents",
19743 "title": "Example usage:",
19744 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19748 "name": "RTAgents",
19749 "group": "RPC_Realtime",
19750 "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>",
19751 "version": "0.0.0",
19752 "filename": "server/api/rpc/index.js",
19753 "groupTitle": "RPC_Realtime"
19757 "url": "/api/rpc/chat/queues",
19758 "title": "Gets a list of RTChatQueues",
19761 "title": "Example usage:",
19762 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19766 "name": "RTChatQueues",
19767 "group": "RPC_Realtime",
19768 "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>",
19769 "version": "0.0.0",
19770 "filename": "server/api/rpc/index.js",
19771 "groupTitle": "RPC_Realtime"
19775 "url": "/api/rpc/fax/queues",
19776 "title": "Gets a list of RTFaxQueues",
19779 "title": "Example usage:",
19780 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19784 "name": "RTFaxQueues",
19785 "group": "RPC_Realtime",
19786 "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>",
19787 "version": "0.0.0",
19788 "filename": "server/api/rpc/index.js",
19789 "groupTitle": "RPC_Realtime"
19793 "url": "/api/rpc/mail/accounts",
19794 "title": "Gets a list of RTMailAccounts",
19797 "title": "Example usage:",
19798 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19802 "name": "RTMailAccounts",
19803 "group": "RPC_Realtime",
19804 "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>",
19805 "version": "0.0.0",
19806 "filename": "server/api/rpc/index.js",
19807 "groupTitle": "RPC_Realtime"
19811 "url": "/api/rpc/mail/queues",
19812 "title": "Gets a list of RTMailQueues",
19815 "title": "Example usage:",
19816 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19820 "name": "RTMailQueues",
19821 "group": "RPC_Realtime",
19822 "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>",
19823 "version": "0.0.0",
19824 "filename": "server/api/rpc/index.js",
19825 "groupTitle": "RPC_Realtime"
19829 "url": "/api/rpc/openchannel/queues",
19830 "title": "Gets a list of RTOpenchannelQueues",
19833 "title": "Example usage:",
19834 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19838 "name": "RTOpenchannelQueues",
19839 "group": "RPC_Realtime",
19840 "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>",
19841 "version": "0.0.0",
19842 "filename": "server/api/rpc/index.js",
19843 "groupTitle": "RPC_Realtime"
19847 "url": "/api/rpc/outbound/channels",
19848 "title": "Gets a list of RTOutboundChannels",
19851 "title": "Example usage:",
19852 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19856 "name": "RTOutboundChannels",
19857 "group": "RPC_Realtime",
19858 "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>",
19859 "version": "0.0.0",
19860 "filename": "server/api/rpc/index.js",
19861 "groupTitle": "RPC_Realtime"
19865 "url": "/api/rpc/sms/queues",
19866 "title": "Gets a list of RTSmsQueues",
19869 "title": "Example usage:",
19870 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19874 "name": "RTSmsQueues",
19875 "group": "RPC_Realtime",
19876 "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>",
19877 "version": "0.0.0",
19878 "filename": "server/api/rpc/index.js",
19879 "groupTitle": "RPC_Realtime"
19883 "url": "/api/rpc/telephones",
19884 "title": "Gets a list of RTTelephones",
19887 "title": "Example usage:",
19888 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19892 "name": "RTTelephones",
19893 "group": "RPC_Realtime",
19894 "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>",
19895 "version": "0.0.0",
19896 "filename": "server/api/rpc/index.js",
19897 "groupTitle": "RPC_Realtime"
19901 "url": "/api/rpc/trunks",
19902 "title": "Gets a list of RTTrunks",
19905 "title": "Example usage:",
19906 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19910 "name": "RTTrunks",
19911 "group": "RPC_Realtime",
19912 "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>",
19913 "version": "0.0.0",
19914 "filename": "server/api/rpc/index.js",
19915 "groupTitle": "RPC_Realtime"
19919 "url": "/api/rpc/voice/channels",
19920 "title": "Gets a list of RTVoiceChannelMixMonitor",
19923 "title": "Example usage:",
19924 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19928 "name": "RTVoiceChannelMixMonitor",
19929 "group": "RPC_Realtime",
19930 "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>",
19931 "version": "0.0.0",
19932 "filename": "server/api/rpc/index.js",
19933 "groupTitle": "RPC_Realtime"
19937 "url": "/api/rpc/voice/channels",
19938 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19941 "title": "Example usage:",
19942 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19946 "name": "RTVoiceChannelStopMixMonitor",
19947 "group": "RPC_Realtime",
19948 "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>",
19949 "version": "0.0.0",
19950 "filename": "server/api/rpc/index.js",
19951 "groupTitle": "RPC_Realtime"
19955 "url": "/api/rpc/voice/channels",
19956 "title": "Gets a list of RTVoiceChannels",
19959 "title": "Example usage:",
19960 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19964 "name": "RTVoiceChannels",
19965 "group": "RPC_Realtime",
19966 "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>",
19967 "version": "0.0.0",
19968 "filename": "server/api/rpc/index.js",
19969 "groupTitle": "RPC_Realtime"
19973 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19974 "title": "Gets a single RTVoiceQueueChannel",
19977 "title": "Example usage:",
19978 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19982 "name": "RTVoiceQueueChannel",
19983 "group": "RPC_Realtime",
19984 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19985 "version": "0.0.0",
19986 "filename": "server/api/rpc/index.js",
19987 "groupTitle": "RPC_Realtime"
19991 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19992 "title": "Hangup a single RTVoiceQueueChannel",
19995 "title": "Example usage:",
19996 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
20000 "name": "RTVoiceQueueChannelHangup",
20001 "group": "RPC_Realtime",
20002 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20003 "version": "0.0.0",
20004 "filename": "server/api/rpc/index.js",
20005 "groupTitle": "RPC_Realtime"
20009 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
20010 "title": "Hangup a single RTVoiceQueueChannel",
20013 "title": "Example usage:",
20014 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
20018 "name": "RTVoiceQueueChannelRedirect",
20019 "group": "RPC_Realtime",
20020 "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>",
20021 "version": "0.0.0",
20022 "filename": "server/api/rpc/index.js",
20023 "groupTitle": "RPC_Realtime"
20027 "url": "/api/rpc/voice/queues/preview/{id}",
20028 "title": "Gets a single preview contact",
20031 "title": "Example usage:",
20032 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
20036 "name": "RTVoiceQueuePreview",
20037 "group": "RPC_Realtime",
20038 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20039 "version": "0.0.0",
20040 "filename": "server/api/rpc/index.js",
20041 "groupTitle": "RPC_Realtime"
20045 "url": "/api/rpc/outbound",
20046 "title": "Gets a list of RTOutbound",
20049 "title": "Example usage:",
20050 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20054 "name": "RTVoiceQueues",
20055 "group": "RPC_Realtime",
20056 "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>",
20057 "version": "0.0.0",
20058 "filename": "server/api/rpc/index.js",
20059 "groupTitle": "RPC_Realtime"
20063 "url": "/api/rpc/voice/queues",
20064 "title": "Gets a list of RTVoiceQueues",
20067 "title": "Example usage:",
20068 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20072 "name": "RTVoiceQueues",
20073 "group": "RPC_Realtime",
20074 "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>",
20075 "version": "0.0.0",
20076 "filename": "server/api/rpc/index.js",
20077 "groupTitle": "RPC_Realtime"
20081 "url": "/api/rpc/voice/queues/channels",
20082 "title": "Gets a list of RTVoiceQueuesChannels",
20085 "title": "Example usage:",
20086 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20090 "name": "RTVoiceQueuesChannels",
20091 "group": "RPC_Realtime",
20092 "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>",
20093 "version": "0.0.0",
20094 "filename": "server/api/rpc/index.js",
20095 "groupTitle": "RPC_Realtime"
20099 "url": "/api/rpc/chat/queues/{id}",
20100 "title": "Gets a single RTChatQueue",
20103 "title": "Example usage:",
20104 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20108 "name": "ShowRTChatQueues",
20109 "group": "RPC_Realtime",
20110 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20111 "version": "0.0.0",
20112 "filename": "server/api/rpc/index.js",
20113 "groupTitle": "RPC_Realtime"
20117 "url": "/api/rpc/fax/queues/{id}",
20118 "title": "Gets a single RTFaxQueue",
20121 "title": "Example usage:",
20122 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20126 "name": "ShowRTFaxQueues",
20127 "group": "RPC_Realtime",
20128 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20129 "version": "0.0.0",
20130 "filename": "server/api/rpc/index.js",
20131 "groupTitle": "RPC_Realtime"
20135 "url": "/api/rpc/mail/queues/{id}",
20136 "title": "Gets a single RTMailQueue",
20139 "title": "Example usage:",
20140 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20144 "name": "ShowRTMailQueues",
20145 "group": "RPC_Realtime",
20146 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20147 "version": "0.0.0",
20148 "filename": "server/api/rpc/index.js",
20149 "groupTitle": "RPC_Realtime"
20153 "url": "/api/rpc/openchannel/queues/{id}",
20154 "title": "Gets a single RTOpenchannelQueue",
20157 "title": "Example usage:",
20158 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20162 "name": "ShowRTOpenchannelQueues",
20163 "group": "RPC_Realtime",
20164 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20165 "version": "0.0.0",
20166 "filename": "server/api/rpc/index.js",
20167 "groupTitle": "RPC_Realtime"
20171 "url": "/api/rpc/sms/queues/{id}",
20172 "title": "Gets a single RTSmsQueue",
20175 "title": "Example usage:",
20176 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20180 "name": "ShowRTSmsQueues",
20181 "group": "RPC_Realtime",
20182 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20183 "version": "0.0.0",
20184 "filename": "server/api/rpc/index.js",
20185 "groupTitle": "RPC_Realtime"
20189 "url": "/api/rpc/voice/queues/{id}",
20190 "title": "Gets a single RTVoiceQueue",
20193 "title": "Example usage:",
20194 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20198 "name": "ShowRTVoiceQueues",
20199 "group": "RPC_Realtime",
20200 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20201 "version": "0.0.0",
20202 "filename": "server/api/rpc/index.js",
20203 "groupTitle": "RPC_Realtime"
20207 "url": "/api/rpc/voice/{id}/queues",
20208 "title": "Updates a single VoiceQueue",
20211 "title": "Example usage:",
20212 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20216 "name": "UpdateVoiceQueues",
20217 "group": "RPC_Realtime",
20218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20219 "version": "0.0.0",
20220 "filename": "server/api/rpc/index.js",
20221 "groupTitle": "RPC_Realtime"
20225 "url": "/api/rpc/agents/:id/notify",
20226 "title": "Notify message to a specific agent",
20229 "title": "Example usage:",
20230 "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",
20234 "name": "agentNotify",
20235 "group": "RPC_Realtime",
20236 "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>",
20237 "version": "0.0.0",
20238 "filename": "server/api/rpc/index.js",
20239 "groupTitle": "RPC_Realtime"
20243 "url": "/api/rpc/chat/queues/:id/notify",
20244 "title": "Notify message to a specific queue",
20247 "title": "Example usage:",
20248 "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",
20252 "name": "chatQueueNotify",
20253 "group": "RPC_Realtime",
20254 "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>",
20255 "version": "0.0.0",
20256 "filename": "server/api/rpc/index.js",
20257 "groupTitle": "RPC_Realtime"
20261 "url": "/api/rpc/chat/queues/waitinginteractions",
20262 "title": "Gets a list of chatQueuesWaitingInteractions",
20265 "title": "Example usage:",
20266 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20270 "name": "chatQueuesWaitingInteractions",
20271 "group": "RPC_Realtime",
20272 "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>",
20273 "version": "0.0.0",
20274 "filename": "server/api/rpc/index.js",
20275 "groupTitle": "RPC_Realtime"
20279 "url": "/api/rpc/fax/queues/:id/notify",
20280 "title": "Notify message to a specific queue",
20283 "title": "Example usage:",
20284 "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",
20288 "name": "faxQueueNotify",
20289 "group": "RPC_Realtime",
20290 "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>",
20291 "version": "0.0.0",
20292 "filename": "server/api/rpc/index.js",
20293 "groupTitle": "RPC_Realtime"
20297 "url": "/api/rpc/fax/queues/waitinginteractions",
20298 "title": "Gets a list of faxQueuesWaitingInteractions",
20301 "title": "Example usage:",
20302 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20306 "name": "faxQueuesWaitingInteractions",
20307 "group": "RPC_Realtime",
20308 "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>",
20309 "version": "0.0.0",
20310 "filename": "server/api/rpc/index.js",
20311 "groupTitle": "RPC_Realtime"
20315 "url": "/api/rpc/mail/queues/:id/notify",
20316 "title": "Notify message to a specific queue",
20319 "title": "Example usage:",
20320 "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",
20324 "name": "mailQueueNotify",
20325 "group": "RPC_Realtime",
20326 "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>",
20327 "version": "0.0.0",
20328 "filename": "server/api/rpc/index.js",
20329 "groupTitle": "RPC_Realtime"
20333 "url": "/api/rpc/mail/queues/waitinginteractions",
20334 "title": "Gets a list of mailQueuesWaitingInteractions",
20337 "title": "Example usage:",
20338 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20342 "name": "mailQueuesWaitingInteractions",
20343 "group": "RPC_Realtime",
20344 "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>",
20345 "version": "0.0.0",
20346 "filename": "server/api/rpc/index.js",
20347 "groupTitle": "RPC_Realtime"
20351 "url": "/api/rpc/openchannel/queues/:id/notify",
20352 "title": "Notify message to a specific queue",
20355 "title": "Example usage:",
20356 "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",
20360 "name": "openchannelQueueNotify",
20361 "group": "RPC_Realtime",
20362 "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>",
20363 "version": "0.0.0",
20364 "filename": "server/api/rpc/index.js",
20365 "groupTitle": "RPC_Realtime"
20369 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20370 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20373 "title": "Example usage:",
20374 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20378 "name": "openchannelQueuesIdWaitingInteractions",
20379 "group": "RPC_Realtime",
20380 "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>",
20381 "version": "0.0.0",
20382 "filename": "server/api/rpc/index.js",
20383 "groupTitle": "RPC_Realtime"
20387 "url": "/api/rpc/openchannel/queues/waitinginteractions",
20388 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20391 "title": "Example usage:",
20392 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20396 "name": "openchannelQueuesWaitingInteractions",
20397 "group": "RPC_Realtime",
20398 "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>",
20399 "version": "0.0.0",
20400 "filename": "server/api/rpc/index.js",
20401 "groupTitle": "RPC_Realtime"
20405 "url": "/api/rpc/sms/queues/:id/notify",
20406 "title": "Notify message to a specific queue",
20409 "title": "Example usage:",
20410 "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",
20414 "name": "smsQueueNotify",
20415 "group": "RPC_Realtime",
20416 "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>",
20417 "version": "0.0.0",
20418 "filename": "server/api/rpc/index.js",
20419 "groupTitle": "RPC_Realtime"
20423 "url": "/api/rpc/sms/queues/waitinginteractions",
20424 "title": "Gets a list of smsQueuesWaitingInteractions",
20427 "title": "Example usage:",
20428 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20432 "name": "smsQueuesWaitingInteractions",
20433 "group": "RPC_Realtime",
20434 "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>",
20435 "version": "0.0.0",
20436 "filename": "server/api/rpc/index.js",
20437 "groupTitle": "RPC_Realtime"
20441 "url": "/api/realtime/agents",
20442 "title": "Gets realtime agents info",
20445 "title": "Example usage:",
20446 "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password} -X GET",
20450 "name": "getAgents",
20451 "group": "Realtime",
20452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20453 "version": "0.0.0",
20454 "filename": "server/api/realtime/index.js",
20455 "groupTitle": "Realtime"
20459 "url": "/api/realtime/queues",
20460 "title": "Gets realtime queues info",
20463 "title": "Example usage:",
20464 "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password} -X GET",
20468 "name": "getQueues",
20469 "group": "Realtime",
20470 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20471 "version": "0.0.0",
20472 "filename": "server/api/realtime/index.js",
20473 "groupTitle": "Realtime"
20477 "url": "/api/integrations/salesforce/accounts",
20478 "title": "Creates a new Salesforce Account",
20481 "title": "Example usage:",
20482 "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",
20486 "name": "CreateSalesforce_Accounts",
20487 "group": "Salesforce_Accounts",
20502 "field": "description",
20509 "field": "username",
20516 "field": "remoteUri",
20523 "field": "password",
20530 "field": "clientId",
20537 "field": "clientSecret",
20544 "field": "securityToken",
20551 "field": "serverUrl",
20558 "\"integrationTab\"",
20568 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20569 "version": "0.0.0",
20570 "filename": "server/api/intSalesforceAccount/index.js",
20571 "groupTitle": "Salesforce_Accounts"
20575 "url": "/api/integrations/salesforce/accounts/{id}",
20576 "title": "Deletes a Salesforce Account",
20579 "title": "Example usage:",
20580 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20584 "name": "DeleteSalesforce_Accounts",
20585 "group": "Salesforce_Accounts",
20586 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20587 "version": "0.0.0",
20588 "filename": "server/api/intSalesforceAccount/index.js",
20589 "groupTitle": "Salesforce_Accounts"
20593 "url": "/api/integrations/salesforce/accounts",
20594 "title": "Gets a list of Salesforce Accounts",
20597 "title": "Example usage:",
20598 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20602 "name": "GetSalesforce_Accounts",
20603 "group": "Salesforce_Accounts",
20604 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20605 "version": "0.0.0",
20606 "filename": "server/api/intSalesforceAccount/index.js",
20607 "groupTitle": "Salesforce_Accounts"
20611 "url": "/api/integrations/salesforce/accounts/{id}",
20612 "title": "Gets a single Salesforce Account",
20615 "title": "Example usage:",
20616 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20620 "name": "ShowSalesforce_Accounts",
20621 "group": "Salesforce_Accounts",
20622 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20623 "version": "0.0.0",
20624 "filename": "server/api/intSalesforceAccount/index.js",
20625 "groupTitle": "Salesforce_Accounts"
20629 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20630 "title": "Creates new configuration",
20633 "title": "Example usage:",
20634 "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",
20638 "name": "addConfiguration",
20639 "group": "Salesforce_Accounts",
20640 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20641 "version": "0.0.0",
20642 "filename": "server/api/intSalesforceAccount/index.js",
20643 "groupTitle": "Salesforce_Accounts"
20647 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20648 "title": "Gets account configurations",
20651 "title": "Example usage:",
20652 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20656 "name": "getConfigurations",
20657 "group": "Salesforce_Accounts",
20658 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20659 "version": "0.0.0",
20660 "filename": "server/api/intSalesforceAccount/index.js",
20661 "groupTitle": "Salesforce_Accounts"
20665 "url": "/api/integrations/salesforce/accounts/{id}/fields",
20666 "title": "Gets account fields",
20669 "title": "Example usage:",
20670 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20674 "name": "getFields",
20675 "group": "Salesforce_Accounts",
20676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20677 "version": "0.0.0",
20678 "filename": "server/api/intSalesforceAccount/index.js",
20679 "groupTitle": "Salesforce_Accounts"
20683 "url": "/api/integrations/salesforce/accounts/{id}",
20684 "title": "Update an existing Salesforce Account",
20687 "title": "Example usage:",
20688 "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",
20692 "name": "updateSalesforce_Accounts",
20693 "group": "Salesforce_Accounts",
20694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20695 "version": "0.0.0",
20696 "filename": "server/api/intSalesforceAccount/index.js",
20697 "groupTitle": "Salesforce_Accounts"
20701 "url": "/api/integrations/salesforce/configurations",
20702 "title": "Creates a new Salesforce Configuration",
20705 "title": "Example usage:",
20706 "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",
20710 "name": "CreateSalesforce_Configurations",
20711 "group": "Salesforce_Configurations",
20726 "field": "description",
20737 "field": "ticketType",
20744 "\"contact_lead\"",
20747 "\"account_contact_lead\"",
20751 "field": "moduleSearch",
20764 "field": "moduleCreate",
20778 "field": "additionalSearchAccount",
20785 "field": "additionalSearchContact",
20792 "field": "additionalSearchLead",
20798 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20799 "version": "0.0.0",
20800 "filename": "server/api/intSalesforceConfiguration/index.js",
20801 "groupTitle": "Salesforce_Configurations"
20805 "url": "/api/integrations/salesforce/configurations/{id}",
20806 "title": "Deletes a Salesforce Configuration",
20809 "title": "Example usage:",
20810 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20814 "name": "DeleteSalesforce_Configurations",
20815 "group": "Salesforce_Configurations",
20816 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20817 "version": "0.0.0",
20818 "filename": "server/api/intSalesforceConfiguration/index.js",
20819 "groupTitle": "Salesforce_Configurations"
20823 "url": "/api/integrations/salesforce/configurations",
20824 "title": "Gets a list of Salesforce Configurations",
20827 "title": "Example usage:",
20828 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20832 "name": "GetSalesforce_Configurations",
20833 "group": "Salesforce_Configurations",
20834 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20835 "version": "0.0.0",
20836 "filename": "server/api/intSalesforceConfiguration/index.js",
20837 "groupTitle": "Salesforce_Configurations"
20841 "url": "/api/integrations/salesforce/configurations/{id}",
20842 "title": "Gets a single Salesforce Configuration",
20845 "title": "Example usage:",
20846 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20850 "name": "ShowSalesforce_Configurations",
20851 "group": "Salesforce_Configurations",
20852 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20853 "version": "0.0.0",
20854 "filename": "server/api/intSalesforceConfiguration/index.js",
20855 "groupTitle": "Salesforce_Configurations"
20859 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20860 "title": "Gets configurations descriptions",
20863 "title": "Example usage:",
20864 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20868 "name": "getDescriptions",
20869 "group": "Salesforce_Configurations",
20870 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20871 "version": "0.0.0",
20872 "filename": "server/api/intSalesforceConfiguration/index.js",
20873 "groupTitle": "Salesforce_Configurations"
20877 "url": "/api/integrations/salesforce/configurations/{id}/fields",
20878 "title": "Gets configurations fields",
20881 "title": "Example usage:",
20882 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20886 "name": "getFields",
20887 "group": "Salesforce_Configurations",
20888 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20889 "version": "0.0.0",
20890 "filename": "server/api/intSalesforceConfiguration/index.js",
20891 "groupTitle": "Salesforce_Configurations"
20895 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20896 "title": "Gets configurations subjects",
20899 "title": "Example usage:",
20900 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20904 "name": "getSubjects",
20905 "group": "Salesforce_Configurations",
20906 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20907 "version": "0.0.0",
20908 "filename": "server/api/intSalesforceConfiguration/index.js",
20909 "groupTitle": "Salesforce_Configurations"
20913 "url": "/api/integrations/salesforce/configurations/{id}",
20914 "title": "Update an existing Salesforce Configuration",
20917 "title": "Example usage:",
20918 "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",
20922 "name": "updateSalesforce_Configurations",
20923 "group": "Salesforce_Configurations",
20924 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20925 "version": "0.0.0",
20926 "filename": "server/api/intSalesforceConfiguration/index.js",
20927 "groupTitle": "Salesforce_Configurations"
20931 "url": "/api/integrations/salesforce/fields",
20932 "title": "Creates a new Salesforce Field",
20935 "title": "Example usage:",
20936 "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",
20940 "name": "CreateSalesforce_Fields",
20941 "group": "Salesforce_Fields",
20951 "\"customVariable\"",
20963 "field": "content",
20979 "\"customVariable\""
20982 "field": "keyType",
20989 "field": "keyContent",
20996 "field": "idField",
21003 "field": "variableName",
21009 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21010 "version": "0.0.0",
21011 "filename": "server/api/intSalesforceField/index.js",
21012 "groupTitle": "Salesforce_Fields"
21016 "url": "/api/integrations/salesforce/fields/{id}",
21017 "title": "Deletes a Salesforce Field",
21020 "title": "Example usage:",
21021 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
21025 "name": "DeleteSalesforce_Fields",
21026 "group": "Salesforce_Fields",
21027 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21028 "version": "0.0.0",
21029 "filename": "server/api/intSalesforceField/index.js",
21030 "groupTitle": "Salesforce_Fields"
21034 "url": "/api/integrations/salesforce/fields",
21035 "title": "Gets a list of Salesforce Fields",
21038 "title": "Example usage:",
21039 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
21043 "name": "GetSalesforce_Fields",
21044 "group": "Salesforce_Fields",
21045 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21046 "version": "0.0.0",
21047 "filename": "server/api/intSalesforceField/index.js",
21048 "groupTitle": "Salesforce_Fields"
21052 "url": "/api/integrations/salesforce/fields/{id}",
21053 "title": "Gets a single Salesforce Field",
21056 "title": "Example usage:",
21057 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21061 "name": "ShowSalesforce_Fields",
21062 "group": "Salesforce_Fields",
21063 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21064 "version": "0.0.0",
21065 "filename": "server/api/intSalesforceField/index.js",
21066 "groupTitle": "Salesforce_Fields"
21070 "url": "/api/integrations/salesforce/fields/{id}",
21071 "title": "Update an existing Salesforce Field",
21074 "title": "Example usage:",
21075 "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",
21079 "name": "updateSalesforce_Fields",
21080 "group": "Salesforce_Fields",
21081 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21082 "version": "0.0.0",
21083 "filename": "server/api/intSalesforceField/index.js",
21084 "groupTitle": "Salesforce_Fields"
21088 "url": "/api/schedules",
21089 "title": "Creates a new Schedule",
21092 "title": "Example usage:",
21093 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21097 "name": "CreateSchedules",
21098 "group": "Schedules",
21113 "field": "description",
21134 "field": "startAt",
21148 "field": "subtractNumber",
21164 "field": "subtractUnit",
21194 "field": "sendMail",
21222 "field": "sendIfEmpty",
21228 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21229 "version": "0.0.0",
21230 "filename": "server/api/schedule/index.js",
21231 "groupTitle": "Schedules"
21235 "url": "/api/schedules/{id}",
21236 "title": "Deletes a Schedule",
21239 "title": "Example usage:",
21240 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21244 "name": "DeleteSchedules",
21245 "group": "Schedules",
21246 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21247 "version": "0.0.0",
21248 "filename": "server/api/schedule/index.js",
21249 "groupTitle": "Schedules"
21253 "url": "/api/schedules",
21254 "title": "Gets a list of Schedules",
21257 "title": "Example usage:",
21258 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21262 "name": "GetSchedules",
21263 "group": "Schedules",
21264 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21265 "version": "0.0.0",
21266 "filename": "server/api/schedule/index.js",
21267 "groupTitle": "Schedules"
21271 "url": "/api/schedules/{id}",
21272 "title": "Gets a single Schedule",
21275 "title": "Example usage:",
21276 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21280 "name": "ShowSchedules",
21281 "group": "Schedules",
21282 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21283 "version": "0.0.0",
21284 "filename": "server/api/schedule/index.js",
21285 "groupTitle": "Schedules"
21289 "url": "/api/schedules/{id}/run",
21290 "title": "Run Scheduler",
21293 "title": "Example usage:",
21294 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21299 "group": "Schedules",
21300 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21301 "version": "0.0.0",
21302 "filename": "server/api/schedule/index.js",
21303 "groupTitle": "Schedules"
21307 "url": "/api/schedules/{id}",
21308 "title": "Update an existing Schedule",
21311 "title": "Example usage:",
21312 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21316 "name": "updateSchedules",
21317 "group": "Schedules",
21318 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21319 "version": "0.0.0",
21320 "filename": "server/api/schedule/index.js",
21321 "groupTitle": "Schedules"
21325 "url": "/api/screen/recordings",
21326 "title": "Creates a new Recording",
21329 "title": "Example usage:",
21330 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21334 "name": "CreateRecordings",
21335 "group": "Screen_Recordings",
21350 "field": "interactionid",
21357 "field": "channel",
21378 "field": "duration",
21385 "field": "startedAt",
21392 "field": "closedAt",
21399 "field": "createdAt",
21406 "field": "updatedAt",
21412 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21413 "version": "0.0.0",
21414 "filename": "server/api/screenRecording/index.js",
21415 "groupTitle": "Screen_Recordings"
21419 "url": "/api/screen/recordings/describe",
21420 "title": "Gets table info about Recordings",
21423 "title": "Example usage:",
21424 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21428 "name": "DescribeRecordings",
21429 "group": "Screen_Recordings",
21430 "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>",
21431 "version": "0.0.0",
21432 "filename": "server/api/screenRecording/index.js",
21433 "groupTitle": "Screen_Recordings"
21437 "url": "/api/screen/recordings",
21438 "title": "Gets a list of Recordings",
21441 "title": "Example usage:",
21442 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21446 "name": "GetRecordings",
21447 "group": "Screen_Recordings",
21448 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21449 "version": "0.0.0",
21450 "filename": "server/api/screenRecording/index.js",
21451 "groupTitle": "Screen_Recordings"
21455 "url": "/api/screen/recordings/{id}",
21456 "title": "Gets a single Recording",
21459 "title": "Example usage:",
21460 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21464 "name": "ShowRecordings",
21465 "group": "Screen_Recordings",
21466 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21467 "version": "0.0.0",
21468 "filename": "server/api/screenRecording/index.js",
21469 "groupTitle": "Screen_Recordings"
21473 "url": "/api/screen/recordings/{id}",
21474 "title": "Delete screen recording",
21477 "title": "Example usage:",
21478 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21483 "group": "Screen_Recordings",
21484 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21485 "version": "0.0.0",
21486 "filename": "server/api/screenRecording/index.js",
21487 "groupTitle": "Screen_Recordings"
21491 "url": "/api/screen/recordings/{id}/download",
21492 "title": "Download Recording",
21495 "title": "Example usage:",
21496 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21500 "name": "download",
21501 "group": "Screen_Recordings",
21502 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21503 "version": "0.0.0",
21504 "filename": "server/api/screenRecording/index.js",
21505 "groupTitle": "Screen_Recordings"
21509 "url": "/api/screen/recordings/{id}",
21510 "title": "Update an existing Recording",
21513 "title": "Example usage:",
21514 "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",
21518 "name": "updateRecordings",
21519 "group": "Screen_Recordings",
21520 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21521 "version": "0.0.0",
21522 "filename": "server/api/screenRecording/index.js",
21523 "groupTitle": "Screen_Recordings"
21527 "url": "/api/integrations/servicenow/accounts",
21528 "title": "Creates a new Servicenow Account",
21531 "title": "Example usage:",
21532 "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",
21536 "name": "CreateServicenow_Accounts",
21537 "group": "Servicenow_Accounts",
21552 "field": "description",
21559 "field": "username",
21566 "field": "password",
21580 "field": "remoteUri",
21587 "field": "serverUrl",
21593 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21594 "version": "0.0.0",
21595 "filename": "server/api/intServicenowAccount/index.js",
21596 "groupTitle": "Servicenow_Accounts"
21600 "url": "/api/integrations/servicenow/accounts/{id}",
21601 "title": "Deletes a Servicenow Account",
21604 "title": "Example usage:",
21605 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21609 "name": "DeleteServicenow_Accounts",
21610 "group": "Servicenow_Accounts",
21611 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21612 "version": "0.0.0",
21613 "filename": "server/api/intServicenowAccount/index.js",
21614 "groupTitle": "Servicenow_Accounts"
21618 "url": "/api/integrations/servicenow/accounts",
21619 "title": "Gets a list of Servicenow Accounts",
21622 "title": "Example usage:",
21623 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21627 "name": "GetServicenow_Accounts",
21628 "group": "Servicenow_Accounts",
21629 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21630 "version": "0.0.0",
21631 "filename": "server/api/intServicenowAccount/index.js",
21632 "groupTitle": "Servicenow_Accounts"
21636 "url": "/api/integrations/servicenow/accounts/{id}",
21637 "title": "Gets a single Servicenow Account",
21640 "title": "Example usage:",
21641 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21645 "name": "ShowServicenow_Accounts",
21646 "group": "Servicenow_Accounts",
21647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21648 "version": "0.0.0",
21649 "filename": "server/api/intServicenowAccount/index.js",
21650 "groupTitle": "Servicenow_Accounts"
21654 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21655 "title": "Creates new configuration",
21658 "title": "Example usage:",
21659 "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",
21663 "name": "addConfiguration",
21664 "group": "Servicenow_Accounts",
21665 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21666 "version": "0.0.0",
21667 "filename": "server/api/intServicenowAccount/index.js",
21668 "groupTitle": "Servicenow_Accounts"
21672 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21673 "title": "Gets account configurations",
21676 "title": "Example usage:",
21677 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21681 "name": "getConfigurations",
21682 "group": "Servicenow_Accounts",
21683 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21684 "version": "0.0.0",
21685 "filename": "server/api/intServicenowAccount/index.js",
21686 "groupTitle": "Servicenow_Accounts"
21690 "url": "/api/integrations/servicenow/accounts/{id}/fields",
21691 "title": "Gets account fields",
21694 "title": "Example usage:",
21695 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21699 "name": "getFields",
21700 "group": "Servicenow_Accounts",
21701 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21702 "version": "0.0.0",
21703 "filename": "server/api/intServicenowAccount/index.js",
21704 "groupTitle": "Servicenow_Accounts"
21708 "url": "/api/integrations/servicenow/accounts/{id}",
21709 "title": "Update an existing Servicenow Account",
21712 "title": "Example usage:",
21713 "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",
21717 "name": "updateServicenow_Accounts",
21718 "group": "Servicenow_Accounts",
21719 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21720 "version": "0.0.0",
21721 "filename": "server/api/intServicenowAccount/index.js",
21722 "groupTitle": "Servicenow_Accounts"
21726 "url": "/api/integrations/servicenow/configurations",
21727 "title": "Creates a new Servicenow Configuration",
21730 "title": "Example usage:",
21731 "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",
21735 "name": "CreateServicenow_Configurations",
21736 "group": "Servicenow_Configurations",
21751 "field": "description",
21757 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21758 "version": "0.0.0",
21759 "filename": "server/api/intServicenowConfiguration/index.js",
21760 "groupTitle": "Servicenow_Configurations"
21764 "url": "/api/integrations/servicenow/configurations/{id}",
21765 "title": "Deletes a Servicenow Configuration",
21768 "title": "Example usage:",
21769 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21773 "name": "DeleteServicenow_Configurations",
21774 "group": "Servicenow_Configurations",
21775 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21776 "version": "0.0.0",
21777 "filename": "server/api/intServicenowConfiguration/index.js",
21778 "groupTitle": "Servicenow_Configurations"
21782 "url": "/api/integrations/servicenow/configurations",
21783 "title": "Gets a list of Servicenow Configurations",
21786 "title": "Example usage:",
21787 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21791 "name": "GetServicenow_Configurations",
21792 "group": "Servicenow_Configurations",
21793 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21794 "version": "0.0.0",
21795 "filename": "server/api/intServicenowConfiguration/index.js",
21796 "groupTitle": "Servicenow_Configurations"
21800 "url": "/api/integrations/servicenow/configurations/{id}",
21801 "title": "Gets a single Servicenow Configuration",
21804 "title": "Example usage:",
21805 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21809 "name": "ShowServicenow_Configurations",
21810 "group": "Servicenow_Configurations",
21811 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21812 "version": "0.0.0",
21813 "filename": "server/api/intServicenowConfiguration/index.js",
21814 "groupTitle": "Servicenow_Configurations"
21818 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21819 "title": "Gets configurations descriptions",
21822 "title": "Example usage:",
21823 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21827 "name": "getDescriptions",
21828 "group": "Servicenow_Configurations",
21829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21830 "version": "0.0.0",
21831 "filename": "server/api/intServicenowConfiguration/index.js",
21832 "groupTitle": "Servicenow_Configurations"
21836 "url": "/api/integrations/servicenow/configurations/{id}/fields",
21837 "title": "Gets configurations fields",
21840 "title": "Example usage:",
21841 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21845 "name": "getFields",
21846 "group": "Servicenow_Configurations",
21847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21848 "version": "0.0.0",
21849 "filename": "server/api/intServicenowConfiguration/index.js",
21850 "groupTitle": "Servicenow_Configurations"
21854 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21855 "title": "Gets configurations subjects",
21858 "title": "Example usage:",
21859 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21863 "name": "getSubjects",
21864 "group": "Servicenow_Configurations",
21865 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21866 "version": "0.0.0",
21867 "filename": "server/api/intServicenowConfiguration/index.js",
21868 "groupTitle": "Servicenow_Configurations"
21872 "url": "/api/integrations/servicenow/configurations/{id}",
21873 "title": "Update an existing Servicenow Configuration",
21876 "title": "Example usage:",
21877 "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",
21881 "name": "updateServicenow_Configurations",
21882 "group": "Servicenow_Configurations",
21883 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21884 "version": "0.0.0",
21885 "filename": "server/api/intServicenowConfiguration/index.js",
21886 "groupTitle": "Servicenow_Configurations"
21890 "url": "/api/integrations/servicenow/fields",
21891 "title": "Creates a new Servicenow Field",
21894 "title": "Example usage:",
21895 "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",
21899 "name": "CreateServicenow_Fields",
21900 "group": "Servicenow_Fields",
21910 "\"customVariable\"",
21922 "field": "content",
21938 "\"customVariable\""
21941 "field": "keyType",
21948 "field": "keyContent",
21955 "field": "idField",
21962 "field": "nameField",
21969 "field": "customField",
21976 "field": "variableName",
21982 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21983 "version": "0.0.0",
21984 "filename": "server/api/intServicenowField/index.js",
21985 "groupTitle": "Servicenow_Fields"
21989 "url": "/api/integrations/servicenow/fields/{id}",
21990 "title": "Deletes a Servicenow Field",
21993 "title": "Example usage:",
21994 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21998 "name": "DeleteServicenow_Fields",
21999 "group": "Servicenow_Fields",
22000 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22001 "version": "0.0.0",
22002 "filename": "server/api/intServicenowField/index.js",
22003 "groupTitle": "Servicenow_Fields"
22007 "url": "/api/integrations/servicenow/fields",
22008 "title": "Gets a list of Servicenow Fields",
22011 "title": "Example usage:",
22012 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
22016 "name": "GetServicenow_Fields",
22017 "group": "Servicenow_Fields",
22018 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22019 "version": "0.0.0",
22020 "filename": "server/api/intServicenowField/index.js",
22021 "groupTitle": "Servicenow_Fields"
22025 "url": "/api/integrations/servicenow/fields/{id}",
22026 "title": "Gets a single Servicenow Field",
22029 "title": "Example usage:",
22030 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
22034 "name": "ShowServicenow_Fields",
22035 "group": "Servicenow_Fields",
22036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22037 "version": "0.0.0",
22038 "filename": "server/api/intServicenowField/index.js",
22039 "groupTitle": "Servicenow_Fields"
22043 "url": "/api/integrations/servicenow/fields/{id}",
22044 "title": "Update an existing Servicenow Field",
22047 "title": "Example usage:",
22048 "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",
22052 "name": "updateServicenow_Fields",
22053 "group": "Servicenow_Fields",
22054 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22055 "version": "0.0.0",
22056 "filename": "server/api/intServicenowField/index.js",
22057 "groupTitle": "Servicenow_Fields"
22061 "url": "/api/settings",
22062 "title": "Gets a list of Settings",
22065 "title": "Example usage:",
22066 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22070 "name": "GetSettings",
22071 "group": "Settings",
22072 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22073 "version": "0.0.0",
22074 "filename": "server/api/setting/index.js",
22075 "groupTitle": "Settings"
22079 "url": "/api/settings/{id}",
22080 "title": "Gets a single Setting",
22083 "title": "Example usage:",
22084 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22088 "name": "ShowSettings",
22089 "group": "Settings",
22090 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22091 "version": "0.0.0",
22092 "filename": "server/api/setting/index.js",
22093 "groupTitle": "Settings"
22097 "url": "/api/settings/{id}/favicon",
22098 "title": "Add Favicon",
22101 "title": "Example usage:",
22102 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22106 "name": "addFavicon",
22107 "group": "Settings",
22108 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22109 "version": "0.0.0",
22110 "filename": "server/api/setting/index.js",
22111 "groupTitle": "Settings"
22115 "url": "/api/settings/{id}/logo",
22116 "title": "Add logo",
22119 "title": "Example usage:",
22120 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22125 "group": "Settings",
22126 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22127 "version": "0.0.0",
22128 "filename": "server/api/setting/index.js",
22129 "groupTitle": "Settings"
22133 "url": "/api/settings/{id}/logo_login",
22134 "title": "Add logo login",
22137 "title": "Example usage:",
22138 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22142 "name": "addLogoLogin",
22143 "group": "Settings",
22144 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22145 "version": "0.0.0",
22146 "filename": "server/api/setting/index.js",
22147 "groupTitle": "Settings"
22151 "url": "/api/settings/{id}/preferred",
22152 "title": "Add Preferred",
22155 "title": "Example usage:",
22156 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22160 "name": "addPreferred",
22161 "group": "Settings",
22162 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22163 "version": "0.0.0",
22164 "filename": "server/api/setting/index.js",
22165 "groupTitle": "Settings"
22169 "url": "/api/settings/now",
22170 "title": "Get Server Current Date",
22173 "title": "Example usage:",
22174 "content": "curl https://{domain}/api/settings/now -v -X GET",
22179 "group": "Settings",
22180 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22181 "version": "0.0.0",
22182 "filename": "server/api/setting/index.js",
22183 "groupTitle": "Settings"
22187 "url": "/api/settings/{id}/favicon",
22188 "title": "Get Favicon",
22191 "title": "Example usage:",
22192 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22196 "name": "getFavicon",
22197 "group": "Settings",
22198 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22199 "version": "0.0.0",
22200 "filename": "server/api/setting/index.js",
22201 "groupTitle": "Settings"
22205 "url": "/api/settings/{id}/gdpr",
22206 "title": "Get gdpr settings",
22209 "title": "Example usage:",
22210 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22215 "group": "Settings",
22216 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22217 "version": "0.0.0",
22218 "filename": "server/api/setting/index.js",
22219 "groupTitle": "Settings"
22223 "url": "/api/settings/{id}/logo",
22224 "title": "Get logo",
22227 "title": "Example usage:",
22228 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22233 "group": "Settings",
22234 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22235 "version": "0.0.0",
22236 "filename": "server/api/setting/index.js",
22237 "groupTitle": "Settings"
22241 "url": "/api/settings/{id}/logo_login",
22242 "title": "Get logo login",
22245 "title": "Example usage:",
22246 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22250 "name": "getLogoLogin",
22251 "group": "Settings",
22252 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22253 "version": "0.0.0",
22254 "filename": "server/api/setting/index.js",
22255 "groupTitle": "Settings"
22259 "url": "/api/settings/{id}/preferred",
22260 "title": "Get Preferred",
22263 "title": "Example usage:",
22264 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22268 "name": "getPreferred",
22269 "group": "Settings",
22270 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22271 "version": "0.0.0",
22272 "filename": "server/api/setting/index.js",
22273 "groupTitle": "Settings"
22277 "url": "/api/settings/{id}",
22278 "title": "Update an existing Setting",
22281 "title": "Example usage:",
22282 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22286 "name": "updateSettings",
22287 "group": "Settings",
22288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22289 "version": "0.0.0",
22290 "filename": "server/api/setting/index.js",
22291 "groupTitle": "Settings"
22295 "url": "/api/sms/accounts/{id}/users",
22296 "title": "Add agents to a sms account",
22299 "title": "Example usage:",
22300 "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",
22304 "name": "AddAgents",
22305 "group": "Sms_Accounts",
22306 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22307 "version": "0.0.0",
22308 "filename": "server/api/smsAccount/index.js",
22309 "groupTitle": "Sms_Accounts"
22313 "url": "/api/sms/accounts",
22314 "title": "Creates a new Account",
22317 "title": "Example usage:",
22318 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22322 "name": "CreateAccounts",
22323 "group": "Sms_Accounts",
22385 "field": "accountSid",
22399 "field": "authToken",
22411 "field": "smsMethod",
22418 "field": "username",
22425 "field": "password",
22439 "field": "applicationId",
22446 "field": "accountId",
22453 "field": "senderString",
22460 "field": "deliveryReport",
22467 "field": "description",
22474 "field": "notificationTemplate",
22481 "field": "notificationSound",
22488 "field": "notificationShake",
22495 "field": "waitForTheAssignedAgent",
22502 "field": "queueTransfer",
22509 "field": "queueTransferTimeout",
22516 "field": "agentTransfer",
22523 "field": "agentTransferTimeout",
22530 "field": "baseUrl",
22537 "field": "mandatoryDispositionPauseId",
22538 "description": "<p>Status to put when mandatory disposition is enabled</p>"
22544 "field": "mandatoryDisposition",
22545 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22550 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22551 "version": "0.0.0",
22552 "filename": "server/api/smsAccount/index.js",
22553 "groupTitle": "Sms_Accounts"
22557 "url": "/api/sms/accounts/{id}",
22558 "title": "Deletes a Account",
22561 "title": "Example usage:",
22562 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22566 "name": "DeleteAccounts",
22567 "group": "Sms_Accounts",
22568 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22569 "version": "0.0.0",
22570 "filename": "server/api/smsAccount/index.js",
22571 "groupTitle": "Sms_Accounts"
22575 "url": "/api/sms/accounts/describe",
22576 "title": "Gets table info about Accounts",
22579 "title": "Example usage:",
22580 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22584 "name": "DescribeAccounts",
22585 "group": "Sms_Accounts",
22586 "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>",
22587 "version": "0.0.0",
22588 "filename": "server/api/smsAccount/index.js",
22589 "groupTitle": "Sms_Accounts"
22593 "url": "/api/sms/accounts",
22594 "title": "Gets a list of Accounts",
22597 "title": "Example usage:",
22598 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22602 "name": "GetAccounts",
22603 "group": "Sms_Accounts",
22604 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22605 "version": "0.0.0",
22606 "filename": "server/api/smsAccount/index.js",
22607 "groupTitle": "Sms_Accounts"
22611 "url": "/api/sms/accounts/{id}/users",
22612 "title": "Gets agents from sms account",
22615 "title": "Example usage:",
22616 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22620 "name": "GetAgents",
22621 "group": "Sms_Accounts",
22622 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22623 "version": "0.0.0",
22624 "filename": "server/api/smsAccount/index.js",
22625 "groupTitle": "Sms_Accounts"
22629 "url": "/api/sms/accounts/{id}/users",
22630 "title": "Removes agents from a sms account",
22633 "title": "Example usage:",
22634 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22638 "name": "RemoveAgents",
22639 "group": "Sms_Accounts",
22640 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/smsAccount/index.js",
22643 "groupTitle": "Sms_Accounts"
22647 "url": "/api/sms/accounts/{id}/canned_answers",
22648 "title": "Removes canned answers from account",
22651 "title": "Example usage:",
22652 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22656 "name": "RemoveAnswers",
22657 "group": "Sms_Accounts",
22658 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22659 "version": "0.0.0",
22660 "filename": "server/api/smsAccount/index.js",
22661 "groupTitle": "Sms_Accounts"
22665 "url": "/api/sms/accounts/{id}/dispositions",
22666 "title": "Removes dispositions from account",
22669 "title": "Example usage:",
22670 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22674 "name": "RemoveDispositions",
22675 "group": "Sms_Accounts",
22676 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22677 "version": "0.0.0",
22678 "filename": "server/api/smsAccount/index.js",
22679 "groupTitle": "Sms_Accounts"
22683 "url": "/api/sms/accounts/{id}",
22684 "title": "Gets a single Account",
22687 "title": "Example usage:",
22688 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22692 "name": "ShowAccounts",
22693 "group": "Sms_Accounts",
22694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22695 "version": "0.0.0",
22696 "filename": "server/api/smsAccount/index.js",
22697 "groupTitle": "Sms_Accounts"
22701 "url": "/api/sms/messages/{id}/accept",
22702 "title": "Accepts message",
22705 "title": "Example usage:",
22706 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22710 "name": "acceptMessage",
22711 "group": "Sms_Accounts",
22712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22713 "version": "0.0.0",
22714 "filename": "server/api/smsMessage/index.js",
22715 "groupTitle": "Sms_Accounts"
22719 "url": "/api/sms/accounts/{id}/canned_answers",
22720 "title": "Creates new canned answer",
22723 "title": "Example usage:",
22724 "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",
22728 "name": "addAnswer",
22729 "group": "Sms_Accounts",
22751 "field": "description",
22764 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22765 "version": "0.0.0",
22766 "filename": "server/api/smsAccount/index.js",
22767 "groupTitle": "Sms_Accounts"
22771 "url": "/api/sms/accounts/{id}/applications",
22772 "title": "Creates new applications",
22775 "title": "Example usage:",
22776 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22780 "name": "addApplications",
22781 "group": "Sms_Accounts",
22789 "field": "priority",
22803 "field": "appdata",
22810 "field": "description",
22817 "field": "interval",
22823 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22824 "version": "0.0.0",
22825 "filename": "server/api/smsAccount/index.js",
22826 "groupTitle": "Sms_Accounts"
22830 "url": "/api/sms/accounts/{id}/dispositions",
22831 "title": "Creates new disposition",
22834 "title": "Example usage:",
22835 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22839 "name": "addDisposition",
22840 "group": "Sms_Accounts",
22867 "field": "description",
22873 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22874 "version": "0.0.0",
22875 "filename": "server/api/smsAccount/index.js",
22876 "groupTitle": "Sms_Accounts"
22880 "url": "/api/sms/accounts/{id}/canned_answers",
22881 "title": "Gets account canned answers",
22884 "title": "Example usage:",
22885 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22889 "name": "getAnswers",
22890 "group": "Sms_Accounts",
22891 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22892 "version": "0.0.0",
22893 "filename": "server/api/smsAccount/index.js",
22894 "groupTitle": "Sms_Accounts"
22898 "url": "/api/sms/accounts/{id}/applications",
22899 "title": "Gets account applications",
22902 "title": "Example usage:",
22903 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22907 "name": "getApplications",
22908 "group": "Sms_Accounts",
22909 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22910 "version": "0.0.0",
22911 "filename": "server/api/smsAccount/index.js",
22912 "groupTitle": "Sms_Accounts"
22916 "url": "/api/sms/accounts/{id}/dispositions",
22917 "title": "Gets account dispositions",
22920 "title": "Example usage:",
22921 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22925 "name": "getDispositions",
22926 "group": "Sms_Accounts",
22927 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22928 "version": "0.0.0",
22929 "filename": "server/api/smsAccount/index.js",
22930 "groupTitle": "Sms_Accounts"
22934 "url": "/api/sms/accounts/{id}/interactions",
22935 "title": "Gets Sms Account interactions",
22938 "title": "Example usage:",
22939 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22943 "name": "getInteractions",
22944 "group": "Sms_Accounts",
22945 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22946 "version": "0.0.0",
22947 "filename": "server/api/smsAccount/index.js",
22948 "groupTitle": "Sms_Accounts"
22952 "url": "/api/sms/accounts/{id}/notify",
22953 "title": "Notify new message",
22956 "title": "Example usage:",
22957 "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",
22962 "group": "Sms_Accounts",
22963 "description": "<p>Motion 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>",
22964 "version": "0.0.0",
22965 "filename": "server/api/smsAccount/index.js",
22966 "groupTitle": "Sms_Accounts"
22970 "url": "/api/sms/messages/{id}/reject",
22971 "title": "Rejects message",
22974 "title": "Example usage:",
22975 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22979 "name": "rejectMessage",
22980 "group": "Sms_Accounts",
22981 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22982 "version": "0.0.0",
22983 "filename": "server/api/smsMessage/index.js",
22984 "groupTitle": "Sms_Accounts"
22988 "url": "/api/sms/accounts/{id}/send",
22989 "title": "Send new sms message",
22992 "title": "Example usage:",
22993 "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",
22998 "group": "Sms_Accounts",
22999 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23000 "version": "0.0.0",
23001 "filename": "server/api/smsAccount/index.js",
23002 "groupTitle": "Sms_Accounts"
23006 "url": "/api/sms/accounts/{id}/status",
23007 "title": "Receive message status as get request",
23010 "title": "Example usage:",
23011 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
23015 "name": "statusMessage",
23016 "group": "Sms_Accounts",
23017 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23018 "version": "0.0.0",
23019 "filename": "server/api/smsAccount/index.js",
23020 "groupTitle": "Sms_Accounts"
23024 "url": "/api/sms/messages/{id}/status",
23025 "title": "Receive message status",
23028 "title": "Example usage:",
23029 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
23033 "name": "statusMessage",
23034 "group": "Sms_Accounts",
23035 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23036 "version": "0.0.0",
23037 "filename": "server/api/smsMessage/index.js",
23038 "groupTitle": "Sms_Accounts"
23042 "url": "/api/sms/accounts/{id}/status",
23043 "title": "Receive message status",
23046 "title": "Example usage:",
23047 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23051 "name": "statusMessage",
23052 "group": "Sms_Accounts",
23053 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23054 "version": "0.0.0",
23055 "filename": "server/api/smsAccount/index.js",
23056 "groupTitle": "Sms_Accounts"
23060 "url": "/api/sms/accounts/{id}",
23061 "title": "Update an existing Account",
23064 "title": "Example usage:",
23065 "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",
23069 "name": "updateAccounts",
23070 "group": "Sms_Accounts",
23071 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23072 "version": "0.0.0",
23073 "filename": "server/api/smsAccount/index.js",
23074 "groupTitle": "Sms_Accounts"
23078 "url": "/api/sms/applications",
23079 "title": "Creates a new Application",
23082 "title": "Example usage:",
23083 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23087 "name": "CreateApplications",
23088 "group": "Sms_Applications",
23096 "field": "priority",
23110 "field": "appdata",
23117 "field": "description",
23124 "field": "interval",
23130 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23131 "version": "0.0.0",
23132 "filename": "server/api/smsApplication/index.js",
23133 "groupTitle": "Sms_Applications"
23137 "url": "/api/sms/applications/{id}",
23138 "title": "Deletes a Application",
23141 "title": "Example usage:",
23142 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23146 "name": "DeleteApplications",
23147 "group": "Sms_Applications",
23148 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23149 "version": "0.0.0",
23150 "filename": "server/api/smsApplication/index.js",
23151 "groupTitle": "Sms_Applications"
23155 "url": "/api/sms/applications",
23156 "title": "Gets a list of Applications",
23159 "title": "Example usage:",
23160 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23164 "name": "GetApplications",
23165 "group": "Sms_Applications",
23166 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23167 "version": "0.0.0",
23168 "filename": "server/api/smsApplication/index.js",
23169 "groupTitle": "Sms_Applications"
23173 "url": "/api/sms/applications/{id}",
23174 "title": "Gets a single Application",
23177 "title": "Example usage:",
23178 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23182 "name": "ShowApplications",
23183 "group": "Sms_Applications",
23184 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23185 "version": "0.0.0",
23186 "filename": "server/api/smsApplication/index.js",
23187 "groupTitle": "Sms_Applications"
23191 "url": "/api/sms/applications/{id}",
23192 "title": "Update an existing Application",
23195 "title": "Example usage:",
23196 "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",
23200 "name": "updateApplications",
23201 "group": "Sms_Applications",
23202 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23203 "version": "0.0.0",
23204 "filename": "server/api/smsApplication/index.js",
23205 "groupTitle": "Sms_Applications"
23209 "url": "/api/sms/interactions/{id}/tags",
23210 "title": "Add tags to the interaction",
23213 "title": "Example usage:",
23214 "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",
23219 "group": "Sms_Interactions",
23220 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23221 "version": "0.0.0",
23222 "filename": "server/api/smsInteraction/index.js",
23223 "groupTitle": "Sms_Interactions"
23227 "url": "/api/sms/interactions",
23228 "title": "Creates a new Interaction",
23231 "title": "Example usage:",
23232 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23236 "name": "CreateInteractions",
23237 "group": "Sms_Interactions",
23252 "field": "closedAt",
23259 "field": "disposition",
23266 "field": "secondDisposition",
23273 "field": "thirdDisposition",
23294 "field": "read1stAt",
23305 "field": "firstMsgDirection",
23312 "field": "lastMsgAt",
23323 "field": "lastMsgDirection",
23330 "field": "autoreplyExecuted",
23336 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23337 "version": "0.0.0",
23338 "filename": "server/api/smsInteraction/index.js",
23339 "groupTitle": "Sms_Interactions"
23343 "url": "/api/sms/interactions/{id}",
23344 "title": "Deletes a Interaction",
23347 "title": "Example usage:",
23348 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23352 "name": "DeleteInteractions",
23353 "group": "Sms_Interactions",
23354 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23355 "version": "0.0.0",
23356 "filename": "server/api/smsInteraction/index.js",
23357 "groupTitle": "Sms_Interactions"
23361 "url": "/api/sms/interactions/describe",
23362 "title": "Gets table info about Interactions",
23365 "title": "Example usage:",
23366 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23370 "name": "DescribeInteractions",
23371 "group": "Sms_Interactions",
23372 "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>",
23373 "version": "0.0.0",
23374 "filename": "server/api/smsInteraction/index.js",
23375 "groupTitle": "Sms_Interactions"
23379 "url": "/api/sms/interactions",
23380 "title": "Gets a list of Interactions",
23383 "title": "Example usage:",
23384 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23388 "name": "GetInteractions",
23389 "group": "Sms_Interactions",
23390 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23391 "version": "0.0.0",
23392 "filename": "server/api/smsInteraction/index.js",
23393 "groupTitle": "Sms_Interactions"
23397 "url": "/api/sms/interactions/{id}/tags",
23398 "title": "Removes tags from interaction",
23401 "title": "Example usage:",
23402 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23406 "name": "RemoveTags",
23407 "group": "Sms_Interactions",
23408 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23409 "version": "0.0.0",
23410 "filename": "server/api/smsInteraction/index.js",
23411 "groupTitle": "Sms_Interactions"
23415 "url": "/api/sms/interactions/{id}",
23416 "title": "Gets a single Interaction",
23419 "title": "Example usage:",
23420 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23424 "name": "ShowInteractions",
23425 "group": "Sms_Interactions",
23426 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23427 "version": "0.0.0",
23428 "filename": "server/api/smsInteraction/index.js",
23429 "groupTitle": "Sms_Interactions"
23433 "url": "/api/sms/interactions/{id}/messages",
23434 "title": "Creates new messages",
23437 "title": "Example usage:",
23438 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23442 "name": "addMessage",
23443 "group": "Sms_Interactions",
23469 "field": "direction",
23476 "field": "messageId",
23504 "field": "providerName",
23511 "field": "providerResponse",
23517 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23518 "version": "0.0.0",
23519 "filename": "server/api/smsInteraction/index.js",
23520 "groupTitle": "Sms_Interactions"
23524 "url": "/api/sms/interactions/{id}/download",
23525 "title": "Gets interaction",
23528 "title": "Example usage:",
23529 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23533 "name": "download",
23534 "group": "Sms_Interactions",
23535 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23536 "version": "0.0.0",
23537 "filename": "server/api/smsInteraction/index.js",
23538 "groupTitle": "Sms_Interactions"
23542 "url": "/api/sms/interactions/{id}/messages",
23543 "title": "Gets interaction messages",
23546 "title": "Example usage:",
23547 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23551 "name": "getMessages",
23552 "group": "Sms_Interactions",
23553 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23554 "version": "0.0.0",
23555 "filename": "server/api/smsInteraction/index.js",
23556 "groupTitle": "Sms_Interactions"
23560 "url": "/api/sms/interactions/{id}",
23561 "title": "Update an existing Interaction",
23564 "title": "Example usage:",
23565 "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",
23569 "name": "updateInteractions",
23570 "group": "Sms_Interactions",
23571 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23572 "version": "0.0.0",
23573 "filename": "server/api/smsInteraction/index.js",
23574 "groupTitle": "Sms_Interactions"
23578 "url": "/api/sms/messages",
23579 "title": "Creates a new Message",
23582 "title": "Example usage:",
23583 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23587 "name": "CreateMessages",
23588 "group": "Sms_Messages",
23614 "field": "direction",
23621 "field": "messageId",
23649 "field": "providerName",
23656 "field": "providerResponse",
23662 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23663 "version": "0.0.0",
23664 "filename": "server/api/smsMessage/index.js",
23665 "groupTitle": "Sms_Messages"
23669 "url": "/api/sms/messages/{id}",
23670 "title": "Deletes a Message",
23673 "title": "Example usage:",
23674 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23678 "name": "DeleteMessages",
23679 "group": "Sms_Messages",
23680 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23681 "version": "0.0.0",
23682 "filename": "server/api/smsMessage/index.js",
23683 "groupTitle": "Sms_Messages"
23687 "url": "/api/sms/messages/describe",
23688 "title": "Gets table info about Messages",
23691 "title": "Example usage:",
23692 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23696 "name": "DescribeMessages",
23697 "group": "Sms_Messages",
23698 "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>",
23699 "version": "0.0.0",
23700 "filename": "server/api/smsMessage/index.js",
23701 "groupTitle": "Sms_Messages"
23705 "url": "/api/sms/messages",
23706 "title": "Gets a list of Messages",
23709 "title": "Example usage:",
23710 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23714 "name": "GetMessages",
23715 "group": "Sms_Messages",
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/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>",
23717 "version": "0.0.0",
23718 "filename": "server/api/smsMessage/index.js",
23719 "groupTitle": "Sms_Messages"
23723 "url": "/api/sms/messages/{id}",
23724 "title": "Gets a single Message",
23727 "title": "Example usage:",
23728 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23732 "name": "ShowMessages",
23733 "group": "Sms_Messages",
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/smsMessage/index.js",
23737 "groupTitle": "Sms_Messages"
23741 "url": "/api/sms/messages/{id}",
23742 "title": "Update an existing Message",
23745 "title": "Example usage:",
23746 "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",
23750 "name": "updateMessages",
23751 "group": "Sms_Messages",
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/smsMessage/index.js",
23755 "groupTitle": "Sms_Messages"
23759 "url": "/api/sms/reports/queue",
23760 "title": "Creates a new Sms Queue Report",
23763 "title": "Example usage:",
23764 "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",
23768 "name": "CreateSms_Queue_Reports",
23769 "group": "Sms_Queue_Reports",
23777 "field": "uniqueid",
23798 "field": "leaveAt",
23805 "field": "acceptAt",
23825 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23826 "version": "0.0.0",
23827 "filename": "server/api/smsQueueReport/index.js",
23828 "groupTitle": "Sms_Queue_Reports"
23832 "url": "/api/sms/reports/queue/{id}",
23833 "title": "Deletes a Sms Queue Report",
23836 "title": "Example usage:",
23837 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23841 "name": "DeleteSms_Queue_Reports",
23842 "group": "Sms_Queue_Reports",
23843 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23844 "version": "0.0.0",
23845 "filename": "server/api/smsQueueReport/index.js",
23846 "groupTitle": "Sms_Queue_Reports"
23850 "url": "/api/sms/reports/queue/describe",
23851 "title": "Gets table info about Sms Queue Reports",
23854 "title": "Example usage:",
23855 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23859 "name": "DescribeSms_Queue_Reports",
23860 "group": "Sms_Queue_Reports",
23861 "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>",
23862 "version": "0.0.0",
23863 "filename": "server/api/smsQueueReport/index.js",
23864 "groupTitle": "Sms_Queue_Reports"
23868 "url": "/api/sms/reports/queue",
23869 "title": "Gets a list of Sms Queue Reports",
23872 "title": "Example usage:",
23873 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23877 "name": "GetSms_Queue_Reports",
23878 "group": "Sms_Queue_Reports",
23879 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23880 "version": "0.0.0",
23881 "filename": "server/api/smsQueueReport/index.js",
23882 "groupTitle": "Sms_Queue_Reports"
23886 "url": "/api/sms/reports/queue/{id}",
23887 "title": "Gets a single Sms Queue Report",
23890 "title": "Example usage:",
23891 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23895 "name": "ShowSms_Queue_Reports",
23896 "group": "Sms_Queue_Reports",
23897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23898 "version": "0.0.0",
23899 "filename": "server/api/smsQueueReport/index.js",
23900 "groupTitle": "Sms_Queue_Reports"
23904 "url": "/api/sms/reports/queue/{id}",
23905 "title": "Update an existing Sms Queue Report",
23908 "title": "Example usage:",
23909 "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",
23913 "name": "updateSms_Queue_Reports",
23914 "group": "Sms_Queue_Reports",
23915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23916 "version": "0.0.0",
23917 "filename": "server/api/smsQueueReport/index.js",
23918 "groupTitle": "Sms_Queue_Reports"
23922 "url": "/api/sms/queues/{id}/users",
23923 "title": "Add agents to a queue",
23926 "title": "Example usage:",
23927 "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",
23931 "name": "AddAgents",
23932 "group": "Sms_Queues",
23933 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23934 "version": "0.0.0",
23935 "filename": "server/api/smsQueue/index.js",
23936 "groupTitle": "Sms_Queues"
23940 "url": "/api/sms/queues/{id}/teams",
23941 "title": "Add teams to a queue",
23944 "title": "Example usage:",
23945 "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",
23949 "name": "AddTeams",
23950 "group": "Sms_Queues",
23951 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23952 "version": "0.0.0",
23953 "filename": "server/api/smsQueue/index.js",
23954 "groupTitle": "Sms_Queues"
23958 "url": "/api/sms/queues",
23959 "title": "Creates a new Queue",
23962 "title": "Example usage:",
23963 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23967 "name": "CreateQueues",
23968 "group": "Sms_Queues",
23983 "field": "description",
23990 "field": "timeout",
24002 "field": "strategy",
24008 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24009 "version": "0.0.0",
24010 "filename": "server/api/smsQueue/index.js",
24011 "groupTitle": "Sms_Queues"
24015 "url": "/api/sms/queues/{id}",
24016 "title": "Deletes a Queue",
24019 "title": "Example usage:",
24020 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
24024 "name": "DeleteQueues",
24025 "group": "Sms_Queues",
24026 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24027 "version": "0.0.0",
24028 "filename": "server/api/smsQueue/index.js",
24029 "groupTitle": "Sms_Queues"
24033 "url": "/api/sms/queues/describe",
24034 "title": "Gets table info about Queues",
24037 "title": "Example usage:",
24038 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
24042 "name": "DescribeQueues",
24043 "group": "Sms_Queues",
24044 "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>",
24045 "version": "0.0.0",
24046 "filename": "server/api/smsQueue/index.js",
24047 "groupTitle": "Sms_Queues"
24051 "url": "/api/sms/queues/{id}/users",
24052 "title": "Gets queue agents",
24055 "title": "Example usage:",
24056 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24060 "name": "GetAgents",
24061 "group": "Sms_Queues",
24062 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24063 "version": "0.0.0",
24064 "filename": "server/api/smsQueue/index.js",
24065 "groupTitle": "Sms_Queues"
24069 "url": "/api/sms/queues/{id}/members",
24070 "title": "GetMembers",
24073 "title": "Example usage:",
24074 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
24078 "name": "GetMembers",
24079 "group": "Sms_Queues",
24080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24081 "version": "0.0.0",
24082 "filename": "server/api/smsQueue/index.js",
24083 "groupTitle": "Sms_Queues"
24087 "url": "/api/sms/queues",
24088 "title": "Gets a list of Queues",
24091 "title": "Example usage:",
24092 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24096 "name": "GetQueues",
24097 "group": "Sms_Queues",
24098 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24099 "version": "0.0.0",
24100 "filename": "server/api/smsQueue/index.js",
24101 "groupTitle": "Sms_Queues"
24105 "url": "/api/sms/queues/{id}/teams",
24106 "title": "Gets queues list",
24109 "title": "Example usage:",
24110 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24114 "name": "GetTeams",
24115 "group": "Sms_Queues",
24116 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24117 "version": "0.0.0",
24118 "filename": "server/api/smsQueue/index.js",
24119 "groupTitle": "Sms_Queues"
24123 "url": "/api/sms/queues/{id}/users",
24124 "title": "Removes agents from a queue",
24127 "title": "Example usage:",
24128 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24132 "name": "RemoveAgents",
24133 "group": "Sms_Queues",
24134 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24135 "version": "0.0.0",
24136 "filename": "server/api/smsQueue/index.js",
24137 "groupTitle": "Sms_Queues"
24141 "url": "/api/sms/queues/{id}",
24142 "title": "Gets a single Queue",
24145 "title": "Example usage:",
24146 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24150 "name": "ShowQueues",
24151 "group": "Sms_Queues",
24152 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24153 "version": "0.0.0",
24154 "filename": "server/api/smsQueue/index.js",
24155 "groupTitle": "Sms_Queues"
24159 "url": "/api/sms/queues/{id}",
24160 "title": "Update an existing Queue",
24163 "title": "Example usage:",
24164 "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",
24168 "name": "updateQueues",
24169 "group": "Sms_Queues",
24170 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24171 "version": "0.0.0",
24172 "filename": "server/api/smsQueue/index.js",
24173 "groupTitle": "Sms_Queues"
24177 "url": "/api/sms/reports/transfer",
24178 "title": "Creates a new Sms Transfer Report",
24181 "title": "Example usage:",
24182 "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",
24186 "name": "CreateSms_Transfer_Reports",
24187 "group": "Sms_Transfer_Reports",
24195 "field": "uniqueid",
24214 "field": "transferredAt",
24220 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24221 "version": "0.0.0",
24222 "filename": "server/api/smsTransferReport/index.js",
24223 "groupTitle": "Sms_Transfer_Reports"
24227 "url": "/api/sms/reports/transfer/{id}",
24228 "title": "Deletes a Sms Transfer Report",
24231 "title": "Example usage:",
24232 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24236 "name": "DeleteSms_Transfer_Reports",
24237 "group": "Sms_Transfer_Reports",
24238 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24239 "version": "0.0.0",
24240 "filename": "server/api/smsTransferReport/index.js",
24241 "groupTitle": "Sms_Transfer_Reports"
24245 "url": "/api/sms/reports/transfer/describe",
24246 "title": "Gets table info about Sms Transfer Reports",
24249 "title": "Example usage:",
24250 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24254 "name": "DescribeSms_Transfer_Reports",
24255 "group": "Sms_Transfer_Reports",
24256 "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>",
24257 "version": "0.0.0",
24258 "filename": "server/api/smsTransferReport/index.js",
24259 "groupTitle": "Sms_Transfer_Reports"
24263 "url": "/api/sms/reports/transfer",
24264 "title": "Gets a list of Sms Transfer Reports",
24267 "title": "Example usage:",
24268 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24272 "name": "GetSms_Transfer_Reports",
24273 "group": "Sms_Transfer_Reports",
24274 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24275 "version": "0.0.0",
24276 "filename": "server/api/smsTransferReport/index.js",
24277 "groupTitle": "Sms_Transfer_Reports"
24281 "url": "/api/sms/reports/transfer/{id}",
24282 "title": "Gets a single Sms Transfer Report",
24285 "title": "Example usage:",
24286 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24290 "name": "ShowSms_Transfer_Reports",
24291 "group": "Sms_Transfer_Reports",
24292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24293 "version": "0.0.0",
24294 "filename": "server/api/smsTransferReport/index.js",
24295 "groupTitle": "Sms_Transfer_Reports"
24299 "url": "/api/sms/reports/transfer/{id}",
24300 "title": "Update an existing Sms Transfer Report",
24303 "title": "Example usage:",
24304 "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",
24308 "name": "updateSms_Transfer_Reports",
24309 "group": "Sms_Transfer_Reports",
24310 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24311 "version": "0.0.0",
24312 "filename": "server/api/smsTransferReport/index.js",
24313 "groupTitle": "Sms_Transfer_Reports"
24317 "url": "/api/sounds",
24318 "title": "Gets a list of Sounds",
24321 "title": "Example usage:",
24322 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24326 "name": "GetSounds",
24328 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24329 "version": "0.0.0",
24330 "filename": "server/api/sound/index.js",
24331 "groupTitle": "Sounds"
24335 "url": "/api/sounds/{id}",
24336 "title": "Gets a single Sound",
24339 "title": "Example usage:",
24340 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24344 "name": "ShowSounds",
24346 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24347 "version": "0.0.0",
24348 "filename": "server/api/sound/index.js",
24349 "groupTitle": "Sounds"
24353 "url": "/api/sounds",
24354 "title": "Create a new sound",
24357 "title": "Example usage:",
24358 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24362 "name": "addSound",
24364 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24365 "version": "0.0.0",
24366 "filename": "server/api/sound/index.js",
24367 "groupTitle": "Sounds"
24371 "url": "/api/sounds/{id}",
24372 "title": "Deletes a sound",
24375 "title": "Example usage:",
24376 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24380 "name": "destroySound",
24382 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24383 "version": "0.0.0",
24384 "filename": "server/api/sound/index.js",
24385 "groupTitle": "Sounds"
24389 "url": "/api/sounds/{id}/download",
24390 "title": "Download Sound",
24393 "title": "Example usage:",
24394 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24398 "name": "download",
24400 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24401 "version": "0.0.0",
24402 "filename": "server/api/sound/index.js",
24403 "groupTitle": "Sounds"
24407 "url": "/api/sounds",
24408 "title": "Update an existing new sound",
24411 "title": "Example usage:",
24412 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24416 "name": "updateSound",
24418 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24419 "version": "0.0.0",
24420 "filename": "server/api/sound/index.js",
24421 "groupTitle": "Sounds"
24425 "url": "/api/square/details/reports",
24426 "title": "Creates a new Square Detail Report",
24429 "title": "Example usage:",
24430 "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",
24434 "name": "CreateSquare_Detail_Reports",
24435 "group": "Square_Details_Reports",
24443 "field": "uniqueid",
24457 "field": "application",
24471 "field": "project_name",
24478 "field": "callerid",
24484 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24485 "version": "0.0.0",
24486 "filename": "server/api/squareReportDetail/index.js",
24487 "groupTitle": "Square_Details_Reports"
24491 "url": "/api/square/details/reports/{id}",
24492 "title": "Deletes a Square Detail Report",
24495 "title": "Example usage:",
24496 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24500 "name": "DeleteSquare_Detail_Reports",
24501 "group": "Square_Details_Reports",
24502 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24503 "version": "0.0.0",
24504 "filename": "server/api/squareReportDetail/index.js",
24505 "groupTitle": "Square_Details_Reports"
24509 "url": "/api/square/details/reports/describe",
24510 "title": "Gets table info about Square Detail Reports",
24513 "title": "Example usage:",
24514 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24518 "name": "DescribeSquare_Detail_Reports",
24519 "group": "Square_Details_Reports",
24520 "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>",
24521 "version": "0.0.0",
24522 "filename": "server/api/squareReportDetail/index.js",
24523 "groupTitle": "Square_Details_Reports"
24527 "url": "/api/square/details/reports",
24528 "title": "Gets a list of Square Detail Reports",
24531 "title": "Example usage:",
24532 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24536 "name": "GetSquare_Detail_Reports",
24537 "group": "Square_Details_Reports",
24538 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24539 "version": "0.0.0",
24540 "filename": "server/api/squareReportDetail/index.js",
24541 "groupTitle": "Square_Details_Reports"
24545 "url": "/api/square/details/reports/{id}",
24546 "title": "Gets a single Square Detail Report",
24549 "title": "Example usage:",
24550 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24554 "name": "ShowSquare_Detail_Reports",
24555 "group": "Square_Details_Reports",
24556 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24557 "version": "0.0.0",
24558 "filename": "server/api/squareReportDetail/index.js",
24559 "groupTitle": "Square_Details_Reports"
24563 "url": "/api/square/details/reports/{id}",
24564 "title": "Update an existing Square Detail Report",
24567 "title": "Example usage:",
24568 "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",
24572 "name": "updateSquare_Detail_Reports",
24573 "group": "Square_Details_Reports",
24574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24575 "version": "0.0.0",
24576 "filename": "server/api/squareReportDetail/index.js",
24577 "groupTitle": "Square_Details_Reports"
24581 "url": "/api/square/messages",
24582 "title": "Creates a new Message",
24585 "title": "Example usage:",
24586 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24590 "name": "CreateMessages",
24591 "group": "Square_Messages",
24599 "field": "uniqueid",
24617 "field": "direction",
24624 "field": "providerName",
24631 "field": "providerResponse",
24637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24638 "version": "0.0.0",
24639 "filename": "server/api/squareMessage/index.js",
24640 "groupTitle": "Square_Messages"
24644 "url": "/api/square/messages/{id}",
24645 "title": "Deletes a Message",
24648 "title": "Example usage:",
24649 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24653 "name": "DeleteMessages",
24654 "group": "Square_Messages",
24655 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24656 "version": "0.0.0",
24657 "filename": "server/api/squareMessage/index.js",
24658 "groupTitle": "Square_Messages"
24662 "url": "/api/square/messages",
24663 "title": "Gets a list of Messages",
24666 "title": "Example usage:",
24667 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24671 "name": "GetMessages",
24672 "group": "Square_Messages",
24673 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24674 "version": "0.0.0",
24675 "filename": "server/api/squareMessage/index.js",
24676 "groupTitle": "Square_Messages"
24680 "url": "/api/square/messages/{id}",
24681 "title": "Gets a single Message",
24684 "title": "Example usage:",
24685 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24689 "name": "ShowMessages",
24690 "group": "Square_Messages",
24691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24692 "version": "0.0.0",
24693 "filename": "server/api/squareMessage/index.js",
24694 "groupTitle": "Square_Messages"
24698 "url": "/api/square/messages/{id}",
24699 "title": "Update an existing Message",
24702 "title": "Example usage:",
24703 "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",
24707 "name": "updateMessages",
24708 "group": "Square_Messages",
24709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24710 "version": "0.0.0",
24711 "filename": "server/api/squareMessage/index.js",
24712 "groupTitle": "Square_Messages"
24716 "url": "/api/square/odbc",
24717 "title": "Creates a new ODBC",
24720 "title": "Example usage:",
24721 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24725 "name": "CreateODBCs",
24726 "group": "Square_ODBC",
24748 "field": "description",
24754 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24755 "version": "0.0.0",
24756 "filename": "server/api/squareOdbc/index.js",
24757 "groupTitle": "Square_ODBC"
24761 "url": "/api/square/odbc/{id}",
24762 "title": "Deletes a ODBC",
24765 "title": "Example usage:",
24766 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24770 "name": "DeleteODBCs",
24771 "group": "Square_ODBC",
24772 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24773 "version": "0.0.0",
24774 "filename": "server/api/squareOdbc/index.js",
24775 "groupTitle": "Square_ODBC"
24779 "url": "/api/square/odbc",
24780 "title": "Gets a list of ODBCs",
24783 "title": "Example usage:",
24784 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24788 "name": "GetODBCs",
24789 "group": "Square_ODBC",
24790 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24791 "version": "0.0.0",
24792 "filename": "server/api/squareOdbc/index.js",
24793 "groupTitle": "Square_ODBC"
24797 "url": "/api/square/odbc/{id}",
24798 "title": "Gets a single ODBC",
24801 "title": "Example usage:",
24802 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24806 "name": "ShowODBCs",
24807 "group": "Square_ODBC",
24808 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24809 "version": "0.0.0",
24810 "filename": "server/api/squareOdbc/index.js",
24811 "groupTitle": "Square_ODBC"
24815 "url": "/api/square/odbc/{id}/test",
24816 "title": "Test Odbc",
24819 "title": "Example usage:",
24820 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24825 "group": "Square_ODBC",
24826 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24827 "version": "0.0.0",
24828 "filename": "server/api/squareOdbc/index.js",
24829 "groupTitle": "Square_ODBC"
24833 "url": "/api/square/odbc/{id}",
24834 "title": "Update an existing ODBC",
24837 "title": "Example usage:",
24838 "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",
24842 "name": "updateODBCs",
24843 "group": "Square_ODBC",
24844 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24845 "version": "0.0.0",
24846 "filename": "server/api/squareOdbc/index.js",
24847 "groupTitle": "Square_ODBC"
24851 "url": "/api/square/projects",
24852 "title": "Creates a new Project",
24855 "title": "Example usage:",
24856 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24860 "name": "CreateProjects",
24861 "group": "Square_Projects",
24876 "field": "description",
24890 "field": "preproduction",
24897 "field": "production",
24904 "field": "savedAt",
24911 "field": "publishedAt",
24917 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24918 "version": "0.0.0",
24919 "filename": "server/api/squareProject/index.js",
24920 "groupTitle": "Square_Projects"
24924 "url": "/api/square/projects/{id}",
24925 "title": "Deletes a Project",
24928 "title": "Example usage:",
24929 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24933 "name": "DeleteProjects",
24934 "group": "Square_Projects",
24935 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24936 "version": "0.0.0",
24937 "filename": "server/api/squareProject/index.js",
24938 "groupTitle": "Square_Projects"
24942 "url": "/api/square/projects",
24943 "title": "Gets a list of Projects",
24946 "title": "Example usage:",
24947 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24951 "name": "GetProjects",
24952 "group": "Square_Projects",
24953 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24954 "version": "0.0.0",
24955 "filename": "server/api/squareProject/index.js",
24956 "groupTitle": "Square_Projects"
24960 "url": "/api/square/projects/{id}",
24961 "title": "Gets a single Project",
24964 "title": "Example usage:",
24965 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24969 "name": "ShowProjects",
24970 "group": "Square_Projects",
24971 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24972 "version": "0.0.0",
24973 "filename": "server/api/squareProject/index.js",
24974 "groupTitle": "Square_Projects"
24978 "url": "/api/square/projects/{id}/users",
24979 "title": "Adds user permissions to a Project",
24982 "title": "Example usage:",
24983 "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",
24987 "name": "addUsers",
24988 "group": "Square_Projects",
24989 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24990 "version": "0.0.0",
24991 "filename": "server/api/squareProject/index.js",
24992 "groupTitle": "Square_Projects"
24996 "url": "/api/square/projects/{id}/users",
24997 "title": "Gets users permissions from Project",
25000 "title": "Example usage:",
25001 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
25005 "name": "getUsers",
25006 "group": "Square_Projects",
25007 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25008 "version": "0.0.0",
25009 "filename": "server/api/squareProject/index.js",
25010 "groupTitle": "Square_Projects"
25014 "url": "/api/square/projects/{id}/users",
25015 "title": "Removes user permissions from a Project",
25018 "title": "Example usage:",
25019 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25023 "name": "removeUsers",
25024 "group": "Square_Projects",
25025 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25026 "version": "0.0.0",
25027 "filename": "server/api/squareProject/index.js",
25028 "groupTitle": "Square_Projects"
25032 "url": "/api/square/projects/{id}",
25033 "title": "Update an existing Project",
25036 "title": "Example usage:",
25037 "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",
25041 "name": "updateProjects",
25042 "group": "Square_Projects",
25043 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25044 "version": "0.0.0",
25045 "filename": "server/api/squareProject/index.js",
25046 "groupTitle": "Square_Projects"
25050 "url": "/api/square/recordings",
25051 "title": "Creates a new Recording",
25054 "title": "Example usage:",
25055 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25059 "name": "CreateRecordings",
25060 "group": "Square_Recordings",
25068 "field": "uniqueid",
25075 "field": "callerid",
25082 "field": "calleridname",
25089 "field": "context",
25096 "field": "extension",
25103 "field": "priority",
25110 "field": "accountcode",
25124 "field": "projectName",
25131 "field": "saveName",
25138 "field": "filename",
25145 "field": "savePath",
25158 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25159 "version": "0.0.0",
25160 "filename": "server/api/squareRecording/index.js",
25161 "groupTitle": "Square_Recordings"
25165 "url": "/api/square/recordings",
25166 "title": "Gets a list of Recordings",
25169 "title": "Example usage:",
25170 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25174 "name": "GetRecordings",
25175 "group": "Square_Recordings",
25176 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25177 "version": "0.0.0",
25178 "filename": "server/api/squareRecording/index.js",
25179 "groupTitle": "Square_Recordings"
25183 "url": "/api/square/recordings/{id}",
25184 "title": "Gets a single Recording",
25187 "title": "Example usage:",
25188 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25192 "name": "ShowRecordings",
25193 "group": "Square_Recordings",
25194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25195 "version": "0.0.0",
25196 "filename": "server/api/squareRecording/index.js",
25197 "groupTitle": "Square_Recordings"
25201 "url": "/api/square/recordings/{id}",
25202 "title": "Delete recording",
25205 "title": "Example usage:",
25206 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25211 "group": "Square_Recordings",
25212 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25213 "version": "0.0.0",
25214 "filename": "server/api/squareRecording/index.js",
25215 "groupTitle": "Square_Recordings"
25219 "url": "/api/square/recordings/{id}/download",
25220 "title": "Download Recording",
25223 "title": "Example usage:",
25224 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25228 "name": "download",
25229 "group": "Square_Recordings",
25230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25231 "version": "0.0.0",
25232 "filename": "server/api/squareRecording/index.js",
25233 "groupTitle": "Square_Recordings"
25237 "url": "/api/square/recordings/{id}",
25238 "title": "Update an existing Recording",
25241 "title": "Example usage:",
25242 "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",
25246 "name": "updateRecordings",
25247 "group": "Square_Recordings",
25248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25249 "version": "0.0.0",
25250 "filename": "server/api/squareRecording/index.js",
25251 "groupTitle": "Square_Recordings"
25255 "url": "/api/square/reports",
25256 "title": "Creates a new Square Report",
25259 "title": "Example usage:",
25260 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25264 "name": "CreateSquare_Reports",
25265 "group": "Square_Reports",
25273 "field": "network",
25280 "field": "network_script",
25287 "field": "request",
25294 "field": "channel",
25301 "field": "language",
25315 "field": "uniqueid",
25322 "field": "version",
25329 "field": "callerid",
25336 "field": "calleridname",
25343 "field": "callingpres",
25350 "field": "callingani2",
25357 "field": "callington",
25364 "field": "callingtns",
25385 "field": "context",
25392 "field": "extension",
25399 "field": "priority",
25406 "field": "enhanced",
25413 "field": "accountcode",
25420 "field": "threadid",
25427 "field": "project_name",
25441 "field": "leaveAt",
25454 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25455 "version": "0.0.0",
25456 "filename": "server/api/squareReport/index.js",
25457 "groupTitle": "Square_Reports"
25461 "url": "/api/square/reports/{id}",
25462 "title": "Deletes a Square Report",
25465 "title": "Example usage:",
25466 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25470 "name": "DeleteSquare_Reports",
25471 "group": "Square_Reports",
25472 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25473 "version": "0.0.0",
25474 "filename": "server/api/squareReport/index.js",
25475 "groupTitle": "Square_Reports"
25479 "url": "/api/square/reports/describe",
25480 "title": "Gets table info about Square Reports",
25483 "title": "Example usage:",
25484 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25488 "name": "DescribeSquare_Reports",
25489 "group": "Square_Reports",
25490 "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>",
25491 "version": "0.0.0",
25492 "filename": "server/api/squareReport/index.js",
25493 "groupTitle": "Square_Reports"
25497 "url": "/api/square/reports",
25498 "title": "Gets a list of Square Reports",
25501 "title": "Example usage:",
25502 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25506 "name": "GetSquare_Reports",
25507 "group": "Square_Reports",
25508 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25509 "version": "0.0.0",
25510 "filename": "server/api/squareReport/index.js",
25511 "groupTitle": "Square_Reports"
25515 "url": "/api/square/reports/{id}",
25516 "title": "Gets a single Square Report",
25519 "title": "Example usage:",
25520 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25524 "name": "ShowSquare_Reports",
25525 "group": "Square_Reports",
25526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25527 "version": "0.0.0",
25528 "filename": "server/api/squareReport/index.js",
25529 "groupTitle": "Square_Reports"
25533 "url": "/api/square/reports/{id}",
25534 "title": "Update an existing Square Report",
25537 "title": "Example usage:",
25538 "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",
25542 "name": "updateSquare_Reports",
25543 "group": "Square_Reports",
25544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25545 "version": "0.0.0",
25546 "filename": "server/api/squareReport/index.js",
25547 "groupTitle": "Square_Reports"
25551 "url": "/api/integrations/sugarcrm/configurations",
25552 "title": "Creates a new SugarCRM Configuration",
25555 "title": "Example usage:",
25556 "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",
25560 "name": "CreateSugarCRM_Configurations",
25561 "group": "SugarCRM_Configurations",
25576 "field": "description",
25582 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25583 "version": "0.0.0",
25584 "filename": "server/api/intSugarcrmConfiguration/index.js",
25585 "groupTitle": "SugarCRM_Configurations"
25589 "url": "/api/integrations/sugarcrm/configurations/{id}",
25590 "title": "Deletes a SugarCRM Configuration",
25593 "title": "Example usage:",
25594 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25598 "name": "DeleteSugarCRM_Configurations",
25599 "group": "SugarCRM_Configurations",
25600 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25601 "version": "0.0.0",
25602 "filename": "server/api/intSugarcrmConfiguration/index.js",
25603 "groupTitle": "SugarCRM_Configurations"
25607 "url": "/api/integrations/sugarcrm/configurations",
25608 "title": "Gets a list of SugarCRM Configurations",
25611 "title": "Example usage:",
25612 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25616 "name": "GetSugarCRM_Configurations",
25617 "group": "SugarCRM_Configurations",
25618 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25619 "version": "0.0.0",
25620 "filename": "server/api/intSugarcrmConfiguration/index.js",
25621 "groupTitle": "SugarCRM_Configurations"
25625 "url": "/api/integrations/sugarcrm/configurations/{id}",
25626 "title": "Gets a single SugarCRM Configuration",
25629 "title": "Example usage:",
25630 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25634 "name": "ShowSugarCRM_Configurations",
25635 "group": "SugarCRM_Configurations",
25636 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25637 "version": "0.0.0",
25638 "filename": "server/api/intSugarcrmConfiguration/index.js",
25639 "groupTitle": "SugarCRM_Configurations"
25643 "url": "/api/integrations/sugarcrm/configurations/{id}",
25644 "title": "Update an existing SugarCRM Configuration",
25647 "title": "Example usage:",
25648 "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",
25652 "name": "updateSugarCRM_Configurations",
25653 "group": "SugarCRM_Configurations",
25654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25655 "version": "0.0.0",
25656 "filename": "server/api/intSugarcrmConfiguration/index.js",
25657 "groupTitle": "SugarCRM_Configurations"
25661 "url": "/api/integrations/sugarcrm/accounts",
25662 "title": "Creates a new Sugarcrm Account",
25665 "title": "Example usage:",
25666 "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",
25670 "name": "CreateSugarcrm_Accounts",
25671 "group": "Sugarcrm_Accounts",
25686 "field": "description",
25693 "field": "username",
25700 "field": "password",
25707 "field": "remoteUri",
25714 "field": "serverUrl",
25720 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25721 "version": "0.0.0",
25722 "filename": "server/api/intSugarcrmAccount/index.js",
25723 "groupTitle": "Sugarcrm_Accounts"
25727 "url": "/api/integrations/sugarcrm/accounts/{id}",
25728 "title": "Deletes a Sugarcrm Account",
25731 "title": "Example usage:",
25732 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25736 "name": "DeleteSugarcrm_Accounts",
25737 "group": "Sugarcrm_Accounts",
25738 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25739 "version": "0.0.0",
25740 "filename": "server/api/intSugarcrmAccount/index.js",
25741 "groupTitle": "Sugarcrm_Accounts"
25745 "url": "/api/integrations/sugarcrm/accounts",
25746 "title": "Gets a list of Sugarcrm Accounts",
25749 "title": "Example usage:",
25750 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25754 "name": "GetSugarcrm_Accounts",
25755 "group": "Sugarcrm_Accounts",
25756 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25757 "version": "0.0.0",
25758 "filename": "server/api/intSugarcrmAccount/index.js",
25759 "groupTitle": "Sugarcrm_Accounts"
25763 "url": "/api/integrations/sugarcrm/accounts/{id}",
25764 "title": "Gets a single Sugarcrm Account",
25767 "title": "Example usage:",
25768 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25772 "name": "ShowSugarcrm_Accounts",
25773 "group": "Sugarcrm_Accounts",
25774 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25775 "version": "0.0.0",
25776 "filename": "server/api/intSugarcrmAccount/index.js",
25777 "groupTitle": "Sugarcrm_Accounts"
25781 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25782 "title": "Creates new configuration",
25785 "title": "Example usage:",
25786 "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",
25790 "name": "addConfiguration",
25791 "group": "Sugarcrm_Accounts",
25792 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25793 "version": "0.0.0",
25794 "filename": "server/api/intSugarcrmAccount/index.js",
25795 "groupTitle": "Sugarcrm_Accounts"
25799 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25800 "title": "Gets account configurations",
25803 "title": "Example usage:",
25804 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25808 "name": "getConfigurations",
25809 "group": "Sugarcrm_Accounts",
25810 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25811 "version": "0.0.0",
25812 "filename": "server/api/intSugarcrmAccount/index.js",
25813 "groupTitle": "Sugarcrm_Accounts"
25817 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25818 "title": "Gets account fields",
25821 "title": "Example usage:",
25822 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25826 "name": "getFields",
25827 "group": "Sugarcrm_Accounts",
25828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25829 "version": "0.0.0",
25830 "filename": "server/api/intSugarcrmAccount/index.js",
25831 "groupTitle": "Sugarcrm_Accounts"
25835 "url": "/api/integrations/sugarcrm/accounts/{id}",
25836 "title": "Update an existing Sugarcrm Account",
25839 "title": "Example usage:",
25840 "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",
25844 "name": "updateSugarcrm_Accounts",
25845 "group": "Sugarcrm_Accounts",
25846 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25847 "version": "0.0.0",
25848 "filename": "server/api/intSugarcrmAccount/index.js",
25849 "groupTitle": "Sugarcrm_Accounts"
25853 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25854 "title": "Gets configurations descriptions",
25857 "title": "Example usage:",
25858 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25862 "name": "getDescriptions",
25863 "group": "Sugarcrm_Configurations",
25864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25865 "version": "0.0.0",
25866 "filename": "server/api/intSugarcrmConfiguration/index.js",
25867 "groupTitle": "Sugarcrm_Configurations"
25871 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25872 "title": "Gets configurations fields",
25875 "title": "Example usage:",
25876 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25880 "name": "getFields",
25881 "group": "Sugarcrm_Configurations",
25882 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25883 "version": "0.0.0",
25884 "filename": "server/api/intSugarcrmConfiguration/index.js",
25885 "groupTitle": "Sugarcrm_Configurations"
25889 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25890 "title": "Gets configurations subjects",
25893 "title": "Example usage:",
25894 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25898 "name": "getSubjects",
25899 "group": "Sugarcrm_Configurations",
25900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25901 "version": "0.0.0",
25902 "filename": "server/api/intSugarcrmConfiguration/index.js",
25903 "groupTitle": "Sugarcrm_Configurations"
25907 "url": "/api/integrations/sugarcrm/fields",
25908 "title": "Creates a new Sugarcrm Field",
25911 "title": "Example usage:",
25912 "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",
25916 "name": "CreateSugarcrm_Fields",
25917 "group": "Sugarcrm_Fields",
25927 "\"customVariable\"",
25939 "field": "content",
25955 "\"customVariable\""
25958 "field": "keyType",
25965 "field": "keyContent",
25972 "field": "idField",
25979 "field": "nameField",
25986 "field": "customField",
25993 "field": "variableName",
25999 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26000 "version": "0.0.0",
26001 "filename": "server/api/intSugarcrmField/index.js",
26002 "groupTitle": "Sugarcrm_Fields"
26006 "url": "/api/integrations/sugarcrm/fields/{id}",
26007 "title": "Deletes a Sugarcrm Field",
26010 "title": "Example usage:",
26011 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
26015 "name": "DeleteSugarcrm_Fields",
26016 "group": "Sugarcrm_Fields",
26017 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26018 "version": "0.0.0",
26019 "filename": "server/api/intSugarcrmField/index.js",
26020 "groupTitle": "Sugarcrm_Fields"
26024 "url": "/api/integrations/sugarcrm/fields",
26025 "title": "Gets a list of Sugarcrm Fields",
26028 "title": "Example usage:",
26029 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
26033 "name": "GetSugarcrm_Fields",
26034 "group": "Sugarcrm_Fields",
26035 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26036 "version": "0.0.0",
26037 "filename": "server/api/intSugarcrmField/index.js",
26038 "groupTitle": "Sugarcrm_Fields"
26042 "url": "/api/integrations/sugarcrm/fields/{id}",
26043 "title": "Gets a single Sugarcrm Field",
26046 "title": "Example usage:",
26047 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26051 "name": "ShowSugarcrm_Fields",
26052 "group": "Sugarcrm_Fields",
26053 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26054 "version": "0.0.0",
26055 "filename": "server/api/intSugarcrmField/index.js",
26056 "groupTitle": "Sugarcrm_Fields"
26060 "url": "/api/integrations/sugarcrm/fields/{id}",
26061 "title": "Update an existing Sugarcrm Field",
26064 "title": "Example usage:",
26065 "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",
26069 "name": "updateSugarcrm_Fields",
26070 "group": "Sugarcrm_Fields",
26071 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26072 "version": "0.0.0",
26073 "filename": "server/api/intSugarcrmField/index.js",
26074 "groupTitle": "Sugarcrm_Fields"
26078 "url": "/api/system",
26079 "title": "Gets system information",
26082 "title": "Example usage:",
26083 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26087 "name": "GetSystemInformation",
26088 "group": "System_Information",
26089 "description": "<p>Motion returns the system information.</p>",
26090 "version": "0.0.0",
26091 "filename": "server/api/system/index.js",
26092 "groupTitle": "System_Information"
26096 "url": "/api/system/process",
26097 "title": "Gets system information",
26100 "title": "Example usage:",
26101 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26105 "name": "GetSystemInformation",
26106 "group": "System_Information",
26107 "description": "<p>Motion returns the system information.</p>",
26108 "version": "0.0.0",
26109 "filename": "server/api/system/index.js",
26110 "groupTitle": "System_Information"
26114 "url": "/api/tags",
26115 "title": "Creates a new Tag",
26118 "title": "Example usage:",
26119 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26123 "name": "CreateTags",
26146 "field": "description",
26152 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26153 "version": "0.0.0",
26154 "filename": "server/api/tag/index.js",
26155 "groupTitle": "Tags"
26159 "url": "/api/tags/{id}",
26160 "title": "Deletes a Tag",
26163 "title": "Example usage:",
26164 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26168 "name": "DeleteTags",
26170 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26171 "version": "0.0.0",
26172 "filename": "server/api/tag/index.js",
26173 "groupTitle": "Tags"
26177 "url": "/api/tags",
26178 "title": "Gets a list of Tags",
26181 "title": "Example usage:",
26182 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26188 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26189 "version": "0.0.0",
26190 "filename": "server/api/tag/index.js",
26191 "groupTitle": "Tags"
26195 "url": "/api/tags/{id}",
26196 "title": "Gets a single Tag",
26199 "title": "Example usage:",
26200 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26204 "name": "ShowTags",
26206 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26207 "version": "0.0.0",
26208 "filename": "server/api/tag/index.js",
26209 "groupTitle": "Tags"
26213 "url": "/api/tags/{id}",
26214 "title": "Update an existing Tag",
26217 "title": "Example usage:",
26218 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26222 "name": "updateTags",
26224 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26225 "version": "0.0.0",
26226 "filename": "server/api/tag/index.js",
26227 "groupTitle": "Tags"
26231 "url": "/api/teams/{id}/queues",
26232 "title": "Add queues to a team",
26235 "title": "Example usage:",
26236 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26240 "name": "AddQueues",
26242 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26243 "version": "0.0.0",
26244 "filename": "server/api/team/index.js",
26245 "groupTitle": "Teams"
26249 "url": "/api/teams",
26250 "title": "Creates a new Team",
26253 "title": "Example usage:",
26254 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26258 "name": "CreateTeams",
26274 "field": "description",
26280 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26281 "version": "0.0.0",
26282 "filename": "server/api/team/index.js",
26283 "groupTitle": "Teams"
26287 "url": "/api/teams/{id}",
26288 "title": "Deletes a Team",
26291 "title": "Example usage:",
26292 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26296 "name": "DeleteTeams",
26298 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26299 "version": "0.0.0",
26300 "filename": "server/api/team/index.js",
26301 "groupTitle": "Teams"
26305 "url": "/api/teams/{id}/users",
26306 "title": "Gets agents from team",
26309 "title": "Example usage:",
26310 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26314 "name": "GetAgents",
26316 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26317 "version": "0.0.0",
26318 "filename": "server/api/team/index.js",
26319 "groupTitle": "Teams"
26323 "url": "/api/teams/{id}/queues?channel={channel}",
26324 "title": "Gets Queues list",
26327 "title": "Example usage:",
26328 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26332 "name": "GetQueues",
26334 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26335 "version": "0.0.0",
26336 "filename": "server/api/team/index.js",
26337 "groupTitle": "Teams"
26341 "url": "/api/teams",
26342 "title": "Gets a list of Teams",
26345 "title": "Example usage:",
26346 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26350 "name": "GetTeams",
26352 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26353 "version": "0.0.0",
26354 "filename": "server/api/team/index.js",
26355 "groupTitle": "Teams"
26359 "url": "/api/teams/{id}/users",
26360 "title": "Removes agents from a team",
26363 "title": "Example usage:",
26364 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26368 "name": "RemoveAgents",
26370 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26371 "version": "0.0.0",
26372 "filename": "server/api/team/index.js",
26373 "groupTitle": "Teams"
26377 "url": "/api/teams/{id}/queues",
26378 "title": "Remove queues to a team",
26381 "title": "Example usage:",
26382 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26386 "name": "RemoveQueues",
26388 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26389 "version": "0.0.0",
26390 "filename": "server/api/team/index.js",
26391 "groupTitle": "Teams"
26395 "url": "/api/openchannel/queues/{id}/teams",
26396 "title": "Remove teams from a queue",
26399 "title": "Example usage:",
26400 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26404 "name": "RemoveTeams",
26406 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26407 "version": "0.0.0",
26408 "filename": "server/api/openchannelQueue/index.js",
26409 "groupTitle": "Teams"
26413 "url": "/api/voice/queues/{id}/teams",
26414 "title": "Remove teams from a queue",
26417 "title": "Example usage:",
26418 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26422 "name": "RemoveTeams",
26424 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26425 "version": "0.0.0",
26426 "filename": "server/api/voiceQueue/index.js",
26427 "groupTitle": "Teams"
26431 "url": "/api/voice/Prefixes/{id}/teams",
26432 "title": "Remove teams from a voice prefix",
26435 "title": "Example usage:",
26436 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26440 "name": "RemoveTeams",
26442 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26443 "version": "0.0.0",
26444 "filename": "server/api/voicePrefix/index.js",
26445 "groupTitle": "Teams"
26449 "url": "/api/sms/queues/{id}/teams",
26450 "title": "Remove teams from a queue",
26453 "title": "Example usage:",
26454 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26458 "name": "RemoveTeams",
26460 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26461 "version": "0.0.0",
26462 "filename": "server/api/smsQueue/index.js",
26463 "groupTitle": "Teams"
26467 "url": "/api/whatsapp/queues/{id}/teams",
26468 "title": "Remove teams from a queue",
26471 "title": "Example usage:",
26472 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26476 "name": "RemoveTeams",
26478 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26479 "version": "0.0.0",
26480 "filename": "server/api/whatsappQueue/index.js",
26481 "groupTitle": "Teams"
26485 "url": "/api/chat/queues/{id}/teams",
26486 "title": "Remove teams from a queue",
26489 "title": "Example usage:",
26490 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26494 "name": "RemoveTeams",
26496 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26497 "version": "0.0.0",
26498 "filename": "server/api/chatQueue/index.js",
26499 "groupTitle": "Teams"
26503 "url": "/api/mail/queues/{id}/teams",
26504 "title": "Remove teams from a queue",
26507 "title": "Example usage:",
26508 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26512 "name": "RemoveTeams",
26514 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26515 "version": "0.0.0",
26516 "filename": "server/api/mailQueue/index.js",
26517 "groupTitle": "Teams"
26521 "url": "/api/fax/queues/{id}/teams",
26522 "title": "Remove teams from a queue",
26525 "title": "Example usage:",
26526 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26530 "name": "RemoveTeams",
26532 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26533 "version": "0.0.0",
26534 "filename": "server/api/faxQueue/index.js",
26535 "groupTitle": "Teams"
26539 "url": "/api/teams/{id}",
26540 "title": "Gets a single Team",
26543 "title": "Example usage:",
26544 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26548 "name": "ShowTeams",
26550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26551 "version": "0.0.0",
26552 "filename": "server/api/team/index.js",
26553 "groupTitle": "Teams"
26557 "url": "/api/teams/{id}/users",
26558 "title": "Adds agents to a team",
26561 "title": "Example usage:",
26562 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26566 "name": "addAgents",
26568 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26569 "version": "0.0.0",
26570 "filename": "server/api/team/index.js",
26571 "groupTitle": "Teams"
26575 "url": "/api/teams/{id}",
26576 "title": "Update an existing Team",
26579 "title": "Example usage:",
26580 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26584 "name": "updateTeams",
26586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26587 "version": "0.0.0",
26588 "filename": "server/api/team/index.js",
26589 "groupTitle": "Teams"
26593 "url": "/api/templates",
26594 "title": "Creates a new Template",
26597 "title": "Example usage:",
26598 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26602 "name": "CreateTemplates",
26603 "group": "Templates",
26618 "field": "description",
26631 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26632 "version": "0.0.0",
26633 "filename": "server/api/template/index.js",
26634 "groupTitle": "Templates"
26638 "url": "/api/templates/{id}",
26639 "title": "Deletes a Template",
26642 "title": "Example usage:",
26643 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26647 "name": "DeleteTemplates",
26648 "group": "Templates",
26649 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26650 "version": "0.0.0",
26651 "filename": "server/api/template/index.js",
26652 "groupTitle": "Templates"
26656 "url": "/api/templates",
26657 "title": "Gets a list of Templates",
26660 "title": "Example usage:",
26661 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26665 "name": "GetTemplates",
26666 "group": "Templates",
26667 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26668 "version": "0.0.0",
26669 "filename": "server/api/template/index.js",
26670 "groupTitle": "Templates"
26674 "url": "/api/templates/{id}",
26675 "title": "Gets a single Template",
26678 "title": "Example usage:",
26679 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26683 "name": "ShowTemplates",
26684 "group": "Templates",
26685 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26686 "version": "0.0.0",
26687 "filename": "server/api/template/index.js",
26688 "groupTitle": "Templates"
26692 "url": "/api/templates/{id}",
26693 "title": "Update an existing Template",
26696 "title": "Example usage:",
26697 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26701 "name": "updateTemplates",
26702 "group": "Templates",
26703 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26704 "version": "0.0.0",
26705 "filename": "server/api/template/index.js",
26706 "groupTitle": "Templates"
26710 "url": "/api/triggers",
26711 "title": "Creates a new Trigger",
26714 "title": "Example usage:",
26715 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26719 "name": "CreateTriggers",
26720 "group": "Triggers",
26735 "field": "channel",
26742 "field": "description",
26755 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26756 "version": "0.0.0",
26757 "filename": "server/api/trigger/index.js",
26758 "groupTitle": "Triggers"
26762 "url": "/api/triggers/{id}",
26763 "title": "Deletes a Trigger",
26766 "title": "Example usage:",
26767 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26771 "name": "DeleteTriggers",
26772 "group": "Triggers",
26773 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26774 "version": "0.0.0",
26775 "filename": "server/api/trigger/index.js",
26776 "groupTitle": "Triggers"
26780 "url": "/api/triggers",
26781 "title": "Gets a list of Triggers",
26784 "title": "Example usage:",
26785 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26789 "name": "GetTriggers",
26790 "group": "Triggers",
26791 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26792 "version": "0.0.0",
26793 "filename": "server/api/trigger/index.js",
26794 "groupTitle": "Triggers"
26798 "url": "/api/triggers/{id}",
26799 "title": "Gets a single Trigger",
26802 "title": "Example usage:",
26803 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26807 "name": "ShowTriggers",
26808 "group": "Triggers",
26809 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26810 "version": "0.0.0",
26811 "filename": "server/api/trigger/index.js",
26812 "groupTitle": "Triggers"
26816 "url": "/api/triggers/{id}/actions",
26817 "title": "Creates new actions",
26820 "title": "Example usage:",
26821 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26825 "name": "addAction",
26826 "group": "Triggers",
26842 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26849 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26856 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26863 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26896 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26897 "version": "0.0.0",
26898 "filename": "server/api/trigger/index.js",
26899 "groupTitle": "Triggers"
26903 "url": "/api/triggers/{id}/all_conditions",
26904 "title": "Creates a new \"AND\"condition",
26907 "title": "Example usage:",
26908 "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",
26912 "name": "addAllCondition",
26913 "group": "Triggers",
26935 "field": "operator",
26948 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26949 "version": "0.0.0",
26950 "filename": "server/api/trigger/index.js",
26951 "groupTitle": "Triggers"
26955 "url": "/api/triggers/{id}/any_conditions",
26956 "title": "Creates a new \"OR\"condition",
26959 "title": "Example usage:",
26960 "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",
26964 "name": "addAnyCondition",
26965 "group": "Triggers",
26987 "field": "operator",
27000 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27001 "version": "0.0.0",
27002 "filename": "server/api/trigger/index.js",
27003 "groupTitle": "Triggers"
27007 "url": "/api/triggers/{id}/actions",
27008 "title": "Gets Trigger Actions",
27011 "title": "Example usage:",
27012 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
27016 "name": "getActions",
27017 "group": "Triggers",
27018 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27019 "version": "0.0.0",
27020 "filename": "server/api/trigger/index.js",
27021 "groupTitle": "Triggers"
27025 "url": "/api/triggers/{id}/all_conditions",
27026 "title": "Gets \"AND\" Trigger Conditions",
27029 "title": "Example usage:",
27030 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
27034 "name": "getAllConditions",
27035 "group": "Triggers",
27036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27037 "version": "0.0.0",
27038 "filename": "server/api/trigger/index.js",
27039 "groupTitle": "Triggers"
27043 "url": "/api/triggers/{id}/any_conditions",
27044 "title": "Gets \"OR\" Trigger Conditions",
27047 "title": "Example usage:",
27048 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27052 "name": "getAnyConditions",
27053 "group": "Triggers",
27054 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27055 "version": "0.0.0",
27056 "filename": "server/api/trigger/index.js",
27057 "groupTitle": "Triggers"
27061 "url": "/api/triggers/{id}",
27062 "title": "Update an existing Trigger",
27065 "title": "Example usage:",
27066 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27070 "name": "updateTriggers",
27071 "group": "Triggers",
27072 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27073 "version": "0.0.0",
27074 "filename": "server/api/trigger/index.js",
27075 "groupTitle": "Triggers"
27079 "url": "/api/trunks/clone",
27080 "title": "Clone an existing Trunk",
27083 "title": "Example usage:",
27084 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27088 "name": "CloneTrunks",
27090 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27091 "version": "0.0.0",
27092 "filename": "server/api/trunk/index.js",
27093 "groupTitle": "Trunks"
27097 "url": "/api/trunks",
27098 "title": "Create a new trunk",
27101 "title": "Example usage:",
27102 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27134 "field": "context",
27141 "\"ALLOWED_NOT_SCREENED\"",
27142 "\"ALLOWED_PASSED_SCREEN\"",
27143 "\"ALLOWED_FAILED_SCREEN\"",
27145 "\"PROHIB_NOT_SCREENED\"",
27146 "\"PROHIB_PASSED_SCREEN\"",
27147 "\"PROHIB_FAILED_SCREEN\"",
27151 "field": "callingpres",
27179 "field": "md5secret",
27186 "field": "remotesecret",
27193 "field": "transport",
27194 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
27207 "field": "dtmfmode",
27221 "field": "directmedia",
27232 "field": "directrtpsetup",
27239 "field": "directmediapermit",
27246 "field": "directmediadeny",
27254 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
27260 "field": "callgroup",
27267 "field": "namedcallgroup",
27274 "field": "pickupgroup",
27281 "field": "namedpickupgroup",
27288 "field": "language",
27295 "field": "tonezone",
27302 "field": "disallow",
27310 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
27320 "field": "autoframing",
27327 "field": "insecure",
27328 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27338 "field": "trustrpid",
27349 "field": "trust_id_outbound",
27361 "field": "progressinband",
27372 "field": "promiscredir",
27383 "field": "useclientcode",
27390 "field": "accountcode",
27404 "field": "callerid",
27411 "field": "amaflags",
27422 "field": "callcounter",
27429 "field": "busylevel",
27440 "field": "allowoverlap",
27451 "field": "allowsubscribe",
27462 "field": "allowtransfer",
27473 "field": "ignoresdpversion",
27480 "field": "subscribecontext",
27487 "field": "template",
27499 "field": "videosupport",
27506 "field": "maxcallbitrate",
27517 "field": "rfc2833compensate",
27524 "field": "mailbox",
27536 "field": "session_timers",
27543 "field": "session_expires",
27550 "field": "session_minse",
27561 "field": "session_refresher",
27568 "field": "t38pt_usertpsource",
27575 "field": "regexten",
27582 "field": "fromdomain",
27589 "field": "fromuser",
27607 "field": "qualify",
27614 "field": "keepalive",
27621 "field": "defaultip",
27628 "field": "defaultuser",
27635 "field": "rtptimeout",
27642 "field": "rtpholdtimeout",
27649 "field": "rtpkeepalive",
27661 "field": "sendrpid",
27668 "field": "outboundproxy",
27675 "field": "callbackextension",
27682 "field": "timert1",
27696 "field": "qualifyfreq",
27703 "field": "contactpermit",
27710 "field": "contactdeny",
27717 "field": "contactacl",
27724 "field": "unsolicited_mailbox",
27731 "field": "use_q850_reason",
27738 "field": "maxforwards",
27749 "field": "encryption",
27771 "field": "force_avp",
27782 "field": "icesupport",
27793 "field": "dtlsenable",
27806 "field": "dtlsverify",
27813 "field": "dtlsrekey",
27820 "field": "dtlscertfile",
27827 "field": "dtlsprivatekey",
27834 "field": "dtlscipher",
27841 "field": "dtlscafile",
27848 "field": "dtlscapath",
27860 "field": "dtlssetup",
27867 "field": "dtlsfingerprint",
27878 "field": "usereqphone",
27885 "field": "recordonfeature",
27892 "field": "recordofffeature",
27899 "field": "call_limit",
27910 "field": "registertrying",
27921 "field": "subscribemwi",
27928 "field": "vmexten",
27935 "field": "mohinterpret",
27942 "field": "mohsuggest",
27949 "field": "parkinglot",
27956 "field": "description",
27977 "field": "canreinvite",
27984 "field": "registry",
27991 "field": "otherFields",
28005 "field": "t38pt_udptl",
28011 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28012 "version": "0.0.0",
28013 "filename": "server/api/trunk/index.js",
28014 "groupTitle": "Trunks"
28018 "url": "/api/trunks/{id}",
28019 "title": "Deletes a trunk",
28022 "title": "Example usage:",
28023 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
28029 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28030 "version": "0.0.0",
28031 "filename": "server/api/trunk/index.js",
28032 "groupTitle": "Trunks"
28036 "url": "/api/trunks",
28037 "title": "Gets a list of Trunks",
28040 "title": "Example usage:",
28041 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28045 "name": "GetTrunks",
28047 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28048 "version": "0.0.0",
28049 "filename": "server/api/trunk/index.js",
28050 "groupTitle": "Trunks"
28054 "url": "/api/trunks/{id}",
28055 "title": "Gets a single Trunk",
28058 "title": "Example usage:",
28059 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28063 "name": "ShowTrunks",
28065 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28066 "version": "0.0.0",
28067 "filename": "server/api/trunk/index.js",
28068 "groupTitle": "Trunks"
28072 "url": "/api/trunks/{id}",
28073 "title": "Update an existing trunk",
28076 "title": "Example usage:",
28077 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28083 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28084 "version": "0.0.0",
28085 "filename": "server/api/trunk/index.js",
28086 "groupTitle": "Trunks"
28090 "url": "/api/userNotifications",
28091 "title": "Send notification to user",
28094 "title": "Example usage:",
28095 "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28100 "group": "UserNotifications",
28101 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28102 "version": "0.0.0",
28103 "filename": "server/api/userNotification/index.js",
28104 "groupTitle": "UserNotifications"
28108 "url": "/api/userProfile/resources",
28109 "title": "Creates a new User Profile Resource",
28112 "title": "Example usage:",
28113 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28117 "name": "CreateUser_Profile_Resources",
28118 "group": "User_Profile_Resources",
28133 "field": "resourceId",
28146 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28147 "version": "0.0.0",
28148 "filename": "server/api/userProfileResource/index.js",
28149 "groupTitle": "User_Profile_Resources"
28153 "url": "/api/userProfile/resources/{id}",
28154 "title": "Deletes a User Profile Resource",
28157 "title": "Example usage:",
28158 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28162 "name": "DeleteUser_Profile_Resources",
28163 "group": "User_Profile_Resources",
28164 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28165 "version": "0.0.0",
28166 "filename": "server/api/userProfileResource/index.js",
28167 "groupTitle": "User_Profile_Resources"
28171 "url": "/api/userProfile/resources/describe",
28172 "title": "Gets table info about User Profile Resources",
28175 "title": "Example usage:",
28176 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28180 "name": "DescribeUser_Profile_Resources",
28181 "group": "User_Profile_Resources",
28182 "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>",
28183 "version": "0.0.0",
28184 "filename": "server/api/userProfileResource/index.js",
28185 "groupTitle": "User_Profile_Resources"
28189 "url": "/api/userProfile/resources",
28190 "title": "Gets a list of User Profile Resources",
28193 "title": "Example usage:",
28194 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28198 "name": "GetUser_Profile_Resources",
28199 "group": "User_Profile_Resources",
28200 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28201 "version": "0.0.0",
28202 "filename": "server/api/userProfileResource/index.js",
28203 "groupTitle": "User_Profile_Resources"
28207 "url": "/api/userProfile/resources/{id}",
28208 "title": "Gets a single User Profile Resource",
28211 "title": "Example usage:",
28212 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28216 "name": "ShowUser_Profile_Resources",
28217 "group": "User_Profile_Resources",
28218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28219 "version": "0.0.0",
28220 "filename": "server/api/userProfileResource/index.js",
28221 "groupTitle": "User_Profile_Resources"
28225 "url": "/api/userProfile/resources/{id}",
28226 "title": "Update an existing User Profile Resource",
28229 "title": "Example usage:",
28230 "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",
28234 "name": "updateUser_Profile_Resources",
28235 "group": "User_Profile_Resources",
28236 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28237 "version": "0.0.0",
28238 "filename": "server/api/userProfileResource/index.js",
28239 "groupTitle": "User_Profile_Resources"
28243 "url": "/api/userProfile/sections",
28244 "title": "Creates a new User Profile Section",
28247 "title": "Example usage:",
28248 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28252 "name": "CreateUser_Profile_Sections",
28253 "group": "User_Profile_Sections",
28268 "field": "category",
28275 "field": "sectionId",
28282 "field": "enabled",
28289 "field": "autoAssociation",
28296 "field": "crudPermissions",
28302 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28303 "version": "0.0.0",
28304 "filename": "server/api/userProfileSection/index.js",
28305 "groupTitle": "User_Profile_Sections"
28309 "url": "/api/userProfile/sections/{id}",
28310 "title": "Deletes a User Profile Section",
28313 "title": "Example usage:",
28314 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28318 "name": "DeleteUser_Profile_Sections",
28319 "group": "User_Profile_Sections",
28320 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28321 "version": "0.0.0",
28322 "filename": "server/api/userProfileSection/index.js",
28323 "groupTitle": "User_Profile_Sections"
28327 "url": "/api/userProfile/sections/describe",
28328 "title": "Gets table info about User Profile Sections",
28331 "title": "Example usage:",
28332 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28336 "name": "DescribeUser_Profile_Sections",
28337 "group": "User_Profile_Sections",
28338 "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>",
28339 "version": "0.0.0",
28340 "filename": "server/api/userProfileSection/index.js",
28341 "groupTitle": "User_Profile_Sections"
28345 "url": "/api/userProfile/sections",
28346 "title": "Gets a list of User Profile Sections",
28349 "title": "Example usage:",
28350 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28354 "name": "GetUser_Profile_Sections",
28355 "group": "User_Profile_Sections",
28356 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28357 "version": "0.0.0",
28358 "filename": "server/api/userProfileSection/index.js",
28359 "groupTitle": "User_Profile_Sections"
28363 "url": "/api/userProfile/sections/{id}",
28364 "title": "Gets a single User Profile Section",
28367 "title": "Example usage:",
28368 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28372 "name": "ShowUser_Profile_Sections",
28373 "group": "User_Profile_Sections",
28374 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28375 "version": "0.0.0",
28376 "filename": "server/api/userProfileSection/index.js",
28377 "groupTitle": "User_Profile_Sections"
28381 "url": "/api/userProfile/sections/{id}",
28382 "title": "Update an existing User Profile Section",
28385 "title": "Example usage:",
28386 "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",
28390 "name": "updateUser_Profile_Sections",
28391 "group": "User_Profile_Sections",
28392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28393 "version": "0.0.0",
28394 "filename": "server/api/userProfileSection/index.js",
28395 "groupTitle": "User_Profile_Sections"
28399 "url": "/api/userProfiles/{id}/resources",
28400 "title": "Add resources' permissions to User Profile",
28403 "title": "Example usage:",
28404 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28408 "name": "AddResources",
28409 "group": "User_Profiles",
28410 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28411 "version": "0.0.0",
28412 "filename": "server/api/userProfile/index.js",
28413 "groupTitle": "User_Profiles"
28417 "url": "/api/userProfiles/{id}/sections",
28418 "title": "Add sections' permissions to User Profile",
28421 "title": "Example usage:",
28422 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28426 "name": "AddSections",
28427 "group": "User_Profiles",
28428 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28429 "version": "0.0.0",
28430 "filename": "server/api/userProfile/index.js",
28431 "groupTitle": "User_Profiles"
28435 "url": "/api/userProfiles/clone",
28436 "title": "Clone an existing User Profile",
28439 "title": "Example usage:",
28440 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28444 "name": "CloneUser_Profiles",
28445 "group": "User_Profiles",
28446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28447 "version": "0.0.0",
28448 "filename": "server/api/userProfile/index.js",
28449 "groupTitle": "User_Profiles"
28453 "url": "/api/userProfiles",
28454 "title": "Creates a new User Profile",
28457 "title": "Example usage:",
28458 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28462 "name": "CreateUser_Profiles",
28463 "group": "User_Profiles",
28478 "field": "crudPermissions",
28485 "field": "description",
28492 "field": "privacyEnabled",
28499 "field": "downloadAttachments",
28506 "field": "downloadCallySquareRecordings",
28513 "field": "downloadContactManagerLists",
28520 "field": "downloadJscriptySessions",
28527 "field": "downloadOmnichannelInteractions",
28534 "field": "downloadScreenRecordings",
28541 "field": "downloadVoiceRecordings",
28547 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28548 "version": "0.0.0",
28549 "filename": "server/api/userProfile/index.js",
28550 "groupTitle": "User_Profiles"
28554 "url": "/api/userProfiles/{id}",
28555 "title": "Deletes a User Profile",
28558 "title": "Example usage:",
28559 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28563 "name": "DeleteUser_Profiles",
28564 "group": "User_Profiles",
28565 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28566 "version": "0.0.0",
28567 "filename": "server/api/userProfile/index.js",
28568 "groupTitle": "User_Profiles"
28572 "url": "/api/userProfiles/describe",
28573 "title": "Gets table info about User Profiles",
28576 "title": "Example usage:",
28577 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28581 "name": "DescribeUser_Profiles",
28582 "group": "User_Profiles",
28583 "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>",
28584 "version": "0.0.0",
28585 "filename": "server/api/userProfile/index.js",
28586 "groupTitle": "User_Profiles"
28590 "url": "/api/userProfiles/{id}/resources?section={section}",
28591 "title": "Get Resources assigned to a Section",
28594 "title": "Example usage:",
28595 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28599 "name": "GetResources",
28600 "group": "User_Profiles",
28601 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28602 "version": "0.0.0",
28603 "filename": "server/api/userProfile/index.js",
28604 "groupTitle": "User_Profiles"
28608 "url": "/api/userProfiles/{id}/sections",
28609 "title": "Get sections associated to a User Profile",
28612 "title": "Example usage:",
28613 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28617 "name": "GetSections",
28618 "group": "User_Profiles",
28619 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28620 "version": "0.0.0",
28621 "filename": "server/api/userProfile/index.js",
28622 "groupTitle": "User_Profiles"
28626 "url": "/api/userProfiles",
28627 "title": "Gets a list of User Profiles",
28630 "title": "Example usage:",
28631 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28635 "name": "GetUser_Profiles",
28636 "group": "User_Profiles",
28637 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28638 "version": "0.0.0",
28639 "filename": "server/api/userProfile/index.js",
28640 "groupTitle": "User_Profiles"
28644 "url": "/api/userProfiles/{id}/resources",
28645 "title": "Removes resources' permissions from User Profile",
28648 "title": "Example usage:",
28649 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28653 "name": "RemoveResources",
28654 "group": "User_Profiles",
28655 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28656 "version": "0.0.0",
28657 "filename": "server/api/userProfile/index.js",
28658 "groupTitle": "User_Profiles"
28662 "url": "/api/userProfiles/{id}/sections",
28663 "title": "Removes sections' permissions from User Profile",
28666 "title": "Example usage:",
28667 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28671 "name": "RemoveSections",
28672 "group": "User_Profiles",
28673 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28674 "version": "0.0.0",
28675 "filename": "server/api/userProfile/index.js",
28676 "groupTitle": "User_Profiles"
28680 "url": "/api/userProfiles/{id}",
28681 "title": "Gets a single User Profile",
28684 "title": "Example usage:",
28685 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28689 "name": "ShowUser_Profiles",
28690 "group": "User_Profiles",
28691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28692 "version": "0.0.0",
28693 "filename": "server/api/userProfile/index.js",
28694 "groupTitle": "User_Profiles"
28698 "url": "/api/userProfiles/{id}",
28699 "title": "Update an existing User Profile",
28702 "title": "Example usage:",
28703 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28707 "name": "updateUser_Profiles",
28708 "group": "User_Profiles",
28709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28710 "version": "0.0.0",
28711 "filename": "server/api/userProfile/index.js",
28712 "groupTitle": "User_Profiles"
28716 "url": "/api/user-settings/{id}",
28717 "title": "Update an existing User Setting",
28720 "title": "Example usage:",
28721 "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",
28725 "name": "updateUserSettings",
28726 "group": "User_Settings",
28727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28728 "version": "0.0.0",
28729 "filename": "server/api/user-setting/index.js",
28730 "groupTitle": "User_Settings"
28734 "url": "/api/users/{id}/chat_interactions",
28735 "title": "Add chat interaction tabs to an agent",
28738 "title": "Example usage:",
28739 "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",
28743 "name": "AddChatInteractions",
28745 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28746 "version": "0.0.0",
28747 "filename": "server/api/user/index.js",
28748 "groupTitle": "Users"
28752 "url": "/api/users/{id}/chat_websites",
28753 "title": "Add a Chat Website to a user",
28756 "title": "Example usage:",
28757 "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",
28761 "name": "AddChatWebsites",
28763 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28764 "version": "0.0.0",
28765 "filename": "server/api/user/index.js",
28766 "groupTitle": "Users"
28770 "url": "/api/users/{id}/contacts",
28771 "title": "Add contacts to a user",
28774 "title": "Example usage:",
28775 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28779 "name": "AddContacts",
28781 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28782 "version": "0.0.0",
28783 "filename": "server/api/user/index.js",
28784 "groupTitle": "Users"
28788 "url": "/api/users/{id}/fax_accounts",
28789 "title": "Add a Fax Account to a user",
28792 "title": "Example usage:",
28793 "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",
28797 "name": "AddFaxAccounts",
28799 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28800 "version": "0.0.0",
28801 "filename": "server/api/user/index.js",
28802 "groupTitle": "Users"
28806 "url": "/api/users/{id}/fax_interactions",
28807 "title": "Add fax interaction tabs to an agent",
28810 "title": "Example usage:",
28811 "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",
28815 "name": "AddFaxInteractions",
28817 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28818 "version": "0.0.0",
28819 "filename": "server/api/user/index.js",
28820 "groupTitle": "Users"
28824 "url": "/api/users/{id}/mail_accounts",
28825 "title": "Add a Mail Account to a user",
28828 "title": "Example usage:",
28829 "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",
28833 "name": "AddMailAccounts",
28835 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28836 "version": "0.0.0",
28837 "filename": "server/api/user/index.js",
28838 "groupTitle": "Users"
28842 "url": "/api/users/{id}/mail_interactions",
28843 "title": "Add mail interaction tabs to an agent",
28846 "title": "Example usage:",
28847 "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",
28851 "name": "AddMailInteractions",
28853 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28854 "version": "0.0.0",
28855 "filename": "server/api/user/index.js",
28856 "groupTitle": "Users"
28860 "url": "/api/users/{id}/openchannel_accounts",
28861 "title": "Add a Open Channel Account to a user",
28864 "title": "Example usage:",
28865 "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",
28869 "name": "AddOpenchannelAccounts",
28871 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28872 "version": "0.0.0",
28873 "filename": "server/api/user/index.js",
28874 "groupTitle": "Users"
28878 "url": "/api/users/{id}/openchannel_interactions",
28879 "title": "Add openchannel interaction tabs to an agent",
28882 "title": "Example usage:",
28883 "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",
28887 "name": "AddOpenchannelInteractions",
28889 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28890 "version": "0.0.0",
28891 "filename": "server/api/user/index.js",
28892 "groupTitle": "Users"
28896 "url": "/api/users/{id}/queues",
28897 "title": "Add queues to an agent",
28900 "title": "Example usage:",
28901 "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",
28905 "name": "AddQueues",
28907 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28908 "version": "0.0.0",
28909 "filename": "server/api/user/index.js",
28910 "groupTitle": "Users"
28914 "url": "/api/users/{id}/sms_accounts",
28915 "title": "Add a Sms Account to a user",
28918 "title": "Example usage:",
28919 "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",
28923 "name": "AddSmsAccounts",
28925 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28926 "version": "0.0.0",
28927 "filename": "server/api/user/index.js",
28928 "groupTitle": "Users"
28932 "url": "/api/users/{id}/sms_interactions",
28933 "title": "Add sms interaction tabs to an agent",
28936 "title": "Example usage:",
28937 "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",
28941 "name": "AddSmsInteractions",
28943 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28944 "version": "0.0.0",
28945 "filename": "server/api/user/index.js",
28946 "groupTitle": "Users"
28950 "url": "/api/users/{id}/square_projects",
28951 "title": "Add a Square Project to a user",
28954 "title": "Example usage:",
28955 "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",
28959 "name": "AddSquareProjects",
28961 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28962 "version": "0.0.0",
28963 "filename": "server/api/user/index.js",
28964 "groupTitle": "Users"
28968 "url": "/api/users/{id}/teams",
28969 "title": "Add teams to an agent",
28972 "title": "Example usage:",
28973 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28977 "name": "AddTeams",
28979 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28980 "version": "0.0.0",
28981 "filename": "server/api/user/index.js",
28982 "groupTitle": "Users"
28986 "url": "/api/users/{id}/whatsapp_accounts",
28987 "title": "Add a Whatsapp Account to a user",
28990 "title": "Example usage:",
28991 "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",
28995 "name": "AddWhatsappAccounts",
28997 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28998 "version": "0.0.0",
28999 "filename": "server/api/user/index.js",
29000 "groupTitle": "Users"
29004 "url": "/api/users/{id}/whatsapp_interactions",
29005 "title": "Add Whatsapp interaction tabs to an agent",
29008 "title": "Example usage:",
29009 "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",
29013 "name": "AddWhatsappInteractions",
29015 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29016 "version": "0.0.0",
29017 "filename": "server/api/user/index.js",
29018 "groupTitle": "Users"
29022 "url": "/api/users/{id}/password",
29023 "title": "Change user password",
29026 "title": "Example usage:",
29027 "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",
29031 "name": "ChangePwd",
29033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29034 "version": "0.0.0",
29035 "filename": "server/api/user/index.js",
29036 "groupTitle": "Users"
29040 "url": "/api/users",
29041 "title": "Create a new user",
29044 "title": "Example usage:",
29045 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29051 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29052 "version": "0.0.0",
29053 "filename": "server/api/user/index.js",
29054 "groupTitle": "Users"
29058 "url": "/api/users/{id}/api_key",
29059 "title": "Create a new API access key for the user",
29062 "title": "Example usage:",
29063 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29067 "name": "CreateApiKey",
29069 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29070 "version": "0.0.0",
29071 "filename": "server/api/user/index.js",
29072 "groupTitle": "Users"
29076 "url": "/api/users/{id}",
29077 "title": "Deletes a user",
29080 "title": "Example usage:",
29081 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29087 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29088 "version": "0.0.0",
29089 "filename": "server/api/user/index.js",
29090 "groupTitle": "Users"
29094 "url": "/api/users/describe",
29095 "title": "Gets table info about Users",
29098 "title": "Example usage:",
29099 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29103 "name": "DescribeUsers",
29105 "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>",
29106 "version": "0.0.0",
29107 "filename": "server/api/user/index.js",
29108 "groupTitle": "Users"
29112 "url": "/api/users/{id}/agents",
29113 "title": "GetAgents",
29116 "title": "Example usage:",
29117 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29121 "name": "GetAgents",
29123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29124 "version": "0.0.0",
29125 "filename": "server/api/user/index.js",
29126 "groupTitle": "Users"
29130 "url": "/api/users/{id}/api_key",
29131 "title": "Get the API access key for the user",
29134 "title": "Example usage:",
29135 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29139 "name": "GetApiKey",
29141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29142 "version": "0.0.0",
29143 "filename": "server/api/user/index.js",
29144 "groupTitle": "Users"
29148 "url": "/api/users/{id}/groups",
29149 "title": "GetChatGroups",
29152 "title": "Example usage:",
29153 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29157 "name": "GetChatGroups",
29159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29160 "version": "0.0.0",
29161 "filename": "server/api/user/index.js",
29162 "groupTitle": "Users"
29166 "url": "/api/users/{id}/chat/interactions",
29167 "title": "GetChatInteractions",
29170 "title": "Example usage:",
29171 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29175 "name": "GetChatInteractions",
29177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29178 "version": "0.0.0",
29179 "filename": "server/api/user/index.js",
29180 "groupTitle": "Users"
29184 "url": "/api/users/{id}/chat_websites",
29185 "title": "GetChatWebsites",
29188 "title": "Example usage:",
29189 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29193 "name": "GetChatWebsites",
29195 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29196 "version": "0.0.0",
29197 "filename": "server/api/user/index.js",
29198 "groupTitle": "Users"
29202 "url": "/api/users/{id}/contacts",
29203 "title": "GetContacts",
29206 "title": "Example usage:",
29207 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29211 "name": "GetContacts",
29213 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29214 "version": "0.0.0",
29215 "filename": "server/api/user/index.js",
29216 "groupTitle": "Users"
29220 "url": "/api/users/{id}/fax_accounts",
29221 "title": "GetFaxAccounts",
29224 "title": "Example usage:",
29225 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29229 "name": "GetFaxAccounts",
29231 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29232 "version": "0.0.0",
29233 "filename": "server/api/user/index.js",
29234 "groupTitle": "Users"
29238 "url": "/api/users/{id}/fax/interactions",
29239 "title": "GetFaxInteractions",
29242 "title": "Example usage:",
29243 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29247 "name": "GetFaxInteractions",
29249 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29250 "version": "0.0.0",
29251 "filename": "server/api/user/index.js",
29252 "groupTitle": "Users"
29256 "url": "/api/users/{id}/lists",
29257 "title": "GetLists",
29260 "title": "Example usage:",
29261 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29265 "name": "GetLists",
29267 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29268 "version": "0.0.0",
29269 "filename": "server/api/user/index.js",
29270 "groupTitle": "Users"
29274 "url": "/api/users/{id}/mail_accounts",
29275 "title": "GetMailAccounts",
29278 "title": "Example usage:",
29279 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29283 "name": "GetMailAccounts",
29285 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29286 "version": "0.0.0",
29287 "filename": "server/api/user/index.js",
29288 "groupTitle": "Users"
29292 "url": "/api/users/{id}/mail/interactions",
29293 "title": "GetMailInteractions",
29296 "title": "Example usage:",
29297 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29301 "name": "GetMailInteractions",
29303 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29304 "version": "0.0.0",
29305 "filename": "server/api/user/index.js",
29306 "groupTitle": "Users"
29310 "url": "/api/users/{id}/openchannel_accounts",
29311 "title": "GetOpenchannelAccounts",
29314 "title": "Example usage:",
29315 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29319 "name": "GetOpenchannelAccounts",
29321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29322 "version": "0.0.0",
29323 "filename": "server/api/user/index.js",
29324 "groupTitle": "Users"
29328 "url": "/api/users/{id}/openchannel/interactions",
29329 "title": "GetOpenchannelInteractions",
29332 "title": "Example usage:",
29333 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29337 "name": "GetOpenchannelInteractions",
29339 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29340 "version": "0.0.0",
29341 "filename": "server/api/user/index.js",
29342 "groupTitle": "Users"
29346 "url": "/api/users/{id}/prefixes",
29347 "title": "GetPrefixes",
29350 "title": "Example usage:",
29351 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29355 "name": "GetPrefixes",
29357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29358 "version": "0.0.0",
29359 "filename": "server/api/user/index.js",
29360 "groupTitle": "Users"
29364 "url": "/api/users/{id}/queues?channel={channel}",
29365 "title": "Gets Queues list",
29368 "title": "Example usage:",
29369 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29373 "name": "GetQueues",
29375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29376 "version": "0.0.0",
29377 "filename": "server/api/user/index.js",
29378 "groupTitle": "Users"
29382 "url": "/api/users/{id}/recordings",
29383 "title": "GetRecordings",
29386 "title": "Example usage:",
29387 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29391 "name": "GetRecordings",
29393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29394 "version": "0.0.0",
29395 "filename": "server/api/user/index.js",
29396 "groupTitle": "Users"
29400 "url": "/api/users/{id}/scheduled_calls",
29401 "title": "GetScheduledCalls",
29404 "title": "Example usage:",
29405 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29409 "name": "GetScheduledCalls",
29411 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29412 "version": "0.0.0",
29413 "filename": "server/api/user/index.js",
29414 "groupTitle": "Users"
29418 "url": "/api/users/{id}/screen_recordings",
29419 "title": "GetScreenRecordings",
29422 "title": "Example usage:",
29423 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29427 "name": "GetScreenRecordings",
29429 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29430 "version": "0.0.0",
29431 "filename": "server/api/user/index.js",
29432 "groupTitle": "Users"
29436 "url": "/api/users/{id}/sms_accounts",
29437 "title": "GetSmsAccounts",
29440 "title": "Example usage:",
29441 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29445 "name": "GetSmsAccounts",
29447 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29448 "version": "0.0.0",
29449 "filename": "server/api/user/index.js",
29450 "groupTitle": "Users"
29454 "url": "/api/users/{id}/sms/interactions",
29455 "title": "GetSmsInteractions",
29458 "title": "Example usage:",
29459 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29463 "name": "GetSmsInteractions",
29465 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29466 "version": "0.0.0",
29467 "filename": "server/api/user/index.js",
29468 "groupTitle": "Users"
29472 "url": "/api/users/{id}/square_projects",
29473 "title": "GetSquareProjects",
29476 "title": "Example usage:",
29477 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29481 "name": "GetSquareProjects",
29483 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29484 "version": "0.0.0",
29485 "filename": "server/api/user/index.js",
29486 "groupTitle": "Users"
29490 "url": "/api/users/{id}/teams",
29491 "title": "GetTeams",
29494 "title": "Example usage:",
29495 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29499 "name": "GetTeams",
29501 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29502 "version": "0.0.0",
29503 "filename": "server/api/user/index.js",
29504 "groupTitle": "Users"
29508 "url": "/api/users",
29509 "title": "Gets a list of Users",
29512 "title": "Example usage:",
29513 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29517 "name": "GetUsers",
29519 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29520 "version": "0.0.0",
29521 "filename": "server/api/user/index.js",
29522 "groupTitle": "Users"
29526 "url": "/api/users/{id}/queues_rt",
29527 "title": "GetVoiceQueuesRt",
29530 "title": "Example usage:",
29531 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29535 "name": "GetVoiceQueuesRt",
29537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29538 "version": "0.0.0",
29539 "filename": "server/api/user/index.js",
29540 "groupTitle": "Users"
29544 "url": "/api/users/{id}/whatsapp_accounts",
29545 "title": "GetWhatsappAccounts",
29548 "title": "Example usage:",
29549 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29553 "name": "GetWhatsappAccounts",
29555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29556 "version": "0.0.0",
29557 "filename": "server/api/user/index.js",
29558 "groupTitle": "Users"
29562 "url": "/api/users/{id}/whatsapp/interactions",
29563 "title": "GetWhatsappInteractions",
29566 "title": "Example usage:",
29567 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29571 "name": "GetWhatsappInteractions",
29573 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29574 "version": "0.0.0",
29575 "filename": "server/api/user/index.js",
29576 "groupTitle": "Users"
29580 "url": "/api/users/{id}/login",
29584 "title": "Example usage:",
29585 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
29591 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29592 "version": "0.0.0",
29593 "filename": "server/api/user/index.js",
29594 "groupTitle": "Users"
29598 "url": "/api/users/{id}/logout",
29602 "title": "Example usage:",
29603 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29609 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29610 "version": "0.0.0",
29611 "filename": "server/api/user/index.js",
29612 "groupTitle": "Users"
29616 "url": "/api/users/{id}/pause",
29620 "title": "Example usage:",
29621 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29627 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29628 "version": "0.0.0",
29629 "filename": "server/api/user/index.js",
29630 "groupTitle": "Users"
29634 "url": "/api/users/{id}/api_key",
29635 "title": "Remove API access key for the user",
29638 "title": "Example usage:",
29639 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29643 "name": "RemoveApiKey",
29645 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29646 "version": "0.0.0",
29647 "filename": "server/api/user/index.js",
29648 "groupTitle": "Users"
29652 "url": "/api/users/{id}/chat_interactions",
29653 "title": "Removes interactions from an agent",
29656 "title": "Example usage:",
29657 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29661 "name": "RemoveChatInteractions",
29663 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29664 "version": "0.0.0",
29665 "filename": "server/api/user/index.js",
29666 "groupTitle": "Users"
29670 "url": "/api/users/{id}/chat_websites",
29671 "title": "Removes a Chat Website from a user",
29674 "title": "Example usage:",
29675 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29679 "name": "RemoveChatWebsites",
29681 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29682 "version": "0.0.0",
29683 "filename": "server/api/user/index.js",
29684 "groupTitle": "Users"
29688 "url": "/api/users/{id}/fax_accounts",
29689 "title": "Removes a Fax Account from a user",
29692 "title": "Example usage:",
29693 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29697 "name": "RemoveFaxAccounts",
29699 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29700 "version": "0.0.0",
29701 "filename": "server/api/user/index.js",
29702 "groupTitle": "Users"
29706 "url": "/api/users/{id}/fax_interactions",
29707 "title": "Removes interactions from an agent",
29710 "title": "Example usage:",
29711 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29715 "name": "RemoveFaxInteractions",
29717 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29718 "version": "0.0.0",
29719 "filename": "server/api/user/index.js",
29720 "groupTitle": "Users"
29724 "url": "/api/users/{id}/mail_accounts",
29725 "title": "Removes a Mail Account from a user",
29728 "title": "Example usage:",
29729 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29733 "name": "RemoveMailAccounts",
29735 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29736 "version": "0.0.0",
29737 "filename": "server/api/user/index.js",
29738 "groupTitle": "Users"
29742 "url": "/api/users/{id}/mail_interactions",
29743 "title": "Removes interactions from an agent",
29746 "title": "Example usage:",
29747 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29751 "name": "RemoveMailInteractions",
29753 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29754 "version": "0.0.0",
29755 "filename": "server/api/user/index.js",
29756 "groupTitle": "Users"
29760 "url": "/api/users/{id}/openchannel_accounts",
29761 "title": "Removes a Open Channel Account from a user",
29764 "title": "Example usage:",
29765 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29769 "name": "RemoveOpenchannelAccounts",
29771 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29772 "version": "0.0.0",
29773 "filename": "server/api/user/index.js",
29774 "groupTitle": "Users"
29778 "url": "/api/users/{id}/openchannel_interactions",
29779 "title": "Removes openchannel interactions from an agent",
29782 "title": "Example usage:",
29783 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29787 "name": "RemoveOpenchannelInteractions",
29789 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29790 "version": "0.0.0",
29791 "filename": "server/api/user/index.js",
29792 "groupTitle": "Users"
29796 "url": "/api/users/{id}/queues",
29797 "title": "Remove queues to an agent",
29800 "title": "Example usage:",
29801 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29805 "name": "RemoveQueues",
29807 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29808 "version": "0.0.0",
29809 "filename": "server/api/user/index.js",
29810 "groupTitle": "Users"
29814 "url": "/api/users/{id}/sms_accounts",
29815 "title": "Removes a Sms Account from a user",
29818 "title": "Example usage:",
29819 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29823 "name": "RemoveSmsAccounts",
29825 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29826 "version": "0.0.0",
29827 "filename": "server/api/user/index.js",
29828 "groupTitle": "Users"
29832 "url": "/api/users/{id}/sms_interactions",
29833 "title": "Removes interactions from an agent",
29836 "title": "Example usage:",
29837 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29841 "name": "RemoveSmsInteractions",
29843 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29844 "version": "0.0.0",
29845 "filename": "server/api/user/index.js",
29846 "groupTitle": "Users"
29850 "url": "/api/users/{id}/square_projects",
29851 "title": "Removes a Square Project from a user",
29854 "title": "Example usage:",
29855 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29859 "name": "RemoveSquareProjects",
29861 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29862 "version": "0.0.0",
29863 "filename": "server/api/user/index.js",
29864 "groupTitle": "Users"
29868 "url": "/api/users/{id}/teams",
29869 "title": "Removes teams from an agent",
29872 "title": "Example usage:",
29873 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29877 "name": "RemoveTeams",
29879 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29880 "version": "0.0.0",
29881 "filename": "server/api/user/index.js",
29882 "groupTitle": "Users"
29886 "url": "/api/users/{id}/whatsapp_accounts",
29887 "title": "Removes a Whatsapp Account from a user",
29890 "title": "Example usage:",
29891 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29895 "name": "RemoveWhatsappAccounts",
29897 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29898 "version": "0.0.0",
29899 "filename": "server/api/user/index.js",
29900 "groupTitle": "Users"
29904 "url": "/api/users/{id}/whatsapp_interactions",
29905 "title": "Removes Whatsapp interactions from an agent",
29908 "title": "Example usage:",
29909 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29913 "name": "RemoveWhatsappInteractions",
29915 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29916 "version": "0.0.0",
29917 "filename": "server/api/user/index.js",
29918 "groupTitle": "Users"
29922 "url": "/api/users/{id}",
29923 "title": "Gets a single User",
29926 "title": "Example usage:",
29927 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29931 "name": "ShowUsers",
29933 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29934 "version": "0.0.0",
29935 "filename": "server/api/user/index.js",
29936 "groupTitle": "Users"
29940 "url": "/api/users/{id}/unpause",
29941 "title": "Unpause",
29944 "title": "Example usage:",
29945 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29951 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29952 "version": "0.0.0",
29953 "filename": "server/api/user/index.js",
29954 "groupTitle": "Users"
29958 "url": "/api/users/whoami",
29962 "title": "Example usage:",
29963 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29969 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29970 "version": "0.0.0",
29971 "filename": "server/api/user/index.js",
29972 "groupTitle": "Users"
29976 "url": "/api/users/{id}/avatar",
29977 "title": "Add avatar",
29980 "title": "Example usage:",
29981 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29985 "name": "addAvatar",
29987 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29988 "version": "0.0.0",
29989 "filename": "server/api/user/index.js",
29990 "groupTitle": "Users"
29994 "url": "/api/users/create_many",
29995 "title": "Create Users",
29998 "title": "Example usage:",
29999 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
30003 "name": "bulkCreate",
30005 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30006 "version": "0.0.0",
30007 "filename": "server/api/user/index.js",
30008 "groupTitle": "Users"
30012 "url": "/api/users/{id}/avatar",
30013 "title": "Get avatar",
30016 "title": "Example usage:",
30017 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30021 "name": "getAvatar",
30023 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30024 "version": "0.0.0",
30025 "filename": "server/api/user/index.js",
30026 "groupTitle": "Users"
30030 "url": "/api/users/{id}/open_tabs",
30031 "title": "Get interactions opened tabs",
30034 "title": "Example usage:",
30035 "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
30039 "name": "getOpenTabs",
30041 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30042 "version": "0.0.0",
30043 "filename": "server/api/user/index.js",
30044 "groupTitle": "Users"
30048 "url": "/api/users/presence",
30049 "title": "Gets agent presence",
30052 "title": "Example usage:",
30053 "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
30057 "name": "getPresence",
30059 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30060 "version": "0.0.0",
30061 "filename": "server/api/user/index.js",
30062 "groupTitle": "Users"
30066 "url": "/api/users/{id}",
30067 "title": "Update an existing User",
30070 "title": "Example usage:",
30071 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30075 "name": "updateUsers",
30077 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30078 "version": "0.0.0",
30079 "filename": "server/api/user/index.js",
30080 "groupTitle": "Users"
30084 "url": "/api/variables",
30085 "title": "Creates a new Variable",
30088 "title": "Example usage:",
30089 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30093 "name": "CreateVariables",
30094 "group": "Variables",
30109 "field": "description",
30115 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30116 "version": "0.0.0",
30117 "filename": "server/api/variable/index.js",
30118 "groupTitle": "Variables"
30122 "url": "/api/variables/{id}",
30123 "title": "Deletes a Variable",
30126 "title": "Example usage:",
30127 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30131 "name": "DeleteVariables",
30132 "group": "Variables",
30133 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30134 "version": "0.0.0",
30135 "filename": "server/api/variable/index.js",
30136 "groupTitle": "Variables"
30140 "url": "/api/variables",
30141 "title": "Gets a list of Variables",
30144 "title": "Example usage:",
30145 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30149 "name": "GetVariables",
30150 "group": "Variables",
30151 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30152 "version": "0.0.0",
30153 "filename": "server/api/variable/index.js",
30154 "groupTitle": "Variables"
30158 "url": "/api/variables/{id}",
30159 "title": "Gets a single Variable",
30162 "title": "Example usage:",
30163 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30167 "name": "ShowVariables",
30168 "group": "Variables",
30169 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30170 "version": "0.0.0",
30171 "filename": "server/api/variable/index.js",
30172 "groupTitle": "Variables"
30176 "url": "/api/variables/{id}",
30177 "title": "Update an existing Variable",
30180 "title": "Example usage:",
30181 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30185 "name": "updateVariables",
30186 "group": "Variables",
30187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30188 "version": "0.0.0",
30189 "filename": "server/api/variable/index.js",
30190 "groupTitle": "Variables"
30194 "url": "/api/version/fetch",
30195 "title": "Fetch git version",
30198 "title": "Example usage:",
30199 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30203 "name": "FetchVersion",
30204 "group": "Version",
30205 "description": "<p>Motion run the following command: git fetch origin master</p>",
30206 "version": "0.0.0",
30207 "filename": "server/api/version/index.js",
30208 "groupTitle": "Version"
30212 "url": "/api/version",
30213 "title": "Gets version",
30216 "title": "Example usage:",
30217 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30221 "name": "GetVersion",
30222 "group": "Version",
30223 "description": "<p>Motion returns the current and latest motion version.</p>",
30224 "version": "0.0.0",
30225 "filename": "server/api/version/index.js",
30226 "groupTitle": "Version"
30230 "url": "/api/version/migrations",
30231 "title": "Launch database migrations",
30234 "title": "Example usage:",
30235 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30239 "name": "MigrateVersion",
30240 "group": "Version",
30241 "description": "<p>Motion launch the database migrations, according to the application version</p>",
30242 "version": "0.0.0",
30243 "filename": "server/api/version/index.js",
30244 "groupTitle": "Version"
30248 "url": "/api/version/pull",
30249 "title": "Pull git version",
30252 "title": "Example usage:",
30253 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30257 "name": "PullVersion",
30258 "group": "Version",
30259 "description": "<p>Motion run the following command: git pull</p>",
30260 "version": "0.0.0",
30261 "filename": "server/api/version/index.js",
30262 "groupTitle": "Version"
30266 "url": "/api/version/reset",
30267 "title": "Reset git version",
30270 "title": "Example usage:",
30271 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30275 "name": "ResetVersion",
30276 "group": "Version",
30277 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30278 "version": "0.0.0",
30279 "filename": "server/api/version/index.js",
30280 "groupTitle": "Version"
30284 "url": "/api/version/restart",
30285 "title": "Restart motion2 after update",
30288 "title": "Example usage:",
30289 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30293 "name": "RestartVersion",
30294 "group": "Version",
30295 "description": "<p>Motion run the following command: pm2 restart motion</p>",
30296 "version": "0.0.0",
30297 "filename": "server/api/version/index.js",
30298 "groupTitle": "Version"
30302 "url": "/api/voice/agents/reports/describe",
30303 "title": "Gets table info about Agent Reports",
30306 "title": "Example usage:",
30307 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30311 "name": "DescribeAgent_Reports",
30312 "group": "Voice_Agent_Reports",
30313 "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>",
30314 "version": "0.0.0",
30315 "filename": "server/api/voiceAgentReport/index.js",
30316 "groupTitle": "Voice_Agent_Reports"
30320 "url": "/api/voice/agents/reports",
30321 "title": "Gets a list of Agent Reports",
30324 "title": "Example usage:",
30325 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30329 "name": "GetAgent_Reports",
30330 "group": "Voice_Agent_Reports",
30331 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30332 "version": "0.0.0",
30333 "filename": "server/api/voiceAgentReport/index.js",
30334 "groupTitle": "Voice_Agent_Reports"
30338 "url": "/api/voice/agents/reports/{id}",
30339 "title": "Gets a single Agent Report",
30342 "title": "Example usage:",
30343 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30347 "name": "ShowAgent_Reports",
30348 "group": "Voice_Agent_Reports",
30349 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30350 "version": "0.0.0",
30351 "filename": "server/api/voiceAgentReport/index.js",
30352 "groupTitle": "Voice_Agent_Reports"
30356 "url": "/api/voice/calls/reports/describe",
30357 "title": "Gets table info about Call Reports",
30360 "title": "Example usage:",
30361 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30365 "name": "DescribeCall_Reports",
30366 "group": "Voice_Call_Reports",
30367 "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>",
30368 "version": "0.0.0",
30369 "filename": "server/api/voiceCallReport/index.js",
30370 "groupTitle": "Voice_Call_Reports"
30374 "url": "/api/voice/calls/reports",
30375 "title": "Gets a list of Call Reports",
30378 "title": "Example usage:",
30379 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30383 "name": "GetCall_Reports",
30384 "group": "Voice_Call_Reports",
30385 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30386 "version": "0.0.0",
30387 "filename": "server/api/voiceCallReport/index.js",
30388 "groupTitle": "Voice_Call_Reports"
30392 "url": "/api/voice/calls/reports/{id}",
30393 "title": "Gets a single Call Report",
30396 "title": "Example usage:",
30397 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30401 "name": "ShowCall_Reports",
30402 "group": "Voice_Call_Reports",
30403 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30404 "version": "0.0.0",
30405 "filename": "server/api/voiceCallReport/index.js",
30406 "groupTitle": "Voice_Call_Reports"
30410 "url": "/api/voice/calls/reports/{id}",
30411 "title": "Update a single cdr",
30414 "title": "Example usage:",
30415 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30420 "group": "Voice_Call_Reports",
30421 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30422 "version": "0.0.0",
30423 "filename": "server/api/voiceCallReport/index.js",
30424 "groupTitle": "Voice_Call_Reports"
30428 "url": "/api/voice/chanspy",
30429 "title": "Creates a new ChanSpy",
30432 "title": "Example usage:",
30433 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30437 "name": "CreateChanSpy",
30438 "group": "Voice_ChanSpy",
30460 "field": "options",
30474 "field": "password",
30488 "field": "recordingFormat",
30495 "field": "description",
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/voiceChanSpy/index.js",
30504 "groupTitle": "Voice_ChanSpy"
30508 "url": "/api/voice/chanspy/{id}",
30509 "title": "Deletes a ChanSpy",
30512 "title": "Example usage:",
30513 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30517 "name": "DeleteChanSpy",
30518 "group": "Voice_ChanSpy",
30519 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/voiceChanSpy/index.js",
30522 "groupTitle": "Voice_ChanSpy"
30526 "url": "/api/voice/chanspy",
30527 "title": "Gets a list of ChanSpy",
30530 "title": "Example usage:",
30531 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30535 "name": "GetChanSpy",
30536 "group": "Voice_ChanSpy",
30537 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30538 "version": "0.0.0",
30539 "filename": "server/api/voiceChanSpy/index.js",
30540 "groupTitle": "Voice_ChanSpy"
30544 "url": "/api/voice/chanspy/{id}",
30545 "title": "Gets a single ChanSpy",
30548 "title": "Example usage:",
30549 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30553 "name": "ShowChanSpy",
30554 "group": "Voice_ChanSpy",
30555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30556 "version": "0.0.0",
30557 "filename": "server/api/voiceChanSpy/index.js",
30558 "groupTitle": "Voice_ChanSpy"
30562 "url": "/api/voice/chanspy/{id}",
30563 "title": "Update an existing ChanSpy",
30566 "title": "Example usage:",
30567 "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",
30571 "name": "updateChanSpy",
30572 "group": "Voice_ChanSpy",
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/voiceChanSpy/index.js",
30576 "groupTitle": "Voice_ChanSpy"
30580 "url": "/api/voice/contexts",
30581 "title": "Create a new context",
30584 "title": "Example usage:",
30585 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30590 "group": "Voice_Contexts",
30605 "field": "description",
30612 "field": "defaultEntry",
30618 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30619 "version": "0.0.0",
30620 "filename": "server/api/voiceContext/index.js",
30621 "groupTitle": "Voice_Contexts"
30625 "url": "/api/voice/contexts/{id}",
30626 "title": "Deletes a context",
30629 "title": "Example usage:",
30630 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30635 "group": "Voice_Contexts",
30636 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30637 "version": "0.0.0",
30638 "filename": "server/api/voiceContext/index.js",
30639 "groupTitle": "Voice_Contexts"
30643 "url": "/api/voice/contexts",
30644 "title": "Gets a list of Contexts",
30647 "title": "Example usage:",
30648 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30652 "name": "GetContexts",
30653 "group": "Voice_Contexts",
30654 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30655 "version": "0.0.0",
30656 "filename": "server/api/voiceContext/index.js",
30657 "groupTitle": "Voice_Contexts"
30661 "url": "/api/voice/contexts/{id}",
30662 "title": "Gets a single Context",
30665 "title": "Example usage:",
30666 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30670 "name": "ShowContexts",
30671 "group": "Voice_Contexts",
30672 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30673 "version": "0.0.0",
30674 "filename": "server/api/voiceContext/index.js",
30675 "groupTitle": "Voice_Contexts"
30679 "url": "/api/voice/contexts/{id}",
30680 "title": "Update an existing context",
30683 "title": "Example usage:",
30684 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30689 "group": "Voice_Contexts",
30690 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30691 "version": "0.0.0",
30692 "filename": "server/api/voiceContext/index.js",
30693 "groupTitle": "Voice_Contexts"
30697 "url": "/api/voice/dials/reports/describe",
30698 "title": "Gets table info about Dial Reports",
30701 "title": "Example usage:",
30702 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30706 "name": "DescribeDial_Reports",
30707 "group": "Voice_Dial_Reports",
30708 "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>",
30709 "version": "0.0.0",
30710 "filename": "server/api/voiceDialReport/index.js",
30711 "groupTitle": "Voice_Dial_Reports"
30715 "url": "/api/voice/dials/reports",
30716 "title": "Gets a list of Dial Reports",
30719 "title": "Example usage:",
30720 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30724 "name": "GetDial_Reports",
30725 "group": "Voice_Dial_Reports",
30726 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30727 "version": "0.0.0",
30728 "filename": "server/api/voiceDialReport/index.js",
30729 "groupTitle": "Voice_Dial_Reports"
30733 "url": "/api/voice/dials/reports/{id}",
30734 "title": "Gets a single Dial Report",
30737 "title": "Example usage:",
30738 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30742 "name": "ShowDial_Reports",
30743 "group": "Voice_Dial_Reports",
30744 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30745 "version": "0.0.0",
30746 "filename": "server/api/voiceDialReport/index.js",
30747 "groupTitle": "Voice_Dial_Reports"
30751 "url": "/api/voice/extensions/{id}",
30752 "title": "Deletes a Extension",
30755 "title": "Example usage:",
30756 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30760 "name": "DeleteExtensions",
30761 "group": "Voice_Extensions",
30762 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30763 "version": "0.0.0",
30764 "filename": "server/api/voiceExtension/index.js",
30765 "groupTitle": "Voice_Extensions"
30769 "url": "/api/voice/extensions",
30770 "title": "Gets a list of Extensions",
30773 "title": "Example usage:",
30774 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30778 "name": "GetExtensions",
30779 "group": "Voice_Extensions",
30780 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30781 "version": "0.0.0",
30782 "filename": "server/api/voiceExtension/index.js",
30783 "groupTitle": "Voice_Extensions"
30787 "url": "/api/voice/extensions/{id}",
30788 "title": "Gets a single Extension",
30791 "title": "Example usage:",
30792 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30796 "name": "ShowExtensions",
30797 "group": "Voice_Extensions",
30798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30799 "version": "0.0.0",
30800 "filename": "server/api/voiceExtension/index.js",
30801 "groupTitle": "Voice_Extensions"
30805 "url": "/api/voice/extensions",
30806 "title": "Create new applications",
30809 "title": "Example usage:",
30810 "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",
30814 "name": "addApplications",
30815 "group": "Voice_Extensions",
30816 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30817 "version": "0.0.0",
30818 "filename": "server/api/voiceExtension/index.js",
30819 "groupTitle": "Voice_Extensions"
30823 "url": "/api/voice/extensions",
30824 "title": "Create an extension",
30827 "title": "Example usage:",
30828 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30833 "group": "Voice_Extensions",
30834 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30835 "version": "0.0.0",
30836 "filename": "server/api/voiceExtension/index.js",
30837 "groupTitle": "Voice_Extensions"
30841 "url": "/api/voice/extensions/{id}",
30842 "title": "Update an extension",
30845 "title": "Example usage:",
30846 "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",
30851 "group": "Voice_Extensions",
30852 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30853 "version": "0.0.0",
30854 "filename": "server/api/voiceExtension/index.js",
30855 "groupTitle": "Voice_Extensions"
30859 "url": "/api/voice/mohs",
30860 "title": "Create a new a new MOH",
30863 "title": "Example usage:",
30864 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30869 "group": "Voice_MOHs",
30870 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30871 "version": "0.0.0",
30872 "filename": "server/api/voiceMusicOnHold/index.js",
30873 "groupTitle": "Voice_MOHs"
30877 "url": "/api/voice/mohs/{id}/sounds",
30878 "title": "Add sound to MOH",
30881 "title": "Example usage:",
30882 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30886 "name": "AddSound",
30887 "group": "Voice_MOHs",
30888 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30889 "version": "0.0.0",
30890 "filename": "server/api/voiceMusicOnHold/index.js",
30891 "groupTitle": "Voice_MOHs"
30895 "url": "/api/voice/mohs/{id}",
30896 "title": "Deletes an MOH",
30899 "title": "Example usage:",
30900 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30904 "name": "DestroyMoh",
30905 "group": "Voice_MOHs",
30906 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30907 "version": "0.0.0",
30908 "filename": "server/api/voiceMusicOnHold/index.js",
30909 "groupTitle": "Voice_MOHs"
30913 "url": "/api/voice/mohs",
30914 "title": "Gets a list of Music On Holds",
30917 "title": "Example usage:",
30918 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30922 "name": "GetMusic_On_Holds",
30923 "group": "Voice_MOHs",
30924 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30925 "version": "0.0.0",
30926 "filename": "server/api/voiceMusicOnHold/index.js",
30927 "groupTitle": "Voice_MOHs"
30931 "url": "/api/voice/mohs/{id}/sounds",
30932 "title": "Gets sounds from MOH",
30935 "title": "Example usage:",
30936 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30940 "name": "GetSounds",
30941 "group": "Voice_MOHs",
30942 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30943 "version": "0.0.0",
30944 "filename": "server/api/voiceMusicOnHold/index.js",
30945 "groupTitle": "Voice_MOHs"
30949 "url": "/api/voice/mohs/{id}/sounds/{id2}",
30950 "title": "Remove sound from MOH",
30953 "title": "Example usage:",
30954 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30958 "name": "RemoveSound",
30959 "group": "Voice_MOHs",
30960 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30961 "version": "0.0.0",
30962 "filename": "server/api/voiceMusicOnHold/index.js",
30963 "groupTitle": "Voice_MOHs"
30967 "url": "/api/voice/mohs/{id}",
30968 "title": "Gets a single Music On Hold",
30971 "title": "Example usage:",
30972 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30976 "name": "ShowMusic_On_Holds",
30977 "group": "Voice_MOHs",
30978 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30979 "version": "0.0.0",
30980 "filename": "server/api/voiceMusicOnHold/index.js",
30981 "groupTitle": "Voice_MOHs"
30985 "url": "/api/voice/mohs/{id}",
30986 "title": "Update an existing Music On Hold",
30989 "title": "Example usage:",
30990 "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",
30994 "name": "updateMusic_On_Holds",
30995 "group": "Voice_MOHs",
30996 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30997 "version": "0.0.0",
30998 "filename": "server/api/voiceMusicOnHold/index.js",
30999 "groupTitle": "Voice_MOHs"
31003 "url": "/api/voice/mails",
31004 "title": "Creates a new Mail",
31007 "title": "Example usage:",
31008 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31012 "name": "CreateMails",
31013 "group": "Voice_Mails",
31021 "field": "customer_id",
31028 "field": "context",
31035 "field": "mailbox",
31042 "field": "password",
31049 "field": "fullname",
31099 "field": "dialout",
31106 "field": "callback",
31128 "field": "operator",
31139 "field": "envelope",
31150 "field": "sayduration",
31157 "field": "saydurationm",
31168 "field": "sendvoicemail",
31190 "field": "nextaftercmd",
31201 "field": "forcename",
31212 "field": "forcegreetings",
31223 "field": "hidefromdir",
31237 "field": "emailsubject",
31244 "field": "emailbody",
31251 "field": "maxsecs",
31271 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31272 "version": "0.0.0",
31273 "filename": "server/api/voiceMail/index.js",
31274 "groupTitle": "Voice_Mails"
31278 "url": "/api/voice/mails/{id}",
31279 "title": "Deletes a Mail",
31282 "title": "Example usage:",
31283 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31287 "name": "DeleteMails",
31288 "group": "Voice_Mails",
31289 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31290 "version": "0.0.0",
31291 "filename": "server/api/voiceMail/index.js",
31292 "groupTitle": "Voice_Mails"
31296 "url": "/api/voice/mails",
31297 "title": "Gets a list of Mails",
31300 "title": "Example usage:",
31301 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31305 "name": "GetMails",
31306 "group": "Voice_Mails",
31307 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31308 "version": "0.0.0",
31309 "filename": "server/api/voiceMail/index.js",
31310 "groupTitle": "Voice_Mails"
31314 "url": "/api/voice/mails/{id}",
31315 "title": "Gets a single Mail",
31318 "title": "Example usage:",
31319 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31323 "name": "ShowMails",
31324 "group": "Voice_Mails",
31325 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31326 "version": "0.0.0",
31327 "filename": "server/api/voiceMail/index.js",
31328 "groupTitle": "Voice_Mails"
31332 "url": "/api/voice/mails/{id}/messages",
31333 "title": "Gets voice mail messages",
31336 "title": "Example usage:",
31337 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31341 "name": "getMessages",
31342 "group": "Voice_Mails",
31343 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31344 "version": "0.0.0",
31345 "filename": "server/api/voiceMail/index.js",
31346 "groupTitle": "Voice_Mails"
31350 "url": "/api/voice/mails/{id}",
31351 "title": "Update an existing Mail",
31354 "title": "Example usage:",
31355 "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",
31359 "name": "updateMails",
31360 "group": "Voice_Mails",
31361 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31362 "version": "0.0.0",
31363 "filename": "server/api/voiceMail/index.js",
31364 "groupTitle": "Voice_Mails"
31368 "url": "/api/voice/mails/messages",
31369 "title": "Creates a new Message",
31372 "title": "Example usage:",
31373 "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",
31377 "name": "CreateMessages",
31378 "group": "Voice_Messages",
31407 "field": "context",
31414 "field": "macrocontext",
31421 "field": "callerid",
31428 "field": "origtime",
31435 "field": "duration",
31442 "field": "mailboxuser",
31449 "field": "mailboxcontext",
31456 "field": "recording",
31483 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31484 "version": "0.0.0",
31485 "filename": "server/api/voiceMailMessage/index.js",
31486 "groupTitle": "Voice_Messages"
31490 "url": "/api/voice/mails/messages/{id}",
31491 "title": "Deletes a Message",
31494 "title": "Example usage:",
31495 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31499 "name": "DeleteMessages",
31500 "group": "Voice_Messages",
31501 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31502 "version": "0.0.0",
31503 "filename": "server/api/voiceMailMessage/index.js",
31504 "groupTitle": "Voice_Messages"
31508 "url": "/api/voice/mails/messages",
31509 "title": "Gets a list of Messages",
31512 "title": "Example usage:",
31513 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31517 "name": "GetMessages",
31518 "group": "Voice_Messages",
31519 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31520 "version": "0.0.0",
31521 "filename": "server/api/voiceMailMessage/index.js",
31522 "groupTitle": "Voice_Messages"
31526 "url": "/api/voice/mails/messages/{id}",
31527 "title": "Gets a single Message",
31530 "title": "Example usage:",
31531 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31535 "name": "ShowMessages",
31536 "group": "Voice_Messages",
31537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31538 "version": "0.0.0",
31539 "filename": "server/api/voiceMailMessage/index.js",
31540 "groupTitle": "Voice_Messages"
31544 "url": "voice/mails/messages/{id}/download",
31545 "title": "Download Voice Message",
31548 "title": "Example usage:",
31549 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31553 "name": "download",
31554 "group": "Voice_Messages",
31555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31556 "version": "0.0.0",
31557 "filename": "server/api/voiceMailMessage/index.js",
31558 "groupTitle": "Voice_Messages"
31562 "url": "/api/voice/mails/messages/{id}",
31563 "title": "Update an existing Message",
31566 "title": "Example usage:",
31567 "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",
31571 "name": "updateMessages",
31572 "group": "Voice_Messages",
31573 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31574 "version": "0.0.0",
31575 "filename": "server/api/voiceMailMessage/index.js",
31576 "groupTitle": "Voice_Messages"
31580 "url": "/api/voice/prefixes/{id}/teams",
31581 "title": "Add teams to voice prefix",
31584 "title": "Example usage:",
31585 "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",
31589 "name": "AddTeams",
31590 "group": "Voice_Prefix",
31591 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31592 "version": "0.0.0",
31593 "filename": "server/api/voicePrefix/index.js",
31594 "groupTitle": "Voice_Prefix"
31598 "url": "/api/voice/prefixes/{id}/teams",
31599 "title": "Gets voice prefix team",
31602 "title": "Example usage:",
31603 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X GET",
31607 "name": "GetTeams",
31608 "group": "Voice_Prefix",
31609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31610 "version": "0.0.0",
31611 "filename": "server/api/voicePrefix/index.js",
31612 "groupTitle": "Voice_Prefix"
31616 "url": "/api/voice/prefixes/{id}/users",
31617 "title": "Add agents to a prefix",
31620 "title": "Example usage:",
31621 "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",
31625 "name": "AddAgents",
31626 "group": "Voice_Prefixes",
31627 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31628 "version": "0.0.0",
31629 "filename": "server/api/voicePrefix/index.js",
31630 "groupTitle": "Voice_Prefixes"
31634 "url": "/api/voice/prefixes/{id}",
31635 "title": "Deletes a Prefix",
31638 "title": "Example usage:",
31639 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31643 "name": "DeletePrefixes",
31644 "group": "Voice_Prefixes",
31645 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31646 "version": "0.0.0",
31647 "filename": "server/api/voicePrefix/index.js",
31648 "groupTitle": "Voice_Prefixes"
31652 "url": "/api/voice/prefixes/describe",
31653 "title": "Gets table info about Prefixes",
31656 "title": "Example usage:",
31657 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31661 "name": "DescribePrefixes",
31662 "group": "Voice_Prefixes",
31663 "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>",
31664 "version": "0.0.0",
31665 "filename": "server/api/voicePrefix/index.js",
31666 "groupTitle": "Voice_Prefixes"
31670 "url": "/api/voice/prefixes/{id}/users",
31671 "title": "Gets agents from prefix",
31674 "title": "Example usage:",
31675 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31679 "name": "GetAgents",
31680 "group": "Voice_Prefixes",
31681 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31682 "version": "0.0.0",
31683 "filename": "server/api/voicePrefix/index.js",
31684 "groupTitle": "Voice_Prefixes"
31688 "url": "/api/voice/prefixes",
31689 "title": "Gets a list of Prefixes",
31692 "title": "Example usage:",
31693 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31697 "name": "GetPrefixes",
31698 "group": "Voice_Prefixes",
31699 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31700 "version": "0.0.0",
31701 "filename": "server/api/voicePrefix/index.js",
31702 "groupTitle": "Voice_Prefixes"
31706 "url": "/api/voice/prefixes/{id}/users",
31707 "title": "Removes agents from a prefix",
31710 "title": "Example usage:",
31711 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31715 "name": "RemoveAgents",
31716 "group": "Voice_Prefixes",
31717 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31718 "version": "0.0.0",
31719 "filename": "server/api/voicePrefix/index.js",
31720 "groupTitle": "Voice_Prefixes"
31724 "url": "/api/voice/prefixes/{id}",
31725 "title": "Gets a single Prefix",
31728 "title": "Example usage:",
31729 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31733 "name": "ShowPrefixes",
31734 "group": "Voice_Prefixes",
31735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31736 "version": "0.0.0",
31737 "filename": "server/api/voicePrefix/index.js",
31738 "groupTitle": "Voice_Prefixes"
31742 "url": "/api/voice/prefixes/{id}",
31743 "title": "Update an existing prefix",
31746 "title": "Example usage:",
31747 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31752 "group": "Voice_Prefixes",
31753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31754 "version": "0.0.0",
31755 "filename": "server/api/voicePrefix/index.js",
31756 "groupTitle": "Voice_Prefixes"
31760 "url": "/api/voice/prefixes",
31761 "title": "Create a prefix",
31764 "title": "Example usage:",
31765 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31770 "group": "Voice_Prefixes",
31771 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31772 "version": "0.0.0",
31773 "filename": "server/api/voicePrefix/index.js",
31774 "groupTitle": "Voice_Prefixes"
31778 "url": "/api/voice/queues/reports/describe",
31779 "title": "Gets table info about Queue Reports",
31782 "title": "Example usage:",
31783 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31787 "name": "DescribeQueue_Reports",
31788 "group": "Voice_Queue_Reports",
31789 "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>",
31790 "version": "0.0.0",
31791 "filename": "server/api/voiceQueueReport/index.js",
31792 "groupTitle": "Voice_Queue_Reports"
31796 "url": "/api/voice/queues/reports",
31797 "title": "Gets a list of Queue Reports",
31800 "title": "Example usage:",
31801 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31805 "name": "GetQueue_Reports",
31806 "group": "Voice_Queue_Reports",
31807 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31808 "version": "0.0.0",
31809 "filename": "server/api/voiceQueueReport/index.js",
31810 "groupTitle": "Voice_Queue_Reports"
31814 "url": "/api/voice/queues/reports/{id}",
31815 "title": "Gets a single Queue Report",
31818 "title": "Example usage:",
31819 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31823 "name": "ShowQueue_Reports",
31824 "group": "Voice_Queue_Reports",
31825 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31826 "version": "0.0.0",
31827 "filename": "server/api/voiceQueueReport/index.js",
31828 "groupTitle": "Voice_Queue_Reports"
31832 "url": "/api/voice/queues/reports/index",
31833 "title": "Get Voice Queues Report",
31836 "title": "Example usage:",
31837 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31841 "name": "getVoiceQueuesReport",
31842 "group": "Voice_Queue_Reports",
31843 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31844 "version": "0.0.0",
31845 "filename": "server/api/voiceQueueReport/index.js",
31846 "groupTitle": "Voice_Queue_Reports"
31850 "url": "/api/voice/queues/{id}/users",
31851 "title": "Add agents to queue",
31854 "title": "Example usage:",
31855 "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",
31859 "name": "AddAgents",
31860 "group": "Voice_Queues",
31861 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31862 "version": "0.0.0",
31863 "filename": "server/api/voiceQueue/index.js",
31864 "groupTitle": "Voice_Queues"
31868 "url": "/api/voice/queues/{id}/blacklists",
31869 "title": "Add blacklists to a queue",
31872 "title": "Example usage:",
31873 "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",
31877 "name": "AddBlackLists",
31878 "group": "Voice_Queues",
31879 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31880 "version": "0.0.0",
31881 "filename": "server/api/voiceQueue/index.js",
31882 "groupTitle": "Voice_Queues"
31886 "url": "/api/voice/queues/{id}/lists",
31887 "title": "Add lists to a queue",
31890 "title": "Example usage:",
31891 "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",
31895 "name": "AddLists",
31896 "group": "Voice_Queues",
31897 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31898 "version": "0.0.0",
31899 "filename": "server/api/voiceQueue/index.js",
31900 "groupTitle": "Voice_Queues"
31904 "url": "/api/voice/queues/{id}/teams",
31905 "title": "Add teams to queue",
31908 "title": "Example usage:",
31909 "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",
31913 "name": "AddTeams",
31914 "group": "Voice_Queues",
31915 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31916 "version": "0.0.0",
31917 "filename": "server/api/voiceQueue/index.js",
31918 "groupTitle": "Voice_Queues"
31922 "url": "/api/voice/queues/clone",
31923 "title": "Clone an existing Queue",
31926 "title": "Example usage:",
31927 "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",
31931 "name": "CloneQueues",
31932 "group": "Voice_Queues",
31933 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31934 "version": "0.0.0",
31935 "filename": "server/api/voiceQueue/index.js",
31936 "groupTitle": "Voice_Queues"
31940 "url": "/api/voice/queues",
31941 "title": "Creates a new Queue",
31944 "title": "Example usage:",
31945 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31949 "name": "CreateQueues",
31950 "group": "Voice_Queues",
31976 "field": "musiconhold",
31983 "field": "announce",
32001 "field": "strategy",
32008 "field": "servicelevel",
32015 "field": "context",
32022 "field": "penaltymemberslimit",
32029 "field": "timeout",
32043 "field": "timeoutpriority",
32057 "field": "wrapuptime",
32068 "field": "autofill",
32080 "field": "autopause",
32087 "field": "autopausedelay",
32098 "field": "autopausebusy",
32109 "field": "autopauseunavail",
32127 "field": "setinterfacevar",
32138 "field": "setqueueentryvar",
32149 "field": "setqueuevar",
32160 "field": "eventmemberstatus",
32167 "field": "membermacro",
32174 "field": "membergosub",
32181 "field": "announce_frequency",
32188 "field": "min_announce_frequency",
32195 "field": "periodic_announce_frequency",
32206 "field": "random_periodic_announce",
32217 "field": "relative_periodic_announce",
32229 "field": "announce_holdtime",
32236 "field": "announce_position",
32247 "field": "announce_to_first_user",
32254 "field": "announce_position_limit",
32269 "field": "announce_round_seconds",
32276 "field": "monitor_format",
32283 "field": "monitor_type",
32290 "field": "queue_youarenext",
32297 "field": "queue_thereare",
32304 "field": "queue_callswaiting",
32311 "field": "queue_holdtime",
32318 "field": "queue_minute",
32325 "field": "queue_minutes",
32332 "field": "queue_seconds",
32339 "field": "queue_thankyou",
32346 "field": "queue_reporthold",
32353 "field": "queue_quantity1",
32360 "field": "queue_quantity2",
32367 "field": "queue_periodic_announce",
32374 "field": "queue_less_than",
32381 "field": "periodic_announce",
32388 "field": "joinempty",
32395 "field": "leavewhenempty",
32406 "field": "reportholdtime",
32417 "field": "ringinuse",
32424 "field": "memberdelay",
32435 "field": "timeoutrestart",
32442 "field": "defaultrule",
32449 "field": "description",
32463 "field": "acwTimeout",
32470 "field": "dialActive",
32471 "description": "<p>Active/Disactive Campaign</p>"
32484 "field": "dialMethod",
32485 "description": "<p>Dial Method.</p>"
32491 "field": "dialLimitChannel",
32492 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32498 "field": "dialLimitQueue",
32499 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32505 "field": "dialPowerLevel",
32506 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32512 "\"agentBusyFactor\"",
32516 "field": "dialPredictiveOptimization",
32517 "description": "<p>Only for predictive method.</p>"
32523 "field": "dialPredictiveOptimizationPercentage",
32524 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32530 "field": "dialPredictiveInterval",
32531 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32537 "field": "dialOriginateCallerIdName",
32544 "field": "dialOriginateCallerIdNumber",
32551 "field": "dialOriginateTimeout",
32552 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32558 "field": "dialQueueOptions",
32559 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32565 "field": "dialQueueTimeout",
32566 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32572 "field": "dialQueueProject",
32573 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32579 "field": "dialCongestionMaxRetry",
32580 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32586 "field": "dialCongestionRetryFrequency",
32587 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32593 "field": "dialBusyMaxRetry",
32594 "description": "<p>#Busy Retry (min:1, max:999)</p>"
32600 "field": "dialBusyRetryFrequency",
32601 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32607 "field": "dialNoAnswerMaxRetry",
32608 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32614 "field": "dialNoAnswerRetryFrequency",
32615 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32621 "field": "dialGlobalMaxRetry",
32622 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32628 "field": "dialTimezone",
32635 "field": "dialGlobalInterval",
32642 "field": "dialPrefix",
32654 "field": "dialCheckDuplicateType",
32661 "field": "dialAMDActive",
32662 "description": "<p>Active/Disactive AMD</p>"
32668 "field": "dialAMDInitialSilence",
32669 "description": "<p>#AMD Initial Silence</p>"
32675 "field": "dialAMDGreeting",
32676 "description": "<p>#AMD Greeting</p>"
32682 "field": "dialAMDAfterGreetingSilence",
32683 "description": "<p>#AMD After Greeting Silence</p>"
32689 "field": "dialAMDTotalAnalysisTime",
32690 "description": "<p>#AMD Total Analysis Time</p>"
32696 "field": "dialAMDMinWordLength",
32697 "description": "<p>#AMD Min Word Length</p>"
32703 "field": "dialAMDBetweenWordsSilence",
32704 "description": "<p>#AMD Between Words Silence</p>"
32710 "field": "dialAMDMaximumNumberOfWords",
32711 "description": "<p>#AMD Maximum Number Of Words</p>"
32717 "field": "dialAMDSilenceThreshold",
32718 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32724 "field": "dialAMDMaximumWordLength",
32725 "description": "<p>#AMD Maximum Word Length</p>"
32731 "field": "dialRecallMeTimeout",
32732 "description": "<p>#RecallMe Timeout (min:1)</p>"
32738 "field": "dialRecallInQueue",
32739 "description": "<p>Active/Disactive Recall In Queue</p>"
32749 "field": "dialOrderByScheduledAt",
32756 "field": "dialQueueProject2",
32757 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32763 "field": "dialAgiAfterHangupClient",
32770 "field": "dialAgiAfterHangupAgent",
32777 "field": "dialRandomLastDigitCallerIdNumber",
32778 "description": "<p>Random Last Digit (min:1, max:15)</p>"
32784 "field": "dialCutDigit",
32785 "description": "<p>Cut Digit (min:1, max:15)</p>"
32791 "field": "dialNoSuchNumberMaxRetry",
32792 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32798 "field": "dialNoSuchNumberRetryFrequency",
32799 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32805 "field": "dialDropMaxRetry",
32806 "description": "<p>#Drop Retry (min:1, max:999)</p>"
32812 "field": "dialDropRetryFrequency",
32813 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32819 "field": "dialAbandonedMaxRetry",
32820 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32826 "field": "dialAbandonedRetryFrequency",
32827 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32833 "field": "dialMachineMaxRetry",
32834 "description": "<p>#Machine Retry (min:1, max:999)</p>"
32840 "field": "dialMachineRetryFrequency",
32841 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32847 "field": "dialAgentRejectMaxRetry",
32848 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32854 "field": "dialAgentRejectRetryFrequency",
32855 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32861 "field": "mandatoryDispositionPauseId",
32862 "description": "<p>Status to put when mandatory disposition is enabled</p>"
32868 "field": "mandatoryDisposition",
32869 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32875 "field": "dialPredictiveIntervalMaxThreshold",
32882 "field": "dialPredictiveIntervalMinThreshold",
32889 "field": "dialPreviewAutoRecallMe",
32895 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32896 "version": "0.0.0",
32897 "filename": "server/api/voiceQueue/index.js",
32898 "groupTitle": "Voice_Queues"
32902 "url": "/api/voice/queues/{id}",
32903 "title": "Deletes a Queue",
32906 "title": "Example usage:",
32907 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32911 "name": "DeleteQueues",
32912 "group": "Voice_Queues",
32913 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32914 "version": "0.0.0",
32915 "filename": "server/api/voiceQueue/index.js",
32916 "groupTitle": "Voice_Queues"
32920 "url": "/api/voice/queues/{id}/users",
32921 "title": "Gets queue agents",
32924 "title": "Example usage:",
32925 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32929 "name": "GetAgents",
32930 "group": "Voice_Queues",
32931 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32932 "version": "0.0.0",
32933 "filename": "server/api/voiceQueue/index.js",
32934 "groupTitle": "Voice_Queues"
32938 "url": "/api/voice/queues/{id}/blacklists",
32939 "title": "Get queue blacklists",
32942 "title": "Example usage:",
32943 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32947 "name": "GetBlackLists",
32948 "group": "Voice_Queues",
32949 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32950 "version": "0.0.0",
32951 "filename": "server/api/voiceQueue/index.js",
32952 "groupTitle": "Voice_Queues"
32956 "url": "/api/voice/queues/{id}/finals",
32957 "title": "Gets queue hopper finals",
32960 "title": "Example usage:",
32961 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
32965 "name": "GetHopperFinals",
32966 "group": "Voice_Queues",
32967 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32968 "version": "0.0.0",
32969 "filename": "server/api/voiceQueue/index.js",
32970 "groupTitle": "Voice_Queues"
32974 "url": "/api/voice/queues/{id}/hopper_histories",
32975 "title": "Gets queue hopper histories",
32978 "title": "Example usage:",
32979 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32983 "name": "GetHopperHistories",
32984 "group": "Voice_Queues",
32985 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32986 "version": "0.0.0",
32987 "filename": "server/api/voiceQueue/index.js",
32988 "groupTitle": "Voice_Queues"
32992 "url": "/api/voice/queues/{id}/hoppers",
32993 "title": "Gets queue hoppers",
32996 "title": "Example usage:",
32997 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33001 "name": "GetHoppers",
33002 "group": "Voice_Queues",
33003 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33004 "version": "0.0.0",
33005 "filename": "server/api/voiceQueue/index.js",
33006 "groupTitle": "Voice_Queues"
33010 "url": "/api/voice/queues/{id}/lists",
33011 "title": "Get queue lists",
33014 "title": "Example usage:",
33015 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33019 "name": "GetLists",
33020 "group": "Voice_Queues",
33021 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33022 "version": "0.0.0",
33023 "filename": "server/api/voiceQueue/index.js",
33024 "groupTitle": "Voice_Queues"
33028 "url": "/api/voice/queues/{id}/members",
33029 "title": "Gets queue members",
33032 "title": "Example usage:",
33033 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33037 "name": "GetMembers",
33038 "group": "Voice_Queues",
33039 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33040 "version": "0.0.0",
33041 "filename": "server/api/voiceQueue/index.js",
33042 "groupTitle": "Voice_Queues"
33046 "url": "/api/voice/queues",
33047 "title": "Gets a list of Queues",
33050 "title": "Example usage:",
33051 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33055 "name": "GetQueues",
33056 "group": "Voice_Queues",
33057 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33058 "version": "0.0.0",
33059 "filename": "server/api/voiceQueue/index.js",
33060 "groupTitle": "Voice_Queues"
33064 "url": "/api/voice/queues/{id}/teams",
33065 "title": "Gets queue team",
33068 "title": "Example usage:",
33069 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
33073 "name": "GetTeams",
33074 "group": "Voice_Queues",
33075 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33076 "version": "0.0.0",
33077 "filename": "server/api/voiceQueue/index.js",
33078 "groupTitle": "Voice_Queues"
33082 "url": "/api/voice/queues/{id}/users",
33083 "title": "Removes agents from a queue",
33086 "title": "Example usage:",
33087 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33091 "name": "RemoveAgents",
33092 "group": "Voice_Queues",
33093 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33094 "version": "0.0.0",
33095 "filename": "server/api/voiceQueue/index.js",
33096 "groupTitle": "Voice_Queues"
33100 "url": "/api/voice/queues/{id}/blacklists",
33101 "title": "Remove blacklists from a queue",
33104 "title": "Example usage:",
33105 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33109 "name": "RemoveBlackLists",
33110 "group": "Voice_Queues",
33111 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33112 "version": "0.0.0",
33113 "filename": "server/api/voiceQueue/index.js",
33114 "groupTitle": "Voice_Queues"
33118 "url": "/api/voice/queues/{id}/lists",
33119 "title": "Remove lists from a queue",
33122 "title": "Example usage:",
33123 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33127 "name": "RemoveLists",
33128 "group": "Voice_Queues",
33129 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33130 "version": "0.0.0",
33131 "filename": "server/api/voiceQueue/index.js",
33132 "groupTitle": "Voice_Queues"
33136 "url": "/api/voice/queues/{id}",
33137 "title": "Gets a single Queue",
33140 "title": "Example usage:",
33141 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33145 "name": "ShowQueues",
33146 "group": "Voice_Queues",
33147 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33148 "version": "0.0.0",
33149 "filename": "server/api/voiceQueue/index.js",
33150 "groupTitle": "Voice_Queues"
33154 "url": "/api/voice/queues/{id}/blacks",
33155 "title": "Gets queue hopper blacks",
33158 "title": "Example usage:",
33159 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
33163 "name": "getHopperBlacks",
33164 "group": "Voice_Queues",
33165 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33166 "version": "0.0.0",
33167 "filename": "server/api/voiceQueue/index.js",
33168 "groupTitle": "Voice_Queues"
33172 "url": "/api/voice/queues/{id}",
33173 "title": "Update an existing Queue",
33176 "title": "Example usage:",
33177 "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",
33181 "name": "updateQueues",
33182 "group": "Voice_Queues",
33183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33184 "version": "0.0.0",
33185 "filename": "server/api/voiceQueue/index.js",
33186 "groupTitle": "Voice_Queues"
33190 "url": "/api/voice/recordings",
33191 "title": "Creates a new Recording",
33194 "title": "Example usage:",
33195 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33199 "name": "CreateRecordings",
33200 "group": "Voice_Recordings",
33215 "field": "uniqueid",
33222 "field": "channel",
33229 "field": "membername",
33236 "field": "calleridnum",
33243 "field": "calleridname",
33250 "field": "connectedlinenum",
33257 "field": "connectedlinename",
33264 "field": "accountcode",
33271 "field": "context",
33313 "field": "userDisposition",
33320 "field": "userSecondDisposition",
33327 "field": "userThirdDisposition",
33334 "field": "location",
33341 "field": "transcribeName",
33348 "field": "transcribeStatus",
33355 "field": "fileUri",
33362 "field": "fileText",
33369 "field": "failureReason",
33376 "field": "sentiment",
33383 "field": "sPositive",
33390 "field": "sNegative",
33397 "field": "sNeutral",
33411 "field": "tempSentiment",
33418 "field": "createdAt",
33425 "field": "updatedAt",
33431 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33432 "version": "0.0.0",
33433 "filename": "server/api/voiceRecording/index.js",
33434 "groupTitle": "Voice_Recordings"
33438 "url": "/api/voice/recordings/describe",
33439 "title": "Gets table info about Recordings",
33442 "title": "Example usage:",
33443 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33447 "name": "DescribeRecordings",
33448 "group": "Voice_Recordings",
33449 "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>",
33450 "version": "0.0.0",
33451 "filename": "server/api/voiceRecording/index.js",
33452 "groupTitle": "Voice_Recordings"
33456 "url": "/api/voice/recordings",
33457 "title": "Gets a list of Recordings",
33460 "title": "Example usage:",
33461 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33465 "name": "GetRecordings",
33466 "group": "Voice_Recordings",
33467 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33468 "version": "0.0.0",
33469 "filename": "server/api/voiceRecording/index.js",
33470 "groupTitle": "Voice_Recordings"
33474 "url": "/api/voice/recordings/{id}",
33475 "title": "Gets a single Recording",
33478 "title": "Example usage:",
33479 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33483 "name": "ShowRecordings",
33484 "group": "Voice_Recordings",
33485 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33486 "version": "0.0.0",
33487 "filename": "server/api/voiceRecording/index.js",
33488 "groupTitle": "Voice_Recordings"
33492 "url": "/api/voice/recordings/{id}",
33493 "title": "Delete voice recording",
33496 "title": "Example usage:",
33497 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33502 "group": "Voice_Recordings",
33503 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33504 "version": "0.0.0",
33505 "filename": "server/api/voiceRecording/index.js",
33506 "groupTitle": "Voice_Recordings"
33510 "url": "/api/voice/recordings/{id}/download",
33511 "title": "Download Recording",
33514 "title": "Example usage:",
33515 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33519 "name": "download",
33520 "group": "Voice_Recordings",
33521 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33522 "version": "0.0.0",
33523 "filename": "server/api/voiceRecording/index.js",
33524 "groupTitle": "Voice_Recordings"
33528 "url": "/api/voice/recordings/{id}/downloads",
33529 "title": "Download Recording",
33532 "title": "Example usage:",
33533 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33537 "name": "downloads",
33538 "group": "Voice_Recordings",
33539 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33540 "version": "0.0.0",
33541 "filename": "server/api/voiceRecording/index.js",
33542 "groupTitle": "Voice_Recordings"
33546 "url": "/api/voice/recordings/{id}/transcribe",
33547 "title": "Run Transcribe Recording",
33550 "title": "Example usage:",
33551 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33555 "name": "transcribe",
33556 "group": "Voice_Recordings",
33557 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33558 "version": "0.0.0",
33559 "filename": "server/api/voiceRecording/index.js",
33560 "groupTitle": "Voice_Recordings"
33564 "url": "/api/voice/recordings/{id}/transcribe",
33565 "title": "Run Transcribe Recording",
33568 "title": "Example usage:",
33569 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33573 "name": "transcribe",
33574 "group": "Voice_Recordings",
33575 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33576 "version": "0.0.0",
33577 "filename": "server/api/voiceRecording/index.js",
33578 "groupTitle": "Voice_Recordings"
33582 "url": "/api/voice/recordings/{id}",
33583 "title": "Update an existing Recording",
33586 "title": "Example usage:",
33587 "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",
33591 "name": "updateRecordings",
33592 "group": "Voice_Recordings",
33593 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33594 "version": "0.0.0",
33595 "filename": "server/api/voiceRecording/index.js",
33596 "groupTitle": "Voice_Recordings"
33600 "url": "/api/voice/transfers/reports",
33601 "title": "Creates a new Transfer Report",
33604 "title": "Example usage:",
33605 "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",
33609 "name": "CreateTransfer_Reports",
33610 "group": "Voice_Transfer_Reports",
33636 "field": "transfererchannel",
33643 "field": "transferercalleridnum",
33650 "field": "transferercalleridname",
33657 "field": "transfererconnectedlinenum",
33664 "field": "transfererconnectedlinename",
33671 "field": "transfereraccountcode",
33678 "field": "transferercontext",
33685 "field": "transfererexten",
33692 "field": "transfererlinkedid",
33699 "field": "transfereechannel",
33706 "field": "transfereecalleridnum",
33713 "field": "transfereecalleridname",
33720 "field": "transfereeconnectedlinenum",
33727 "field": "transfereeconnectedlinename",
33734 "field": "transfereeaccountcode",
33741 "field": "transfereecontext",
33748 "field": "transfereeexten",
33755 "field": "transfereelinkedid",
33766 "field": "isexternal",
33773 "field": "context",
33780 "field": "extension",
33786 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33787 "version": "0.0.0",
33788 "filename": "server/api/voiceTransferReport/index.js",
33789 "groupTitle": "Voice_Transfer_Reports"
33793 "url": "/api/voice/transfers/reports/{id}",
33794 "title": "Deletes a Transfer Report",
33797 "title": "Example usage:",
33798 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33802 "name": "DeleteTransfer_Reports",
33803 "group": "Voice_Transfer_Reports",
33804 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33805 "version": "0.0.0",
33806 "filename": "server/api/voiceTransferReport/index.js",
33807 "groupTitle": "Voice_Transfer_Reports"
33811 "url": "/api/voice/transfers/reports/describe",
33812 "title": "Gets table info about Transfer Reports",
33815 "title": "Example usage:",
33816 "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33820 "name": "DescribeTransfer_Reports",
33821 "group": "Voice_Transfer_Reports",
33822 "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>",
33823 "version": "0.0.0",
33824 "filename": "server/api/voiceTransferReport/index.js",
33825 "groupTitle": "Voice_Transfer_Reports"
33829 "url": "/api/voice/transfers/reports",
33830 "title": "Gets a list of Transfer Reports",
33833 "title": "Example usage:",
33834 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33838 "name": "GetTransfer_Reports",
33839 "group": "Voice_Transfer_Reports",
33840 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33841 "version": "0.0.0",
33842 "filename": "server/api/voiceTransferReport/index.js",
33843 "groupTitle": "Voice_Transfer_Reports"
33847 "url": "/api/voice/transfers/reports/{id}",
33848 "title": "Gets a single Transfer Report",
33851 "title": "Example usage:",
33852 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33856 "name": "ShowTransfer_Reports",
33857 "group": "Voice_Transfer_Reports",
33858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33859 "version": "0.0.0",
33860 "filename": "server/api/voiceTransferReport/index.js",
33861 "groupTitle": "Voice_Transfer_Reports"
33865 "url": "/api/voice/transfers/reports/{id}",
33866 "title": "Update an existing Transfer Report",
33869 "title": "Example usage:",
33870 "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",
33874 "name": "updateTransfer_Reports",
33875 "group": "Voice_Transfer_Reports",
33876 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33877 "version": "0.0.0",
33878 "filename": "server/api/voiceTransferReport/index.js",
33879 "groupTitle": "Voice_Transfer_Reports"
33883 "url": "/api/integrations/vtiger/accounts",
33884 "title": "Creates a new Vtiger Account",
33887 "title": "Example usage:",
33888 "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",
33892 "name": "CreateVtiger_Accounts",
33893 "group": "Vtiger_Accounts",
33908 "field": "description",
33915 "field": "username",
33922 "field": "moduleName",
33929 "field": "remoteUri",
33936 "field": "serverUrl",
33943 "field": "accessKey",
33949 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33950 "version": "0.0.0",
33951 "filename": "server/api/intVtigerAccount/index.js",
33952 "groupTitle": "Vtiger_Accounts"
33956 "url": "/api/integrations/vtiger/accounts/{id}",
33957 "title": "Deletes a Vtiger Account",
33960 "title": "Example usage:",
33961 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33965 "name": "DeleteVtiger_Accounts",
33966 "group": "Vtiger_Accounts",
33967 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33968 "version": "0.0.0",
33969 "filename": "server/api/intVtigerAccount/index.js",
33970 "groupTitle": "Vtiger_Accounts"
33974 "url": "/api/integrations/vtiger/accounts",
33975 "title": "Gets a list of Vtiger Accounts",
33978 "title": "Example usage:",
33979 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33983 "name": "GetVtiger_Accounts",
33984 "group": "Vtiger_Accounts",
33985 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33986 "version": "0.0.0",
33987 "filename": "server/api/intVtigerAccount/index.js",
33988 "groupTitle": "Vtiger_Accounts"
33992 "url": "/api/integrations/vtiger/accounts/{id}",
33993 "title": "Gets a single Vtiger Account",
33996 "title": "Example usage:",
33997 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34001 "name": "ShowVtiger_Accounts",
34002 "group": "Vtiger_Accounts",
34003 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34004 "version": "0.0.0",
34005 "filename": "server/api/intVtigerAccount/index.js",
34006 "groupTitle": "Vtiger_Accounts"
34010 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34011 "title": "Creates new configuration",
34014 "title": "Example usage:",
34015 "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",
34019 "name": "addConfiguration",
34020 "group": "Vtiger_Accounts",
34021 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34022 "version": "0.0.0",
34023 "filename": "server/api/intVtigerAccount/index.js",
34024 "groupTitle": "Vtiger_Accounts"
34028 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34029 "title": "Gets account configurations",
34032 "title": "Example usage:",
34033 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34037 "name": "getConfigurations",
34038 "group": "Vtiger_Accounts",
34039 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34040 "version": "0.0.0",
34041 "filename": "server/api/intVtigerAccount/index.js",
34042 "groupTitle": "Vtiger_Accounts"
34046 "url": "/api/integrations/vtiger/accounts/{id}/fields",
34047 "title": "Gets account fields",
34050 "title": "Example usage:",
34051 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34055 "name": "getFields",
34056 "group": "Vtiger_Accounts",
34057 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34058 "version": "0.0.0",
34059 "filename": "server/api/intVtigerAccount/index.js",
34060 "groupTitle": "Vtiger_Accounts"
34064 "url": "/api/integrations/vtiger/accounts/{id}",
34065 "title": "Update an existing Vtiger Account",
34068 "title": "Example usage:",
34069 "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",
34073 "name": "updateVtiger_Accounts",
34074 "group": "Vtiger_Accounts",
34075 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34076 "version": "0.0.0",
34077 "filename": "server/api/intVtigerAccount/index.js",
34078 "groupTitle": "Vtiger_Accounts"
34082 "url": "/api/integrations/vtiger/configurations",
34083 "title": "Creates a new Vtiger Configuration",
34086 "title": "Example usage:",
34087 "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",
34091 "name": "CreateVtiger_Configurations",
34092 "group": "Vtiger_Configurations",
34107 "field": "description",
34113 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34114 "version": "0.0.0",
34115 "filename": "server/api/intVtigerConfiguration/index.js",
34116 "groupTitle": "Vtiger_Configurations"
34120 "url": "/api/integrations/vtiger/configurations/{id}",
34121 "title": "Deletes a Vtiger Configuration",
34124 "title": "Example usage:",
34125 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34129 "name": "DeleteVtiger_Configurations",
34130 "group": "Vtiger_Configurations",
34131 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34132 "version": "0.0.0",
34133 "filename": "server/api/intVtigerConfiguration/index.js",
34134 "groupTitle": "Vtiger_Configurations"
34138 "url": "/api/integrations/vtiger/configurations",
34139 "title": "Gets a list of Vtiger Configurations",
34142 "title": "Example usage:",
34143 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34147 "name": "GetVtiger_Configurations",
34148 "group": "Vtiger_Configurations",
34149 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34150 "version": "0.0.0",
34151 "filename": "server/api/intVtigerConfiguration/index.js",
34152 "groupTitle": "Vtiger_Configurations"
34156 "url": "/api/integrations/vtiger/configurations/{id}",
34157 "title": "Gets a single Vtiger Configuration",
34160 "title": "Example usage:",
34161 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34165 "name": "ShowVtiger_Configurations",
34166 "group": "Vtiger_Configurations",
34167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34168 "version": "0.0.0",
34169 "filename": "server/api/intVtigerConfiguration/index.js",
34170 "groupTitle": "Vtiger_Configurations"
34174 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34175 "title": "Gets configurations descriptions",
34178 "title": "Example usage:",
34179 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34183 "name": "getDescriptions",
34184 "group": "Vtiger_Configurations",
34185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34186 "version": "0.0.0",
34187 "filename": "server/api/intVtigerConfiguration/index.js",
34188 "groupTitle": "Vtiger_Configurations"
34192 "url": "/api/integrations/vtiger/configurations/{id}/fields",
34193 "title": "Gets configurations fields",
34196 "title": "Example usage:",
34197 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34201 "name": "getFields",
34202 "group": "Vtiger_Configurations",
34203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34204 "version": "0.0.0",
34205 "filename": "server/api/intVtigerConfiguration/index.js",
34206 "groupTitle": "Vtiger_Configurations"
34210 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34211 "title": "Gets configurations subjects",
34214 "title": "Example usage:",
34215 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34219 "name": "getSubjects",
34220 "group": "Vtiger_Configurations",
34221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34222 "version": "0.0.0",
34223 "filename": "server/api/intVtigerConfiguration/index.js",
34224 "groupTitle": "Vtiger_Configurations"
34228 "url": "/api/integrations/vtiger/configurations/{id}",
34229 "title": "Update an existing Vtiger Configuration",
34232 "title": "Example usage:",
34233 "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",
34237 "name": "updateVtiger_Configurations",
34238 "group": "Vtiger_Configurations",
34239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34240 "version": "0.0.0",
34241 "filename": "server/api/intVtigerConfiguration/index.js",
34242 "groupTitle": "Vtiger_Configurations"
34246 "url": "/api/integrations/vtiger/fields",
34247 "title": "Creates a new Vtiger Field",
34250 "title": "Example usage:",
34251 "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",
34255 "name": "CreateVtiger_Fields",
34256 "group": "Vtiger_Fields",
34266 "\"customVariable\"",
34278 "field": "content",
34294 "\"customVariable\""
34297 "field": "keyType",
34304 "field": "keyContent",
34311 "field": "idField",
34318 "field": "nameField",
34325 "field": "customField",
34332 "field": "variableName",
34338 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34339 "version": "0.0.0",
34340 "filename": "server/api/intVtigerField/index.js",
34341 "groupTitle": "Vtiger_Fields"
34345 "url": "/api/integrations/vtiger/fields/{id}",
34346 "title": "Deletes a Vtiger Field",
34349 "title": "Example usage:",
34350 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34354 "name": "DeleteVtiger_Fields",
34355 "group": "Vtiger_Fields",
34356 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34357 "version": "0.0.0",
34358 "filename": "server/api/intVtigerField/index.js",
34359 "groupTitle": "Vtiger_Fields"
34363 "url": "/api/integrations/vtiger/fields",
34364 "title": "Gets a list of Vtiger Fields",
34367 "title": "Example usage:",
34368 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34372 "name": "GetVtiger_Fields",
34373 "group": "Vtiger_Fields",
34374 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34375 "version": "0.0.0",
34376 "filename": "server/api/intVtigerField/index.js",
34377 "groupTitle": "Vtiger_Fields"
34381 "url": "/api/integrations/vtiger/fields/{id}",
34382 "title": "Gets a single Vtiger Field",
34385 "title": "Example usage:",
34386 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34390 "name": "ShowVtiger_Fields",
34391 "group": "Vtiger_Fields",
34392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34393 "version": "0.0.0",
34394 "filename": "server/api/intVtigerField/index.js",
34395 "groupTitle": "Vtiger_Fields"
34399 "url": "/api/integrations/vtiger/fields/{id}",
34400 "title": "Update an existing Vtiger Field",
34403 "title": "Example usage:",
34404 "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",
34408 "name": "updateVtiger_Fields",
34409 "group": "Vtiger_Fields",
34410 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34411 "version": "0.0.0",
34412 "filename": "server/api/intVtigerField/index.js",
34413 "groupTitle": "Vtiger_Fields"
34417 "url": "/api/webbar/answer",
34418 "title": "answer webrtc call",
34421 "title": "Example usage:",
34422 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34426 "name": "Web_Bar_answer",
34435 "field": "sessionId",
34448 "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>",
34449 "version": "0.0.0",
34450 "filename": "server/api/webbar/index.js",
34451 "groupTitle": "WebBar"
34455 "url": "/api/webbar/calls",
34456 "title": "webrtc call list",
34459 "title": "Example usage:",
34460 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34464 "name": "Web_Bar_calls",
34479 "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>",
34480 "version": "0.0.0",
34481 "filename": "server/api/webbar/index.js",
34482 "groupTitle": "WebBar"
34486 "url": "/api/webbar/hangup",
34487 "title": "hangup webrtc call",
34490 "title": "Example usage:",
34491 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34495 "name": "Web_Bar_hangup",
34504 "field": "sessionId",
34517 "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>",
34518 "version": "0.0.0",
34519 "filename": "server/api/webbar/index.js",
34520 "groupTitle": "WebBar"
34524 "url": "/api/webbar/unhold",
34525 "title": "unhold webrtc call",
34528 "title": "Example usage:",
34529 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34533 "name": "Web_Bar_hold",
34542 "field": "sessionId",
34555 "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>",
34556 "version": "0.0.0",
34557 "filename": "server/api/webbar/index.js",
34558 "groupTitle": "WebBar"
34562 "url": "/api/webbar/hold",
34563 "title": "hold webrtc call",
34566 "title": "Example usage:",
34567 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34571 "name": "Web_Bar_hold",
34580 "field": "sessionId",
34593 "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>",
34594 "version": "0.0.0",
34595 "filename": "server/api/webbar/index.js",
34596 "groupTitle": "WebBar"
34600 "url": "/api/webbar/originate",
34601 "title": "Originate new webrtc call",
34604 "title": "Example usage:",
34605 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34609 "name": "Web_Bar_originate",
34618 "field": "callNumber",
34632 "field": "callerId",
34639 "field": "callbackUrl",
34645 "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>",
34646 "version": "0.0.0",
34647 "filename": "server/api/webbar/index.js",
34648 "groupTitle": "WebBar"
34652 "url": "/api/webbar/transfer",
34653 "title": "blind transfer webrtc call",
34656 "title": "Example usage:",
34657 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34661 "name": "Web_Bar_transfer",
34677 "field": "sessionId",
34684 "field": "transferNumber",
34690 "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>",
34691 "version": "0.0.0",
34692 "filename": "server/api/webbar/index.js",
34693 "groupTitle": "WebBar"
34697 "url": "/api/whatsapp/accounts/{id}/users",
34698 "title": "Add agents to a whatsapp account",
34701 "title": "Example usage:",
34702 "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",
34706 "name": "AddAgents",
34707 "group": "Whatsapp_Accounts",
34708 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34709 "version": "0.0.0",
34710 "filename": "server/api/whatsappAccount/index.js",
34711 "groupTitle": "Whatsapp_Accounts"
34715 "url": "/api/whatsapp/accounts",
34716 "title": "Creates a new Account",
34719 "title": "Example usage:",
34720 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34724 "name": "CreateAccounts",
34725 "group": "Whatsapp_Accounts",
34778 "field": "accountSid",
34785 "field": "authToken",
34792 "field": "notificationTemplate",
34799 "field": "notificationSound",
34806 "field": "notificationShake",
34813 "field": "waitForTheAssignedAgent",
34820 "field": "queueTransfer",
34827 "field": "queueTransferTimeout",
34834 "field": "agentTransfer",
34841 "field": "agentTransferTimeout",
34848 "field": "mandatoryDispositionPauseId",
34849 "description": "<p>Status to put when mandatory disposition is enabled</p>"
34855 "field": "mandatoryDisposition",
34856 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34862 "field": "description",
34868 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34869 "version": "0.0.0",
34870 "filename": "server/api/whatsappAccount/index.js",
34871 "groupTitle": "Whatsapp_Accounts"
34875 "url": "/api/whatsapp/accounts/{id}",
34876 "title": "Deletes a Account",
34879 "title": "Example usage:",
34880 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34884 "name": "DeleteAccounts",
34885 "group": "Whatsapp_Accounts",
34886 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34887 "version": "0.0.0",
34888 "filename": "server/api/whatsappAccount/index.js",
34889 "groupTitle": "Whatsapp_Accounts"
34893 "url": "/api/whatsapp/accounts/describe",
34894 "title": "Gets table info about Accounts",
34897 "title": "Example usage:",
34898 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34902 "name": "DescribeAccounts",
34903 "group": "Whatsapp_Accounts",
34904 "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>",
34905 "version": "0.0.0",
34906 "filename": "server/api/whatsappAccount/index.js",
34907 "groupTitle": "Whatsapp_Accounts"
34911 "url": "/api/whatsapp/accounts",
34912 "title": "Gets a list of Accounts",
34915 "title": "Example usage:",
34916 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34920 "name": "GetAccounts",
34921 "group": "Whatsapp_Accounts",
34922 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34923 "version": "0.0.0",
34924 "filename": "server/api/whatsappAccount/index.js",
34925 "groupTitle": "Whatsapp_Accounts"
34929 "url": "/api/whatsapp/accounts/{id}/users",
34930 "title": "Gets agents from whatsapp account",
34933 "title": "Example usage:",
34934 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34938 "name": "GetAgents",
34939 "group": "Whatsapp_Accounts",
34940 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34941 "version": "0.0.0",
34942 "filename": "server/api/whatsappAccount/index.js",
34943 "groupTitle": "Whatsapp_Accounts"
34947 "url": "/api/whatsapp/accounts/{id}/users",
34948 "title": "Removes agents from a whatsapp account",
34951 "title": "Example usage:",
34952 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34956 "name": "RemoveAgents",
34957 "group": "Whatsapp_Accounts",
34958 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34959 "version": "0.0.0",
34960 "filename": "server/api/whatsappAccount/index.js",
34961 "groupTitle": "Whatsapp_Accounts"
34965 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34966 "title": "Removes canned answers from account",
34969 "title": "Example usage:",
34970 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34974 "name": "RemoveAnswers",
34975 "group": "Whatsapp_Accounts",
34976 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34977 "version": "0.0.0",
34978 "filename": "server/api/whatsappAccount/index.js",
34979 "groupTitle": "Whatsapp_Accounts"
34983 "url": "/api/whatsapp/accounts/{id}/dispositions",
34984 "title": "Removes dispositions from account",
34987 "title": "Example usage:",
34988 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34992 "name": "RemoveDispositions",
34993 "group": "Whatsapp_Accounts",
34994 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34995 "version": "0.0.0",
34996 "filename": "server/api/whatsappAccount/index.js",
34997 "groupTitle": "Whatsapp_Accounts"
35001 "url": "/api/whatsapp/accounts/{id}",
35002 "title": "Gets a single Account",
35005 "title": "Example usage:",
35006 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35010 "name": "ShowAccounts",
35011 "group": "Whatsapp_Accounts",
35012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35013 "version": "0.0.0",
35014 "filename": "server/api/whatsappAccount/index.js",
35015 "groupTitle": "Whatsapp_Accounts"
35019 "url": "/api/whatsapp/messages/{id}/accept",
35020 "title": "Accepts message",
35023 "title": "Example usage:",
35024 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35028 "name": "acceptMessage",
35029 "group": "Whatsapp_Accounts",
35030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35031 "version": "0.0.0",
35032 "filename": "server/api/whatsappMessage/index.js",
35033 "groupTitle": "Whatsapp_Accounts"
35037 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35038 "title": "Creates new canned answer",
35041 "title": "Example usage:",
35042 "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",
35046 "name": "addAnswer",
35047 "group": "Whatsapp_Accounts",
35069 "field": "description",
35082 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35083 "version": "0.0.0",
35084 "filename": "server/api/whatsappAccount/index.js",
35085 "groupTitle": "Whatsapp_Accounts"
35089 "url": "/api/whatsapp/accounts/{id}/applications",
35090 "title": "Creates new applications",
35093 "title": "Example usage:",
35094 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35098 "name": "addApplications",
35099 "group": "Whatsapp_Accounts",
35107 "field": "priority",
35121 "field": "appdata",
35128 "field": "description",
35135 "field": "interval",
35141 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35142 "version": "0.0.0",
35143 "filename": "server/api/whatsappAccount/index.js",
35144 "groupTitle": "Whatsapp_Accounts"
35148 "url": "/api/whatsapp/accounts/{id}/dispositions",
35149 "title": "Creates new disposition",
35152 "title": "Example usage:",
35153 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35157 "name": "addDisposition",
35158 "group": "Whatsapp_Accounts",
35185 "field": "description",
35191 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35192 "version": "0.0.0",
35193 "filename": "server/api/whatsappAccount/index.js",
35194 "groupTitle": "Whatsapp_Accounts"
35198 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35199 "title": "Gets account canned answers",
35202 "title": "Example usage:",
35203 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35207 "name": "getAnswers",
35208 "group": "Whatsapp_Accounts",
35209 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35210 "version": "0.0.0",
35211 "filename": "server/api/whatsappAccount/index.js",
35212 "groupTitle": "Whatsapp_Accounts"
35216 "url": "/api/whatsapp/accounts/{id}/applications",
35217 "title": "Gets account applications",
35220 "title": "Example usage:",
35221 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35225 "name": "getApplications",
35226 "group": "Whatsapp_Accounts",
35227 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35228 "version": "0.0.0",
35229 "filename": "server/api/whatsappAccount/index.js",
35230 "groupTitle": "Whatsapp_Accounts"
35234 "url": "/api/whatsapp/accounts/{id}/dispositions",
35235 "title": "Gets account dispositions",
35238 "title": "Example usage:",
35239 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35243 "name": "getDispositions",
35244 "group": "Whatsapp_Accounts",
35245 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35246 "version": "0.0.0",
35247 "filename": "server/api/whatsappAccount/index.js",
35248 "groupTitle": "Whatsapp_Accounts"
35252 "url": "/api/whatsapp/accounts/{id}/notify",
35253 "title": "Notify new message",
35256 "title": "Example usage:",
35257 "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",
35262 "group": "Whatsapp_Accounts",
35263 "description": "<p>Motion 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>",
35264 "version": "0.0.0",
35265 "filename": "server/api/whatsappAccount/index.js",
35266 "groupTitle": "Whatsapp_Accounts"
35270 "url": "/api/whatsapp/messages/{id}/reject",
35271 "title": "Rejects message",
35274 "title": "Example usage:",
35275 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35279 "name": "rejectMessage",
35280 "group": "Whatsapp_Accounts",
35281 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35282 "version": "0.0.0",
35283 "filename": "server/api/whatsappMessage/index.js",
35284 "groupTitle": "Whatsapp_Accounts"
35288 "url": "/api/whatsapp/accounts/{id}/send",
35289 "title": "Send new whatsapp message",
35292 "title": "Example usage:",
35293 "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",
35297 "name": "sendWhatsapp",
35298 "group": "Whatsapp_Accounts",
35299 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35300 "version": "0.0.0",
35301 "filename": "server/api/whatsappAccount/index.js",
35302 "groupTitle": "Whatsapp_Accounts"
35306 "url": "/api/whatsapp/messages/{id}/status",
35307 "title": "Receive message status",
35310 "title": "Example usage:",
35311 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35315 "name": "statusMessage",
35316 "group": "Whatsapp_Accounts",
35317 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35318 "version": "0.0.0",
35319 "filename": "server/api/whatsappMessage/index.js",
35320 "groupTitle": "Whatsapp_Accounts"
35324 "url": "/api/whatsapp/accounts/{id}",
35325 "title": "Update an existing Account",
35328 "title": "Example usage:",
35329 "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",
35333 "name": "updateAccounts",
35334 "group": "Whatsapp_Accounts",
35335 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35336 "version": "0.0.0",
35337 "filename": "server/api/whatsappAccount/index.js",
35338 "groupTitle": "Whatsapp_Accounts"
35342 "url": "/api/whatsapp/applications",
35343 "title": "Creates a new Application",
35346 "title": "Example usage:",
35347 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35351 "name": "CreateApplications",
35352 "group": "Whatsapp_Applications",
35360 "field": "priority",
35374 "field": "appdata",
35381 "field": "description",
35388 "field": "interval",
35394 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35395 "version": "0.0.0",
35396 "filename": "server/api/whatsappApplication/index.js",
35397 "groupTitle": "Whatsapp_Applications"
35401 "url": "/api/whatsapp/applications/{id}",
35402 "title": "Deletes a Application",
35405 "title": "Example usage:",
35406 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35410 "name": "DeleteApplications",
35411 "group": "Whatsapp_Applications",
35412 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35413 "version": "0.0.0",
35414 "filename": "server/api/whatsappApplication/index.js",
35415 "groupTitle": "Whatsapp_Applications"
35419 "url": "/api/whatsapp/applications",
35420 "title": "Gets a list of Applications",
35423 "title": "Example usage:",
35424 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35428 "name": "GetApplications",
35429 "group": "Whatsapp_Applications",
35430 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35431 "version": "0.0.0",
35432 "filename": "server/api/whatsappApplication/index.js",
35433 "groupTitle": "Whatsapp_Applications"
35437 "url": "/api/whatsapp/applications/{id}",
35438 "title": "Gets a single Application",
35441 "title": "Example usage:",
35442 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35446 "name": "ShowApplications",
35447 "group": "Whatsapp_Applications",
35448 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35449 "version": "0.0.0",
35450 "filename": "server/api/whatsappApplication/index.js",
35451 "groupTitle": "Whatsapp_Applications"
35455 "url": "/api/whatsapp/applications/{id}",
35456 "title": "Update an existing Application",
35459 "title": "Example usage:",
35460 "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",
35464 "name": "updateApplications",
35465 "group": "Whatsapp_Applications",
35466 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35467 "version": "0.0.0",
35468 "filename": "server/api/whatsappApplication/index.js",
35469 "groupTitle": "Whatsapp_Applications"
35473 "url": "/api/whatsapp/interactions/{id}/tags",
35474 "title": "Add tags to the interaction",
35477 "title": "Example usage:",
35478 "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",
35483 "group": "Whatsapp_Interactions",
35484 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35485 "version": "0.0.0",
35486 "filename": "server/api/whatsappInteraction/index.js",
35487 "groupTitle": "Whatsapp_Interactions"
35491 "url": "/api/whatsapp/interactions",
35492 "title": "Creates a new Interaction",
35495 "title": "Example usage:",
35496 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35500 "name": "CreateInteractions",
35501 "group": "Whatsapp_Interactions",
35516 "field": "closedAt",
35523 "field": "disposition",
35530 "field": "secondDisposition",
35537 "field": "thirdDisposition",
35558 "field": "read1stAt",
35569 "field": "firstMsgDirection",
35576 "field": "lastMsgAt",
35587 "field": "lastMsgDirection",
35594 "field": "autoreplyExecuted",
35600 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35601 "version": "0.0.0",
35602 "filename": "server/api/whatsappInteraction/index.js",
35603 "groupTitle": "Whatsapp_Interactions"
35607 "url": "/api/whatsapp/interactions/{id}",
35608 "title": "Deletes a Interaction",
35611 "title": "Example usage:",
35612 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35616 "name": "DeleteInteractions",
35617 "group": "Whatsapp_Interactions",
35618 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35619 "version": "0.0.0",
35620 "filename": "server/api/whatsappInteraction/index.js",
35621 "groupTitle": "Whatsapp_Interactions"
35625 "url": "/api/whatsapp/interactions/describe",
35626 "title": "Gets table info about Interactions",
35629 "title": "Example usage:",
35630 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35634 "name": "DescribeInteractions",
35635 "group": "Whatsapp_Interactions",
35636 "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>",
35637 "version": "0.0.0",
35638 "filename": "server/api/whatsappInteraction/index.js",
35639 "groupTitle": "Whatsapp_Interactions"
35643 "url": "/api/whatsapp/interactions",
35644 "title": "Gets a list of Interactions",
35647 "title": "Example usage:",
35648 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35652 "name": "GetInteractions",
35653 "group": "Whatsapp_Interactions",
35654 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35655 "version": "0.0.0",
35656 "filename": "server/api/whatsappInteraction/index.js",
35657 "groupTitle": "Whatsapp_Interactions"
35661 "url": "/api/whatsapp/interactions/{id}/tags",
35662 "title": "Removes tags from interaction",
35665 "title": "Example usage:",
35666 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35670 "name": "RemoveTags",
35671 "group": "Whatsapp_Interactions",
35672 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35673 "version": "0.0.0",
35674 "filename": "server/api/whatsappInteraction/index.js",
35675 "groupTitle": "Whatsapp_Interactions"
35679 "url": "/api/whatsapp/interactions/{id}",
35680 "title": "Gets a single Interaction",
35683 "title": "Example usage:",
35684 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35688 "name": "ShowInteractions",
35689 "group": "Whatsapp_Interactions",
35690 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35691 "version": "0.0.0",
35692 "filename": "server/api/whatsappInteraction/index.js",
35693 "groupTitle": "Whatsapp_Interactions"
35697 "url": "/api/whatsapp/interactions/{id}/messages",
35698 "title": "Creates new messages",
35701 "title": "Example usage:",
35702 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35706 "name": "addMessage",
35707 "group": "Whatsapp_Interactions",
35733 "field": "direction",
35740 "field": "messageId",
35768 "field": "providerName",
35775 "field": "providerResponse",
35781 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35782 "version": "0.0.0",
35783 "filename": "server/api/whatsappInteraction/index.js",
35784 "groupTitle": "Whatsapp_Interactions"
35788 "url": "/api/whatsapp/interactions/{id}/download",
35789 "title": "Gets interaction",
35792 "title": "Example usage:",
35793 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35797 "name": "download",
35798 "group": "Whatsapp_Interactions",
35799 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35800 "version": "0.0.0",
35801 "filename": "server/api/whatsappInteraction/index.js",
35802 "groupTitle": "Whatsapp_Interactions"
35806 "url": "/api/whatsapp/interactions/{id}/messages",
35807 "title": "Gets interaction messages",
35810 "title": "Example usage:",
35811 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35815 "name": "getMessages",
35816 "group": "Whatsapp_Interactions",
35817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35818 "version": "0.0.0",
35819 "filename": "server/api/whatsappInteraction/index.js",
35820 "groupTitle": "Whatsapp_Interactions"
35824 "url": "/api/whatsapp/interactions/{id}",
35825 "title": "Update an existing Interaction",
35828 "title": "Example usage:",
35829 "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",
35833 "name": "updateInteractions",
35834 "group": "Whatsapp_Interactions",
35835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35836 "version": "0.0.0",
35837 "filename": "server/api/whatsappInteraction/index.js",
35838 "groupTitle": "Whatsapp_Interactions"
35842 "url": "/api/whatsapp/messages",
35843 "title": "Creates a new Message",
35846 "title": "Example usage:",
35847 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35851 "name": "CreateMessages",
35852 "group": "Whatsapp_Messages",
35878 "field": "direction",
35885 "field": "messageId",
35913 "field": "providerName",
35920 "field": "providerResponse",
35926 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35927 "version": "0.0.0",
35928 "filename": "server/api/whatsappMessage/index.js",
35929 "groupTitle": "Whatsapp_Messages"
35933 "url": "/api/whatsapp/messages/{id}",
35934 "title": "Deletes a Message",
35937 "title": "Example usage:",
35938 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35942 "name": "DeleteMessages",
35943 "group": "Whatsapp_Messages",
35944 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35945 "version": "0.0.0",
35946 "filename": "server/api/whatsappMessage/index.js",
35947 "groupTitle": "Whatsapp_Messages"
35951 "url": "/api/whatsapp/messages/describe",
35952 "title": "Gets table info about Messages",
35955 "title": "Example usage:",
35956 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35960 "name": "DescribeMessages",
35961 "group": "Whatsapp_Messages",
35962 "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>",
35963 "version": "0.0.0",
35964 "filename": "server/api/whatsappMessage/index.js",
35965 "groupTitle": "Whatsapp_Messages"
35969 "url": "/api/whatsapp/messages",
35970 "title": "Gets a list of Messages",
35973 "title": "Example usage:",
35974 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35978 "name": "GetMessages",
35979 "group": "Whatsapp_Messages",
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/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>",
35981 "version": "0.0.0",
35982 "filename": "server/api/whatsappMessage/index.js",
35983 "groupTitle": "Whatsapp_Messages"
35987 "url": "/api/whatsapp/messages/{id}",
35988 "title": "Gets a single Message",
35991 "title": "Example usage:",
35992 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35996 "name": "ShowMessages",
35997 "group": "Whatsapp_Messages",
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/whatsappMessage/index.js",
36001 "groupTitle": "Whatsapp_Messages"
36005 "url": "/api/whatsapp/messages/{id}",
36006 "title": "Update an existing Message",
36009 "title": "Example usage:",
36010 "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",
36014 "name": "updateMessages",
36015 "group": "Whatsapp_Messages",
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/whatsappMessage/index.js",
36019 "groupTitle": "Whatsapp_Messages"
36023 "url": "/api/whatsapp/reports/queue",
36024 "title": "Creates a new Whatsapp Queue Report",
36027 "title": "Example usage:",
36028 "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",
36032 "name": "CreateWhatsapp_Queue_Reports",
36033 "group": "Whatsapp_Queue_Reports",
36041 "field": "uniqueid",
36062 "field": "leaveAt",
36069 "field": "acceptAt",
36089 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36090 "version": "0.0.0",
36091 "filename": "server/api/whatsappQueueReport/index.js",
36092 "groupTitle": "Whatsapp_Queue_Reports"
36096 "url": "/api/whatsapp/reports/queue/{id}",
36097 "title": "Deletes a Whatsapp Queue Report",
36100 "title": "Example usage:",
36101 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36105 "name": "DeleteWhatsapp_Queue_Reports",
36106 "group": "Whatsapp_Queue_Reports",
36107 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36108 "version": "0.0.0",
36109 "filename": "server/api/whatsappQueueReport/index.js",
36110 "groupTitle": "Whatsapp_Queue_Reports"
36114 "url": "/api/whatsapp/reports/queue/describe",
36115 "title": "Gets table info about Whatsapp Queue Reports",
36118 "title": "Example usage:",
36119 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36123 "name": "DescribeWhatsapp_Queue_Reports",
36124 "group": "Whatsapp_Queue_Reports",
36125 "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>",
36126 "version": "0.0.0",
36127 "filename": "server/api/whatsappQueueReport/index.js",
36128 "groupTitle": "Whatsapp_Queue_Reports"
36132 "url": "/api/whatsapp/reports/queue",
36133 "title": "Gets a list of Whatsapp Queue Reports",
36136 "title": "Example usage:",
36137 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36141 "name": "GetWhatsapp_Queue_Reports",
36142 "group": "Whatsapp_Queue_Reports",
36143 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36144 "version": "0.0.0",
36145 "filename": "server/api/whatsappQueueReport/index.js",
36146 "groupTitle": "Whatsapp_Queue_Reports"
36150 "url": "/api/whatsapp/reports/queue/{id}",
36151 "title": "Gets a single Whatsapp Queue Report",
36154 "title": "Example usage:",
36155 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36159 "name": "ShowWhatsapp_Queue_Reports",
36160 "group": "Whatsapp_Queue_Reports",
36161 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36162 "version": "0.0.0",
36163 "filename": "server/api/whatsappQueueReport/index.js",
36164 "groupTitle": "Whatsapp_Queue_Reports"
36168 "url": "/api/whatsapp/reports/queue/{id}",
36169 "title": "Update an existing Whatsapp Queue Report",
36172 "title": "Example usage:",
36173 "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",
36177 "name": "updateWhatsapp_Queue_Reports",
36178 "group": "Whatsapp_Queue_Reports",
36179 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36180 "version": "0.0.0",
36181 "filename": "server/api/whatsappQueueReport/index.js",
36182 "groupTitle": "Whatsapp_Queue_Reports"
36186 "url": "/api/whatsapp/queues/{id}/users",
36187 "title": "Add agents to a queue",
36190 "title": "Example usage:",
36191 "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",
36195 "name": "AddAgents",
36196 "group": "Whatsapp_Queues",
36197 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36198 "version": "0.0.0",
36199 "filename": "server/api/whatsappQueue/index.js",
36200 "groupTitle": "Whatsapp_Queues"
36204 "url": "/api/whatsapp/queues/{id}/teams",
36205 "title": "Add teams to a queue",
36208 "title": "Example usage:",
36209 "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",
36213 "name": "AddTeams",
36214 "group": "Whatsapp_Queues",
36215 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36216 "version": "0.0.0",
36217 "filename": "server/api/whatsappQueue/index.js",
36218 "groupTitle": "Whatsapp_Queues"
36222 "url": "/api/whatsapp/queues",
36223 "title": "Creates a new Queue",
36226 "title": "Example usage:",
36227 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36231 "name": "CreateQueues",
36232 "group": "Whatsapp_Queues",
36247 "field": "timeout",
36259 "field": "strategy",
36266 "field": "description",
36272 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36273 "version": "0.0.0",
36274 "filename": "server/api/whatsappQueue/index.js",
36275 "groupTitle": "Whatsapp_Queues"
36279 "url": "/api/whatsapp/queues/{id}",
36280 "title": "Deletes a Queue",
36283 "title": "Example usage:",
36284 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36288 "name": "DeleteQueues",
36289 "group": "Whatsapp_Queues",
36290 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36291 "version": "0.0.0",
36292 "filename": "server/api/whatsappQueue/index.js",
36293 "groupTitle": "Whatsapp_Queues"
36297 "url": "/api/whatsapp/queues/describe",
36298 "title": "Gets table info about Queues",
36301 "title": "Example usage:",
36302 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36306 "name": "DescribeQueues",
36307 "group": "Whatsapp_Queues",
36308 "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>",
36309 "version": "0.0.0",
36310 "filename": "server/api/whatsappQueue/index.js",
36311 "groupTitle": "Whatsapp_Queues"
36315 "url": "/api/whatsapp/queues/{id}/users",
36316 "title": "Gets queue agents",
36319 "title": "Example usage:",
36320 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36324 "name": "GetAgents",
36325 "group": "Whatsapp_Queues",
36326 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36327 "version": "0.0.0",
36328 "filename": "server/api/whatsappQueue/index.js",
36329 "groupTitle": "Whatsapp_Queues"
36333 "url": "/api/whatsapp/queues/{id}/members",
36334 "title": "GetMembers",
36337 "title": "Example usage:",
36338 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
36342 "name": "GetMembers",
36343 "group": "Whatsapp_Queues",
36344 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36345 "version": "0.0.0",
36346 "filename": "server/api/whatsappQueue/index.js",
36347 "groupTitle": "Whatsapp_Queues"
36351 "url": "/api/whatsapp/queues",
36352 "title": "Gets a list of Queues",
36355 "title": "Example usage:",
36356 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36360 "name": "GetQueues",
36361 "group": "Whatsapp_Queues",
36362 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36363 "version": "0.0.0",
36364 "filename": "server/api/whatsappQueue/index.js",
36365 "groupTitle": "Whatsapp_Queues"
36369 "url": "/api/whatsapp/queues/{id}/teams",
36370 "title": "Gets queues list",
36373 "title": "Example usage:",
36374 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36378 "name": "GetTeams",
36379 "group": "Whatsapp_Queues",
36380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36381 "version": "0.0.0",
36382 "filename": "server/api/whatsappQueue/index.js",
36383 "groupTitle": "Whatsapp_Queues"
36387 "url": "/api/whatsapp/queues/{id}/users",
36388 "title": "Removes agents from a queue",
36391 "title": "Example usage:",
36392 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36396 "name": "RemoveAgents",
36397 "group": "Whatsapp_Queues",
36398 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36399 "version": "0.0.0",
36400 "filename": "server/api/whatsappQueue/index.js",
36401 "groupTitle": "Whatsapp_Queues"
36405 "url": "/api/whatsapp/queues/{id}",
36406 "title": "Gets a single Queue",
36409 "title": "Example usage:",
36410 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36414 "name": "ShowQueues",
36415 "group": "Whatsapp_Queues",
36416 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36417 "version": "0.0.0",
36418 "filename": "server/api/whatsappQueue/index.js",
36419 "groupTitle": "Whatsapp_Queues"
36423 "url": "/api/whatsapp/queues/{id}",
36424 "title": "Update an existing Queue",
36427 "title": "Example usage:",
36428 "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",
36432 "name": "updateQueues",
36433 "group": "Whatsapp_Queues",
36434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36435 "version": "0.0.0",
36436 "filename": "server/api/whatsappQueue/index.js",
36437 "groupTitle": "Whatsapp_Queues"
36441 "url": "/api/whatsapp/reports/transfer",
36442 "title": "Creates a new Whatsapp Transfer Report",
36445 "title": "Example usage:",
36446 "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",
36450 "name": "CreateWhatsapp_Transfer_Reports",
36451 "group": "Whatsapp_Transfer_Reports",
36459 "field": "uniqueid",
36478 "field": "transferredAt",
36484 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36485 "version": "0.0.0",
36486 "filename": "server/api/whatsappTransferReport/index.js",
36487 "groupTitle": "Whatsapp_Transfer_Reports"
36491 "url": "/api/whatsapp/reports/transfer/{id}",
36492 "title": "Deletes a Whatsapp Transfer Report",
36495 "title": "Example usage:",
36496 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36500 "name": "DeleteWhatsapp_Transfer_Reports",
36501 "group": "Whatsapp_Transfer_Reports",
36502 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36503 "version": "0.0.0",
36504 "filename": "server/api/whatsappTransferReport/index.js",
36505 "groupTitle": "Whatsapp_Transfer_Reports"
36509 "url": "/api/whatsapp/reports/transfer/describe",
36510 "title": "Gets table info about Whatsapp Transfer Reports",
36513 "title": "Example usage:",
36514 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36518 "name": "DescribeWhatsapp_Transfer_Reports",
36519 "group": "Whatsapp_Transfer_Reports",
36520 "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>",
36521 "version": "0.0.0",
36522 "filename": "server/api/whatsappTransferReport/index.js",
36523 "groupTitle": "Whatsapp_Transfer_Reports"
36527 "url": "/api/whatsapp/reports/transfer",
36528 "title": "Gets a list of Whatsapp Transfer Reports",
36531 "title": "Example usage:",
36532 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36536 "name": "GetWhatsapp_Transfer_Reports",
36537 "group": "Whatsapp_Transfer_Reports",
36538 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36539 "version": "0.0.0",
36540 "filename": "server/api/whatsappTransferReport/index.js",
36541 "groupTitle": "Whatsapp_Transfer_Reports"
36545 "url": "/api/whatsapp/reports/transfer/{id}",
36546 "title": "Gets a single Whatsapp Transfer Report",
36549 "title": "Example usage:",
36550 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36554 "name": "ShowWhatsapp_Transfer_Reports",
36555 "group": "Whatsapp_Transfer_Reports",
36556 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36557 "version": "0.0.0",
36558 "filename": "server/api/whatsappTransferReport/index.js",
36559 "groupTitle": "Whatsapp_Transfer_Reports"
36563 "url": "/api/whatsapp/reports/transfer/{id}",
36564 "title": "Update an existing Whatsapp Transfer Report",
36567 "title": "Example usage:",
36568 "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",
36572 "name": "updateWhatsapp_Transfer_Reports",
36573 "group": "Whatsapp_Transfer_Reports",
36574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36575 "version": "0.0.0",
36576 "filename": "server/api/whatsappTransferReport/index.js",
36577 "groupTitle": "Whatsapp_Transfer_Reports"
36581 "url": "/api/integrations/zendesk/accounts",
36582 "title": "Creates a new Zendesk Account",
36585 "title": "Example usage:",
36586 "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",
36590 "name": "CreateZendesk_Accounts",
36591 "group": "Zendesk_Accounts",
36606 "field": "description",
36613 "field": "username",
36620 "field": "password",
36634 "field": "remoteUri",
36645 "field": "authType",
36652 "field": "serverUrl",
36659 "\"integrationTab\"",
36669 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36670 "version": "0.0.0",
36671 "filename": "server/api/intZendeskAccount/index.js",
36672 "groupTitle": "Zendesk_Accounts"
36676 "url": "/api/integrations/zendesk/accounts/{id}",
36677 "title": "Deletes a Zendesk Account",
36680 "title": "Example usage:",
36681 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36685 "name": "DeleteZendesk_Accounts",
36686 "group": "Zendesk_Accounts",
36687 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36688 "version": "0.0.0",
36689 "filename": "server/api/intZendeskAccount/index.js",
36690 "groupTitle": "Zendesk_Accounts"
36694 "url": "/api/integrations/zendesk/accounts",
36695 "title": "Gets a list of Zendesk Accounts",
36698 "title": "Example usage:",
36699 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36703 "name": "GetZendesk_Accounts",
36704 "group": "Zendesk_Accounts",
36705 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36706 "version": "0.0.0",
36707 "filename": "server/api/intZendeskAccount/index.js",
36708 "groupTitle": "Zendesk_Accounts"
36712 "url": "/api/integrations/zendesk/accounts/{id}",
36713 "title": "Gets a single Zendesk Account",
36716 "title": "Example usage:",
36717 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36721 "name": "ShowZendesk_Accounts",
36722 "group": "Zendesk_Accounts",
36723 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36724 "version": "0.0.0",
36725 "filename": "server/api/intZendeskAccount/index.js",
36726 "groupTitle": "Zendesk_Accounts"
36730 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36731 "title": "Creates new configuration",
36734 "title": "Example usage:",
36735 "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",
36739 "name": "addConfiguration",
36740 "group": "Zendesk_Accounts",
36741 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36742 "version": "0.0.0",
36743 "filename": "server/api/intZendeskAccount/index.js",
36744 "groupTitle": "Zendesk_Accounts"
36748 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36749 "title": "Gets account configurations",
36752 "title": "Example usage:",
36753 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36757 "name": "getConfigurations",
36758 "group": "Zendesk_Accounts",
36759 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36760 "version": "0.0.0",
36761 "filename": "server/api/intZendeskAccount/index.js",
36762 "groupTitle": "Zendesk_Accounts"
36766 "url": "/api/integrations/zendesk/accounts/{id}/fields",
36767 "title": "Gets account fields",
36770 "title": "Example usage:",
36771 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36775 "name": "getFields",
36776 "group": "Zendesk_Accounts",
36777 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36778 "version": "0.0.0",
36779 "filename": "server/api/intZendeskAccount/index.js",
36780 "groupTitle": "Zendesk_Accounts"
36784 "url": "/api/integrations/zendesk/accounts/{id}",
36785 "title": "Update an existing Zendesk Account",
36788 "title": "Example usage:",
36789 "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",
36793 "name": "updateZendesk_Accounts",
36794 "group": "Zendesk_Accounts",
36795 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36796 "version": "0.0.0",
36797 "filename": "server/api/intZendeskAccount/index.js",
36798 "groupTitle": "Zendesk_Accounts"
36802 "url": "/api/integrations/zendesk/configurations",
36803 "title": "Creates a new Zendesk Configuration",
36806 "title": "Example usage:",
36807 "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",
36811 "name": "CreateZendesk_Configurations",
36812 "group": "Zendesk_Configurations",
36827 "field": "description",
36833 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36834 "version": "0.0.0",
36835 "filename": "server/api/intZendeskConfiguration/index.js",
36836 "groupTitle": "Zendesk_Configurations"
36840 "url": "/api/integrations/zendesk/configurations/{id}",
36841 "title": "Deletes a Zendesk Configuration",
36844 "title": "Example usage:",
36845 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36849 "name": "DeleteZendesk_Configurations",
36850 "group": "Zendesk_Configurations",
36851 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36852 "version": "0.0.0",
36853 "filename": "server/api/intZendeskConfiguration/index.js",
36854 "groupTitle": "Zendesk_Configurations"
36858 "url": "/api/integrations/zendesk/configurations",
36859 "title": "Gets a list of Zendesk Configurations",
36862 "title": "Example usage:",
36863 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36867 "name": "GetZendesk_Configurations",
36868 "group": "Zendesk_Configurations",
36869 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36870 "version": "0.0.0",
36871 "filename": "server/api/intZendeskConfiguration/index.js",
36872 "groupTitle": "Zendesk_Configurations"
36876 "url": "/api/integrations/zendesk/configurations/{id}",
36877 "title": "Gets a single Zendesk Configuration",
36880 "title": "Example usage:",
36881 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36885 "name": "ShowZendesk_Configurations",
36886 "group": "Zendesk_Configurations",
36887 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36888 "version": "0.0.0",
36889 "filename": "server/api/intZendeskConfiguration/index.js",
36890 "groupTitle": "Zendesk_Configurations"
36894 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36895 "title": "Gets configurations descriptions",
36898 "title": "Example usage:",
36899 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36903 "name": "getDescriptions",
36904 "group": "Zendesk_Configurations",
36905 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36906 "version": "0.0.0",
36907 "filename": "server/api/intZendeskConfiguration/index.js",
36908 "groupTitle": "Zendesk_Configurations"
36912 "url": "/api/integrations/zendesk/configurations/{id}/fields",
36913 "title": "Gets configurations fields",
36916 "title": "Example usage:",
36917 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36921 "name": "getFields",
36922 "group": "Zendesk_Configurations",
36923 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36924 "version": "0.0.0",
36925 "filename": "server/api/intZendeskConfiguration/index.js",
36926 "groupTitle": "Zendesk_Configurations"
36930 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36931 "title": "Gets configurations subjects",
36934 "title": "Example usage:",
36935 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36939 "name": "getSubjects",
36940 "group": "Zendesk_Configurations",
36941 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36942 "version": "0.0.0",
36943 "filename": "server/api/intZendeskConfiguration/index.js",
36944 "groupTitle": "Zendesk_Configurations"
36948 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36949 "title": "Gets configurations tags",
36952 "title": "Example usage:",
36953 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36958 "group": "Zendesk_Configurations",
36959 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36960 "version": "0.0.0",
36961 "filename": "server/api/intZendeskConfiguration/index.js",
36962 "groupTitle": "Zendesk_Configurations"
36966 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36967 "title": "Sets new tags",
36970 "title": "Example usage:",
36971 "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",
36976 "group": "Zendesk_Configurations",
36977 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36978 "version": "0.0.0",
36979 "filename": "server/api/intZendeskConfiguration/index.js",
36980 "groupTitle": "Zendesk_Configurations"
36984 "url": "/api/integrations/zendesk/configurations/{id}",
36985 "title": "Update an existing Zendesk Configuration",
36988 "title": "Example usage:",
36989 "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",
36993 "name": "updateZendesk_Configurations",
36994 "group": "Zendesk_Configurations",
36995 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36996 "version": "0.0.0",
36997 "filename": "server/api/intZendeskConfiguration/index.js",
36998 "groupTitle": "Zendesk_Configurations"
37002 "url": "/api/integrations/zendesk/fields",
37003 "title": "Creates a new Zendesk Field",
37006 "title": "Example usage:",
37007 "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",
37011 "name": "CreateZendesk_Fields",
37012 "group": "Zendesk_Fields",
37022 "\"customVariable\"",
37034 "field": "content",
37050 "\"customVariable\""
37053 "field": "keyType",
37060 "field": "keyContent",
37067 "field": "idField",
37074 "field": "nameField",
37081 "field": "customField",
37088 "field": "variableName",
37094 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37095 "version": "0.0.0",
37096 "filename": "server/api/intZendeskField/index.js",
37097 "groupTitle": "Zendesk_Fields"
37101 "url": "/api/integrations/zendesk/fields/{id}",
37102 "title": "Deletes a Zendesk Field",
37105 "title": "Example usage:",
37106 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37110 "name": "DeleteZendesk_Fields",
37111 "group": "Zendesk_Fields",
37112 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37113 "version": "0.0.0",
37114 "filename": "server/api/intZendeskField/index.js",
37115 "groupTitle": "Zendesk_Fields"
37119 "url": "/api/integrations/zendesk/fields",
37120 "title": "Gets a list of Zendesk Fields",
37123 "title": "Example usage:",
37124 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37128 "name": "GetZendesk_Fields",
37129 "group": "Zendesk_Fields",
37130 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37131 "version": "0.0.0",
37132 "filename": "server/api/intZendeskField/index.js",
37133 "groupTitle": "Zendesk_Fields"
37137 "url": "/api/integrations/zendesk/fields/{id}",
37138 "title": "Gets a single Zendesk Field",
37141 "title": "Example usage:",
37142 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37146 "name": "ShowZendesk_Fields",
37147 "group": "Zendesk_Fields",
37148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37149 "version": "0.0.0",
37150 "filename": "server/api/intZendeskField/index.js",
37151 "groupTitle": "Zendesk_Fields"
37155 "url": "/api/integrations/zendesk/fields/{id}",
37156 "title": "Update an existing Zendesk Field",
37159 "title": "Example usage:",
37160 "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",
37164 "name": "updateZendesk_Fields",
37165 "group": "Zendesk_Fields",
37166 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37167 "version": "0.0.0",
37168 "filename": "server/api/intZendeskField/index.js",
37169 "groupTitle": "Zendesk_Fields"
37173 "url": "/api/integrations/zoho/accounts",
37174 "title": "Creates a new Zoho Account",
37177 "title": "Example usage:",
37178 "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",
37182 "name": "CreateZoho_Accounts",
37183 "group": "Zoho_Accounts",
37198 "field": "description",
37219 "field": "clientId",
37226 "field": "clientSecret",
37233 "field": "serverUrl",
37247 "field": "refreshToken",
37253 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37254 "version": "0.0.0",
37255 "filename": "server/api/intZohoAccount/index.js",
37256 "groupTitle": "Zoho_Accounts"
37260 "url": "/api/integrations/zoho/accounts/{id}",
37261 "title": "Deletes a Zoho Account",
37264 "title": "Example usage:",
37265 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37269 "name": "DeleteZoho_Accounts",
37270 "group": "Zoho_Accounts",
37271 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37272 "version": "0.0.0",
37273 "filename": "server/api/intZohoAccount/index.js",
37274 "groupTitle": "Zoho_Accounts"
37278 "url": "/api/integrations/zoho/accounts",
37279 "title": "Gets a list of Zoho Accounts",
37282 "title": "Example usage:",
37283 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37287 "name": "GetZoho_Accounts",
37288 "group": "Zoho_Accounts",
37289 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37290 "version": "0.0.0",
37291 "filename": "server/api/intZohoAccount/index.js",
37292 "groupTitle": "Zoho_Accounts"
37296 "url": "/api/integrations/zoho/accounts/{id}",
37297 "title": "Gets a single Zoho Account",
37300 "title": "Example usage:",
37301 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37305 "name": "ShowZoho_Accounts",
37306 "group": "Zoho_Accounts",
37307 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37308 "version": "0.0.0",
37309 "filename": "server/api/intZohoAccount/index.js",
37310 "groupTitle": "Zoho_Accounts"
37314 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37315 "title": "Creates new configuration",
37318 "title": "Example usage:",
37319 "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",
37323 "name": "addConfiguration",
37324 "group": "Zoho_Accounts",
37325 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37326 "version": "0.0.0",
37327 "filename": "server/api/intZohoAccount/index.js",
37328 "groupTitle": "Zoho_Accounts"
37332 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37333 "title": "Gets account configurations",
37336 "title": "Example usage:",
37337 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37341 "name": "getConfigurations",
37342 "group": "Zoho_Accounts",
37343 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37344 "version": "0.0.0",
37345 "filename": "server/api/intZohoAccount/index.js",
37346 "groupTitle": "Zoho_Accounts"
37350 "url": "/api/integrations/zoho/accounts/{id}/fields",
37351 "title": "Gets account fields",
37354 "title": "Example usage:",
37355 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37359 "name": "getFields",
37360 "group": "Zoho_Accounts",
37361 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37362 "version": "0.0.0",
37363 "filename": "server/api/intZohoAccount/index.js",
37364 "groupTitle": "Zoho_Accounts"
37368 "url": "/api/integrations/zoho/accounts/{id}",
37369 "title": "Update an existing Zoho Account",
37372 "title": "Example usage:",
37373 "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",
37377 "name": "updateZoho_Accounts",
37378 "group": "Zoho_Accounts",
37379 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37380 "version": "0.0.0",
37381 "filename": "server/api/intZohoAccount/index.js",
37382 "groupTitle": "Zoho_Accounts"
37386 "url": "/api/integrations/zoho/configurations",
37387 "title": "Creates a new Zoho Configuration",
37390 "title": "Example usage:",
37391 "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",
37395 "name": "CreateZoho_Configurations",
37396 "group": "Zoho_Configurations",
37416 "field": "moduleCreate",
37423 "\"contact_lead\"",
37428 "field": "moduleSearch",
37435 "field": "description",
37441 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37442 "version": "0.0.0",
37443 "filename": "server/api/intZohoConfiguration/index.js",
37444 "groupTitle": "Zoho_Configurations"
37448 "url": "/api/integrations/zoho/configurations/{id}",
37449 "title": "Deletes a Zoho Configuration",
37452 "title": "Example usage:",
37453 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37457 "name": "DeleteZoho_Configurations",
37458 "group": "Zoho_Configurations",
37459 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37460 "version": "0.0.0",
37461 "filename": "server/api/intZohoConfiguration/index.js",
37462 "groupTitle": "Zoho_Configurations"
37466 "url": "/api/integrations/zoho/configurations",
37467 "title": "Gets a list of Zoho Configurations",
37470 "title": "Example usage:",
37471 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37475 "name": "GetZoho_Configurations",
37476 "group": "Zoho_Configurations",
37477 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37478 "version": "0.0.0",
37479 "filename": "server/api/intZohoConfiguration/index.js",
37480 "groupTitle": "Zoho_Configurations"
37484 "url": "/api/integrations/zoho/configurations/{id}",
37485 "title": "Gets a single Zoho Configuration",
37488 "title": "Example usage:",
37489 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37493 "name": "ShowZoho_Configurations",
37494 "group": "Zoho_Configurations",
37495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37496 "version": "0.0.0",
37497 "filename": "server/api/intZohoConfiguration/index.js",
37498 "groupTitle": "Zoho_Configurations"
37502 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37503 "title": "Gets configurations descriptions",
37506 "title": "Example usage:",
37507 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37511 "name": "getDescriptions",
37512 "group": "Zoho_Configurations",
37513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37514 "version": "0.0.0",
37515 "filename": "server/api/intZohoConfiguration/index.js",
37516 "groupTitle": "Zoho_Configurations"
37520 "url": "/api/integrations/zoho/configurations/{id}/fields",
37521 "title": "Gets configurations fields",
37524 "title": "Example usage:",
37525 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37529 "name": "getFields",
37530 "group": "Zoho_Configurations",
37531 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37532 "version": "0.0.0",
37533 "filename": "server/api/intZohoConfiguration/index.js",
37534 "groupTitle": "Zoho_Configurations"
37538 "url": "/api/integrations/zoho/configurations/{id}/subjects",
37539 "title": "Gets configurations subjects",
37542 "title": "Example usage:",
37543 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37547 "name": "getSubjects",
37548 "group": "Zoho_Configurations",
37549 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37550 "version": "0.0.0",
37551 "filename": "server/api/intZohoConfiguration/index.js",
37552 "groupTitle": "Zoho_Configurations"
37556 "url": "/api/integrations/zoho/configurations/{id}",
37557 "title": "Update an existing Zoho Configuration",
37560 "title": "Example usage:",
37561 "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",
37565 "name": "updateZoho_Configurations",
37566 "group": "Zoho_Configurations",
37567 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37568 "version": "0.0.0",
37569 "filename": "server/api/intZohoConfiguration/index.js",
37570 "groupTitle": "Zoho_Configurations"
37574 "url": "/api/integrations/zoho/fields",
37575 "title": "Creates a new Zoho Field",
37578 "title": "Example usage:",
37579 "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",
37583 "name": "CreateZoho_Fields",
37584 "group": "Zoho_Fields",
37594 "\"customVariable\"",
37606 "field": "content",
37622 "\"customVariable\""
37625 "field": "keyType",
37632 "field": "keyContent",
37639 "field": "idField",
37646 "field": "nameField",
37653 "field": "customField",
37660 "field": "variableName",
37666 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37667 "version": "0.0.0",
37668 "filename": "server/api/intZohoField/index.js",
37669 "groupTitle": "Zoho_Fields"
37673 "url": "/api/integrations/zoho/fields/{id}",
37674 "title": "Deletes a Zoho Field",
37677 "title": "Example usage:",
37678 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37682 "name": "DeleteZoho_Fields",
37683 "group": "Zoho_Fields",
37684 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37685 "version": "0.0.0",
37686 "filename": "server/api/intZohoField/index.js",
37687 "groupTitle": "Zoho_Fields"
37691 "url": "/api/integrations/zoho/fields",
37692 "title": "Gets a list of Zoho Fields",
37695 "title": "Example usage:",
37696 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37700 "name": "GetZoho_Fields",
37701 "group": "Zoho_Fields",
37702 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37703 "version": "0.0.0",
37704 "filename": "server/api/intZohoField/index.js",
37705 "groupTitle": "Zoho_Fields"
37709 "url": "/api/integrations/zoho/fields/{id}",
37710 "title": "Gets a single Zoho Field",
37713 "title": "Example usage:",
37714 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37718 "name": "ShowZoho_Fields",
37719 "group": "Zoho_Fields",
37720 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37721 "version": "0.0.0",
37722 "filename": "server/api/intZohoField/index.js",
37723 "groupTitle": "Zoho_Fields"
37727 "url": "/api/integrations/zoho/fields/{id}",
37728 "title": "Update an existing Zoho Field",
37731 "title": "Example usage:",
37732 "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",
37736 "name": "updateZoho_Fields",
37737 "group": "Zoho_Fields",
37738 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37739 "version": "0.0.0",
37740 "filename": "server/api/intZohoField/index.js",
37741 "groupTitle": "Zoho_Fields"
37746 "title": "Creates a new Cdr",
37749 "title": "Example usage:",
37750 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37754 "name": "CreateCdrs",
37763 "field": "calldate",
37791 "field": "dcontext",
37798 "field": "channel",
37805 "field": "dstchannel",
37812 "field": "lastapp",
37819 "field": "lastdata",
37826 "field": "duration",
37833 "field": "billsec",
37840 "field": "disposition",
37847 "field": "amaflags",
37854 "field": "accountcode",
37861 "field": "userfield",
37868 "field": "uniqueid",
37875 "field": "linkedid",
37882 "field": "sequence",
37889 "field": "peeraccount",
37909 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37910 "version": "0.0.0",
37911 "filename": "server/api/cdr/index.js",
37912 "groupTitle": "cdr"
37916 "url": "/api/cdr/{id}",
37917 "title": "Deletes a Cdr",
37920 "title": "Example usage:",
37921 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37925 "name": "DeleteCdrs",
37927 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37928 "version": "0.0.0",
37929 "filename": "server/api/cdr/index.js",
37930 "groupTitle": "cdr"
37934 "url": "/api/cdr/describe",
37935 "title": "Gets table info about Cdrs",
37938 "title": "Example usage:",
37939 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37943 "name": "DescribeCdrs",
37945 "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>",
37946 "version": "0.0.0",
37947 "filename": "server/api/cdr/index.js",
37948 "groupTitle": "cdr"
37953 "title": "Gets a list of Cdrs",
37956 "title": "Example usage:",
37957 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37963 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37964 "version": "0.0.0",
37965 "filename": "server/api/cdr/index.js",
37966 "groupTitle": "cdr"
37970 "url": "/api/cdr/{id}",
37971 "title": "Gets a single Cdr",
37974 "title": "Example usage:",
37975 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37979 "name": "ShowCdrs",
37981 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37982 "version": "0.0.0",
37983 "filename": "server/api/cdr/index.js",
37984 "groupTitle": "cdr"
37988 "url": "/api/cdr/{id}",
37989 "title": "Update an existing Cdr",
37992 "title": "Example usage:",
37993 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37997 "name": "updateCdrs",
37999 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38000 "version": "0.0.0",
38001 "filename": "server/api/cdr/index.js",
38002 "groupTitle": "cdr"
38006 "url": "/api/voiceQueuesLog",
38007 "title": "Creates a new VoiceQueuesLog",
38010 "title": "Example usage:",
38011 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38015 "name": "CreateVoiceQueuesLogs",
38016 "group": "voiceQueuesLog",
38038 "field": "queuename",
38107 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38108 "version": "0.0.0",
38109 "filename": "server/api/voiceQueuesLog/index.js",
38110 "groupTitle": "voiceQueuesLog"
38114 "url": "/api/voiceQueuesLog/{id}",
38115 "title": "Deletes a VoiceQueuesLog",
38118 "title": "Example usage:",
38119 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38123 "name": "DeleteVoiceQueuesLogs",
38124 "group": "voiceQueuesLog",
38125 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38126 "version": "0.0.0",
38127 "filename": "server/api/voiceQueuesLog/index.js",
38128 "groupTitle": "voiceQueuesLog"
38132 "url": "/api/voiceQueuesLog",
38133 "title": "Gets a list of VoiceQueuesLogs",
38136 "title": "Example usage:",
38137 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38141 "name": "GetVoiceQueuesLogs",
38142 "group": "voiceQueuesLog",
38143 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38144 "version": "0.0.0",
38145 "filename": "server/api/voiceQueuesLog/index.js",
38146 "groupTitle": "voiceQueuesLog"
38150 "url": "/api/voiceQueuesLog/{id}",
38151 "title": "Gets a single VoiceQueuesLog",
38154 "title": "Example usage:",
38155 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38159 "name": "ShowVoiceQueuesLogs",
38160 "group": "voiceQueuesLog",
38161 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38162 "version": "0.0.0",
38163 "filename": "server/api/voiceQueuesLog/index.js",
38164 "groupTitle": "voiceQueuesLog"
38168 "url": "/api/voiceQueuesLog/{id}",
38169 "title": "Update an existing VoiceQueuesLog",
38172 "title": "Example usage:",
38173 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38177 "name": "updateVoiceQueuesLogs",
38178 "group": "voiceQueuesLog",
38179 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38180 "version": "0.0.0",
38181 "filename": "server/api/voiceQueuesLog/index.js",
38182 "groupTitle": "voiceQueuesLog"